로깅 전략

로깅 전략

• @ExceptionHandler가 붙은 메소드 에러 메시지 출력 (error)
• @EnableLog 붙인 클래스 혹은 메소드 요청, 응답 출력 (debug)

1. @ExceptionHandler

실행 조건

1. @ExceptionHandler 붙이기
2. 첫 번째 인자는 Exception

사용 예시

    @ExceptionHandler({RuntimeException.class})
    public ResponseEntity<ApiErrorResponse> handleException(final Exception exception) {
        ApiErrorResponse apiErrorResponse = ApiErrorResponse.builder()
                .message(exception.getMessage())
                .status(HttpStatus.BAD_REQUEST.value())
                .build();
        return ResponseEntity.badRequest().body(apiErrorResponse);
    }

처리 코드

    @Around("@annotation(org.springframework.web.bind.annotation.ExceptionHandler) && args (exception, ..)")
    public Object restControllerAdviceLogging(final ProceedingJoinPoint pjp, Exception exception) throws Throwable {
        Logger log = getLog(pjp.getSignature().getDeclaringType());

        Object result = pjp.proceed();
        log.error("errorMessage: {}", exception.getMessage());

        return result;
    }

2. methodLogging

실행 조건

1. @EnableLog 를 클래스 혹은 메소드에 붙인다. (클래스에 붙이면 모든 메소드에 적용)

사용 예시1. 클래스에 붙이기 (모든 메소드에 적용)

@EnableLog
@RestController
@RequestMapping("/api/v1/users/products")
public class UserProductApiController {
    private final UserProductService userProductService;

    ....
}

사용 예시2. 메소드에 붙이기

    @EnableLog
    @PostMapping
    public ResponseEntity<UserProductResponseDto> create(@RequestBody final UserProductCreateDto userProductCreateDto,
                                                         @LoginUser final SessionUser sessionUser) {
        Long userId = sessionUser.getId();
        UserProductResponseDto responseDto = userProductService.save(userProductCreateDto, userId);
        URI uri = linkTo(UserProductApiController.class).slash(responseDto.getId()).toUri();
        return ResponseEntity.created(uri).body(responseDto);
    }

처리 코드

    @Around("@within(com.gaejangmo.apiserver.commons.logging.EnableLog) || @annotation(com.gaejangmo.apiserver.commons.logging.EnableLog)")
    public Object methodLogging(final ProceedingJoinPoint pjp) throws Throwable {
        Logger log = getLog(pjp.getSignature().getDeclaringType());

        log.debug("request by {}, args: {} ", pjp.getSignature().getDeclaringType(), pjp.getArgs());
        Object requestResult = pjp.proceed();
        log.debug("response {}", requestResult);

        return requestResult;
    }