📄 [문서] LogInvocation

[Chuseok22]

❌ 문제 상황

No response

📝 핵심 내용과 방향성

커스텀 어노테이션

LogTimeInvocation, LogMonitoringInvocation, LogMethodInvocation

LogTimeInvocation

@Retention(value = RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogTimeInvocation {
    
}

LogMonitoringInvocation

@Retention(value = RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogMonitoringInvocation {
    
}

LogMethodInvocation

@Retention(value = RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogMethodInvocation {

}

• 목적

  해당 어노테이션들은 단순히 “표시용” 마커(Marker)

  새로운 커스텀 어노테이션 생성

• 특징

  • @Retention(RetentionPolicy.RUNTION): 런타임까지 유지되어 AOP에서 리플렉션을 통해 접근 가능
  • @Target(ElementType.METHOD): 메서드에만 적용

• 사용예시

  **@LogTimeInvocation
  public void someMethod() { ... }**

  이 경우, AOP 설정에서 @LogTimeInvocation이 붙은 메서드를 찾아 처리

---

ExecutionTimeLoggingAspect

@Aspect
@Component
@RequiredArgsConstructor
@Slf4j
public class ExecutionTimeLoggingAspect {

    /**
     * LogTimeInvocation, LogMonitoringInvocation 어노테이션이 붙은 메서드가 호출될 때 해당 어드바이스 동작
     * ProceedingJoinPoint 를 통해 호출 대상(메서드) 정보 가져옴
     */
    @Around("@annotation(LogTimeInvocation) || @annotation(LogMonitoringInvocation)")
    public Object logMethod(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Object result;

        long startTime = System.currentTimeMillis(); // 메서드 시작시간 (ms)
        try {
            result = joinPoint.proceed(); // 메서드 실행
        } finally {
            long endTime = System.currentTimeMillis(); // 메서드 종료시간 (ms)
            long durationTimeSec = endTime - startTime;
            log.debug("[{}] 실행시간: {}ms", signature.getMethod().getName(), durationTimeSec);
        }

        return result;
    }
}

역할

• 실행 시간 측정 및 로깅

  이 Aspect는 메서드 실행 전후의 시간을 측정하여 실행 시간을 로깅

동작 방식

• @Around어드바이스

  메서드 호출 전 후에 공통 로직 (여기서는 시간 측정)을 삽입 가능

• 대상

  @LogTimeInvocation또는 @LogMonitoringInvocation 어노테이션이 붙은 메서드가 호출 될 때마다 해당 어드바이스 동작

• 구현 세부사항

  1. ProceedingJoinPoint를 사용해 호출 대상(메서드)의 정보를 가져옵니다.
  2. 메서드 실행 전 현재 시간(startTime)을 기록합니다.
  3. joinPoint.proceed()를 호출하여 실제 메서드를 실행합니다.
  4. 실행 후 현재 시간(endTime)을 기록한 후, 두 시간의 차이를 계산하여 실행 시간을 구합니다.
  5. 메서드 이름과 실행 시간을 로그에 출력합니다.

---

MethodInvocationLoggingAspect

@Aspect
@Component
@RequiredArgsConstructor
@Slf4j
public class MethodInvocationLoggingAspect {

    private final Logger LOGGER = LoggerFactory.getLogger(MethodInvocationLoggingAspect.class);

    /**
     * RequestContextHolder를 통해 현재 HTTP 요청 객체를 가져와 RequestID 값을 읽음
     */
    @Around("@annotation(LogMethodInvocation) || @annotation(LogMonitoringInvocation)")
    public Object logMethod(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();

        // 현재 HTTP 요청 객체를 얻음
        ServletRequestAttributes attributes =
                (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // RequestID 속성을 읽음
        String requestId = (String) request.getAttribute("RequestID");

        // 메서드 호출 전 로그 기록
        LOGGER.debug("[{}] RequestID: {}, Parameter: {}",
                signature.getMethod().getName(),
                requestId,
                Arrays.toString(joinPoint.getArgs()));

        Object result = ErrorCode.INTERNAL_SERVER_ERROR; // 기본 반환값 설정
        try {
            result = joinPoint.proceed(); // 메서드 실행
        } finally {
            // 메서드 호출 후 결과 값 로그 기록
            LOGGER.debug("[{}] RequestID: {}, Result: {}",
                    signature.getMethod().getName(),
                    requestId,
                    result);
        }

        return result;
    }
}

역할

• 메서드 호출 시 상세 정보 로깅

  이 Aspect는 특정 메서드가 호출 될 때 해당 메서드의 이름, HTTP 요청에 설정된 RequestID, 파라미터, 실행 결과 로깅

동작 방식

• 대상

  @LogMethodInvocation 또는 @LogMonotoringInvocation 어노테이션 호출 시

• HTTP 요청 정보 활용

  RequestContextHolder 를 통해 현재 HTTP 요청 객체를 가져와, 저장 된 "RequestID" 값을 읽음

• 세부사항

  1. MethodSignature를 통해 호출된 메서드의 이름과 파라미터 정보를 가져옵니다.
  2. ServletRequestAttributes를 사용해 현재 HTTP 요청 객체를 얻고, "RequestID" 속성을 읽습니다.
  3. 메서드 호출 전에 메서드 이름, RequestID, 파라미터 배열을 로그에 기록합니다.
  4. joinPoint.proceed()를 호출하여 실제 메서드를 실행하고 결과를 획득합니다.
  5. 메서드 실행 후 결과 값을 로그에 기록합니다.

---

@Aspect

핵심 개념

AOP(Aspect-Oriented Programming) 에서 Aspect는 공통 관심사(cross-cuttion concern)를 모듈화 한 단위

예를들어, 로깅, 트랜잭션, 보안 검사 등 여러 클래스 or 공통적으로 적용되어야 하는 기능을 Aspect로 작성 가능

기능

• Aspect 클래스는 내부에 Advice(어드바이스)와 Pointcut(포인트컷) 정의를 포함

  • Advice: 실제로 실행될 부가기능 (메서드 실행 전후의 로직) 정의 → 실행 로직
  • Pointcut: Advice가 적용될 대상 (메서드 호출, 실행)을 표현하는 식(expression) → 언제 실행할건지

  @Aspect
  @Component
  public class LoggingAspect {
      // 특정 어노테이션이 붙은 메서드에 대해 로깅 기능을 적용할 수 있다.
  }

  → @Aspect가 선언된 클래스는 스프링 컨테이너에 의해 Aspect 로 인식, 지정된 포인트컷 에 맞는 메서드가 호출될 때 자동으로 Advice 적용

---

@Around 어드바이스

핵심 개념

Join Point(메서드 호출 등) 전후에 실행되는 Advice → 실제 로직

메서드 실행 전, 후 모두에 코드 삽입이 가능하므로 가장 유연한 형태의 어드바이스

동작 과정

1. 실행 전 처리

• @Around어드바이스 메서드가 호출되면, 원하는 사전 처리 (ex. 시작 시간 기록, 파라미터 로깅 등) 수행

2. 메서드 실행

• ProceedingJoinPost.proceed()를 호출하여 대상 메서드 실행
• 실제 실행 트리거, 결과 값 반환

3. 실행 후 반환

• 메서드 실행 후 후처리 (ex.실행 시간 계산, 결과 로깅) 수행

---

ProceedingJoinPoint 인터페이스

JoinPoint 인터페이스를 확장한 버전

메서드 실행을 직접 제어 가능

주요 메서드

• proceed():
  • 가장 중요한 메서드로, 이 메서드를 호출하면 대상 메서드(또는 다음 어드바이스)가 실행됩니다.
  • 호출 시 실행 흐름이 대상 메서드로 넘어가며, 그 결과값을 반환합니다.
  • 필요에 따라 인자를 변경하여 호출할 수도 있습니다. (즉, 인자 수정 후 proceed(Object[] args)를 사용할 수 있음)
• getArgs():
  • 대상 메서드에 전달된 인자들을 배열 형태로 반환합니다.
• getSignature():
  • 대상 메서드의 서명(signature)을 반환합니다. 여기에는 메서드 이름, 매개변수, 반환 타입 등의 정보가 포함됩니다.
• getTarget():
  • 대상 객체(메서드를 호출하는 객체)를 반환합니다.
• toShortString(), toLongString():
  • JoinPoint의 정보를 간략하거나 자세하게 문자열 형태로 반환합니다.

---

정리

• @aspect:

  AOP의 핵심 단위로, 공통 관심사를 모듈화하는 클래스에 붙여서 여러 대상 메서드에 공통 기능(예: 로깅, 트랜잭션 관리 등)을 적용할 수 있도록 합니다.

• @around 어드바이스:

  대상 메서드 호출 전후에 실행되는 어드바이스로, 메서드 실행 전후에 원하는 부가기능(예: 성능 측정, 인자/결과 로깅 등)을 적용하며, 실행 자체를 제어할 수 있습니다.

• ProceedingJoinPoint:

  @around 어드바이스에서 사용되는 인터페이스로, 대상 메서드의 실행을 제어할 수 있는 핵심 인터페이스입니다.

  이를 통해 메서드 실행 전후의 인자, 서명, 결과 등을 얻고 조작할 수 있습니다.

📚 트러블슈팅 및 기대효과

No response

🔗 관련 자료

No response

🙋‍ 담당자

• 백엔드: 이름
• 프로트엔드: 이름
• 디자인: 이름