[스프링 핵심 원리 - 고급편] #11. 스프링 AOP 구현 2/2

[YuDeokRin]

6️⃣ 스프링 AOP 구현4 - 포인터컷 참조

• 포인트컷을 공용으로 사용하기 위해 별도의 외부 클래스에 모아두는 방법을 해보자.
• 참고로 외부에서 호출할 때는 포인트컷의 접근 제어자를 public 으로 변경해서 열어두어야한다.

✅ Pointcuts

package hello.aop.order.aop;

import org.aspectj.lang.annotation.Pointcut;

public class Pointcuts {

    //hello.aop.order 패키지와 하위 패키지
    @Pointcut("execution(* hello.aop.order..*(..))")
    public void allOrder(){}

    //클래스 이름 패턴이 *Service
    @Pointcut("execution(* *..*Service.*(..))")
    public void allService(){}

    //allOrder && allService
    @Pointcut("allOrder() && allService()")
    public void orderAndService(){}
}

• OrderAndService() : allOrder() 포인트컷와 allService() 포인트컷을 조합해서 새로운 포인트컷을 만들었다.

✅ AspectV4Pointcut

package hello.aop.order.aop;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;

@Slf4j
@Aspect
public class AspectV4Pointcut {

    //기존 삭제 

    @Around("hello.aop.order.aop.Pointcuts.allOrder()") // 패키지 경로 확인
    public Object doLog(ProceedingJoinPoint joinPoint) throws Throwable {
        log.info("[log] {}", joinPoint.getSignature());
        return joinPoint.proceed();
    }

    @Around("hello.aop.order.aop.Pointcuts.allService()")
    public Object doTransaction(ProceedingJoinPoint joinPoint) throws Throwable {
        try {
            log.info("[트랜잭션 시작] {}", joinPoint.getSignature());
            Object result = joinPoint.proceed();
            log.info("[트랜잭션 커밋] {}", joinPoint.getSignature());
            return result;
        } catch (Exception e) {
            log.info("[트랜잭션 롤백] {}", joinPoint.getSignature());
            throw e;
        } finally {
            log.info("[리소스 릴리즈] {}", joinPoint.getSignature());
        }
    }
}

• 사용하는 방법은 패키지명을 포함한 클래스 이름과 포인트컷 시그니처를 모두 지정하면 된다.
• 포인터컷을 여러 어드바이스에서 함께 사용할 때 이 방법을 사용하면 효과적이다.

✅ AopTest

@Slf4j
@Import(AspectV4Pointcut.class) // 변경된 부분 
@SpringBootTest
public class AopTest {

}

7️⃣스프링 AOP 구현5 - 어드바이스 순서

• 어드바이스는 기본적으로 순서를 보장하지 않는다.

• 순서를 지정하고 싶으면 @aspect 적용 단위로 org.springframework.core.annotation.@order 애노테이션을 적용해야 한다.

• 문제는 이것을 어드바이스 단위가 아니라 클래스 단위로 적용할 수 있다는 점이다.

• 그래서 아래와 같이 하나의 애스펙트에 여러 어드바이스가 있으면 순서를 보장 받을 수 없다.

• 따라서 애스펙트를 별도의 클래스로 분리해야 한다.

• 현재 로그를 남기는 순서가 아마도 [doLog() doTransaction() ] 이 순서로 남을 것이다.
  (참고로 이 순서로 실행되지 않는 분도 있을 수 있다. JVM이나 실행 환경에 따라 달라질 수도 있다.)

• 실습

  • 로그를 남기는 순서를 바꾸어서 [doTransaction() doLog() ] 트랜잭션이 먼저 처리되고, 이후에 로그가 남도록 변경해보자.

✅ AspectV5Order

package hello.aop.order.aop;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.core.annotation.Order;

@Slf4j
public class AspectV5Order {

    //따로 에스펙트로 분리 
    @Aspect
    @Order(2)
    public static class LogAspect {

        @Around("hello.aop.order.aop.Pointcuts.allOrder()")
        public Object doLog(ProceedingJoinPoint joinPoint) throws Throwable {
            log.info("[log] {}", joinPoint.getSignature());
            return joinPoint.proceed();
        }
    }

		// 따로 에스펙트 분리 
    @Aspect
    @Order(1) // 1번 실행 
    public static class TxAspect {
        @Around("hello.aop.order.aop.Pointcuts.allService()")
        public Object doTransaction(ProceedingJoinPoint joinPoint) throws Throwable {
            try {
                log.info("[트랜잭션 시작] {}", joinPoint.getSignature());
                Object result = joinPoint.proceed();
                log.info("[트랜잭션 커밋] {}", joinPoint.getSignature());
                return result;
            } catch (Exception e) {
                log.info("[트랜잭션 롤백] {}", joinPoint.getSignature());
                throw e;
            } finally {
                log.info("[리소스 릴리즈] {}", joinPoint.getSignature());
            }
        }
    }

}

