[Spring] 🌱AOP (Aspect-oriented Programming)

---

스프링에서는 스키마 기반 접근 방식 이나 @Aspect 어노테이션을 통해 AOP를 사용할 수 있도록 도와줍니다. 이중에서 @Aspect 기반의 AOP에 대해 정리해 보려고 합니다.

🌱 AOP(관점 지향 프로그래밍)

AOP는 관점(Aspect)지향 프로그래밍으로, 여러 기능들에 나타나는 공통적인 부가 기능을 모듈화하여 재사용 하는 기법을 의미합니다.

AOP의 목적

보통 중요한 로직을 수행하는 핵심 기능들을 구현하면 해당 기능들에 공통적으로 따라오는 부가 기능들이 존재합니다. 이것을 횡단 관심사(Cross-cutting Concern) 이라고 합니다. (핵심기능들을 관통한다고 해서 이러한 이름을 가짐) 이러한 부가기능을 핵심 기능마다 하나하나 일일이 설정해 주게 된다면, 유지보수 측면에서 매우 비효율적일 것이라는 예상할 수 있습니다.

이러한 부가 기능의 코드를 핵심 기능의 코드와 분리하여, 코드의 유연한 확장이 가능하도록 하는 것이 AOP의 목적입니다.

AOP 적용이 필요한 간단한 예시

만약 Product를 생성하는 기능을 수행하는데 걸리는 시간을 측정하고 싶다면 아래와 같은 코드를 작성할 수 있을 것입니다.

@PostMapping("/products")
public Response createProduct(@RequestBody ProductRequestDto requestDto) {
    // 측정 시작 시간
    long startTime = System.currentTimeMillis();

    try {
    	// 핵심 기능 수행
        return productService.createProduct(requestDto, userDetails.getUser());
    } finally {
        // 측정 종료 시간
        long endTime = System.currentTimeMillis();
        // 수행시간 = 종료 시간 - 시작 시간
        long runTime = endTime - startTime;
    }
}

이러한 방법으로 해당 기능 수행 이전과 이후에 코드를 작성하여 부가기능을 수행할 수 있습니다. 그러나 기존 컨트롤러 계층이 추가된 부가 기능까지 처리하게 되어 SRP를 어기게 됩니다. 또한 생성 뿐만아니라 조회, 수정, 삭제에도 적용시키고 싶다거나, 앞으로 새로운 기능에도 적용하고 싶다면 모든 기능 앞뒤에 아래와 같이 부가기능을 선언해 주어야 할 것입니다.

이러한 문제를 해결해 줄 AOP에 대해 하나씩 살펴보려 합니다.

---

🌱 Advice, JoinPoint, Pointcut

Advice - 부가기능을 언제 수행할 것인지(핵심기능 이전, 이후, 전 후 둘다, 예외 발생시) 를 지정하는 방법

JoinPoint - 프로세스 내부에서 Advice가 적용될 수 있는 위치

Pointcut - 부가기능이 어느 핵심기능에서 작동할 것인지를 지정하는 방법

부가기능을 언제 실행시킬지에 대한 정보를 정해 주어야 합니다. 이러한 정보(핵심기능 이전인지, 이후인지 등)를 정하는 방법이 Advice 이고, 프로세스 내부에서 Advice가 적용될 수 있는 위치를 의미하는 것이 JoinPoint, 해당 기능을 어느 핵심기능에 붙일 겉인지 그 위치를 나타내는 것이 Pointcut 입니다.

Advice 의 종류

Advice 는 크게 5가지 종류로 나누어 집니다.

@Before - 기능이 수행되기 이전에 부가기능을 실행

@AfterReturning - 기능이 성공적으로 응답하면 부가기능을 실행 (함수 return 값 사용 가능)

@AfterThrowing - 기능이 실행 도중 응답에 실패하여 예외를 반환할 경우 부가기능을 실행

@After - @AfterReturning과 @AfterThrwoing을 합친 것으로 응답 성공,실패 여부 상관없이 기능이 끝나면 부가기능을 실행 (finally{} 처럼 동작)

@Around - 기능 전 후 모두 부가기능을 실행 (@Before + @After)

JoinPoint

JoinPoint는 Advice가 적용될 수 있는 위치를 의미합니다.

• 메소드를 호출할 때
• 변수에 접근할 때
• 객체를 초기화할 때
• 객체에 접근할 때

그러나 Spring AOP는 Proxy 기반의 AOP이기 때문에 메소드를 호출할 때 만 Advice가 적용될 수 있습니다.

💡 Spring AOP에서 JoinPoint 라고 하면 그냥 메소드를 호출할 때 라고 생각하면 됩니다.

Pointcut

Pointcut은 Advice를 적용할 JoinPoint를 선별하는 작업입니다.

Pointcut Expression Language

어느 메소드에 적용시킬지 지정 할 수 있는 표현식 입니다.

