<Spring> Success Custom Response 적용하기

📌 기존 프로젝트

프로젝트에서 커스텀 리스폰스를 이용하여 API response를 보내주기로 했었다.

@GetMapping(value = "")
@Operation(summary = "팀플 상세 정보 조회", description = "팀플 상세 정보 조회 API 입니다.")
public CommonResponse<GetTeamDetailDto> getTeamDetail(@AuthUser User authUser,
                                                      @Valid @RequestParam("teamId") Long teamId) {
    log.info("[api-get] 팀 상세 정보 가져오기");

    GetTeamDetailDto teamDetail = teamsService.getTeamDetail(authUser, teamId);
    return CommonResponse.onSuccess(HttpStatus.OK.value(), teamDetail);
}

@PostMapping(value = "")
@Operation(summary = "팀플 생성", description = "팀플 생성 API 입니다.\n"
        + "stage가 없어도 []를 보내줘야 합니다.")
public CommonResponse<PostTeamResDto> postTeam(@AuthUser User authUser,
                                               @Valid @RequestBody PostTeamDto postTeamDto) {
    log.info("[api-post] 팀 생성");

    PostTeamResDto postTeamResDto = teamsService.createTeam(authUser, postTeamDto);
    return CommonResponse.onSuccess(HttpStatus.CREATED.value(), postTeamResDto);
}

Common Response 알아보기 ↓

@Getter
public class CommonResponse<T> {
    @JsonProperty("status")
    private int code;

    @JsonProperty("isSuccess")
    private boolean success;

    @JsonProperty("message")
    private String message;

    @JsonProperty("data")
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private T data;

    @Builder
    public CommonResponse(int code, boolean success, String message, T data) {
        this.code = code;
        this.success = success;
        this.message = message;
        this.data = data;
    }

    public static <T> CommonResponse<T> onSuccess(int code) {
        return CommonResponse.<T>builder()
                .code(code)
                .success(true)
                .message("요청에 성공하였습니다.")
                .data(null)
                .build();
    }

    public static <T> CommonResponse<T> onSuccess(int code, T data) {
        return CommonResponse.<T>builder()
                .code(code)
                .success(true)
                .message("요청에 성공하였습니다.")
                .data(data)
                .build();
    }
}

위 코드는 초기 구현한 컨트롤러이다. 

코드를 볼 경우 return 부분에 custom response를 생성하는 부분이 중복되어있다.

이를 해결하고자 한다.

---

📌 ResponseBodyAdvice 커스텀

🔵 ResponseBodyAdvice 란?

 ResponseBodyAdvice는 controller에서 처리된 응답을 가로채서, 해당 응답을 변환하거나 추가적인 처리를 수행할 수 있도록 해준다. 이를 통해 컨트롤러에서 처리된 데이터를 조작하고, 클라이언트에게 보내기 전에 변환하거나, 추가적인 메타데이터를 삽입할 수 있다.

public interface ResponseBodyAdvice<T> {
	boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);

	@Nullable
	T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType,
			Class<? extends HttpMessageConverter<?>> selectedConverterType,
			ServerHttpRequest request, ServerHttpResponse response);

}

이런 식으로 interface가 구성되어있는데 

쉽게 말하면, support는 controller 작업이 끝난 response를 beforeBodyWrite 메서드에 보낼지 판단하는 역할을 하고, beforeBodyWrite 메서드는 실제 사용자가 원하는 body의 값을 교체 또는 response에 헤더 정보를 추가할 수 있다.

이를 이용하여 controller 단에서 데이터만 반환하면, response가 Common Response로 변환되도록 구현할 것이다.

🔵 적용하기

🔹전체코드

전체 코드는 이러하다

