Spring boot 快速实现 aop :无需了解 spring aop 技术简单配置下yml开箱即用!
最新版本请移步github查阅
作用:
-
支持yml配置的形式实现前置、后置、异常、环绕处理器,将业务与配置搭建解耦,降低spring aop 学习成本,快速实现功能。
-
提供基于Slf4j的Log实现cn.cnaworld.framework.infrastructure.processor.impl.CnaworldAopSlf4jProcessor,根据日志等级log-level 打印切点方法入参,返参,响应时间,异常信息。
-
内置注解@CnaAopLog 可直接配置到方法上实现AOP,采用默认实现。若在配置文件中有相同execution配置项,则以配置文件为准,配置项为:@annotation(cn.cnaworld.framework.infrastructure.annotation.CnaAopLog)
-
默认实现暂不支持MultipartFile类型入参
-
客户端配置
pom.xml 引入依赖后,无需进行配置,可直接对方法使用@CnaAopLog注解观察控制台打印日志
<dependency> <groupId>cn.cnaworld.framework</groupId> <artifactId>aop</artifactId> <version>{latest}</version> </dependency>
application.yml 配置
#使用cnaworld.aop完整配置 cnaworld: aop: #@CnaAopLog默认实现开关,默认为true,可关闭。 #若切面列表出现@CnaAopLog默认表达式,则以下方配置为准,但依然受此开关影响 default-enable: true #切面列表 properties: #配置切面表达式语法可以切包,方法等 根据业务开启环绕处理器和异常处理器 - execution: "execution(* cn.cnaworld.framework..*.*Controller.*(..))" #默认logback实现 可不配置 processor-class: cn.cnaworld.framework.infrastructure.processor.impl.CnaworldAopSlf4jProcessor #默认CnaworldAopSlf4jProcessor实现日志等级默认为info级别,自定义实现无效 log-level: info #前置处理器开关配置,默认为true 开启 pre-processor: true #后置处理器开关配置,默认为true 开启 post-processor: true #异常处理器开关配置,默认为true 开启 error-processor: true #环绕处理器开关配置,默认为true 开启 around-processor: true #配置注解方式支持配置注解切面,可使用自定义注解 根据业务开启环绕处理器和异常处理器 - execution: "@annotation(cn.cnaworld.framework.infrastructure.annotation.CnaAopLog)" #自定义本地数据库实现 processor-class: cn.cnaworld.framework.infrastructure.component.operatelog.CnaworldAopOperateLogProcessor #前置处理器开关关闭 pre-processor: false #后置处理器开关关闭 post-processor: false
-
效果演示
项目启动时进行注册
2023-02-25 18:57:16.547 INFO 1940 --- [ main] .i.c.CnaworldAopBeanFactoryPostProcessor : cna-aop register CnaworldAopBeanFactoryPostProcessor start 2023-02-25 18:57:16.567 INFO 1940 --- [ main] .i.c.CnaworldAopBeanFactoryPostProcessor : cna-aop register @annotation(cn.cnaworld.framework.infrastructure.annotation.CnaAopLog) success 2023-02-25 18:57:16.568 INFO 1940 --- [ main] .i.c.CnaworldAopBeanFactoryPostProcessor : cna-aop register CnaworldAopBeanFactoryPostProcessor finish
默认日志实现
2023-02-01 18:31:46.393 INFO 13536 --- [nio-8080-exec-3] c.c.f.i.p.i.CnaworldAopSlf4jProcessor : 前置处理器|方法名:cn.cnaworld.cnaworldaoptest.api.TestApi.test,入参:["text"] 业务输出:text 2023-02-01 18:31:46.418 INFO 13536 --- [nio-8080-exec-3] c.c.f.i.p.i.CnaworldAopSlf4jProcessor : 后置处理器|方法名:cn.cnaworld.cnaworldaoptest.api.TestApi.test,入参:["text"],反参:"return : text" 2023-02-01 18:31:46.418 INFO 13536 --- [nio-8080-exec-3] c.c.f.i.p.i.CnaworldAopSlf4jProcessor : 环绕处理器|方法名:cn.cnaworld.cnaworldaoptest.api.TestApi.test,执行时间:81毫秒,入参:["text"],返参:"return : text"
-
自定义逻辑需实现 CnaworldAopProcessor接口,并配置到配置项processor-class 中
import org.aopalliance.intercept.MethodInvocation; import org.springframework.context.annotation.Configuration; import com.alibaba.fastjson.JSON; import com.cnaworld.cbdf.aop.infrastructure.processor.CbdfAopProcessor; import lombok.extern.slf4j.Slf4j; public class CnaworldAopOperateLogProcessor implements CnaworldAopProcessor{ /** *前置处理器 */ @Override public void prePostProcessor(MethodInvocation invocation,long stime) { // TODO 自定义业务实现 例如可以将日志存入数据库 } /** *后置处理器 */ @Override public Object postProcessor(MethodInvocation invocation, Object returnObject,long stime,long etime) { // TODO 自定义业务实现 例如可以将日志存入数据库 } /** *异常处理器 */ @Override public void errorProcessor(MethodInvocation invocation, Exception e, long stime, long etime) { // TODO 自定义业务实现 例如可以将日志存入数据库 } /** *环绕处理器 */ @Override public Object aroundProcessor(MethodInvocation invocation , Object returnObject, long stime, long etime) { // TODO 自定义业务实现 例如可以将日志存入数据库 } }
-
客户端应用demo
应用demo