📚[Spring] AOP

AOP 를 활용한 로깅구현

요구사항

• 어드민 API 메서드 실행 전후에 요청/응답 데이터를 로깅합니다.
• 로깅 내용에는 다음이 포함되어야 합니다:
  • 요청한 사용자의 ID
  • API 요청 시각
  • API 요청 URL
  • 요청 본문(RequestBody)
  • 응답 본문(ResponseBody)

---

핵심개념

1. @Aspect : AOP 클래스를 정의하는 어노테이션으로 공통 관심사를 담는 역할을 한다.
2. @Pointcut : 관심 대상 메서드를 지정하는 어노테이션

@Pointcut("execution(* 위치 표현식)")
	public void startPoint() {}

복잡한 위치 표현식을 @Pointcut 을 사용하여 메서드로 추상화해 이름을 붙일 수 있다.
이렇게 정의된 메서드들은 Advice 에서 "startPoint()" 처럼 재사용하여 쉽게 적용할 수 있다.

3. Advice : 구체적인 실행로직에 대해 정의하며 아래 어노테이션에 따라 실행 시점을 정한다.
   • @Before : 메서드 실행 전 동작
   • @After : 메서드 실행 후 동작
   • @Around : 메서드 실행 전후에 동작하며 실행을 직접 제어할 수 있다
   • @AfterReturning : 메서드가 성공적으로 반환된 후 동작
   • @AfterThrowing : 메서드에서 예외가 발생했을 때 동작

---

구현예제 - LoggingAspect

@Slf4j
@Aspect
@Component
@RequiredArgsConstructor
public class LoggingAspect {
	private final ObjectMapper objectMapper;

	@Pointcut("execution(* org.example.expert.domain.user.controller.UserAdminController.*(..)) ||"
		+ " execution(* org.example.expert.domain.comment.controller.CommentAdminController.*(..))")
	public void adminMethod() {}

	@Around("adminMethod()")
	public Object beforeLogging(ProceedingJoinPoint joinPoint) throws Throwable {
		//스레드 안에서 request 객체 가져오기
		HttpServletRequest request = ((ServletRequestAttributes)Objects.requireNonNull(
			RequestContextHolder.getRequestAttributes())).getRequest();

		//실행중인 메서드 정보
		Method joinMethod = ((MethodSignature)joinPoint.getSignature()).getMethod();

		//메서드 파라미터 정보 및 실제 값
		Parameter[] params = joinMethod.getParameters();
		Object[] args = joinPoint.getArgs();

		//요청, 응답 바디값을 담을 문자열 null -> 값이 없거나 직렬화 실패
		String requestBody = null;
		String responseBody = null;

		// 요청 본문 직렬화 시도
		try {
			for (int i = 0; i < args.length; i++) {
				if (params[i].isAnnotationPresent(RequestBody.class)) {
					requestBody = objectMapper.writeValueAsString(args[i]);
				}
			}
		} catch (JsonProcessingException e) {
			log.warn("requestBody 직렬화 실패 : {}", e.getMessage());
		}

		String url = request.getRequestURI();

		log.info("[Method Before] path={}, timestamp={}, requestBody={} ", url, LocalDateTime.now(), requestBody);

		//실제 메서드 실행 및 결과 저장
		Object result = joinPoint.proceed();

		// 응답 본문 직렬화 시도
		try {
			responseBody = objectMapper.writeValueAsString(result);
		} catch (JsonProcessingException e) {
			log.warn("responseBody 직렬화 실패 : {}", e.getMessage());
		}

		log.info("[Method After] path={}, timestamp={}, responseBody={} ", url, LocalDateTime.now(), responseBody);

		return result;
	}

}

어드민 요청이 필요한 메서드들에 대해 공통 로깅 로직을 수행하는 Aspect 이다.
@Around 어드바이스를 활용해 메서드 실행 전후의 요청과 응답 데이터를 한번에 처리할 수 있도록 구성했다.
메서드 실행전 RequestBody 어노테이션이 붙은 파라미터를 찾아 요청 본문을 추출하고 실행 후 반환값도 직렬화해 응답 본문으로 로그에 남긴다.