✅ AopTest

@Slf4j
//@Import(AspectV1.class)
//@Import(AspectV2.class)
//@Import(AspectV3.class)
//@Import(AspectV4Pointcut.class)
@Import({AspectV5Order.LogAspect.class, AspectV5Order.TxAspect.class})
@SpringBootTest
public class AopTest {
}

• 실행 결과

hello.aop.order.aop.AspectV5Order        : [트랜잭션 시작] void hello.aop.order.OrderService.orderItem(String)
hello.aop.order.aop.AspectV5Order        : [log] void hello.aop.order.OrderService.orderItem(String)
hello.aop.order.OrderService             : [orderService] 실행
hello.aop.order.aop.AspectV5Order        : [log] String hello.aop.order.OrderRepository.save(String)
hello.aop.order.OrderRepository          : [orderRepository] 실행]
hello.aop.order.aop.AspectV5Order        : [트랜잭션 커밋] void hello.aop.order.OrderService.orderItem(String)
hello.aop.order.aop.AspectV5Order        : [리소스 릴리즈] void hello.aop.order.OrderService.orderItem(String)
hello.aop.AopTest                        : isAopProxy, orderService=true
hello.aop.AopTest                        : isAopProxy, orderRepository=true
hello.aop.order.aop.AspectV5Order        : [트랜잭션 시작] void hello.aop.order.OrderService.orderItem(String)
hello.aop.order.aop.AspectV5Order        : [log] void hello.aop.order.OrderService.orderItem(String)
hello.aop.order.OrderService             : [orderService] 실행
hello.aop.order.aop.AspectV5Order        : [log] String hello.aop.order.OrderRepository.save(String)
hello.aop.order.OrderRepository          : [orderRepository] 실행]
hello.aop.order.aop.AspectV5Order        : [트랜잭션 롤백] void hello.aop.order.OrderService.orderItem(String)
hello.aop.order.aop.AspectV5Order        : [리소스 릴리즈] void hello.aop.order.OrderService.orderItem(String)

8️⃣스프링 AOP 수현6 - 어드바이스 종류

• 어드바이스는 @around외에도 여러가지 종류가 있다.

➡️ 어드바이스 종류

• @around : 메서드 호출 전후에 수행, 가장 강력한 어드바이스, 조인 포인트 실행 여부 선택, 반환 값 변환, 예외변환 등이 가능
• @before : 조인 포인트 실행 이전에 실행
• @AfterReturning : 조인 포인트가 정상 완료후 실행
• @AfterThrowing : 메서드가 예외를 던지는 경우 실행
• @after : 조인 포인트가 정상 또는 예외에 관계없이 실행(finally)

✅ AspectV6Advice

• doTransaction() 메서드에 남겨둔 주석을 보자.
• 복잡해 보이지만 사실 @around를 제외한 나머지 어드바이스들은 @around가 할 수 있는 일의 일부만 제공할 뿐이다.
• 따라서 @around 어드바이스만 사용해도 필요한 기능을 모두 수행 가능하다.

✅ 참고 정보 획득

• 모든 어드바이스는 org.aspectj.lang.JoinPoint 를 첫번째 파라미터에 사용할 수 있다. (생략해도 된다.)

  • 단 @Around 는 ProceedingJoinPoint 을 사용해야 한다

• 참고로 ProceedingJoinPoint 는 org.aspectj.lang.JoinPoint 의 하위 타입이다.

➡️ JoinPoint 인터페이스의 주요 기능

• getArgs() : 메서드 인수를 반환합니다.
• getThis() : 프록시 객체를 반환합니다.
• getTarget() : 대상 객체를 반환합니다.
• getSignature() : 조언되는 메서드에 대한 설명을 반환합니다.
• toString() : 조언되는 방법에 대한 유용한 설명을 인쇄합니다.

➡️ProceedingJoinPoint 인터페이스의 주요 기능

• proceed() : 다음 어드바이스나 타켓을 호출한다.
• 추가로 호출시 전달한 매개변수를 파라미터를 통해서도 전달 받을 수도 있는데, 이 부분은 뒤에서 설명한다.

✅ 어드바이스 종류

• @before
  • 조인 포인트 실행 전

@Before("hello.aop.order.aop.Pointcuts.orderAndService()")
public void doBefore(JoinPoint joinPoint) {
			log.info("[before] {}", joinPoint.getSignature());
}

