古杏 發表於 2025-4-28 22:55:00

精通 Spring AOP Execution 表达式:精准匹配你的切点

<p>本文已收录在Github,<strong>关注我,紧跟本系列专栏文章,咱们下篇再续!</strong></p>
<ul>
<li>🚀 魔都架构师 | 全网30W技术追随者</li>
<li>🔧 大厂分布式系统/数据中台实战专家</li>
<li>🏆 主导交易系统百万级流量调优 &amp; 车联网平台架构</li>
<li>🧠 AIGC应用开发先行者 | 区块链落地实践者</li>
<li>🌍 以技术驱动创新,我们的征途是改变世界!</li>
<li>👉 实战干货:编程严选网</li>
</ul>
<h2 id="0-前言">0 前言</h2>
<p>AOP中,execution表达式是定义切点(Pointcut)的重要方式,切点决定了在哪些方法上应用增强(Advice,如前置通知、后置通知等 )。</p>
<h2 id="1-表达式语法结构">1 表达式语法结构</h2>
<p>execution表达式完整语法格式为:</p>
<pre><code class="language-bash">execution([修饰符模式] 返回值类型模式 [类名模式]方法名模式(参数模式)[异常模式])
</code></pre>
<p>修饰符模式、异常模式较少用,常用部分:</p>
<ul>
<li><strong>execution()</strong>:表达式主体,固定写法,标志这是一个用于匹配方法执行的切点表达式。</li>
<li><strong>返回值类型模式</strong>:用 <code>*</code> 表示匹配任意返回值类型;也可指定具体类型,如 <code>void</code> 表示无返回值 、<code>int</code> 表示返回整数类型等。如 <code>execution(void com.example.service.UserService.add(..))</code> 表示匹配 <code>UserService</code> 类中 <code>add</code> 方法且返回值为 <code>void</code></li>
<li><strong>类名模式</strong>:指定包名和类名相关信息。包名后若跟 <code>..</code> 表示当前包及其子包;类名用 <code>*</code> 表示匹配所有类。如 <code>com.example.service..*</code> 表示 <code>com.example.service</code> 包及其子包下的所有类</li>
<li><strong>方法名模式</strong>: <code>*</code> 表示匹配所有方法名;也可指定特定方法名,如 <code>get*</code> 表示 <code>get</code> 开头方法</li>
<li><strong>参数模式</strong>: <code>(..)</code> 表示匹配任意参数数量和类型;也可具体指定,如 <code>(int, String)</code> 表示方法有两个参数,分别为 <code>int</code> 类型和 <code>String</code> 类型 ,<code>(int,..)</code> 表示第一个参数是 <code>int</code> 类型,后面可以跟任意数量和类型参数。</li>
</ul>
<h2 id="2-常用示例">2 常用示例</h2>
<p>匹配指定包下所有类的所有方法:</p>
<p><code>execution(* com.example.dao..*.*(..))</code> ,表示匹配 <code>com.example.dao</code> 包及其子包下所有类的所有方法,第一个 <code>*</code> 匹配任意返回值类型,第二个 <code>*</code> 匹配所有类,第三个 <code>*</code> 匹配所有方法名,<code>(..)</code> 匹配任意参数。</p>
<p>匹配指定类的所有方法:</p>
<p><code>execution(* com.example.service.UserService.*(..))</code> ,即匹配 <code>com.example.service.UserService</code> 类的所有方法 。</p>
<p>匹配指定接口所有实现类的方法:</p>
<p><code>execution(* com.example.dao.GenericDAO+.*(..))</code> ,<code>+</code> 表示匹配 <code>GenericDAO</code> 接口的所有实现类的方法。</p>
<p>匹配特定方法名开头的方法:<br>
<code>execution(* save*(..))</code> ,表示匹配所有以 <code>save</code> 开头的方法,不限定返回值类型、类和参数。</p>
<h2 id="3-多表达式组合">3 多表达式组合</h2>
<p>多个execution表达式之间可以通过逻辑运算符组合:</p>
<ul>
<li><strong>或(<code>||</code>或 <code>or</code> )</strong>:表示满足其中一个表达式即可。如 <code>execution(* com.example.service.UserService.add(..)) || execution(* com.example.service.UserService.delete(..))</code> ,表示匹配 <code>UserService</code> 类中的 <code>add</code> 方法或者 <code>delete</code> 方法。</li>
<li><strong>与(<code>&amp;&amp;</code> 或 <code>and</code> )</strong>:要求同时满足多个表达式。例如 <code>execution(* com.example.service..*.*(..)) &amp;&amp; args(String)</code> ,表示匹配 <code>com.example.service</code> 包及其子包下所有类的方法,且方法参数包含 <code>String</code> 类型 。</li>
<li><strong>非(<code>!</code> 或 <code>not</code> )</strong>:对表达式取反。如 <code>!execution(* com.example.service.UserService.get*(..))</code> ,表示匹配除了 <code>UserService</code> 类中以 <code>get</code> 开头方法之外的其他方法。</li>
</ul>
<h2 id="4-其他切点指示符">4 其他切点指示符</h2>
<h3 id="41-within表达式">4.1 within表达式</h3>
<p>主要用于根据类型(类或包)匹配连接点。即它可指定在哪些类或包中的方法执行时应用切面逻辑:</p>
<ul>
<li>execution更侧重方法签名匹配</li>
<li>within侧重类或包的范围匹配</li>
</ul>
<h4 id="-匹配指定包下的所有类">① 匹配指定包下的所有类</h4>
<ul>
<li>语法:<code>within(包名..*)</code>,其中 <code>..</code> 表示当前包及其子包。</li>
<li>示例:<code>within(com.example.service..*)</code> 表示匹配 <code>com.example.service</code> 包及其子包下所有类的所有方法。</li>
<li>解释:这个表达式会让切面逻辑应用到该包及其子包中所有类的方法执行上。比如,在这个包下有 <code>UserService</code>、<code>OrderService</code> 等类,这些类的所有方法都会被匹配。</li>
</ul>
<h4 id="-匹配指定类">② 匹配指定类</h4>
<ul>
<li>语法:<code>within(全限定类名)</code></li>
<li>示例:<code>within(com.example.service.UserService)</code> 表示只匹配 <code>com.example.service.UserService</code> 类的所有方法。</li>
<li>解释:只有 <code>UserService</code> 类中的方法执行时,切面逻辑才会被应用。</li>
</ul>
<h3 id="42-annotation表达式">4.2 @annotation表达式</h3>
<p>根据方法上是否存在特定注解来匹配连接点。当某方法标注指定注解,该方法执行就触发相应切面逻辑。</p>
<h4 id="-自定义注解">① 自定义注解</h4>
<pre><code class="language-java">@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Loggable {
}
</code></pre>
<h4 id="-用-annotation-匹配带注解的方法">② 用 <code>@annotation</code> 匹配带注解的方法</h4>
<p>语法:</p>
<pre><code class="language-java">@annotation(注解全限定名)
</code></pre>
<p>示例:</p>
<pre><code class="language-java">// 匹配所有带有 @Loggable 的方法
@annotation(com.example.annotation.Loggable)
</code></pre>
<p>示例:</p>
<pre><code class="language-java">@Aspect
@Component
public class LoggingAspect {

