[Java] 어노테이션

출처

Gemini

---

어노테이션(Annotation)이란

자바 소스 코드에 추가하여 특정 정보를 제공하는 메타데이터의 일종이다. 이러한 메타데이터는 컴파일러, 개발 도구, 또는 런타임 시스템에 의해 읽혀져 다양한 용도로 활용될 수 있다. 마치 포스트잇처럼 코드에 메모를 붙여 놓는 것과 비슷하다고 생각하면 쉽다.

 

특징

선언적 프로그래밍

코드에 대한 정보를 명시적으로 선언하여 코드의 가독성을 높이고 유지보수를 용이하게 한다.

메타데이터 제공

컴파일러, IDE, 프레임워크 등에 추가적인 정보를 제공하여 더욱 정교한 처리를 가능하게 한다.

코드에 영향을 미치지 않음

어노테이션 자체는 실행 코드에 직접적인 영향을 미치지 않지만, 컴파일 시점이나 런타임 시점에 특정 행위를 유발할 수 있다.

 

종류

표준 어노테이션

자바에서 기본적으로 제공되는 어노테이션. @Override, @Deprecated, @SuppressWarnings 등이 있다.

메타 어노테이션

다른 어노테이션을 정의하기 위한 어노테이션. @Target, @Retention, @Documented 등이 있다.

사용자 정의 어노테이션

개발자가 직접 정의하여 사용하는 어노테이션.

 

활용

컴파일러 지시

컴파일러에게 특정 코드에 대한 추가적인 검사나 처리를 지시한다.

IDE 지원

IDE에서 코드 자동 완성, 리팩토링 등을 지원하는 데 사용된다.

프레임워크 연동

스프링 프레임워크와 같은 프레임워크에서 빈 설정, AOP 등을 위한 메타데이터로 활용된다.

• 관련 글 -> [용어] AOP Aspect Oriented Programming
• 어노테이션은 AOP의 핵심 기능인 포인트컷을 지정하고, 어드바이스를 설정하는 데 사용되는 메타데이터이다.

빌드 도구 설정

빌드 도구(Maven, Gradle)에서 프로젝트 빌드 설정을 위한 정보를 제공한다.

런타임 시스템

런타임 시스템에서 객체 직렬화, 리플렉션 등을 위한 정보를 제공한다.

 

장점

코드 가독성 향상

코드의 의도를 명확하게 표현하여 코드를 이해하기 쉽게 만든다.

유지보수성 향상

코드 변경 시 어노테이션을 통해 관련 부분을 쉽게 찾아 수정할 수 있다.

재사용성 증가

어노테이션을 통해 공통적인 기능을 추출하여 재사용할 수 있다.

확장성

사용자 정의 어노테이션을 통해 다양한 기능을 구현할 수 있다.

 

단점

1. 과도한 의존성

• 컴파일 시 의존: 어노테이션 프로세서가 필요하기 때문에 컴파일 과정이 복잡해질 수 있다.
• 런타임 의존: 런타임 시 어노테이션 값을 읽어와 로직을 변경하는 경우, 어노테이션에 대한 의존성이 강해져 유지 보수가 어려워질 수 있다.

2. 가독성 저하

• 코드에 직접적인 영향을 미치지 않지만, 코드의 의미를 파악하는 데 방해가 될 수 있다. 특히, 많은 어노테이션이 사용될 경우 코드가 복잡해 보일 수 있다.
• 어노테이션의 의미를 정확히 파악하기 위해 추가적인 문서화가 필요하다.

3. 오버 엔지니어링

• 간단한 로직에 불필요하게 어노테이션을 사용하면 오히려 코드를 복잡하게 만들 수 있다.
• 어노테이션을 남용하면 코드의 가독성이 오히려 떨어질 수 있다.

4. 런타임 성능 저하:

• 어노테이션 처리를 위해 추가적인 오버헤드가 발생할 수 있다. 특히, 많은 어노테이션이 사용되는 경우 성능 저하가 발생할 수 있다.

5. 툴 의존성

• 어노테이션 프로세서와 같은 외부 도구에 의존하기 때문에, 도구의 버전 문제나 호환성 문제가 발생할 수 있다.

6. 테스트의 어려움

• 어노테이션 기반의 코드를 테스트하기 위해서는 어노테이션 프로세서를 함께 사용해야 하는 경우가 많다. 이는 테스트 환경 설정을 복잡하게 만들 수 있다.

 

어노테이션을 효과적으로 사용하기 위한 팁

필요한 경우에만 사용

모든 상황에 어노테이션을 사용하는 것은 바람직하지 않다.

명확한 의미 부여

어노테이션의 의미를 명확하게 정의하고, 다른 개발자들이 쉽게 이해할 수 있도록 문서화해야 한다.

과도한 사용 자제

