如何在外部项目中动态定制已编译 Aspect 的切点表达式

冬明君_2354

冬明君_2354

2026-05-06

218人浏览

原创

如何在外部项目中动态定制已编译 Aspect 的切点表达式

本文介绍一种基于抽象 aspect 的优雅方案:将切点声明为抽象方法,使下游项目可通过继承并重写具体切点来灵活适配包路径,无需修改原始 jar 或重新编译切面逻辑。

本文介绍一种基于抽象 aspect 的优雅方案:将切点声明为抽象方法,使下游项目可通过继承并重写具体切点来灵活适配包路径,无需修改原始 jar 或重新编译切面逻辑。

在使用 AspectJ 进行横切关注点(如统一日志)开发时,一个常见需求是:将通用切面逻辑打包为可复用的 Maven 依赖(如 log-aspect.jar),供多个业务项目直接引用;同时,又希望各业务方能按需自定义“哪些包下的方法需要被织入”,而非硬编码在原始切面中。然而,Java 注解值必须是编译期常量,因此无法通过配置参数动态修改 @Pointcut 字符串——这是语言层面的限制,与 AspectJ 本身无关。

解决该问题的核心思路是面向抽象编程:将切面类声明为 abstract,并将需定制的切点定义为抽象方法。这样,原始 jar 中仅提供切面骨架与核心逻辑(如日志格式、异常捕获、耗时统计),而具体的织入范围则交由下游项目实现。

✅ 正确实践:抽象切面 + 具体继承

首先,在基础切面模块中定义抽象 Aspect:

@Aspect
public abstract class AutoLogAspect {

    private static final Logger log = LoggerFactory.getLogger(AutoLogAspect.class);

    // 抽象切点:由子类实现,决定包级织入范围
    @Pointcut("")
    public abstract void packagePC();

    // 注解驱动切点(保持不变)
    @Pointcut("execution(@com.stellariver.milky.aspectj.tool.log.Log * *(..))")
    public void annotationPC() {}

    // 组合切点:支持两种触发方式
    @Pointcut("annotationPC() || packagePC()")
    public void loggingPointcut() {}

    @Around("loggingPointcut()")
    public Object logExecution(ProceedingJoinPoint pjp) throws Throwable {
        long start = System.currentTimeMillis();
        String methodName = pjp.getSignature().toShortString();
        Object[] args = pjp.getArgs();

        try {
            Object result = pjp.proceed();
            long cost = System.currentTimeMillis() - start;
            log.info("=====msg: execution({})\n" +
                     "==header: {} [success:true] [cost:{}] [result:{}]\n" +
                     "====args: {}", 
                     methodName, 
                     LocalDateTime.now(), cost, result, 
                     Arrays.toString(args));
            return result;
        } catch (Throwable e) {
            long cost = System.currentTimeMillis() - start;
            log.error("=====msg: execution({})\n" +
                      "==header: {} [success:false] [cost:{}] [exception:{}]\n" +
                      "====args: {}", 
                      methodName, 
                      LocalDateTime.now(), cost, e.getClass().getSimpleName(), 
                      Arrays.toString(args));
            throw e;
        }
    }
}

⚠️ 注意:@Pointcut("") 中的空字符串是合法占位符,仅表示该方法将被子类重写为有效切点表达式;编译器不会校验其内容,实际织入由子类实现决定。

然后,在业务项目中继承该抽象类,并提供具体的包级切点:

package com.example.myapp.aspect;

import com.stellariver.milky.aspectj.tool.log.AutoLogAspect;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;

@Aspect
public class MyAppLogAspect extends AutoLogAspect {

    // ✅ 下游项目自由指定包路径,支持通配符和组合逻辑
    @Pointcut("within(com.example.myapp.service..*) && execution(* *(..))")
    public void packagePC() {}
}

此时,只要确保 MyAppLogAspect 被 AspectJ 编译器识别(例如通过 aspectj-maven-plugin 配置),所有 com.example.myapp.service 包及其子包下的方法调用,都会自动触发日志逻辑——无需添加 @Log 注解,也无需改动原始切面代码。

? 构建与部署说明

  • 基础模块(jar):仅包含 AutoLogAspect 及其依赖,发布至私有 Maven 仓库;
  • 业务模块:引入上述 jar,并编写 MyAppLogAspect(建议放在 src/main/java 下,参与 CTW 编译);
  • Maven 插件配置示例:
    <plugin><groupid>org.codehaus.mojo</groupid><artifactid>aspectj-maven-plugin</artifactid><version>1.14.0</version><configuration><compliancelevel>17</compliancelevel><source>17</source><target>17</target><weavedependencies><weavedependency><groupid>com.stellariver.milky</groupid><artifactid>log-aspect</artifactid></weavedependency></weavedependencies></configuration><executions><execution><goals><goal>compile</goal></goals></execution></executions></plugin>

? 补充方案:运行时定制(LTW)

若业务项目倾向使用加载时织入(LTW),还可完全跳过编译步骤:在 src/main/resources/META-INF/aop.xml 中直接声明具体切点:

<aspectj><aspects><aspect name="com.stellariver.milky.aspectj.tool.log.AutoLogAspect"></aspect></aspects><weaver options="-verbose -showWeaveInfo"><include within="com.example.myapp.service..*"></include><!-- 可配合 aop.xml 的 <pointcut> 标签进一步细化 --></weaver></aspectj>

此时,甚至无需编写 Java 子类,仅靠 XML 即可完成织入范围配置(需启用 -javaagent:aspectjweaver.jar)。

✅ 总结

  • ❌ 不要尝试在注解中传入动态字符串(Java 语法不支持);
  • ✅ 推荐抽象切点 + 继承重写模式,兼顾复用性与灵活性;
  • ✅ 切点组合(&&, ||, !)和 within() 等语义可在子类中自由发挥;
  • ✅ CTW 和 LTW 均适用,选择取决于团队构建规范与运维约束;
  • ✅ 所有日志格式、上下文提取、异常处理等通用逻辑,集中维护于抽象父类,保障一致性与可维护性。
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3529

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2408

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1340

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1298

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1416

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2318

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3800

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17795

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习