어노테이션(Annotation)
어노테이션은 메타데이터(Metadata)입니다. 여기서 메타데이터란 다른 데이터를 설명하기 위한 데이터입니다. 그래서 어노테이션은 코드를 설명하기 위한 데이터라고 정의할 수 있습니다.
아래는 자바에서 제공하는 기본 어노테이션인 @Override를 사용한 코드입니다.
@Override
public String toString() {
return "재정의된 메소드";
}
흔히 클래스를 상속받거나 인터페이스를 구현하여 메소드를 재정의할 때 붙이는 어노테이션입니다. 이 것을 지운다고 해서 컴파일 에러가 나거나 프로그램이 정상적으로 동작하거나 하지 않습니다. 실행에는 전혀 영향을 미치지 않죠. 단지 메소드가 재정의되었다는 것만 알려주는 용도로만 사용됩니다.
그럼 어노테이션을 붙임으로써 얻을 수 있는 장점은 무엇일까요?
이 경우는 컴파일러에게 메소드가 재정의된 것을 알려주면 컴파일러는 사용자가 잘못된 오버라이드 (메소드명에 오타가 있다던가 메소드 시그니쳐를 다르다던가)를 했을 때, 컴파일 에러를 발생시켜 사용자가 이를 고칠 수 있게 도와줍니다.
이처럼 어노테이션은 클래스, 필드, 메소드 등등에 코드에 대한 부가설명 및 컴파일 단계에서 도움을 주는 역할로 사용됩니다.
내장 어노테이션
자바에서는 몇가지 어노테이션을 기본적으로 제공합니다.
java.lang 패키지에 속하며, 총 5개의 어노테이션이 있습니다.
@Override: 상위 타입에 정의된 메소드를 재정의했다는 것을 알리기 위해 사용합니다.@Deprecated: 사용하면 위험한 코드임을 표시하거나 해당 코드보다 개선된 코드가 존재하기 때문에 사용하지말 것을 알리기 위해 사용합니다.@SuppressWarnings: 이미 인지한 컴파일러의 경고를 제거하기 위해 사용합니다.@SafeVarargs: 자바 7부터 추가되었으며, 생성자나 메소드의 가변인자 파라미터가 안전하게 사용된다는 것을 나타내기 위해 사용합니다. (String… values와 같은 형태를 가변인자라고 함)@FunctionalInterface: 자바 8부터 추가되었으며, 인터페이스를 함수형 프로그래밍인 람다 방식으로 사용하기를 추천하는 용도로 사용합니다. (자바 8부터 추가)
위의 내장 어노테이션뿐만 아니라 사용자가 원하는 형태의 다양한 어노테이션을 만들 수 있습니다.
커스텀 어노테이션
커스텀 어노테이션와 관련된 소스는 java.lang.annotation 패키지에 속해있습니다.
커스텀 어노테이션을 정의하려면 @interface로 선언해주면 됩니다. @는 인터페이스와 어노테이션을 구분하기 위한 기호입니다. interface에 기호를 붙여주는 방식이라서 공백을 넣어 @ interface도 가능하지만, 표준 스타일을 맞추기 위해 공백없이 붙여주는게 좋습니다.
public @interface MyAnnotation {}
어노테이션 타입은 컴파일시 항상 java.lang.annotation.Annotation을 슈퍼인터페이스로 상속받아서 인터페이스가 어노테이션 타입임을 나타냅니다. 아래는 컴파일된 class 파일의 내용입니다.
public interface MyAnnotation extends java.lang.annotation.Annotation {}
어노테이션 내용 정의
어노테이션 타입은 다음과 같은 내용을 인터페이스 내에 작성할 수 있습니다.
일반 선언 : [추상메소드선언자] 타입 명칭() [DefaultValue];
배열 선언 : [추상메소드선언자] 타입 명칭() [] [DefaultValue];
- […]와 같은 내용은 옵션으로 생략할 수 있습니다.
- 여러 값을 하나의 선언에 넣기 위해선 명칭() []와 같이 배열 선언을 해줘야 합니다.
- 내용 작성시 public abstract 키워드를 붙여줄 수 있지만, class로 컴파일될 때 컴파일러가 붙여 주기 때문에 선언하지 않아도 됩니다.
위와 같은 내용 정의 외에도 상수, enum, class, interface, annotation를 선언할 수 있습니다.
public @interface MyCustom {
// 내용 정의
String name() default "Custom annotation";
// 상수
int CONSTANT = 1;
// enum
enum Status {STOP, RUNNING, FINISHED}
// class
class InnerClass {}
// interface
interface InnerInterface {}
// annotation
@interface InnerAnnotation {}
}
어노테이션의 내용으로 1가지의 내용만 정의하는 경우에는 관례적으로 명칭을 value() 라고 사용합니다.
그리고 default 옵션을 생략할 경우에는 반드시 어노테이션 사용시 값을 입력하도록 할 수 있습니다.
// default를 생략해 어노테이션 사용시 입력 필요
@interface SingleElement {
String value();
}
@SingleElement // 잘못된 사용 - 컴파일 에러
public class MyClass {}
@SingleElement("foo") // 올바른 사용
public class MyClass {}
// default로 선언할 경우 어노테이션 사용시 값을 입력하지 않으면 default로 설정된 값 사용
@interface SingleElement {
String value() default "foo";
}
잘못된 내용 정의
자기 자신을 타입으로 받는 경우 컴파일 에러 "Cyclic annotation element type" 발생
@interface SelfRef { SelfRef value(); }
그리고 어노테이션끼리 서로를 타입으로 받는 경우에도 컴파일 에러가 발생합니다.
@interface Ping { Pong value(); }
@interface Pong { Ping value(); }
미리 정의된 메타 어노테이션
커스텀 어노테이션 작성시 어노테이션을 설명하기 위한 메타 어노테이션이 있습니다.
메타 어노테이션은 아래와 같이 5개가 존재합니다.
@Documented: javadoc 및 기타 문서툴에 의해 문서화될 때, 해당 어노테이션이 문서에 표시됩니다.@Target: 어노테이션 적용 가능한 대상을 지정할 수 있습니다.@Retention: 어노테이션 유지 범위를 지정할 수 있습니다.@Inherited: 자식클래스에서 부모클래스에 선언된 어노테이션을 상속받을 수 있습니다.@Repeatable: 동일한 위치에 같은 어노테이션을 여러 개 선언할 수 있게 합니다.
@Target
어노테이션을 적용할 수 있는 대상(위치)를 나타내는 어노테이션입니다. 만약, Target에 선언된 대상과 다른 대상에 어노테이션을 적용할 경우 컴파일 에러가 발생합니다.
타입으로 enum인 ElementType[]을 받습니다. 아래는 ElementType에 정의된 대상입니다.
TYPE: class, interface, annotation, enum 에만 적용 가능FIELD: 필드, enum 상수에만 적용 가능METHOD: 메소드에만 적용 가능PARAMETER: 파라미터에만 적용 가능CONSTRUCTOR: 생성자에만 적용 가능LOCAL_VARIABLE: 지역변수에만 적용 가능ANNOTATION_TYPE: 어노테이션에만 적용 가능PACKAGE: 패키지에만 적용 가능TYPE_PARAMETER: 자바 8부터 추가되었으며, 타입 파라미터(T, E와 같은)에만 적용 가능TYPE_USE: 자바 8부터 추가되었으며, JLS의 15가지 타입과 타입 파라미터에 적용 가능
// 필드에만 MyCustom 어노테이션 적용 가능
@Target(ElementType.FIELD)
public @interface MyCustom {}
// 필드와 메소드에만 MyCustom 어노테이션 적용 가능
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface MyCustom {}
@Retention
어노테이션이 어느 시점까지 유지되는지를 나타낼 수 있습니다.
enum RetentionPolicy에 3가지의 정책이 있습니다. @Retention을 생략한다면 RetentionPolicy.CLASS가 적용됩니다.
- SOURCE : 컴파일 시점에 컴파일러에 의해 제거됩니다. 즉, java파일내에서만 적용됩니다.
- CLASS : SOURCE 범위뿐만 아니라 class 파일까지 적용됩니다.
- RUNTIME : SOURCE, CLASS 범위뿐만 아니라 JVM에서 실행될 때도 적용돼 리플렉션으로 어노테이션을 조회할 수 있습니다.
// 클래스 파일에 어노테이션이 기록됨
@Retention(RetentionPolicy.CLASS)
@interface MyAnnotation {}
// 어노테이션이 적용된 클래스의 바이트 코드에 RuntimeInvisibleAnnotations이 기록되어 실행시 무시됨.
> javap -v MyClass
...중략...
Constant pool:
...중략...
#10 = Utf8 RuntimeInvisibleAnnotations
#11 = Utf8 LMyAnnotation;
...중략...
// 클래스 파일에 기록될 뿐만 아니라 실행시에도 JVM에 적재돼 유지됨
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {}
// 런타임시 유지될 수 있도록 어노테이션이 적용된 클래스의 바이트 코드에 RuntimeVisibleAnnotations이 기록되어 있습니다.
> javap -v MyClass
...중략...
Constant pool:
...중략...
#10 = Utf8 RuntimeVisibleAnnotations
#11 = Utf8 LMyAnnotation;
...중략...
@Inherited
해당 어노테이션을 적용하면 부모클래스에 선언된 어노테이션이 자식클래스에 상속됩니다.
테스트를 위해 아래와 같이 @NonInheritedAnnotation, @InheritedAnnotation 어노테이션을 만듭니다.
@Retention(RetentionPolicy.RUNTIME)
@interface NonInheritedAnnotation {}
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface InheritedAnnotation {}
다음과 같이 A, B, C 클래스를 만듭니다.
@NonInheritedAnnotation
class A {}
@InheritedAnnotation
class B extends A {}
class C extends B {}
A, B, C를 리플렉션을 통해 @NonInheritedAnnotation을 조회하면 해당 어노테이션이 적용된 A만 어노테이션을 가지고 있습니다.
System.out.println("Non inherited A : " + new A().getClass().getAnnotation(NonInheritedAnnotation.class));
System.out.println("Non inherited B : " + new B().getClass().getAnnotation(NonInheritedAnnotation.class));
System.out.println("Non inherited C : " + new C().getClass().getAnnotation(NonInheritedAnnotation.class));
Non inherited A : @NonInheritedAnnotation()
Non inherited B : null
Non inherited C : null
이번엔 @InheritedAnnotation을 조회하면 B, C만 어노테이션이 출력됩니다. C는 선언된 어노테이션이 없지만, 상속 받은 B 클래스에 적용된 어노테이션이 C에도 동일하게 적용됩니다.
System.out.println("inherited A : " + new A().getClass().getAnnotation(InheritedAnnotation.class));
System.out.println("inherited B : " + new B().getClass().getAnnotation(InheritedAnnotation.class));
System.out.println("inherited C : " + new C().getClass().getAnnotation(InheritedAnnotation.class));
inherited A : null
inherited B : @InheritedAnnotation()
inherited C : @InheritedAnnotation()
@Repeatable
동일한 어노테이션을 여러 개 선언할 경우 컴파일 에러가 발생하지만, @Repeatable을 적용하면 여러 개의 동일한 어노테이션을 선언할 수 있게 됩니다.
@Repeatable(Roles.class) // 컴파일시 Roles에 여러 개의 Role을 컴파일러가 저장
@interface Role {
String value();
}
@interface Roles {
Role[] value();
}
@Role("Role1")
@Role("Role2")
class Repeat {}
동일한 어노테이션이 여러 개 적용된 Repeat 클래스의 바이트 코드 출력하면 Roles에 어노테이션이 저장되는 것을 확인할 수 있습니다.
❯ javap -p -v Repeat
Classfile /Users/hong/test/Repeat.class
...중략...
Constant pool:
...중략...
#9 = Utf8 MyClass.java
#10 = Utf8 RuntimeInvisibleAnnotations
#11 = Utf8 LRoles;
#12 = Utf8 value
#13 = Utf8 LRole;
#14 = Utf8 Role1
#15 = Utf8 Role2
#16 = NameAndType #4:#5 // "<init>":()V
#17 = Utf8 Repeat
#18 = Utf8 java/lang/Object
...중략...
SourceFile: "MyClass.java"
RuntimeInvisibleAnnotations:
// Roles(#11)의 value(#12)값에 Role(#13) 어노테이션인 Role1(#14), Role2(#15)가 배열로 저장됨
0: #11(#12=[@#13(#12=s#14),@#13(#12=s#15)])
커스텀 어노테이션 적용
위의 내용을 토대로 커스텀 어노테이션을 만들어 사용해보겠습니다.
유저를 생성할 때, 자동으로 생성일시를 설정해주는 어노테이션을 만들겠습니다.
런타임시 필드에 사용할 수 있는 @CreatedTime 어노테이션을 아래와 같이 만들어줍니다.
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface CreatedTime {}
User 클래스에 createdTime 이라는 필드를 만들고 어노테이션을 적용합니다.
class User{
private String name;
private String password;
@CreatedTime
private LocalDateTime createdTime;
public User(String name, String password) {
this.name = name;
this.password = password;
}
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", password='" + password + '\'' +
", createdTime=" + createdTime +
'}';
}
}
setCreatedTime 메소드에서 리플렉션을 통해 User 클래스의 필드를 조회해 @CreatedTime이 있는 필드에 현재 시간을 설정해줍니다.
public class AnnotationTest {
public static void main(String[] args) throws Exception {
User newUser = new User("이름", "비밀번호"); // 유저 생성
System.out.println("before : " + newUser);
setCreatedTime(newUser); // 생성일시 설정
System.out.println(" after : " + newUser);
}
public static void setCreatedTime(Object target) throws Exception {
Class<?> clazz = target.getClass();
Arrays.stream(clazz.getDeclaredFields()) // 클래스의 필드 조회
.filter(field -> Objects.nonNull(field.getDeclaredAnnotation(CreatedTime.class))) // @CreatedTime이 적용된 필드만 필터
.forEach(field -> {
try {
field.setAccessible(true); // private 필드에 접근하기 위해 Accessible을 true로 설정
field.set(target, LocalDateTime.now()); // 필드에 현재 시간 설정
} catch (IllegalAccessException e) {
e.printStackTrace();
}
});
}
}
코드를 실행하면 생성일시가 설정되는 것을 확인할 수 있습니다.
before : User{name='이름', password='비밀번호', createdTime=null}
after : User{name='이름', password='비밀번호', createdTime=2018-12-12T23:31:06.172}