Spring AOP-用代理代替繁琐逻辑
Spring AOP
基础概念
AOP 是一种面向切面的编程思想,通俗来讲,这里假如我们有多个方法。
@Component
public class Demo {
public void say1() {
System.out.println("say1~~~~~~~");
}
public void say2() {
System.out.println("say2~~~~~~~");
}
public void say3() {
System.out.println("say3~~~~~~~");
}
}
此时,如果我们要在每个方法执行完毕后,再输出一句话,则需要在每个方法里面都再加一个方法。
public void say1() {
System.out.println("say1~~~~~~~");
System.out.println("XX say good!!!");
}
public void say2() {
System.out.println("say2~~~~~~~");
System.out.println("XX say good!!!");
}
public void say3() {
System.out.println("say3~~~~~~~");
System.out.println("XX say good!!!");
}
这种方式,就会显得代码十分的冗余且不够优雅。
我们想一下,该实现的逻辑是在我们要在每个方法后面(切点)实现一个差不多的逻辑(切面实现),通过类似于下图所示的方式,将和主要业务无关的代码抽离出来,实现代码的解耦。
类似于下图所示的方式:
Spring 实现
首先,我们在一个 Spring Web 程序中,引入 spring-aop 的相关 jar 包。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
然后,我们构建一个切面类,在该类里面,我们来定义要切入的点,以及切入后该做什么。
@Aspect
@Component
public class LogAspect {
@After("execution(public * say*(..))")
public void saveLog() {
System.out.println("XX say good!!!");
}
}
在这里,首先我们用 @Aspect
来声明这是一个切面,然后用 @Component
来让 Spring 容器可以扫描到该类。
紧接着,我们定义一个方法 saveLog()
,该方法的目的是在执行完 say1()
后,可以输出一条日志,所通过的方式便是注解: @After("execution(public * say*(..))")
。
有关于 aop 可以使用的注解,已经注解里配置的切点表达式,在后续再进行展开。
最后,我们在启动类上加上 @EnableAspectJAutoProxy
即可。
最后的实现效果,如下所示:
概念详解
切面
Aspect,要抽象出来的横跨多个地方的功能。
连接点
Joinpoint,定义在应用程序流程的何处插入切面进行执行。
切入点
Pointcut,一组连接点的集合。
其实在 AOP 中,这些概念点并不重要,重要是理解,以及如何在实战中进行演练。
可用切面
- before:先执行拦截代码,如果拦截代码错误,目标代码不执行;
- after:先执行目标代码,无论目标代码执行正确与否,都会执行拦截代码;
- afterReturning:和after不同的是,只有目标代码正确返回,才会执行拦截代码;
- afterThrowing:和after不同的是,只有目标代码抛出异常,才会执行拦截代码;
- around:能完全控制代码执行,并可以在目标代码前后,任意执行拦截代码。
切点表达式
execution
execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern)throws-pattern?)
- motifiers-pattern?:修饰符,public、protect、private、*(所有类型);
- ret-type-pattern:返回值;
- declaring-type-pattern?:类路径匹配;
- name-pattern:方法名,支持*,_占位符;
- param-pattern:参数匹配,..代表所有参数类型;
- throws-pattern?异常类型匹配
其中?代表该项是可选项。
另外切点表达式是可以组合的,用 || 或 && 可以进行逻辑组合。(不止是 execution,也可以跟其他的切点表达式进行组合)
// 匹配所有方法,无法使用
execution(* *(..))
// 匹配所有 com.demo 包下的公有的,返回值为void的,方法名是say为前缀的,参数随意的方法
execution(public void com.demo say*(..))
@annotation
当执行的方法上有指定的注解,则算是匹配成功。
我认为该方式会更加的灵活些,在下面的实战演练中,我用的就是该方式,其拦截规则可以充分自定义,且可以在注解中,定义一些自己需要的值,然后在切面中进行使用。
args
用来匹配方法参数的。
- args():匹配不带参数的方法;
- args(type(String)):匹配一个参数,且类型为String的方法;
- args(..):匹配任意参数方法;
- args(String,..):匹配任意参数方法,但第一个参数类型是String的方法;
- args(..,String):匹配任意参数方法,但最后一个参数类型是String的方法;
该方法其实就是 execution 的变种形式,了解即可。
@args
也是用来匹配方法参数的,但是其匹配的逻辑是方法参数带有执行注解的方法。
其他方法,如 within、this、target、@target、@within、bean 不多做介绍了,平常用的也不多,以后有兴趣,或者在实际使用中有所涉及,再进行补充。
实战演练
在实战中,我们通过注解的方式来进行切入,
定义注解
/**
* 操作行为注解,通过该注解获取数据详情
*
* @author iceWang
* @date 2020/9/10
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperatorAnnotation {
String bodyType();
String operatorType();
}
在这里,我们定义一个注解,后续在要拦截的方法上,加上该注解即可。
其中 bodyType 代表我们要操作的实体类型,OperatorType 代表我们要操作的行为类型。
业务逻辑
@OperatorAnnotation(bodyType = LogAspect.BODY_TYPE_COMPANY, operatorType = LogAspect.OPERATOR_TYPE_DELETE)
public String deleteCompany(String companyUniqueId) {
Optional.of(companyMapper.deleteCompany(companyUniqueId))
.filter(result -> result > 0)
.orElseThrow(() -> new IllegalArgumentException("无法删除,请稍后再试!"));
return companyUniqueId;
}
因为个人原因,这里我们只展示一部分代码——根据 id 删除公司,定义实体类型为 company,操作类型为删除,为后续插入日志做数据铺垫。
切面定义
@Aspect
@Component
public class LogAspect {
public static final String BODY_TYPE_COMPANY = "company";
public static final String OPERATOR_TYPE_DELETE = "delete";
@AfterReturning(value = "@annotation(OperatorAnnotation)", returning = "result")
public void saveOperatorLog(JoinPoint joinPoint, Object result) {
Signature signature = joinPoint.getSignature();
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
OperatorAnnotation operatorAnnotation = methodSignature.getMethod().getAnnotation(OperatorAnnotation.class);
String bodyType = operatorAnnotation.bodyType();
String operatorType = operatorAnnotation.operatorType();
if (bodyType.contains(BODY_TYPE_COMPANY) && operatorType.contains(OPERATOR_TYPE_DELETE)) {
saveOperatorLog(bodyType, operatorType, result);
return;
}
}
/**
* 返回日志操作实体类
* @param bodyType
* @param operatorType
* @return
*/
private Operator getOperator(String bodyType, String operatorType) {
return Operator.builder()
.bodyType(bodyType)
.operatorType(operatorType)
.createTime(LocalDateTime.now())
.build();
}
/**
* 保存日志操作实体类
* @param bodyType
* @param operatorType
* @param result
*/
private void saveOperatorLog(String bodyType, String operatorType, Object result) {
Operator operator = getOperator(bodyType, operatorType);
operator.setOperatorUser(mdUserInfo.getPhone());
operator.setBody(result.toString());
operatorMapper.insert(operator);
}
}
在切面中,首先,我们用反射的方式来获取方法上的注解,通过注解获取实际的操作实体类型和操作类型,然后根据不同的实体类型和操作类型,执行不同的方法,将日志插入数据库中。
文章在公众号「iceWang」第一手更新,有兴趣的朋友可以关注公众号,第一时间看到笔者分享的各项知识点,谢谢!笔芯!
Spring AOP-用代理代替繁琐逻辑的更多相关文章
- 死磕Spring之AOP篇 - Spring AOP自动代理(三)创建代理对象
该系列文章是本人在学习 Spring 的过程中总结下来的,里面涉及到相关源码,可能对读者不太友好,请结合我的源码注释 Spring 源码分析 GitHub 地址 进行阅读. Spring 版本:5.1 ...
- Hibernate 延迟加载的代理模式 和 Spring AOP的代理模式
Hibernate 延迟加载的代理模式 和 Spring AOP的代理模式 主题 概念 Hibernate 延迟加载的代理模式 Spring AOP的代理模式 区别和联系 静态代理和动态代理 概念 代 ...
- 死磕Spring之AOP篇 - Spring AOP自动代理(一)入口
该系列文章是本人在学习 Spring 的过程中总结下来的,里面涉及到相关源码,可能对读者不太友好,请结合我的源码注释 Spring 源码分析 GitHub 地址 进行阅读. Spring 版本:5.1 ...
- 死磕Spring之AOP篇 - Spring AOP自动代理(二)筛选合适的通知器
该系列文章是本人在学习 Spring 的过程中总结下来的,里面涉及到相关源码,可能对读者不太友好,请结合我的源码注释 Spring 源码分析 GitHub 地址 进行阅读. Spring 版本:5.1 ...
- Spring AOP动态代理原理与实现方式
AOP:面向切面.面向方面.面向接口是一种横切技术横切技术运用:1.事务管理: (1)数据库事务:(2)编程事务(3)声明事物:Spring AOP-->声明事物 2.日志处理:3.安全验证 ...
- 什么是 Spring AOP 和代理
https://mbd.baidu.com/newspage/data/landingsuper?context=%7B%22nid%22%3A%22news_9403056301388627935% ...
- spring AOP 动态代理和静态代理以及事务
AOP(Aspect Oriented Programming),即面向切面编程 AOP技术,它利用一种称为"横切"的技术,剖解开封装的对象内部,并将那些影响了多个类的公共行为封装 ...
- Spring AOP动态代理实现,解决Spring Boot中无法正常启用JDK动态代理的问题
Spring AOP底层的动态代理实现有两种方式:一种是JDK动态代理,另一种是CGLib动态代理. JDK动态代理 JDK 1.3版本以后提供了动态代理,允许开发者在运行期创建接口的代理实例,而且只 ...
- 求求你,下次面试别再问我什么是 Spring AOP 和代理了!
https://mbd.baidu.com/newspage/data/landingsuper?context=%7B%22nid%22%3A%22news_9403056301388627935% ...
随机推荐
- C#LeetCode刷题-数学
数学篇 # 题名 刷题 通过率 难度 2 两数相加 29.0% 中等 7 反转整数 C#LeetCode刷题之#7-反转整数(Reverse Integer) 28.6% 简单 8 字符串转整数 ...
- PostgreSQL在没有备份情况下误删除Clog恢复
创建实验表postgres# create table t (n_id int primary key,c_name varchar(300));CREATE TABLEpostgres# inser ...
- [Hei-Ocelot-Gateway ].Net Core Api网关Ocelot的开箱即用版本
写在前面 很多neter都有在用Ocelot做Api网关,但是Ocelot又不像kong或者其他网关一样,开箱即用.它需要你单独开一个web项目来部署,这样很多同学都在做重复的事了. 这里[Hei.O ...
- LinkedBlockingQueue 和 ConcurrentLinkedQueue的区别
1. 简单的开篇 LinkedBlockingQueue 和 ConcurrentLinkedQueue 是 Java 高并发场景中最常使用的队列.尽管这两个队列经常被用作并发场景的数据结构,但它们之 ...
- mac下protobuf配置记录
sudo vi /etc/profile加到文件底部 export PATH=$PATH:$GOBIN:/usr/local/go/bin export GOPATH=/Users/jinfuzhan ...
- 为什么 max() 应该写成 b < a ? a : b 呢?
在 < C++ Templates 2nd Edition >Chapter 1 中,作者将 max() 模板定义如下: template <typename T> T max ...
- better-scroll实现滚动
通过better-scroll这个插件实现微信好友滚动列表 安装better-scroll npm i better-scroll 初始化better-scroll //better-scroll ...
- 使用Seq搭建免费的日志服务
Seq简介 Seq是老外开发的一个针对.NET平台非常友好的日志服务.支持容器部署,提供一个单用户免费的开发版本. 官网:https://datalust.co/seq 使用文档:https://do ...
- Java面试题(Redis篇)
Redis 179.redis 是什么?都有哪些使用场景? Redis是一个开源的使用ANSI C语言编写.支持网络.可基于内存亦可持久化的日志型.Key-Value数据库,并提供多种语言的API. ...
- “路由大当家”OSPF的小秘密
引入 OPSF是应用最广的路由协议,基本上,所有的IGP用到的都是OSPF,下面我们看看它的“小秘密” 优点: •没有跳数限制 •使用组播更新变化的路由和网络信息 •路由收敛速度较快 •以开销(Cos ...