[AOP] AOP 포인트컷 표현식 (1) - execution

 

 

 

 

 

 

포인트컷 지시자 (Pointcut Designators)

스프링에서는 포인트컷 표현식에서 사용하기 위해 다음 AspectJ 포인트컷 지시자(PCD)를 지원합니다.

 

• execution: 메서드 실행 조인 포인트를 매칭합니다.
  • 스프링 AOP에서 가장 많이 사용합니다.

 

• within: 특정한 타입 내의 조인 포인트를 매칭합니다.
  • 부모 타입을 지정하면 적용되지 않습니다.
  • 다음을 참고 - (https://ttl-blog.tistory.com/871)

 

• this: 스프링 빈 객체(스프링 AOP 프록시)를 대상으로 하는 조인 포인트를 매칭합니다.
  • 다음을 참고 - (https://ttl-blog.tistory.com/878)

 

• target: target 객체(스프링 AOP 프록시가 가리키는 실제 대상)를 대상으로 하는 조인 포인트를 매칭합니다.
  • 다음을 참고 - (https://ttl-blog.tistory.com/879)

 

• args: 인자가, 주어진 타입의 인스턴스인 조인 포인트를 매칭합니다. 
  • 다음을 참고 - (https://ttl-blog.tistory.com/872)

 

• @target: 실행 객체의 클래스에, 주어진 타입의 애노테이션이 있는 조인 포인트를 매칭합니다. 
  • 다음을 참고 - (https://ttl-blog.tistory.com/873)

 

• @args: 전달된 실제 인수의 런타임 시의 타입이, 주어진 타입의 애노테이션을 갖는 조인 포인트를 매칭합니다. 
  • 다음을 참고 - (https://ttl-blog.tistory.com/876)

 

• @within: 주어진 애노테이션이 있는 타입 내 조인 포인트를 매칭합니다. 
  • 다음을 참고 - (https://ttl-blog.tistory.com/874)

 

• @annotation: 메서드가 주어진 애노테이션을 가지고 있는 조인 포인트를 매칭합니다.
  • 다음을 참고 - (https://ttl-blog.tistory.com/875)

 

 

• bean : 스프링 전용 포인트컷 지시자로, 빈의 이름으로 포인트컷을 지정합니다.
  • 다음을 참고 - (https://ttl-blog.tistory.com/877)

 

 

 

 

 

 

 

 

 

 

 

예시를 위한 코드

package hello.advanced.aop.member

interface MemberService {
    fun hello(param: String): String
}

 

 

package hello.advanced.aop.member

import org.springframework.stereotype.Component


@Component
class MemberServiceImpl : MemberService{

    override fun hello(param: String): String {
        return "ok"
    }

    fun internal(param: String): String {
        return "ok"
    }
}

 

 

 

 

 

 

 

 

class ExecutionTest {
    val log = logger<ExecutionTest>()


    val pointcut = AspectJExpressionPointcut()
    lateinit var helloMethod: Method


    @BeforeEach
    fun init() {
        helloMethod = MemberServiceImpl::class.java.getMethod("hello", String::class.java)
    }


    @Test
    fun printMethod() {
    	//helloMethod={public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)}
        log.info("helloMethod={${helloMethod}}")
    }

}

 

결과는 다음과 같습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

execution

메서드 실행 조인 포인트를 매칭합니다.

 

 

 

문법은 다음과 같습니다.

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

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

 

?는 생략이 가능한 설정입니다.

 

*로 상관 없음 설정이 가능합니다. (파라미터의 경우에는 ..으로 상관 없을 처리를 합니다.)

 

 

위의 형식은 바로 직전 테스트코드의 결과값으로 나온 것과 동일합니다.

public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)

 

 

 

 

가장 정확한 매칭

package hello.advanced.pointcut

import hello.advanced.aop.member.MemberServiceImpl
import hello.advanced.logger
import org.assertj.core.api.Assertions
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.DisplayName
import org.junit.jupiter.api.Test
import org.springframework.aop.aspectj.AspectJExpressionPointcut
import java.lang.reflect.Method

/**
 * Created by ShinD on 2022/08/02.
 */
class ExecutionTest {
    val log = logger<ExecutionTest>()

    val pointcut = AspectJExpressionPointcut()

    lateinit var helloMethod: Method


    @BeforeEach
    fun init() {
        helloMethod = MemberServiceImpl::class.java.getMethod("hello", String::class.java)
    }

    @Test
    @DisplayName("가장 정확한 포인트컷")
    fun exactMatch() {
        //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
        pointcut.expression = "execution(public String hello.advanced.aop.member.MemberServiceImpl.hello(String))"

        Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
    }

}

접근 제어자? : public

반환 타입  : String

선언 타입.? : hello.advanced.aop.member.MemberServiceImpl

메서드이름 : hello

(파라미터) : (String)

예외? : 생략(없으므로)

 

 

 

 

 

 

 

 

가장 많이 생략한 매칭

@Test
@DisplayName("가장 많이 생략한 포인트컷")
fun skipMatch() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

접근 제어자? : 생략 

반환 타입 : * 

선언 타입.? : 생략

메서드이름 : *

(파라미터) : .. (파라미터의 타입과 수가 상관없음)

예외? : 생략

 

 

 

 

 

 

 

메서드 이름 매칭

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : hello
 * (파라미터) : .. 
 * 예외? : 생략
 */
@Test
@DisplayName("메서드 이름 매치 - 동일한 이름")
fun methodNameMatch() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : hel*
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("메서드 이름 매치 - 패턴 매칭 V1")
fun methodNameMatchV1() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hel*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *llo
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("메서드 이름 매치 - 패턴 매칭 V2")
fun methodNameMatchV2() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *llo(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *el*
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("메서드 이름 매치 - 패턴 매칭 V3")
fun methodNameMatchV3() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *el*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : h*l*
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("메서드 이름 매치 - 패턴 매칭 V4")
fun methodNameMatchV4() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* h*l*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : h*o
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("메서드 이름 매치 - 패턴 매칭 V5")
fun methodNameMatchV5() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* h*o(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

 

 

 

 

 

 

 

 

 

 

패키지 이름 매칭

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.member.MemberServiceImpl
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("패키지 이름 매치 - 동일한 이름")
fun packageNameMatch() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.member.MemberServiceImpl.*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}


/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.member.*
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("패키지 이름 매치 - 패키지 내부 모두 포함")
fun packageNameMatchV1() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.member.*.*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.*
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("패키지 이름 매치 - 패키지 상위만 지정해주면 하위 패키지에 대해서는 적용 실패")
fun packageNameMatchV2() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.*.*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isFalse
    //isFalse 주의!!
    //isFalse 주의!!
    //isFalse 주의!!
    //isFalse 주의!!
    //isFalse 주의!!
}


/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop..*     : ..을 사용하여 하위 패키지 포함
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("패키지 이름 매치 - 하위 패키지 포함 방법")
fun packageNameMatchV3() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop..*.*(..))"
    //hello.advanced.aop 와 그 하위 패키지 모두 포함

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}


/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : he*o.*vance*.*ao*p*.*.*
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("패키지 이름 매치 - 패턴 매치")
fun packageNameMatchV4() {
    //public java.lang.String          he[*]o.[*]vance[*].[*]ao[*]p[*].member(== *).MemberServiceImpl(== *).hello(== *)(java.lang.String)
    pointcut.expression = "execution(* he*o.*vance*.*ao*p*.*.*.*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

 

 

패키지 매치에서 .과 ..은 차이가 발생합니다.

 

.은 정확하게 해당 위치의 패키지를 의미하며,

..은 해당 위치의 패키지와 그 하위 패키지도 포함합니다.

 

 

 

 

 

 

 

 

 

 

 

타입 매칭

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.member.MemberServiceImpl
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("타입 매치")
fun typeMatch() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.member.MemberServiceImpl.*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.member.MemberService
 * 메서드이름 : *
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("타입 매치 - 상위 타입 허용")
fun typeMatchV1() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.member.MemberService.*(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.member.MemberService
 * 메서드이름 : internal
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("타입 매치 - 상위 타입 매치 시 상위 타입에 없는 메서드는 허용 X")
fun typeMatchV2() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.member.MemberService.internal(..))"

    val internalMethod = MemberServiceImpl::class.java.getMethod("internal", String::class.java)

    Assertions.assertThat(pointcut.matches(internalMethod, MemberServiceImpl::class.java)).isFalse
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : hello.advanced.aop.member.MemberServiceImpl
 * 메서드이름 : internal
 * (파라미터) : ..
 * 예외? : 생략
 */
@Test
@DisplayName("타입 매치 - 하위 타입에만 있는 메서드는 허용")
fun typeMatchV3() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* hello.advanced.aop.member.MemberServiceImpl.internal(..))"

    val internalMethod = MemberServiceImpl::class.java.getMethod("internal", String::class.java)

    Assertions.assertThat(pointcut.matches(internalMethod, MemberServiceImpl::class.java)).isTrue
}

 

 

부모 타입으로 적용 시 부모 타입에 있는 메서드에 대해서만 적용됩니다.

 

 

 

 

 

 

 

 

 

 

 

파라미터 매치

부모 타입의 파라미터는 허용되지 않습니다.

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *
 * (파라미터) : (..)
 * 예외? : 생략
 */
@Test
@DisplayName("파라미터 매치 - 숫자와 무관하게 모든 파라미터, 모든 타입 허용 ")
fun paramMatch() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *(..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *
 * (파라미터) : ()
 * 예외? : 생략
 */
@Test
@DisplayName("파라미터 매치 - 파라미터 없는 경우만 매치")
fun paramMatchV1() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *())"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isFalse
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *
 * (파라미터) : (*)
 * 예외? : 생략
 */
@Test
@DisplayName("파라미터 매치 - 정확히 하나의 파라미터, 모든 타입의 파라미터 허용")
fun paramMatchV2() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *(*))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *
 * (파라미터) : (String, ..)
 * 예외? : 생략
 */
@Test
@DisplayName("파라미터 매치 - String을 맨 처음에 하나 받고, 이후 개수와 타입은 무관한 파라미터 허용)")
fun paramMatchV3() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *(String, ..))"

    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isTrue()
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *
 * (파라미터) : (*, *)
 * 예외? : 생략
 */
@Test
@DisplayName("파라미터 매치 - 아무 타입 딱 두개의 파라미터 허용)")
fun paramMatchV4() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *(*, *))"
    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isFalse
}

/**
 * 접근 제어자? : 생략
 * 반환 타입 : *
 * 선언 타입? : 생략
 * 메서드이름 : *
 * (파라미터) : (Object)   : Any도 안됨
 * 예외? : 생략
 */
@Test
@DisplayName("파라미터 매치 - 상위 타입으로 매치 불허용)")
fun paramMatchV5() {
    //public java.lang.String hello.advanced.aop.member.MemberServiceImpl.hello(java.lang.String)
    pointcut.expression = "execution(* *(Object))"
    Assertions.assertThat(pointcut.matches(helloMethod, MemberServiceImpl::class.java)).isFalse
}

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Reference

https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#aop-pointcuts

Core Technologies

스프링 핵심 원리 - 고급편 - 인프런 | 강의