[Spring]API 로깅

API=Application Programming Interface

 

쉽게 말해, 프로그램끼리 소통하는 창구

 

예) 네이버 날씨 앱-> 네이버 서버에 서울 날씨 알려줘 요청-> 서버가 날씨 데이터 응답

 

여기서 날씨 앱과 네이버 서버 사이의 통신이 API

 

로깅이란?

 

프로그램의 동작 기록

 

프로그램이 언제, 어떤 일을 했는지 기록하는 것

 

예) 사용자 A가 로그인 시도함, 사용자 B가 로그인 시도함

 

즉, 나중에 문제 발생 시 원인 추적하거나 사용 패턴 분석할 때 사용

 

 

API로깅이란?

 

API를 사용한 요청과 응답을 기록하는 것

 

이번 과제에서는 어드민 사용자가 특정 API를 호출했을 때만 로그를 남기는 것

 

 

API로깅이 필요한 이유

 

문제 추척: 누가 언제 무슨 요청을 해서 문제가 발생했는지 알 수 있음

 

보안: 관리자가 아닌 사람이 민감한 API를 호출했는지 확인 가능

 

사용자 패턴 분석: 어떤 API가 많이 쓰이는지 성능 문제는 없는지 분석 가능

 

Interceptor VS AOP

 

1. Interceptor

 

API가 실제 실행되기 전에 요청을 잡고 싶을 때

 

특징으로는 요청 정보(HttpServletRequest) 접근 가능, 인증/권한 체크 용도임

 

 

2. AOP

 

메서드 실행 전후를 가로채서 처리하고 싶을 때

 

특징으로는 메서드 파라미터/ 리턴 값까지 접근 가능, 로깅, 트랜잭션 처리 등에 활용

 

쉽게 말해, Interceptor는 문 앞에서 신분증 확인, AOP는 문 앞에서 행동 감시하고 기록

 

 

Interceptor를 활용한 API 로깅

 

어떤 역할인가?

• 요청이 컨트롤러에 도착하기 전에 사용자 권한 확인
• 어드민인지 아닌지 판단
• 어드민이면 로그 기록
• 아니면 접근 차단

@Component
public class AdminInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response,
                             Object handler) throws Exception {
        // 권한 체크 및 로그 기록
        return true; // 허용/false: 차단
    }
}

 

 

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AdminInterceptor())
                .addPathPatterns("/admin/**"); // 적용 경로
    }
}

 

AOP를 활용한 API 로깅

 

어떤 역할인가?

• 메서드 실행 전후를 감시
• 요청 본문(RequestBody)과 응답 본문(ResponseBody)까지 기록가능
• 즉, 누가, 언제, 무엇을 요청했고 결과가 무엇인지까지 남김

@Aspect
@Component
public class AdminLoggingAspect {

    @Around("execution(* 패키지명..controller.*AdminController.*(..))")
    public Object logAdminApi(ProceedingJoinPoint joinPoint) throws Throwable {
        // 실행 전: joinPoint.getArgs() → 요청 데이터
        Object result = joinPoint.proceed(); // 메서드 실행
        // 실행 후: result → 응답 데이터
        return result;
    }
}

 

 

---

 

Interceptor흐름

 

1. 클라이언트가 /admin/deleteComment요청

 

2. DispatchServlet이 요청을 받음

 

3. AdminInterceptor(preHandle)실행
- 사용자 정보 확인
- 권한 체크(어드민인지?)
- 어드민이면 로그 기록
- 어드민 아니면 예외발생/ 접근 차단

 

4. 컨트롤러 실행(deleteComment())

 

5. 컨트롤러 응답

 

6. AdminInterceptor(postHandle/ afterCompletion) 실행 가능
- 추가 로깅이나 후 처리

 

7. 클라이언트로 응답 전송

Interceptor 핵심 역할: 권한 체크 + 요청 전/후 로그 기록

 

AOP흐름

 

1. 클라이언트가 /admin/deleteComment 요청

 

2. 컨트롤러 메서드 호출 시점에서 AOP @Around가로채기

• Before 실행
  • 요청한 사용자 ID
  • 요청 URL
  • 요청 본문(RequestBody)
  • 요청 시각
  • 로그분석
• Proceed -> 실제 컨트롤러 메서드 실행
• After실행
  • 컨트롤러 응답(ResponseBody)
  • 응답 시각
  • 로그 기록

AOP 핵심 역할: 메서드 실행 전/후 감시 + 요청/응답 데이터 로그

 

 

API 로깅 시각화: Interceptor vs AOP

┌──────────────────┐
│   클라이언트      │
│ (웹/앱 요청)      │
└─────────┬────────┘
          │
          ▼
┌──────────────────┐
│ DispatcherServlet│
└─────────┬────────┘
          │
          ▼
 ┌─────────────────────────┐
 │      Interceptor        │
 │-------------------------│
 │ preHandle()             │
 │ - 권한 체크 (어드민?)    │
 │ - 로그 기록 (URL, 시각)  │
 │                         │
 │ postHandle()            |
 |  /afterCompletion()     │
 │ - 후처리 로그 기록       │
 └────────┬────────────────┘
          │
          ▼
 ┌─────────────────────────┐
 │      Controller         │
 │-------------------------│
 │ deleteComment() /       │
 │ changeUserRole()        │
 │ 실제 비즈니스 로직 수행  │
 └─────────┬───────────────┘
          │
          ▼
 ┌─────────────────────────┐
 │          AOP            │
 │-------------------------│
 │ @Around                 │
 │ Before:                 │
 │ - 사용자 ID             │
 │ - 요청 URL              │
 │ - RequestBody           │
 │ - 요청 시각             │
 │ proceed() → 실제 메서드 실행 │
 │ After:                  │
 │ - ResponseBody          │
 │ - 응답 시각              │
 │ - 로그 기록              │
 └────────┬────────────────┘
          │
          ▼
┌──────────────────┐
│   클라이언트      │
│ (응답 수신)       │
└──────────────────┘