[Spring Boot] 05장. 스프링 시큐리티와 OAuth 2.0으로 로그인 기능 구현하기 - 어노테이션 기반으로 개선하기
🌱 이번 장의 스터디 범위
ArgumentResolver를 이용하면 어노테이션으로 로그인 세션 정보를 가져올 수 있다는 것
🌱 어노테이션 기반으로 개선하기
같은 코드가 반복되는 부분은 프로그래밍에서 유지보수와 연관되어 개선이 필요한 나쁜 코드
IndexController에서 세션값을 가져오는 부분이 개선 필요
// web/dto/IndexController.java
SessionUser user = (SessionUser) httpSession.getAttribute("user");
index 메소드 외에 다른 컨트롤러와 메소드에서 세션값이 필요하면 그때마다 직접 세션에서 값을 가져와야 함
이런 반복은 불필요하여 메소드 인자로 세션값을 바로 받을 수 있도록 변경
@LoginUser 어노테이션 생성
// config/auth/LoginUser.java
/* @Target(ElementType.PARAMETER)
: 이 어노테이션이 생성될 수 있는 위치를 지정
PARAMETER로 지정했으니 메소드의 파라미터로 선언된 객체에서만 사용할 수 있음
이 외에도 클래스 선언문에 쓸 수 있는 TYPE 등이 있음 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
/* @interface
: 이 파일을 어노테이션 클래스로 지정
LoginUser라는 이름을 가진 어노테이션이 생성된 것 */
public @interface LoginUser {
}
LoginUserArgumentResolver 생성 : HandleMethodArgumentResolver 인터페이스를 구현한 클래스
HandleMethodArgumentResolver는 조건에 맞는 경우 메소드가 있다면 HandleMethodArgumentResolver의 구현체가 지정한 값으로 해당 메소드의 파라미터로 넘기는 기능을 지원
// config/auth/LoginUserArgumentResolver.java
@RequiredArgsConstructor
@Component
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {
private final HttpSession httpSession;
@Override
/* supportsParameter
: 컨트롤러 메소드의 특정 파라미터를 지원하는지 판단
파라미터에 @LoginUser 어노테이션이 붙어있고,
파라미터 클래스 타입이 SessionUser.class인 경우 true 반환 */
public boolean supportsParameter(MethodParameter parameter) {
boolean isLoginUserAnnotation = parameter.getParameterAnnotation(LoginUser.class) != null;
boolean isUserClass = SessionUser.class.equals(parameter.getParameterType());
return isLoginUserAnnotation && isUserClass;
}
@Override
/* resolveArgument
: 파라미터에 전달할 객체를 생성
세션에서 객체를 가져옴 */
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
return httpSession.getAttribute("user");
}
}
LoginUserArgumentResolver가 스프링에서 인식될 수 있도록 WebMvcConfigure에 추가
HandleMethodArgumentResolver는 항상 WebMvcConfigure의 addArgumentResolvers()를 통해 추가해야 함
다른 HandleMethodArgumentResolver가 필요하다면 같은 방식으로 추가
// config/WebConfig.java
@RequiredArgsConstructor
@Configuration
public class WebConfig implements WebMvcConfigurer {
private final LoginUserArgumentResolver loginUserArgumentResolver;
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
argumentResolvers.add(loginUserArgumentResolver);
}
}
IndexController의 코드에서 반복되는 부분들을 모두 @LoginUser로 개선
// web/dto/IndexController.java
@RequiredArgsConstructor
@Controller
public class IndexController {
private final PostsService postsService;
@GetMapping("/")
/* @LoginUser SessionUser user
: 기존 user = (SessionUser) httpSession.getAttribute("user")로 가져오던 세션 정보 값이 개선
어느 컨트롤러든지 @LoginUser만 사용하면 세션 정보를 가져올 수 있게 됨 */
public String index(Model model, @LoginUser SessionUser user) {
model.addAttribute("posts", postsService.findAllDesc());
if(user != null) {
model.addAttribute("myName", user.getName());
}
return "index";
}
...
}
