포인트컷 지시자

💡 김영한님의 스프링 핵심 원리 고급편 강의를 듣고 정리한 내용입니다.

포인트컷 지시자

애스펙트J는 포인트컷을 편리하게 표현하기 위한 특별한 표현식을 제공한다.

예) @Pointcut("execution(* hello.aop.order..*(..))")

포인트컷 표현식은 AspectJ pointcut expression 즉 애스펙트J가 제공하는 포인트컷 표현식을 줄여서 말하는 것이다.

포인트컷 지시자

포인트컷 표현식은 execution 같은 포인트컷 지시자(Pointcut Designator)로 시작한다. 줄여서 PCD라 한다.

포인트컷 지시자의 종류

• execution: 메소드 실행 조인 포인트를 매칭한다. 스프링 AOP에서 가장 많이 사용하고, 기능도 복잡하다.
• within: 특정 타입 내의 조인 포인트를 매칭한다
• args: 인자가 주어진 타입의 인스턴스인 조인 포인트
• this: 스프링 빈 객체(스프링 AOP 프록시)를 대상으로 하는 조인 포인트
• target: Target 객체(스프링 AOP 프록시가 가리키는 실제 대상)를 대상으로 하는 조인 포인트
• @target: 실행 객체의 클래스에 주어진 타입의 애노테이션이 있는 조인 포인트
• @within: 주어진 애노테이션이 있는 타입 내 조인 포인트
• @annotation: 메서드가 주어진 애노테이션을 가지고 있는 조인 포인트를 매칭
• @args: 전달된 실제 인수의 런타임 타입이 주어진 타입의 애노테이션을 갖는 조인 포인트
• bean: 스프링 전용 포인트컷 지시자, 빈의 이름으로 포인트컷을 지정한다.

ClassAop

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ClassAop {
}

MethodAop

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MethodAop {
    String value();
}

MemberServiceImpl

@ClassAop
@Component
public class MemberServiceImpl implements MemberService {

    @Override
    @MethodAop("test value")
    public String hello(String param) {
        return "ok";
    }

    public String internal(String param) {
        return "ok";
    }
}

ExecutionTest

@Slf4j
public class ExecutionTest {

    AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut();
    Method helloMethod;

    @BeforeEach
    public void init() throws NoSuchMethodException {
        helloMethod = MemberServiceImpl.class.getMethod("hello", String.class);
    }

    @Test
    void printMethod() {
        //public java.lang.String hello.aop.member.MemberServiceImpl.hello(java.lang.String)
        log.info("helloMethod={}", helloMethod);
    }
}

AspectJExpressionPointcut이 바로 포인트컷 표현식을 처리해주는 클래스다.

여기에 포인트컷 표현식을 지정 하면 된다.

AspectJExpressionPointcut는 상위에 Pointcut 인터페이스를 가진다.

execution 문법

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

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

• 메소드 실행 조인 포인트를 매칭한다.
• ?는 생략할 수 있다.
• * 같은 패턴을 지정할 수 있다.

exactMatch(가장 정확한 포인트컷)

@Test
void exactMatch() {
    //public java.lang.String hello.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.setExpression("execution(public String hello.aop.member.MemberServiceImpl.hello(String))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

 

MemberServiceImpl.hello(String) 메서드와 가장 정확하게 모든 내용이 매칭되는 표현식이다.

AspectJExpressionPointcut에 pointcut.setExpression을 통해서 포인트컷 표현식을 적용할 수 있다.
pointcut.matches(메서드, 대상 클래스)를 실행하면 지정한 포인트컷 표현식의 매칭 여부를 true, false로 반환한다.

매칭 조건

• 접근제어자?: public
• 반환타입: String
• 선언타입?: hello.aop.member.MemberServiceImpl
• 메서드이름: hello
• 파라미터: (String)
• 예외?: 생략

MemberServiceImpl.hello(String) 메서드와 포인트컷 표현식의 모든 내용이 정확하게 일치한다.

따라서 true를 반환한다.

가장 많이 생략한 포인트컷

@Test
void allMatch() {
    pointcut.setExpression("execution(* *(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}​

 매칭 조건

• 접근제어자?: 생략
• 반환타입: *
• 선언타입?: 생략
• 메서드이름: * 
• 파라미터: (..) 
• 예외?: 없음

*은 아무 값이 들어와도 된다는 뜻이다.

파라미터에서 .. 은 파라미터의 타입과 파라미터 수가 상관없다는 뜻이다.

메서드 이름 매칭 관련 포인트컷

@Test
void nameMatch() {
    pointcut.setExpression("execution(* hello(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

@Test
void nameMatchStar1() {
    pointcut.setExpression("execution(* hel*(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

@Test
void nameMatchStar2() {
    pointcut.setExpression("execution(* *el*(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

@Test
void nameMatchFalse() {
    pointcut.setExpression("execution(* nono(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isFalse();
}

패키지 매칭 관련 포인트컷

@Test
void packageExactMatch1() {
    pointcut.setExpression("execution(* hello.aop.member.MemberServiceImpl.hello(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

@Test
void packageExactMatch2() {
    pointcut.setExpression("execution(* hello.aop.member.*.*(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

@Test
void packageExactFalse() {
    pointcut.setExpression("execution(* hello.aop.*.*(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isFalse();
}

@Test
void packageMatchSubPackage1() {
    pointcut.setExpression("execution(* hello.aop.member..*.*(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}

@Test
void packageMatchSubPackage2() {
    pointcut.setExpression("execution(* hello.aop..*.*(..))");
    assertThat(pointcut.matches(helloMethod, MemberServiceImpl.class)).isTrue();
}​

 

hello.aop.member.*(1).*(2)

• (1): 타입
• (2): 메서드 이름

패키지에서 . , .. 의 차이를 이해해야 한다.

• . : 정확하게 해당 위치의 패키지
• .. : 해당 위치의 패키지와 그 하위 패키지도 포함

hello.aop.member -> 매칭 됨

hello.aop -> 매칭 안됨

@target, @within

정의

• @target: 실행 객체의 클래스에 주어진 타입의 애노테이션이 있는 조인 포인트
• @within: 주어진 애노테이션이 있는 타입 내 조인 포인트

어렵게 생각할 필요없다.

애노테이션을 타입에 적용하면 된다.

설명

• @target, @within은 다음과 같이 타입에 있는 애노테이션으로 AOP 적용 여부를 판단한다.
• @target(hello.aop.member.annotation.ClassAop)
• @within(hello.aop.member.annotation.ClassAop)

 @ClassAop
 class Target{}

 

@target vs @within

@target은 인스턴스의 모든 메서드를 조인 포인트로 적용한다.

@within은 해당 타입 내에 있는 메서드만 조인 포인트로 적용한다.

 

쉽게 이야기해서 @target은 부모 클래스의 메서드까지 어드바이스를 다 적용하고, @within은 자기 자신의 클래스에 정의된 메서드에만 어드바이스를 적용한다.

@target은 내가 가지고 있는 모든 메서드(상속 받은 클래스, 구현한 인터페이스 들의 메서드)가 대상이 된다.

@within은 딱 나한테만 적용이 된다.

주의

다음 포인트컷 지시자는 단독으로 사용하면 안된다. args, @args, @target