1. Argument Resolver란?
클라이언트의 요청을 처리하는 핸들러 메소드에 전달할 인자를 자동으로 생성하거나 변환해주는 역할을 한다.
Spring Framework 에서는 컨트롤러 메서드의 파라미터를 자동으로 매핑하여 필요한 데이터를 주입하는 기능을 한다.
2. Argument Resolver의 위치
Client가 요청을 보내면 Filter가 먼저 요청을 가로채서 필요한 작업을 한다. 그다음 DispatcherServlet이 요청을 받아서, HandlerMapping을 통해 적절한 컨트롤러를 찾아 컨트롤러를 실행하기 위해 파라미터를 준비하는데, 이 과정에서 ArgumentResolver가 역할을 한다.
ArgumentResolver가 파라미터의 HTTP 요청 본문에서 가져온 데이터일 수도 있고, 세션, 쿠키, 혹은 다른 복잡한 객체일 수도 있다. ArgumentResolver는 이런 다양한 케이스에 맞게 데이터를 준비하고, 해당 메서드를 실행할 수 있게 도와준다.
그러면, 준비된 파라미터와 함께 Controller가 요청을 처리하고, 그 결과를 다시 클라이언트에게 응답으로 반환하게 된다.
3. Argument Resolver를 이용해서 사용자 정보 가져오기
1. 사용자 정보를 받기 위한 AuthUser Dto 만들기
- @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 Auth {
}- AuthUser 클래스 작성
import lombok.AllArgsConstructor;
import lombok.Getter;
@Getter
@AllArgsConstructor
public class AuthUser {
private Long id;
}이 DTO가 가지고 있는 id 필드는, User의 Id로 고유 식별자로 사용된다.
2. 필터 생성
- 필터 작성
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.ExpiredJwtException;
import io.jsonwebtoken.MalformedJwtException;
import io.jsonwebtoken.UnsupportedJwtException;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.*;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.regex.Pattern;
@Slf4j
@RequiredArgsConstructor
public class JwtFilter implements Filter {
private final JwtUtil jwtUtil;
private final Pattern authPattern = Pattern.compile("/users/(signup|login)");
@Override
public void init(FilterConfig filterConfig) throws ServletException {
Filter.super.init(filterConfig);
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest) request;
HttpServletResponse httpResponse = (HttpServletResponse) response;
String url = httpRequest.getRequestURI();
if (authPattern.matcher(url).matches()) {
chain.doFilter(request, response);
return;
}
String bearerJwt = null;
Cookie[] cookies = httpRequest.getCookies();
if (cookies != null) {
for (Cookie cookie : cookies) {
if ("Authorization".equals(cookie.getName())) {
bearerJwt = URLDecoder.decode(cookie.getValue(), "UTF-8");
break;
}
}
}
if (bearerJwt == null || !bearerJwt.startsWith("Bearer ")) {
httpResponse.sendError(HttpServletResponse.SC_UNAUTHORIZED, "JWT 토큰이 필요합니다.");
return;
}
String jwt = jwtUtil.substringToken(bearerJwt);
try {
// JWT 유효성 검사와 claims 추출
Claims claims = jwtUtil.extractClaims(jwt);
// 사용자 정보를 ArgumentResolver 로 넘기기 위해 HttpServletRequest 에 세팅
httpRequest.setAttribute("userId", Long.parseLong(claims.getSubject()));
chain.doFilter(request, response);
} catch (SecurityException | MalformedJwtException e) {
log.error("Invalid JWT signature, 유효하지 않는 JWT 서명 입니다.", e);
httpResponse.sendError(HttpServletResponse.SC_UNAUTHORIZED, "유효하지 않는 JWT 서명입니다.");
} catch (ExpiredJwtException e) {
log.error("Expired JWT token, 만료된 JWT token 입니다.", e);
httpResponse.sendError(HttpServletResponse.SC_UNAUTHORIZED, "만료된 JWT 토큰입니다.");
} catch (UnsupportedJwtException e) {
log.error("Unsupported JWT token, 지원되지 않는 JWT 토큰 입니다.", e);
httpResponse.sendError(HttpServletResponse.SC_BAD_REQUEST, "지원되지 않는 JWT 토큰입니다.");
} catch (IllegalArgumentException e) {
log.error("JWT claims is empty, 잘못된 JWT 토큰 입니다.", e);
httpResponse.sendError(HttpServletResponse.SC_BAD_REQUEST, "잘못된 JWT 토큰입니다.");
} catch (Exception e) {
log.error("JWT 토큰 검증 중 오류가 발생했습니다.", e);
httpResponse.sendError(HttpServletResponse.SC_UNAUTHORIZED, "JWT 토큰 검증 중 오류가 발생했습니다.");
}
}
@Override
public void destroy() {
Filter.super.destroy();
}
}- 필터 등록
import lombok.RequiredArgsConstructor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@RequiredArgsConstructor
public class FilterConfig {
private final JwtUtil jwtUtil;
// Filter 등록
@Bean
public FilterRegistrationBean<JwtFilter> jwtFilter() {
FilterRegistrationBean<JwtFilter> registrationBean = new FilterRegistrationBean<>();
registrationBean.setFilter(new JwtFilter(jwtUtil));
registrationBean.addUrlPatterns("/*");
return registrationBean;
}
}
3. ArgumentResolver생성
- ArgumentResolver 생성
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.core.MethodParameter;
import org.springframework.lang.Nullable;
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;
public class AuthUserArgumentResolver implements HandlerMethodArgumentResolver {
@Override
public boolean supportsParameter(MethodParameter parameter) {
boolean hasAuthAnnotation = parameter.getParameterAnnotation(Auth.class) != null;
boolean isAuthUserType = parameter.getParameterType().equals(AuthUser.class);
// @Auth 어노테이션과 AuthUser 타입이 함께 사용되지 않은 경우 예외 발생
if (hasAuthAnnotation != isAuthUserType) {
throw new IllegalArgumentException("@Auth와 AuthUser 타입은 함께 사용되어야 합니다.");
}
return hasAuthAnnotation;
}
@Override
public Object resolveArgument(
@Nullable MethodParameter parameter,
@Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
@Nullable WebDataBinderFactory binderFactory
) {
HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
// JwtFilter 에서 set 한 userId 값을 가져옴
Long userId = (Long) request.getAttribute("userId");
return new AuthUser(userId);
}
}- ArgumentResolver 등록
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 {
// ArgumentResolver 등록
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
resolvers.add(new AuthUserArgumentResolver());
}
}
4. Controller에서 AuthUser사용
...
@GetMapping("/users/withdrawal") // 회원 탈퇴
public ResponseEntity<Void> withdrawal(@Auth AuthUser authUser) {
userService.withdrawal(authUser);
return ResponseEntity.ok().build();
}
...
이렇게 하면 Controller 이전에 User정보를 받을 수 있다.