[Spring]@Documented, @AuthenticationPrincipal, @Retention, @Target

목차

• @Documented
• @AuthenticationPrincipal
• @Retention
• @Target

 

인증이 끝난 사용자를 애너테이션으로 분류하는 구현을 하다가 몇 가지 애너테이션을 만나게 되었다.

 

우선 (CP로)구현은 끝났는데 뭔지는 알고 넘어가야 할 것 같아서.

 

하나씩 알아보자.

@Documented
@AuthenticationPrincipal
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.TYPE})
public @interface SignInUser {
}

 

@Documented

 

해당 애너테이션이 메타 애너테이션으로 설정된 애너테이션을 JavaDoc에 포함시킨다.

 

JavaDoc은 기본적으론 애너테이션에 대해선 문서화를 해주지 않는다고 한다.

 

@AuthenticationPrincipal

 

인증이 끝난 유저를 가져오는 애너테이션이다. UserDetails를 구현한 유저 객체에 사용할 수 있다고 하는데,

 

내가 구현한 OidcUser 역시 사용할 수 있도록 스프링 시큐리티가 처리해준다고 한다.

 

@Retention

 

단어 뜻 그대로 애너테이션이 유지되는 기간을 지정한다.

 

Source, Class, Runtime의 세 종류가 있으며

 

• Source - 소스코드(.java)까지만 유지된다.
• Class - 클래스파일(.class = 바이트코드)까지 유지된다.
• Runtime - 런타임까지 유지된다. 계속 사용할 수 있다는 뜻.

 

@Target

 

위의 경우가 유지 기간이라면 이 경우는 적용할 수 있는 위치의 범위이다.

 

아래의 타입을 지정하지 않으면 오류가 나게 된다. 복수로 사용하려면 {}를 사용해야 한다.

 

• ElementType.ANNOTATION_TYPE - 애너테이션 타입
• ElementType.CONSTRUCTOR - 생성자
• ElementType.FIELD - 멤버변수
• ElementType.LOCAL_VARIABLE - 지역변수
• ElementType.METHOD - 메서드
• ElementType.PACKAGE - 패키지
• ElementType.MODULE - 모듈
• ElementType.PARAMETER - 파라미터
• ElementType.TYPE - 타입(클래스, 인터페이스, 애너테이션, enum)
• ElementType.TYPE _PARAMETER - 타입 파라미터(제네릭 등)
• ElementType.TYPE_USE - 타입이 사용되는 모든 대상