Categories: 미분류

Java 애너테이션(Annotation)과 커스텀 애너테이션 활용법에 대해 알아보기

Java의 애너테이션(Annotation)은 메타데이터를 코드에 추가하는 기능을 제공합니다. 이를 활용하면 코드의 가독성을 높이고, 프레임워크에서 런타임 처리를 자동화할 수 있습니다. 또한, 개발자가 직접 커스텀 애너테이션을 만들어 특정 기능을 수행하도록 할 수도 있습니다.

이번 글에서는 Java의 애너테이션 개념과 기본적인 사용법, 그리고 커스텀 애너테이션을 활용하는 방법을 심층적으로 다뤄보겠습니다.

1. 애너테이션(Annotation)이란?

애너테이션은 코드에 부가적인 정보를 제공하는 기능입니다. 주석(Comment)과 달리 애너테이션은 컴파일러, 런타임 환경에서 분석할 수 있으며, 프레임워크에서 특정 동작을 수행하는 데 사용됩니다.

1) 기본 애너테이션 종류

Java에서 기본적으로 제공하는 주요 애너테이션은 다음과 같습니다.

애너테이션	설명
`@Override`	부모 클래스의 메서드를 오버라이드하는 경우 사용
`@Deprecated`	사용이 권장되지 않는 메서드나 클래스를 표시
`@SuppressWarnings`	특정 경고를 무시할 때 사용
`@FunctionalInterface`	함수형 인터페이스임을 명시
`@Retention`	애너테이션의 유지 정책을 정의
`@Target`	애너테이션을 적용할 수 있는 위치 지정

2) 애너테이션 사용 예제

class Parent {
    @Deprecated
    public void oldMethod() {
        System.out.println("이 메서드는 더 이상 사용되지 않습니다.");
    }
}

public class AnnotationExample {
    @Override
    public String toString() {
        return "애너테이션 예제";
    }

    public static void main(String[] args) {
        Parent parent = new Parent();
        parent.oldMethod(); // 컴파일러 경고 발생
    }
}

2. 커스텀 애너테이션(Custom Annotation) 만들기

Java에서는 개발자가 직접 애너테이션을 만들고, 이를 활용하여 특정 기능을 수행할 수 있습니다.

1) 커스텀 애너테이션 정의

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    String value() default "Default Value";
}

@Retention(RetentionPolicy.RUNTIME): 런타임까지 유지되어 리플렉션을 통해 접근 가능합니다.
@Target(ElementType.METHOD): 메서드에만 적용 가능합니다.
String value() default "Default Value";: 기본값을 설정할 수 있는 요소가 추가 됩니다.

2) 애너테이션 적용

class MyClass {
    @MyAnnotation(value = "Hello Annotation!")
    public void myMethod() {
        System.out.println("실행 중");
    }
}

3) 리플렉션을 활용한 애너테이션 분석

import java.lang.reflect.Method;

public class AnnotationProcessor {
    public static void main(String[] args) throws Exception {
        Class<?> clazz = MyClass.class;
        Method method = clazz.getMethod("myMethod");
        
        if (method.isAnnotationPresent(MyAnnotation.class)) {
            MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
            System.out.println("애너테이션 값: " + annotation.value());
        }
    }
}

출력

애너테이션 값: Hello Annotation!

3. 실무에서 애너테이션 활용 사례

Spring 프레임워크: @Service, @Component, @Autowired 등의 애너테이션을 활용하여 의존성 주입 및 빈 관리 수행하게 됩니다.
JUnit 테스트 프레임워크: @Test 애너테이션을 사용하여 테스트 케이스 실행하게 됩니다.
Lombok 라이브러리: @Getter, @Setter, @Builder 등의 애너테이션을 사용하여 자동 코드 생성합니다.
ORM 프레임워크(Hibernate, JPA): @Entity, @Column, @OneToMany 등의 애너테이션을 활용하여 데이터베이스 매핑 수행을 하게 합니다.

4. 애너테이션 활용 시 주의할 점

과도한 사용을 피하라: 너무 많은 애너테이션을 사용하면 코드가 난해해질 수 있습니다.
적절한 유지 정책(RetentionPolicy) 설정: SOURCE, CLASS, RUNTIME 중 필요에 맞게 선택 합니다.
리플렉션 성능 고려: 런타임 애너테이션 사용 시 성능 저하 가능성이 있습니다.

문의 내용 예시 및 답변

1. 애너테이션을 많이 사용하면 성능에 영향을 미칠까요?

답변: 애너테이션 자체는 성능에 큰 영향을 미치지 않지만, 리플렉션을 사용하여 런타임에 애너테이션을 처리할 경우 성능 저하가 발생할 수 있습니다. 성능이 중요한 시스템에서는 캐싱을 활용하는 것이 좋습니다.

2. 애너테이션과 인터페이스의 차이점은 무엇인가요?

답변: 인터페이스는 클래스의 동작을 정의하는 반면, 애너테이션은 메타데이터를 제공하는 역할을 합니다. 인터페이스는 메서드를 선언하고 구현해야 하지만, 애너테이션은 코드의 의미를 추가하는 용도로 사용됩니다.

3. 커스텀 애너테이션을 사용할 때 가장 중요한 점은 무엇인가요?

답변: 유지 정책(@Retention)과 적용 대상(@Target)을 적절히 설정하는 것이 가장 중요합니다. 또한, 리플렉션을 활용할 경우 성능을 고려하여 캐싱 또는 적절한 데이터 구조를 활용하는 것이 좋습니다.

5. 마무리

Java 애너테이션(Annotation)과 커스텀 애너테이션 활용법에 대해 알아 보았습니다. Java의 애너테이션과 커스텀 애너테이션은 코드의 유지보수성과 가독성을 높이는 강력한 기능입니다. 실무에서는 프레임워크, 테스트 자동화, ORM 등의 다양한 분야에서 활용되니, 좀 더 연습하여 다양한 분야 사용하면 좋을 듯 합니다.

루루파파