Backend/Spring Boot
원본 글 보기

[Spring Boot] AOP(@Aspect)로 로깅 처리하기

1. AOP 란

AOP는 프로그램의 주요 비즈니스 로직과는 별개로 공통적인 기능(로깅, 트랜잭션, 보안 등)을 분리해 관리할 수 있게 해준다.

AOP를 사용하는 이유:

예를들어 프로젝트에서 메서드들이 호출될때마다 로그를 찍게 하고 싶은데, 메서드 하나하나 log.info... 어쩌고 이런 식으로 하기는 번거로우니까.

그리고 로그 찍는게 로직 상 중요한 것도 아닌데 코드 사이사이 지방처럼 껴 있는 것도 보기 싫으니까.

한방에 처리하자는 느낌이다.

즉, '모든 메서드가 호출될때 로그를 찍게 해주세요'라는 명령을 내리는 것이다.

이런 기능은 Aspect라는 단위로 분리되고, 코드에 적용되는 방식으로 동작한다.

2. 프로젝트 설정

우선 Spring Boot 프로젝트를 생성하고, spring-boot-starter-aop와, 웹을 처리하기 위한 spring-boot-starter-web 의존성을 추가한다.



dependencies {
// Spring Web Starter (Web API 개발을 위한 의존성)
    implementation 'org.springframework.boot:spring-boot-starter-web'
// Spring AOP Starter (AOP 사용을 위한 의존성)
    implementation 'org.springframework.boot:spring-boot-starter-aop'
}

3. Admin API 컨트롤러 생성

이제 간단한 Admin API 컨트롤러를 생성한다.



import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/admin")
@Slf4j
public class AdminController {

    @GetMapping("/hello")
public String hello() {
// AOP가 없었다면 아래처럼 메서드가 호출될 때마다 직접 로깅 처리
        log.info("Method called: hello");
return "Hello, AOP!";
}

    @GetMapping("/status")
public String status() {
// AOP가 없었다면 또 다른 메서드에 대해 또 로깅 추가
        log.info("Method called: hello2");
return "Hello, AOP2!";
}
}

AOP를 사용하지 않았다면, 로깅이 필요한 메서드마다

log.info("Method called: hello"); 이걸 달아줘야 한다.

이때 AOP로 로깅 처리를 하면 메서드 하나로 수많은 곳의 로깅처리를 간단하게 할 수 있다.

4. AOP 설정

AOP로 모든 메서드 호출 전에 로그를 남기도록 LoggingAspect를 생성한다.



import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;


@Aspect
@Component
@Slf4j
public class LoggingAspect {

    @Before("execution(* com.example.aoptest.*.*(..))")
public void logBefore(JoinPoint joinPoint) {
        log.info("Method called: " + joinPoint.getSignature().getName());
}
}

@Aspect :

스프링 AOP를 적용할 때 주로 사용되는 애너테이션, 이를 통해 프록시 방식의 AOP가 적용된다.

@Aspect는 표식일 뿐, 객체를 컴포넌트 스캔의 대상으로 만들어주진 않으므로 AOP 적용을 위해선 별도 빈으로 등록하는 과정이 필요하다.

@Bean을 이용한 수동 등록, @Component를 이용한 자동 등록, @Import를 사용한 클래스 참조 (주로 설정 파일을 추가할 때 사용) 으로 가능!

@Before: 메서드가 실행되기 전에 로깅 수행

execution(* com.example.aoptest.controller.*.*(..)): Admin API 컨트롤러 내 모든 메서드를 대상으로 AOP를 적용한다. (Pointcut)

사실상 이 3개가 핵심이다.

JoinPoint: 현재 실행 중인 메서드에 대한 정보를 가져올 수 있으며, 여기서는 메서드 이름을 로깅한다.

5. 실행 및 테스트

모든 설정이 완료되면 애플리케이션을 실행하고 url로 GET 요청을 보내보자.

요청이 성공하면, 다음과 같이 Aspect에서 설정한 로그가 콘솔에 출력된다.

+ aop 패키지를 따로 만들면 보기에 좋다.

더 고도화 할 수도 있지만, 간단 사용법에 대해서는 이 정도가 딱이다..!