Spring AOP를 사용하여 클라이언트의 요청 정보 로깅하기

서비스에서 클라이언트의 모든 호출에 대해 저장하여 관리를 할 수 있습니다.

 

이 때, 단순히 로그로 남길수도 있고 혹은 데이터베이스에 모든 요청 정보를 저장하여 관리할 수 있습니다.

 

이번 포스팅에서는 클라이언트의 요청 정보(URI, Http Method, payload 등등)들을 로깅 및 데이터베이스에 저장하여 관리하는 방법에 대해 간략히 살펴봅니다.

 

예제 코드는 GitHub에서 확인할 수 있습니다 :)

 

 

🔗 ApiRequestEntity

 ApiRequestEntity  클래스는 데이터베이스에 저장할 클라이언트의 요청 데이터셋으로 각 필드의 역할은 다음과 같습니다.

•  id : PK
•  methodValue : Http Method
•  apiUri : Request URI
•  payload : Request Body
•  requestIp : Client IP
•  createdAt : 호출 시각
•  updateAt : 수정 시각(=최초 호출 시각)

 

 

🔗 LoggingAspect

LoggingAspect 클래스는 AOP를 사용하여 리퀘스트가 컨트롤러 호출 전, 호출 후, 예외 반환 시 처리를 할 수 있도록 메서드를 추가해주었습니다.

(Spring AOP에 대한 내용은 해당 포스팅을 참고해주세요)

 

• loggingBefore() : 컨트롤러 호출 전 클라이언트의 요청 정보를 로그로 남기고, LoggingEvent 객체로 이벤트를 발행합니다.
• loggingAfter() : 컨트롤러 호출 후 메서드의 응답값이 존재할 경우 로그로 남깁니다.
• loggingAfterThrowing() : 컨트롤러의 메서드 호출 시 로직에서 예외가 발생할 경우 로그로 남깁니다.

 

 

🔗 LoggingEvent

LoggingEvent  클래스는 이벤트를 전달할 객체입니다.

해당 클래스는 ApiRequestEntity 클래스에서 필요한 클라이언트의 요청 정보에 대한 값들을 가지고 있습니다.

 

 

 

🔗 LoggingEventListener

LoggingEventListener  클래스는 LoggingAspect 에서 발행한 이벤트를 리스너에서 받아 처리하는 역할을 합니다.

handleLoggingEvent() 메서드는 컨트롤러 호출 전 요청 정보에 대해서만 데이터베이스에 저장합니다.

 

클라이언트의 요청 데이터를 단순히 데이터베이스에 저장하는 로직은 핵심 기능은 아니기 때문에 따로 이벤트로 발행하여 비동기로 처리하도록 하였습니다.

 

 

 

🔗 ApiRequestRepository

프로젝트에서 Spring Data JPA를 사용하고 있기 때문에 단순히 JpaRepository 인터페이스를 상속받은 인터페이스입니다.

 

 

 

🔗 UserController

테스트에서 사용할 매우 간단한 컨트롤러입니다.

Get, Post 메서드가 존재하고 throwsGet() 메서드는 예외 처리 시 로그를 확인하기 위한 메서드입니다.

 

 

 

🔗 API_REQUEST 테이블

CREATE TABLE `api_request` (
  `id` bigint NOT NULL AUTO_INCREMENT,
  `api_uri` varchar(100) DEFAULT NULL,
  `method_value` varchar(100) DEFAULT NULL,
  `payload` varchar(255) DEFAULT NULL,
  `request_ip` varchar(30) DEFAULT NULL,
  `created_at` datetime(6) DEFAULT NULL,
  `updated_at` datetime(6) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

JPA를 사용하여 테이블을 자동으로 생성해주어도 상관없지만 칼럼 순서가 랜덤이어서 직접 생성해주었습니다.

 

 

 

테스트

Controller의 get메서드를 호출하면 Request & Response 정보가 로깅에 남고, Request 정보는 데이터베이스에 저장됩니다.

 

Controller의 post메서드를 호출해도 동일하게 정보들이 로깅 및 데이터베이스에 저장이 됩니다.

 

Controller의 throwsGet 메서드를 호출할 경우 Request & Response 정보가 로깅에 남고 이후 예외가 발생합니다.

마찬가지로 Request 정보는 데이터베이스에 저장되는 것을 확인할 수 있습니다.