Spring

Custom Annotation 어노테이션 만들기 (@LoginUser)

주씨. 2023. 1. 18. 15:29
728x90
/**
 * 1.
 * 이 어노테이션이 생성될 수 있는 위치를 지정한다.
 * PARAMETER로 지정했으니 메소드의 파라미터로 선언된 객체에서만 사용할 수 있다.
 * 이 외에도 클래스 선언문에 쓸 수 있는 TYPE 등이 있다.
 */

/**
 * 2.
 * @Retention 어노테이션은 라이프사이클,
 * 즉, 어노테이션이 언제까지 살아 남아 있을지를 정하는 역할을 한다.
 */

@Target(ElementType.PARAMETER) // 1
@Retention(RetentionPolicy.RUNTIME) // 2
public @interface LoginUser {
}
@RequiredArgsConstructor
@Component
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {
    private final HttpSession httpSession;


    /**
     * 컨트롤러 메서드의 특정 파라미터를 지원하는지 판단한다.
     * 여기서는 파라미터에 @LoginUser 어노테이션이 붙어 있고, 파라미터 클래스 타입이 SessionUser.class 인 경우 true를 반환한다.
     */
    @Override
    public boolean supportsParameter(MethodParameter parameter){
        boolean isLoginUserAnnotation = parameter.getParameterAnnotation(LoginUser.class) != null;
        boolean isUserClass = SessionUser.class.equals(parameter.getParameterType());

        return isLoginUserAnnotation && isUserClass;
    }

    /**
     * 파라미터에 전달할 객체를 생성한다.
     * 여기서는 세션에서 객체를 가져온다.
     */
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception{
        return httpSession.getAttribute("user");
    }
}

/**
 * @LoginUser 를 사용하기 위한 환경이 구성되었다.
 * 이제 LoginUserArgumentResolver가 스프링에서 인식될 수 있도록 WebMvcConfigurer에 추가한다.
 */
@RequiredArgsConstructor
@Configuration
public class WebConfig implements WebMvcConfigurer {
    private final LoginUserArgumentResolver loginUserArgumentResolver;

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers){
        argumentResolvers.add(loginUserArgumentResolver);
    }
}

* HandlerMethodArgumentResolver는 항상 WebMvcConfigurer의 addArgumentResolvers()를 통해 추가해야 한다.
* 다른 HandlerMethodArgumentResolver가 필요하다면 같은 방식으로 추가하면 된다.