너무 많은 어노테이션을 사용하면 코드 가독성이 저하될 수 있으므로 적절한 수준에서 사용해야 한다.

테스트 환경 구축

어노테이션 기반의 코드를 테스트하기 위한 환경을 미리 구축해 두는 것이 좋다.

툴 활용

어노테이션 프로세서를 효과적으로 활용하기 위한 툴을 사용하면 개발 생산성을 높일 수 있다.

 

 

알면 좋은 어노테이션들

1. 표준 어노테이션

@Override

메서드가 부모 클래스의 메서드를 오버라이드했음을 나타낸다. 컴파일러가 오타나 실수를 잡아내는 데 도움을 준다.

@Deprecated

더 이상 사용되지 않는 요소임을 나타낸다. 사용 시 컴파일러 경고를 발생시켜 코드 유지보수에 도움을 준다.

@SuppressWarnings

컴파일러 경고를 억제한다. 특정 경고 메시지가 코드의 본질적인 문제를 나타내지 않을 때 사용한다.

 

2. 메타 어노테이션

@Target

어노테이션을 적용할 수 있는 위치를 지정합니다. 예를 들어, 클래스, 메서드, 필드 등에 적용할 수 있다.

@Retention

어노테이션이 유지되는 시기를 지정합니다. 컴파일 시, 클래스 파일, 런타임 중에 유지될 수 있다.

@Documented

어노테이션이 Javadoc에 포함되어 문서화될 수 있도록 한다.

 

3. 자주 사용되는 프레임워크 어노테이션

스프링 프레임워크

• @Component: 스프링 컨테이너에 빈으로 등록한다.
• @Service: 서비스 계층의 빈을 나타낸다.
• @Repository: 데이터 접근 계층의 빈을 나타낸다.
• @Controller: 웹 계층의 컨트롤러를 나타낸다.
• @Autowired: 의존성 주입을 위한 어노테이션.

JPA

• @Entity: 자바 클래스를 데이터베이스 테이블과 매핑한다.
• @Id: 엔티티의 기본 키를 나타낸다.
• @Column: 테이블의 컬럼과 매핑한다.

JUnit

• @Test: 테스트 메소드를 나타낸다..
• @Before, @After: 각 테스트 메소드 실행 전후에 실행될 메소드를 지정한다.

 

사용자 어노테이션이 필요성

코드의 의도를 명확하게 표현하고 싶을 때

• 예를 들어, 특정 메소드가 로그를 남겨야 한다거나, 특정 필드는 필수 입력값인지를 명시하고 싶을 때 사용자 정의 어노테이션을 활용하여 코드의 의도를 명확하게 드러낼 수 있다.

프레임워크와의 연동을 위한 설정

• 스프링 프레임워크와 같은 프레임워크에서 빈 설정, AOP 등을 위한 메타데이터로 활용된다. 예를 들어, 스프링 MVC에서 @Controller, @Service, @Repository 등의 어노테이션을 사용하여 각 계층의 역할을 명확히 구분하고 의존성 주입을 자동화한다.

코드 검증

• 컴파일 시점이나 런타임 시점에 코드의 유효성을 검증하는 데 사용할 수 있다. 예를 들어, 특정 필드에 특정 값만 허용하도록 제한하는 어노테이션을 정의하여 오류를 미리 방지할 수 있다.

도구 지원

• IDE나 빌드 도구와 같은 개발 도구에서 코드 분석, 자동 완성, 리팩토링 등을 지원하는 데 사용된다.

 

 

사용자 어노테이션 예시

로그 남기기

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Loggable {
}

@Loggable
public void someMethod() {
    // ...
}

 

위 예시에서는 @Loggable 어노테이션을 사용하여 해당 메소드에 대한 로그를 남겨야 함을 명시적으로 표현했다. AOP를 활용하여 어노테이션이 붙은 메소드 실행 전후에 로그를 남기는 기능을 구현할 수 있다.

 

필수 입력값 검증

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Required {
}

public class User {
    @Required
    private String name;
    // ...
}

 

위 예시에서는 @Required 어노테이션을 사용하여 name 필드가 필수 입력값임을 나타낸다. 데이터 검증 로직에서 이 어노테이션을 참고하여 필수 필드가 입력되었는지 확인할 수 있다.

 

커스텀 데이터 형식

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Email {
}

public class User {
    @Email
    private String email;
    // ...
}

 

위 예시에서는 @Email 어노테이션을 사용하여 해당 필드가 이메일 형식이어야 함을 나타낸다. 데이터 검증 로직에서 이 어노테이션을 참고하여 이메일 형식이 맞는지 확인할 수 있다.

 

 

 

 

---

Gemini 글의 출처

https://knowledgebasement.com/how-to-create-custom-annotations-in-java/

How to Create Custom Annotations in Java