🌱 Spring MVC (12) custom annotation을 이용한 ArgumentResolver 활용

Github 소스코드

🔎 Custom Annotation를 이용한 ArgumentResolver 적용

@GetMapping("/")
public String homeLogin(
        @SessionAttribute(name="SESSION_KEY", required = false) Member member, Model model) {

    if (member == null) return "home";

    model.addAttribute("member", member);
    return "loginHome";
}

위 코드는 적용 전 코드입니다. 먼저 적용 후 코드를 보시죠.

@GetMapping("/")
public String homeLoginV4(@Login Member member, Model model) {
    if (member == null) return "home";
    model.addAttribute("member", member);
    return "loginHome";
}

@Login 이라는 어노테이션으로 Member에 대해 적용 전 코드와 동일한 결과를 만들어 냅니다.

🔎 custom annotation 정의

어노테이션 정의는 interface 앞에 @를 붙여줘야 합니다. 아래 어노테이션은 @Login이 되는 것 입니다.

public @interface Login

어노테이션 설정

• @Target은 정의한 어노테이션이 붙을 수 있는 타입을 정의하는 부분입니다.
• PARAMETER 는 파라미터에 붙을 수 있는 어노테이션이라는 의미입니다.
  • @Target(ElementType.PARAMETER)
• @Retention 은 어노테이션이 어디까지 메모리를 유지할 지에 대한 설정입니다. 간단하게 어노테이션의 생명주기를 설정해준다고 생각해도 될 것 같습니다.
• RetentionPolicy.RUNTIME은 실행될 때까지 어노테이션을 유효하게 하겠다는 정책 설정입니다.
  • @Retention(RetentionPolicy.RUNTIME)

---

🔎 ArgumentResolver 직접 구현

ArgumentResolver 를 직접 구현하려면 HandlerMethodArgumentResolver 인터페이스를 구현해야 합니다.

public class LoginArgumentResolver implements HandlerMethodArgumentResolver

HandlerMethodArgumentResolver 구현 메서드는 아래와 같이 supportParameter와 resolveArguent 두 개입니다.

supportParameter

첫 번째 구현 메서드인 supportParameter는 받은 파라미터를 처리할 수 있는지 검증하는 역할입니다.

• 검증해야 할 사항
  • @Login 어노테이션이 붙은 파라미터인지
  • Member 타입인지

어노테이션에 대한 검증을 위해 MethodParameter는 hasParameterAnnotation 메서드를 지원합니다.

boolean hasLoginAnnotation = parameter.hasParameterAnnotation(Login.class);

타입에 대한 검증은 getParameterType을 이용합니다.
isAssignableFrom은 파라미터의 클래스 타입이 자신이거나 자신을 상속/구현했는지 검증하는 메서드입니다.

boolean isMemberType = Member.class.isAssignableFrom(parameter.getParameterType());

두 검증을 만족한 경우에만 resolveArgument 메서드가 실행됩니다.

return hasLoginAnnotation && isMemberType;

resolveArgument

요청에 대한 세션을 검증해야 하므로 HttpServletRequest를 이용해 세션 정보를 가져온 후 검증을 수행합니다.

HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
HttpSession session = request.getSession(false);

if (session == null) return null;

리턴은 세션에 담긴 Member 입니다.

return (Member) session.getAttribute("SESSION_KEY";

ArgumentResolver가 호출되면 가장 먼저 supportParameter를 통해 파라미터 지원 여부를 확인하고 지원한다면 resolveArgument를 호출하여 실제 객체를 생성하여 호출한 곳의 객체에 바인딩 시켜주는 것 입니다.

인프런 김영한님의 스프링 MVC 2편 을 수강하고 정리한 내용입니다.