随着Spring框架的不断发展,execution表达式作为Spring AOP切点表达式的核心语法之一,也逐渐成为了Java开发人员必备的技能之一。execution表达式主要作用是定义切点,即哪些方法或者哪些类的哪些方法需要被拦截。本文将从多个方面对execution表达式进行详细阐述,以帮助读者深入了解execution表达式。
一、基础语法
execution表达式的格式为:execution(modifiers-pattern? ret-type-pattern declaring-type-pattern?name-pattern(param-pattern)throws-pattern?) 。其中,各组成部分分别表示:
- modifiers-pattern:修饰符模式(可选),如public、private、protected、static等。
- ret-type-pattern:返回值模式,如任何类型用*表示,void用special。
- declaring-type-pattern:类路径表达式(可选),如com.example.demo.*Service表示匹配com.example.demo包下所有以Service结尾的类。
- name-pattern:方法名表达式,如*表示匹配所有方法名。
- param-pattern:参数列表表达式,如()表示匹配无参方法,(*)表示匹配任意一个参数方法,(..)表示匹配任意个参数方法。
- throws-pattern:异常类型表达式(可选),如表示匹配抛出RuntimeException和NullPointerException异常的方法。
举个例子:对于一个返回类型为int,包含两个参数的方法,名称为add,参数类型分别为int和int的方法,可以这样匹配:
execution(int com.example.demo.Calculator.add(int, int))
需要注意的是,在declaring-type-pattern、name-pattern、param-pattern以及throws-pattern中可以使用通配符,其中*表示匹配任何字符,..表示任意个字符。
二、修饰符模式
execution表达式的modifiers-pattern部分可以匹配方法的修饰符,如public、private、protected、static等。可以使用的修饰符模式包括:
- public:匹配public类型的方法。
- protected:匹配protected类型的方法。
- private:匹配private类型的方法。
- default:匹配default类型的方法。
- static:匹配static类型的方法。
- final:匹配final类型的方法。
- native:匹配native类型的方法。
- synchronized:匹配synchronized类型的方法。
- abstract:匹配abstract类型的方法。
举个例子:对于一个返回类型为void,参数个数为一个且参数类型为字符串类型,名字为log,并且是public修饰符的方法,代码如下所示:
public void log(String message);
可以这样匹配:
execution(public void com.example.demo.LogService.log(String))
三、返回类型模式
execution表达式的ret-type-pattern部分可以匹配返回类型,使用*来匹配任何类型,使用special来匹配void类型。
举个例子:对于返回值为String类型的方法,可以这样匹配:
execution(String com.example.demo.MyService.getString())
四、类路径模式
execution表达式的declaring-type-pattern部分可以匹配类路径,可以使用通配符*来匹配任何类,可以使用..来匹配任何路径。
举个例子:对于匹配类路径为com.example.demo下所有以Service结尾的类中,名称为add,参数列表中有两个参数且类型为int的方法,可以这样匹配:
execution(* com.example.demo.*Service.add(int, int))
五、方法名模式
execution表达式的name-pattern部分可以匹配方法名,可以使用通配符*匹配任何方法名。
举个例子:对于匹配名称包含save的方法,可以这样匹配:
execution(* save*(..))
六、参数列表模式
execution表达式的param-pattern部分可以匹配参数列表,可以使用()表示无参方法,可以使用(*)表示匹配任意一个参数,可以使用(..)表示匹配任意多个参数。
举个例子:对于匹配参数为两个int类型的方法,可以这样匹配:
execution(* *(int, int))
七、异常类型模式
execution表达式的throws-pattern部分可以匹配抛出的异常类型,可以使用通配符*匹配任何异常类型,可以使用..匹配任意异常继承体系中的异常。
举个例子:对于匹配抛出RuntimeException或者NullPointerException异常的方法,可以这样匹配:
execution(* *(..) throws RuntimeException, NullPointerException)
八、结合多个表达式
可以使用&&连接多个execution表达式,让它们都满足才能匹配成功。
举个例子,对于匹配类路径为com.example.demo且名称以Service结尾的类的任意public方法,可以这样匹配:
execution(public * com.example.demo.*Service.*(..))
九、总结
通过本文的详细阐述,相信读者对execution表达式有了更加深刻的理解。execution表达式是Spring AOP切点表达式的核心语法之一,可以用来定义切点,即哪些方法或者哪些类的哪些方法需要被拦截。需要注意的是,execution表达式的格式十分灵活,可以使用多种通配符来精确匹配到需要拦截的方法。
十、代码示例
下面给出使用execution表达式定义切面的代码示例:
@Aspect public class LogAspect { @Pointcut("execution(public * com.example.demo.*Service.*(..))") public void logPointCut() {} @Before("logPointCut()") public void beforeLog(JoinPoint joinPoint) { //在方法执行之前输出日志 System.out.println("entering method: " + joinPoint.getSignature().getName()); } @AfterReturning("logPointCut()") public void afterLog(JoinPoint joinPoint, Object result) { //在方法执行之后输出日志 System.out.println("exiting method: " + joinPoint.getSignature().getName()); } }
在上述示例中,定义了一个切点logPointCut,使用了execution表达式来精确匹配需要拦截的方法。可以看出,execution表达式可以被用来定义切点,这对于使用Spring AOP进行方法拦截非常有用。