• @around와 다르게 작업 흐름을 변경할 수는 없다.@around는 ProceedingJoinPoint.proceed()를 호출해야 다음 대상이 호출된다. 만약 호출하지 않으면 다음 대상이 호출되지 않는다. 반면에 @Before 는 ProceedingJoinPoint.proceed() 자체를 사용하지 않는다. 메서드 종료시 자동으로 다음 타켓이 호출된다. 물론 예외가 발생하면 다음 코드가 호출되지는 않는다.

• @AfterReturning

@AfterReturning(value = "hello.aop.order.aop.Pointcuts.orderAndService()",returning = "result")
public void doReturn(JoinPoint joinPoint, Object result) {
		log.info("[return] {} return={}", joinPoint.getSignature(), result);
}

• returning 속성에 사용된 이름은 어드바이스 메서드의 매개변수 이름과 일치해야 한다.
• returning 절에 지정된 타입의 값을 반환하는 메서드만 대상으로 실행한다. (부모 타입을 지정하면 모든 자식타입은 인정된다.)
• @Around 와 다르게 반환되는 객체를 변경할 수는 없다. 반환 객체를 변경하려면 @Around 를 사용해야 한다.
• 참고로 반환 객체를 조작할 수 는 있다.

@after

• 메서드 실행이 종료되면 실행된다. (finally를 생각하면 된다.)
• 정상 및 예외 반환 조건을 모두 처리한다.
• 일반적으로 리소스를 해제하는 데 사용한다.

@around

• 메서드의 실행의 주변에서 실행된다. 메서드 실행 전후에 작업을 수행한다.
  가장 강력한 어드바이스
• 조인 포인트 실행 여부 선택 joinPoint.proceed() 호출 여부 선택
• 전달 값 변환: joinPoint.proceed(args[])
• 반환 값 변환
• 예외 변환
• 트랜잭션 처럼 try ~ catch~ finally 모두 들어가는 구문 처리 가능
• 어드바이스의 첫 번째 파라미터는 ProceedingJoinPoint 를 사용해야 한다.
• proceed() 를 통해 대상을 실행한다.
• proceed() 를 여러번 실행할 수도 있음(재시도)

//@Import({AspectV5Order.LogAspect.class, AspectV5Order.TxAspect.class})
@Import(AspectV6Advice.class)
@SpringBootTest

public class AopTest {}

• 순서

• 스프링은 5.2.7 버전부터 동일한 @Aspect 안에서 동일한 조인포인트의 우선순위를 정했다.

• 실행 순서 @around, @before, @after , @AfterReturning, @AfterThrowing

• 어드바이스가 적용되는 순서는 이렇게 적용되지만, 호출 순서와 리턴 순서는 반대라는 점을 알아두자.

• 물론 @aspect 안에 동일한 종류의 어드바이스가 2개 있으면 순서가 보장되지 않는다. 이 경우 앞서 배운 것 처럼 @aspect 를 분리하고 @order 를 적용하자.

• @around 외에 다른 어드바이스가 존재하는 이유

  • @Around` 하나만 있어도 모든 기능을 수행할 수 있다. 그런데 다른 어드바이스들이 존재하는 이유는 무엇일까?

@Around("hello.aop.order.aop.Pointcuts.orderAndService()")
public void doBefore(ProceedingJoinPoint joinPoint) {
		log.info("[before] {}", joinPoint.getSignature());
}

• 이 코드의 문제점을 찾을 수 있겠는가? 이 코드는 타켓을 호출하지 않는 문제가 있다.
• 이 코드를 개발한 의도는 타켓 실행 전에 로그를 출력하는 것이다. 그런데 @Around 는 항상
  joinPoint.proceed() 를 호출해야 한다.
• 만약 실수로 호출하지 않으면 타켓이 호출되지 않는 치명적인 버그가 발생한다.

그와 반면에…

• @Before 는 joinPoint.proceed() 를 호출하는 고민을 하지 않아도 된다.

@Before("hello.aop.order.aop.Pointcuts.orderAndService()")
public void doBefore(JoinPoint joinPoint) {
log.info("[before] {}", joinPoint.getSignature());
}

• @Around 가 가장 넓은 기능을 제공하는 것은 맞지만, 실수할 가능성이 있다. 반면에 @Before , @After 같은 어드바이스는 기능은 적지만 실수할 가능성이 낮고, 코드도 단순하다.
• 그리고 가장 중요한 점이 있는데, 바로 이 코드를 작성한 의도가 명확하게 드러난다는 점이다.
• @Before 라는 애노테이션을 보는 순간 아~ 이 코드는 타켓 실행 전에 한정해서 어떤 일을 하는 코드구나 라는 것이 드러난다.