    @Pointcut("@annotation(com.example.annotation.Loggable)")
    public void loggableMethods() {}

    @Before("loggableMethods()")
    public void beforeLoggableMethod(JoinPoint joinPoint) {
      System.out.println("Before method: " + joinPoint.getSignature().getName());
    }
}
</code></pre>
<h4 id="-在方法上用注解">③ 在方法上用注解</h4>
<pre><code class="language-java">import com.example.annotation.Loggable;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Loggable
    public void saveUser() {
      System.out.println("Saving user...");
    }
}
</code></pre>
<p>UserService#saveUser执行时,由于该方法有 <code>@Loggable</code> ,会触发 <code>LoggingAspect</code> 中的 <code>beforeLoggableMethod</code> 方法执行,实现在带特定注解的方法执行前添加切面逻辑。</p>
<h3 id="43-小结">4.3 小结</h3>
<ul>
<li><code>within</code> 适用于按照类或包的范围来应用切面逻辑,是一种较为宽泛的匹配方式。</li>
<li><code>@annotation</code> 适用于根据方法上的注解来精确控制切面逻辑的应用,更具针对性。这两种表达式可以和 <code>execution</code> 等其他表达式结合使用,以满足更复杂的切点定义需求。</li>
</ul>
<blockquote>
<p>本文由博客一文多发平台 OpenWrite 发布!</p>
</blockquote><br><br>
来源:https://www.cnblogs.com/JavaEdge/p/18852642
頁: [1]
查看完整版本: 精通 Spring AOP Execution 表达式:精准匹配你的切点