AOP를 사용하여 custom Annotation의 Log만 출력하기

운영을 하다보면 서비스가 살아있는지 데이터베이스 연결이 잘되었는지 체크를 하는데 해당 이력들은 로그에서 제외하고 원하는 메소드만 로그로 남기고 싶을때 사용하면 된다.

Custom Annotaion을 만들기

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoggerTarget {
}

LoggerTarget 이라는 이름으로 Annotation을 만들어줬다. 메소드영역이고 런타임범위까지 되도록 만들어준다.

AOP 설정하기

@Aspect
@Component
@Slf4j
public class LoggingAspect {

    private final String ANNOTATION_LOGGER_TARGET = "@annotation(com.sample.testapi.infrastructure.configuration.aop.LoggerTarget)";

    @Before(ANNOTATION_LOGGER_TARGET)
    public void loggingBefore(JoinPoint joinPoint) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
        log.info("## REQUEST [{}] {} {}, Payload: {}", request.getRemoteAddr(), request.getMethod(), request.getRequestURI(), getPayload(joinPoint));
    }

    @AfterReturning(value = ANNOTATION_LOGGER_TARGET, returning = "result")
    public void afterReturn(Object result) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
        log.info("## RESPONSE [{}] {} {}, Result: {}", request.getRemoteAddr(), request.getMethod(), request.getRequestURI(), result.toString());
    }

    @AfterThrowing(value = ANNOTATION_LOGGER_TARGET, throwing = "e")
    public void loggingAfterThrowing(Exception e) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
        log.info("## RESPONSE [{}] {} {}, Exception: {}", request.getRemoteAddr(), request.getMethod(), request.getRequestURI(), e.toString());
    }

    private String getPayload(JoinPoint joinPoint) {
        return Arrays.stream(joinPoint.getArgs())
                .map(Object::toString)
                .collect(Collectors.joining(", "));
    }

}

AOP 설정을 한 이후 로그가 나오기를 원하는 메소드에 @LoggerTarget 어노테이션을 붙여주자

//Controller
@LoggerTarget
@ResponseStatus(HttpStatus.OK)
@PostMapping(value = "/schTest")
public ResponseEntity controllerLogTest(@RequestBody @Valid SaleProdRequest saleProdRequest) {
	log.info("in");
    return ResponseEntity.ok("test");
}

@LoggerTarget 커스텀 어노테이션으로 로그를 남기고 싶은 메소드에 붙여주기만 하면 된다.!!