[Spring] 로그인 유저 어노테이션 기반으로 정보 가져오기

• 로그인 유저 어노테이션 기반으로 정보 가져오기
  • 1) @LoginUser 어노테이션 생성 
  • 2) 같은 위치에 LoginUserArgumentResolver를 생성 
  • 3) WebConfig 클래스 생성
  • 4) @LoginUser 적용

로그인 유저 어노테이션 기반으로 정보 가져오기

이 부분은 OAuth2.0과는 관계없고 프로젝트 성능 개선에 관련한 부분이다. 일반적으로 프로그래밍에서 개선이 필요한 부분은 반복되는 부분인데 위의 로직에서는 세션값을 가져오는 부분이다.

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

→ 이 코드를 계속해서 반복하게 만든다면 이후에 수정이나 개선이 필요할 때 모든 로직에 다시 복붙을 해야 할 것이다.

 

index메소드 외에 다른 컨트롤러와 메소드에서 세션값이 필요하면 그때마다 직접 세션에서 값을 가져와야 한다. 같은 코드가 계속해서 반복되는 것은 불필요하기 때문에 이부분을 메소드 인자로 세션값을 바로 받을 수 있도록 변경해주자.

 

1) @LoginUser 어노테이션 생성 

package com.loosie.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 {
}

 

2) 같은 위치에 LoginUserArgumentResolver를 생성 

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

 

HandlerMethodArgumentResolver는 조건에 맞는 경우 메소드가 있다면 HandlerMethodArgumentResolver의 구현체(LoginUserArgumentResolver)가 지정한 값을 해당 메소드의 파라미터를 넘길 수 있다.

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

import com.loosie.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;

@Component
@RequiredArgsConstructor
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {

    private final HttpSession httpSession;

    /**
     * Controller 메서드가 특정 파라미터를 지원하는지 판단
     * 1) @LoginUser 어노테이션이 붙어있는지
     * 2) 파라미터 클래스타입 SessionUser.class인지
     *   ==>  1) && 2) ? true : false
     */
    @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"); // 세션에서 유저 객체 정보 가져옴
    }
}

 

3) WebConfig 클래스 생성

LoginUserArgumentResolver가 스프링에 인식될 수 있도록 WebMvcConfiguer에 등록

package com.loosie.book.springboot.config;

import com.loosie.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;

@Configuration
@RequiredArgsConstructor
public class WebConfig implements WebMvcConfigurer {
    private final LoginUserArgumentResolver loginUserArgumentResolver;

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

 

4) @LoginUser 적용

해당 어노테이션(@LoginUser)을 Controller단에 적용해보면 잘 작동한다.

package com.loosie.book.springboot.web;

import com.loosie.book.springboot.config.auth.LoginUser;
import com.loosie.book.springboot.config.auth.dto.SessionUser;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;


@Controller
@RequiredArgsConstructor
public class IndexController {

    @GetMapping("/")
    public String index(Model model, @LoginUser SessionUser user){
        model.addAttribute("posts", postsService.findAllDesc());

        if(user != null){
            model.addAttribute("userName", user.getName());
        }
        return "index";
    }
}

 

 

 

---

※참고

스프링 부트와 AWS로 혼자 구현하는 웹 서비스