[Spring Boot] aLog Project - Spring Security와 OAuth2.0으로 로그인 기능 구현하기 2

[Spring Boot] aLog Project - Spring Security와 OAuth2.0으로 로그인 기능 구현하기 1 에 이어서 Spring Security와 OAuth2.0으로 로그인 기능을 구현합니다. 🏆

---

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

유지보수성을 높이기 위해 같은 코드가 반복되는 부분을 수정합니다.

LoginUser.java

config.auth 패키지에 @LoginUser 어노테이션을 생성합니다.

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

📁 코드 설명

1. @Target(ElementType.PARAMETER)
	- 어노테이션이 생성될 수 있는 위치를 지정합니다.
    - PARAMETER로 지정했으니 메소드의 파라미터로 선언된 객체에서만 사용할 수 있습니다.

2. @interface
	- 어노테이션 클래스로 지정합니다.

LoginUserArgumentResolver.java

config.auth 패키지에 LoginUserArgumentResolver.java 어노테이션을 생성합니다. LoginUserArgumentResolver라는 HandlerMethodArgumentResolver 인터페이스를 구현한 클래스입니다.
조건에 맞는 경우 메소드가 있다면 HandlerMethodArgumentResolver의 구현체가 지정한 값으로 해당 메소드의 파라미터로 넘길 수 있습니다.

package com.aLog.config.auth;

import com.aLog.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");
    }
}

📁 코드 설명

1. supportsParameter()
	- 컨트롤러 메서드의 특정 파라미터를 지원하는지 판단합니다.
    - 파라미터에 @LoginUser 어노테이션이 붙어 있고, 파리미터 클래스 타입이 SessionUser.class인 경우 true를 반환합니다.
    
2. resolveArgument()
	- 파라미터에 전달할 객체를 생성합니다.
    - 세션에서 객체를 가져옵니다.

WebConfig.java

config 패키지에 WebConfig.java 클래스를 생성합니다.

package com.aLog.config;

import com.aLog.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);
    }
}

IndexController.java

IndexController.java의 코드에서 반복되는 부분들을 모두 @LoginUser로 개선합니다.

．．．
@RequiredArgsConstructor
@Controller
public class IndexController {

    private final PostsService postsService;
    private final HttpSession httpSession;

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

📁 코드 설명

1. @LoginUser SessionUser user
	- 기존에 (User) httpSession.getAttribute("user")로 가져오던 세션 정보 값이 개선되었습니다.
    - 어느 컨트롤러든지 @LoginUser만 사용하면 세션 정보를 가져올 수 있게 되었습니다.

💻 세션 저장소로 데이터베이스 사용하기

실제 현업에서 사용하는 방법

1. 톰캣 세션을 사용한다.
	- 일반적으로 별다른 설정을 하지 않을 대 기본적으로 선택되는 방식입니다.
    - 톰캣(WAS)에 세션이 저장되기 때문에 2대 이상의 WAS가 구동되는 환경에서는 톰캣들 간의 세션 공유를 위한 추가 설정이 필요합니다.
    
2. MySQL과 같은 데이터베이스를 세션 저장소롤 사용한다.
	- 여러 WAS 간의 고용ㅇ 세션을 사용할 수 있는 가장 쉬운 방법입니다.
    - 많은 설정이 필요 없지만, 결국 로그인 요청마다 DB IO가 발생하여 성능상 이슈가 발생할 수 있습니다.
    - 보통 로그인 요청이 많이 없는 백오피스, 사내 시스템 용도에서 사용합니다.
    
3. Redis, Memcached와 같은 메모리 DB를 세션 저장소로 사용한다.
	- B2C 서비스에서 가장 많이 사용하는 방식입니다.
    - 실제 서비스로 사용하기 위해서는 Embedded Redis와 같은 방식이 아닌 외부 메모리 서버가 필요합니다.

build.gradle

build.gradle에 spring-session-jdbc를 추가합니다.

．．．
implementation 'org.springframework.session:spring-session-jdbc'
．．．

application.yml

application.yml에 세션 저장소를 jdbc로 선택하도록 코드를 추가합니다.

spring:
  profiles:
    include: oauth

  session:
    store-type: jdbc
    ．．．

---

✔ 어노테이션 기반으로 개선하기와 세션 저장소로 데이터베이스 사용하기를 진행하였습니다.