구글 로그인 어노테이션 기반으로 개선하기

지금까지 짠 코드를 확인하면 같은 코드가 반복되는 부분이 존재한다. 이렇게 같은 코드가 반복하면 이후에 수적이 필요할 때 모든 부분을 하나씩 찾아가며 수정해야 하므로 유지보수성이 떨어진다. 바로 세션값을 가져오는 부분이 개선할만한 가치가 있다.

SessionUser user = (SessionUser) httpSession.getAttribute("user");

이제 이 부분을 메소드 인자로 세션값을 바로 받을 수 있게 만들 것이다.

 

@LoginUser 만들기

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginUser {
}

@Target(ElementType.PARAMETER)

• 이 어노테이션이 생성될 수 있는 위치를 지정한다.
• PARAMETER로 지정했으니 메소드의 파라미터로 선언된 객체에서만 사용할 수 있다.

@Retention

• 어노테이션이 언제까지 살아 남아 있을지를 정한다.

@interface

• 이 파일을 어노테이션 클래스로 지정한다.
• LoginUser라는 이름을 가진 어노테이션이 생성되었다.

 

LoginUserArgumentResolver

HandlerMethodArgumentResolver 인터페이스를 구현한 클래스이다.

이 인터페이스는 조건에 맞는 경우 메소드가 있다면 HandlerMethodArgumentResolver의 구현체가 지정한 값으로 해당 메소드의 파라미터로 넘길 수 있다.

@RequiredArgsConstructor
@Component
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {
    private final HttpSession httpSession;
    @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");
    }
}

supportsParameter()

• 컨트롤러 메서드의 특정 파라미터를 지원하는지 판단한다.
• 여기서는 파라미터에 @LoginUser 어노테이션이 붙어 있고, 파라미터 클래스 타입이 SessionUser.class 인경우 true를 반환한다.

resolveArgument()

• 파라미터에 전달할 객체를 생성한다.
• 여기서는 세션에서 객체를 가져온다.

 

WebConfig

이제 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를 통해 추가해야 합니다.

이제 이렇게 하면 @LoginUser를 파라미터로 가져올 수 있습니다.

@GetMapping("/")
public String index(Model model, @LoginUser SessionUser user){
    model.addAttribute("posts", postsService.findAllDesc());
    if(user != null){
        model.addAttribute("userName",user.getName());
    }
    return "index";
}

이렇게 LoginUser를 파리미터로 가져오고 SessionUser또한 한번에 가져올 수 있습니다.