@RestControllerAdvice
public class SuccessResponseAdvice implements ResponseBodyAdvice<Object> {
    private final String[] SwaggerPatterns = {
            "swagger",
            "/v2/api-docs"
    };

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Nullable
    public Object beforeBodyWrite(
            Object body,
            MethodParameter returnType,
            MediaType selectedContentType,
            Class selectedConverterType,
            ServerHttpRequest request,
            ServerHttpResponse response){
        HttpServletResponse servletResponse =
                ((ServletServerHttpResponse) response).getServletResponse();
        HttpServletRequest servletRequest =
                ((ServletServerHttpRequest) request).getServletRequest();
        HttpMessageConverter

        // 스웨거일 경우 리스폰스 처리 안하도록
        for (String swaggerPattern : SwaggerPatterns) {
            if (servletRequest.getRequestURI().contains(swaggerPattern))
                return body;
        }

        HttpStatus resolve = HttpStatus.resolve(servletResponse.getStatus());

        if (resolve == null)
            return body;

        if (resolve.is2xxSuccessful())
            return CommonResponse.onSuccess(statusProvider(servletRequest.getMethod()), body);


        return body;
    }

    private int statusProvider(String method) {
        if (method.equals("POST"))
            return 201;
        if (method.equals("DELETE"))
            return 204;
        return 200;
    }
}

 

ResponseBodyAdvice의 구현체로 만든 후, 두 함수를 오버라이딩 하는 방식으로 구현하였다.

🔹support

먼저 support 함수부터 보겠다

@Override
public boolean supports(MethodParameter returnType, Class converterType) {
    return true;
}

요청이 어느 컨트롤러에서 오는가에 상관없이 beforeBodyWrite 메서드를 실행시켜 response를 커스텀할 계획이기 때문에, 다른 변경, 필터링 없어 true만 반환했다.

그러므로 beforeBodyWrite가 실행된다.

🔹beforeBodyWrite

@Nullable
public Object beforeBodyWrite(
        Object body,
        MethodParameter returnType,
        MediaType selectedContentType,
        Class selectedConverterType,
        ServerHttpRequest request,
        ServerHttpResponse response){
    HttpServletResponse servletResponse =
            ((ServletServerHttpResponse) response).getServletResponse();
    HttpServletRequest servletRequest =
            ((ServletServerHttpRequest) request).getServletRequest();

    // 스웨거일 경우 리스폰스 처리 안하도록
    for (String swaggerPattern : SwaggerPatterns) {
        if (servletRequest.getRequestURI().contains(swaggerPattern))
            return body;
    }

    HttpStatus resolve = HttpStatus.resolve(servletResponse.getStatus());

    if (resolve == null)
        return body;

    if (resolve.is2xxSuccessful())
        return CommonResponse.onSuccess(statusProvider(servletRequest.getMethod()), body);


    return body;
}

url이 스웨거 연관된 url이거나, http status가 200이 response의 경우, custom response로 변환하지 않도록 로직을 구성했다.

만약 이 조건을 통과한다면 CommonResponse 라는 custom response로 변환하여 response가 전달되도록 구성했다.

🔹스웨거 url 판별 후 response 분리

초기에 스웨거 url을 따로 처리하지 않았을 때, 위 에러가 발생했다.

위 로직에 따르면, 모든 success response 즉, 200번대 response는 common response로 변환된다.

정확한 이유는 모르겠으나, 이 부분에서 에러가 발생한 것 같다. 

그래서 스웨거 url을 가진 response일 경우, 따로 처리하여 body를 return 해주는 로직을 추가했다.

private final String[] SwaggerPatterns = {
        "swagger",
        "/v2/api-docs"
};

...

// 스웨거일 경우 리스폰스 처리 안하도록
for (String swaggerPattern : SwaggerPatterns) {
    if (servletRequest.getRequestURI().contains(swaggerPattern))
        return body;
}

🔹Http Method로 Http status code 분류하여 response 생성하기

초기 코드에서 common response를 생성할 경우, 모두 http status code가 200번으로 생성되었다. 

하지만 기존 코드 response는 201, 204 등 200 이외 다양한 http status code를 반환했다.

그래서 아래 코드를 추가하여 Http Method에 따라 http status code를 분류하여 common response를 생성할 수 있도록 했다.

private int statusProvider(String method) {
    if (method.equals("POST"))
        return 201;
    if (method.equals("DELETE"))
        return 204;
    return 200;
}

이 방법이 정확히 맞는 방법인지는 의문이다...

좋은 방법 아시는 분 있으시면, 댓글 남겨주세요....