execution(modifiers-pattern? return-type-pattern declaring-type-pattern? method-name-pattern(param-pattern) throws-pattern?)

💡 뒤에 ? 가 붙어있는 요소는 생략 가능합니다.

예시

@Pointcut("execution(* com.example.myblog.controller.ProductController.*(..))")
private void product() {
}

modifiers-pattern - 해당 접근 제어 지시자의 메소드를 지정

• public, priavte, *

return-type-pattern - 해당 반환값을 가진 메소드를 지정

• void, String, ResponseDto, *

declaring-type-pattern

• 클래스명 (패키지명 필요)
• com.example.myblog.controller.*
  • controller 패키지의 모든 클래스에 적용
• com.example.myblog.controller..
  • controller 패키지 및 하위 패키지 모든 클래스에 적용

method-name-pattern(param-pattern)

• 함수명

  • createProduct : createProduct() 함수에만 적용
  • create* : create로 시작하는 모든 함수에 적용

• 파라미터 패턴 (param-pattern)

  • (com.sparta.myselectshop.dto.FolderRequestDto) - FolderRequestDto 인수 (arguments) 만 적용

  • () - 인수 없음

  • (*) - 인수 1개 (타입 상관없음)

  • (..) - 인수 0~N개 (타입 상관없음)

    
    

포인트 컷은 재사용과 결합이 가능합니다.

@Pointcut("execution(* com.example.myblog.controller.*.*(..))")
private void forAllController() {}

@Pointcut("execution(String com.example.myblog.controller.*.*())")
private void forAllViewController() {}

@Around("forAllContorller() && !forAllViewController()")
public void saveRestApiLog() {
	...
}

---

🌱 AOP 적용해보기

AOP는 빈 객체에 적용 가능하기 때문에 대상 클래스가 Bean으로 등록 되어있어야 합니다.

@Aspect

공통적용할 부가 기능(cross-cutting Concern)에 @Aspect 어노테이션을 지정해 줍니다.

@Aspect // 클래스에 달아야 하고 bean 클래스에만 가능하다.
@Component
public class UseTimeAop {

	// ProductController 내부 모든 메소드 지정
	@Pointcut("execution(* com.example.myblog.controller.ProductController.*(..))") 
    private void product() {
    }

	// FolderController 내부 모든 메소드 지정
    @Pointcut("execution(* com.example.myblog.controller.FolderController.*(..))")
    private void folder() {
    }
    
    // 두개의 포인트 컷 병합
    @Pointcut("product() || folder()")
    private void productAndFolder() {
    }
    
}

Advice 어노테이션들 적용해보기

@Slf4j(topic = "UseTimeAop")
@RequiredArgsConstructor
@Aspect // 클래스에 달아야 하고 bean 클래스에만 적용 가능하다.
@Component // Aspect도 스프링 빈으로 등록
public class UseTimeAop {

	...

	// 메소드 수행 직전에 실행
    @Before("productAndFolder()")  // ProductController와 FolderController 에 적용
    public void executeBefore() {
        log.info("[API Use Time] [Before] Method Start");
    }

	// 메소드 수행 직후에 실행
    @After("productAndFolder()") 
    public void executeAfter() {
        log.info("[API Use Time] [After] Method End");
    }

	// 메소드 수행 전과 후 모두 적용
    @Around("productAndFolder()")
    public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {
        // 측정 시작 시간
        long startTime = System.currentTimeMillis();
        log.info("[API Use Time] [Around] Around Start");
        try {
            // 핵심기능 수행 - 기존의 기능(AOP가 감싼 해당 메소드의 기능을 수행)
            Object output = joinPoint.proceed(); // createProduct()를 감싸고 있다면 createProduct()를 실행
            return output;
        } finally {
            // 측정 종료 시간
            long endTime = System.currentTimeMillis();
            // 수행시간 = 종료 시간 - 시작 시간
            long runTime = endTime - startTime;
            log.info("[API Use Time] [Around] Around End, Runtime: " + runTime + " ms");
        }
    }
}

출력 결과

@Around는 ProceedingJoinPoint 를 인자로 받아서 원하는 시점에 joinPoint를 실행할 수 있습니다.

jopinPoint.proceed() 이전과 이후로 구분지어서 원하는 기능을 추가할 수 있습니다.

---

Intellij 가 제공하는 기능

AOP를 적용해보면서 알게 된 기능인데, 인텔리제이에서는 AOP를 적용하면 이렇게 해당 모듈이 어느 메소드들에 지정되었는지 왼쪽 버튼을 통해 확인할 수 있도록 도와주고,

AOP가 적용된 메소드에 가면 어떠한 모듈들이 적용되어 있는지 확인할 수 있게 기능을 제공합니다.

---

참고

• https://docs.spring.io/spring-framework/reference/core/aop.html
• https://www.youtube.com/watch?v=hjDSKhyYK14