🔥 TIL - Day 82 AspectJ Pointcut 기본문법 (Spring AOP를 이용한 테스트)

Kim Dae Hyun·2022년 1월 18일

Spring Spring AOP

Spring-AOP

목록 보기

4/6

Pointcut은 AOP 적용이 가능한 모든 JoinPoint 중에서 조건을 통해 특정 부분에 적용하기 위해 사용된다.

프록시 방식으로 사용되는 Spring AOP의 경우 JoinPoint가 메서드가 실행되는 곳으로 제한되긴 하지만 그 시점이 한 두개가 아니니 조건을 통한 제한은 반드시 필요하다.

Pointcut을 이용해서 제한할 수 있는 조건은 아래와 같이 다양하다.

가능한 모든 JointPoint에 매칭
특정 패키지 이하 모든 JointPoint와 매칭
특정 메서드 이름에 매칭
특정 클래스 이하 모든 JointPoint와 매칭
경로 뿐만 아니라 반환타입, 파라미터 등과 매칭
...
...

Spring AOP는 AspectJ의 Pointcut문법을 그대로 사용한다. 기본적은 틀은 아래와 같다.

execution(접근지시자? 반환타입 선언타입? 메서드이름(파라미터_타입) 예외?)

? 가 붙은 부분은 생략가능한 부분이다. 반면 굵은 부분은 생략 불가능하다.

execution 과 같은 Pointcut 지시자도 여러 개 있는데 가장 강력하고 범용적인 execution을 통해 AspectJ Pointcut 문법을 익혀보자.

테스트 환경 구성

의존성 추가

implementation 'org.springframework.boot:spring-boot-starter-aop'

테스트를 위한 클래스 작성 후 스프링 빈으로 등록한다.
스프링 빈으로 등록되어야 AOP를 적용할 수 있으므로 컴포넌트 스캔의 대상이 되도록 한다.

@Component
public class TestClass {

    public String test(String str) {
        return "test";
    }
}

테스트 클래스

AspectJ 표현식을 Pointcut으로 사용하기 위해 AspectJExpressionPointcut을 사용한다.
여러가지 Aspect표현식으로 Pointcut으로 TestClass와 매칭해보고 매칭 여부를 확인해보기 위해 test 메서드의 정보를 가져온다.

@Slf4j
public class PointcutTest {

    AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut();
    Method method;

    @BeforeEach
    void init() throws NoSuchMethodException {
        method = TestClass.class.getMethod("test", String.class);
    }

    @Test
    void showMethodInfo() {
        log.info("method = {}", method);
    }

}

현재 테스트 대상 메서드의 정보는 아래와 같다.

📌 모든 Jointpoint에 매칭 (생략가능한 조건 모두 생략)

생략 불가능한 조건 3개

반환타입, 메서드이름, 파라미터
생략 불가능 한 3개 타입의 경우 * 로 조건없음을 나타낸다.
파라미터의 경우에 *이 아닌 ..로 조건없음을 나타내는데 파라미터의 개수에 상관없음을 나타낸다고 이해하자.

@DisplayName("모든 Joinpoint와 매칭")
@Test
void allMatching() {
    pointcut.setExpression("execution(* *(..))");
    assertThat(pointcut.matches(method, TestClass.class)).isTrue();
}

📌 특정 메서드에 매칭 (정확하게 한 개 메서드에 매칭)

접근지시자: public
반환타입: String
선언타입(풀패키지): hello.aop.test.TestClass
메서드이름: test
파라미터타입: String

위 조건과 정확하게 일치하는 메서드와 매칭된다.

@Test
void exactMatching() {
    pointcut.setExpression("execution(public String hello.aop.test.TestClass.test(String))");
    assertThat(pointcut.matches(method, TestClass.class)).isTrue();
}

📌 특정 선언타입(클래스)에 매칭

@DisplayName("선언타입(클래스) 이하 모든 메서드와 매칭")
@Test
void declareTypeMatching() {
    pointcut.setExpression("execution(* hello.aop.test.TestClass.*(..))");
    assertThat(pointcut.matches(method, TestClass.class)).isTrue();
}

📌 특정 선언타입(클래스) 이하 메서드 이름 패턴 매칭

*es* 와 같이 메서드 이름을 표시해서 메서드 이름에 대한 패터매칭이 가능하다.

@DisplayName("특정 선언타입(클래스) 이하 메서드 이름 패턴 매칭")
@Test
void declareTypeMatching2() {
    pointcut.setExpression("execution(* hello.aop.test.TestClass.*es*(..))");
    assertThat(pointcut.matches(method, TestClass.class)).isTrue();
}

📌 특정 패키지 이하 모든 Jointpoint와 매칭

의도한 바는 hello.aop 이하 모든 JointPoint와 매칭하는 것이다.
hello.aop.*.* 별로 이상한 것 같지 않은데 isFalse() 한 실패 테스트가 성공했다.
특정 패키지 이하에 대한 패턴매칭은 조금 다른 방식으로 표현된다.

@DisplayName("특정 패키지 이하 모든 Jointpoint와 매칭 (실패)")
@Test
void packageNameMatchingFailureTest() {
    pointcut.setExpression("execution(* hello.aop.*.*(..))");
    assertThat(pointcut.matches(method, TestClass.class)).isFalse();
}

성공 케이스
hello.aop이하 경로를 표현할 때 ..를 사용했다.
..를 사용하면 특정 패키지 이하 경로와 매칭이 가능하다.

@DisplayName("특정 패키지 이하 모든 Jointpoint와 매칭 (성공)")
@Test
void packageNameMatchingTest() {
    pointcut.setExpression("execution(* hello.aop..*.*(..))");
    assertThat(pointcut.matches(method, TestClass.class)).isTrue();
}