Chapter 05. 스프링 시큐리티와 OAuth 2.0으로 로그인 기능 구현하기 (4)

5.4 어노테이션 기반으로 개선하기

 

앞서 만든 코드에서 개선할만한 것은 IndexController에서 세션값을 가져오는 부분

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

index 메소드 외에 다른 컨트롤러와 메소드에서 세션값이 필요하면

 그 때마다 직접 세션에서 값을 가져와야 함.

같은 코드가 계속해서 반복되는 것은 불필요

 

-> 이 부분을 메소드 인자로 세션값을 바로 받을 수 있도록 변경

 

LoginUser.java

package com.jojoldu.book.springboot.config.auth;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

① @Target(ElementType.PARAMETER)
 - 이 어노테이션이 생성될 수 있는 위치를 지정
 - PARAMETER로 지정했으니 메소드의 파라미터로 선언된 객체에서만 사용할 수 있음
 - 이 외에도 클래스 선언문에 쓸 수 있는 TYPE 등이 있다.

② @interface
 - 이 파일을 어노테이션 클래스로 지정
 - LoginUser라는 이름을 가진 어노테이션이 생성되었다고 보면 됨

 

그리고 같은 위치에 LoginUserArgumentResolver를 생성한다

: HandlerMethodeArgumentResolver 인터페이스를 구현한 클래스

 

HandlerMethodeArgumentResolver는 한 가지 기능을 지원

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

 

LoginUserArgumentResolver.java

package com.jojoldu.book.springboot.config.auth;

import com.jojoldu.book.springboot.config.auth.dto.SessionUser;
import lombok.RequiredArgsConstructor;
import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

import javax.servlet.http.HttpSession;

@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를 반환

② resolveArgment()
 - 파라미터에 전달할 객체를 생성
 - 여기서는 세션에서 객체를 가져옴

 

이렇게 생성된 LoginUserArgumentResolver가 스프링에서 인식될 수 있도록 WebMvcConfigurer에 추가

 

WebConfig.java

package com.jojoldu.book.springboot.config;

import com.jojoldu.book.springboot.config.auth.LoginUserArgumentResolver;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@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가 필요하다면 같은 방식으로 추가

 

---

개선

 

IndexController.java

...
@RequiredArgsConstructor
@Controller
public class IndexController {

    private final PostsService postsService;


    @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 user
 - 기존에 (User) httpSession.getAttribute("user")로 가져오던 세션 정보 값이 개선 되었다.
 - 이제는 어느 컨트롤러든지 @LoginUser만 사용하면 세션 정보를 가져올 수 있게 됨

 

이후 실행하면 로그인 기능이 정상적으로 작동하는 것을 확인할 수 있다.

 

 

출처 : 스프링 부트와 AWS로 혼자 구현하는 웹 서비스 [이동욱 지음]