一、 设计模式-代理模式

代理模式:给某一个对象提供一个代理对象,并由代理对象控制对源对象的引用。代理就是一个人或一个机构代表另一个人或者一个机构采取行动。某些情况下,客户不想或者不能够直接引用一个对象,代理对象可以在客户和目标对象直接起到中介的作用。客户端分辨不出代理主题对象与真实主题对象。代理模式可以并不知道真正的被代理对象,而仅仅持有一个被代理对象的接口,这时候代理对象不能够创建被代理对象,被代理对象必须有系统的其他角色代为创建并传入。
为什么要使用代理模式呢?
第一,它有间接的特点,可以起到中介隔离作用。就好比在租房的时候,房东可能不在本地,而短期内又不能赶回来,此时中介的出场,就作为房东的代理实现和我们签订承租合同。而我们和房东之间就没有耦合了。
第二,它有增强的功能。还以租房为例,我们首先考虑的是找一个靠谱的中介,由中介给我们提供房源信息,并且告诉我们房屋的细节,合同的细节等等。当然我们也可以自己去找一些个人出租的房屋,但是在这之中,我们要了解租赁合同,房屋验收,租金监管等情况,这无疑对我们是繁重的工作。而有了中介作为我们的代理中间人,他把了解到的信息告诉我们,我们一样可以租到房子,而不必做那些繁重的工作。
静态代理:类一开始就准备好了,字节码随着类在编译的时候就会编译出来
动态代理:字节码是谁用谁创建,谁用谁加载。在不需要的时候,没有创建代理类的字节码

二、 A0P思想及实现原理

1、案例分析

1.1 关于使用JdbcTemplate时获取当前线程的连接

  1. @Bean("connection")
  2. public Connection getConnection(DataSource dataSource){
  3. //1.初始化事务同步管理器
  4. TransactionSynchronizationManager.initSynchronization();
  5. //2.使用spring的数据源工具类获取当前线程的连接。连接跟当前线程绑定,每次存入Ioc容器中的连接都是当前线程的
  6. Connection connection = DataSourceUtils.getConnection(dataSource);
  7. //3.返回
  8. return connection;
  9. }

1.2 实现事务管理工具类

  1. @Component
  2. public class TransactionManager {
  3. @Autowired //当前线程的连接
  4. private Connection connection;
  5. // 开启事务
  6. public void begin(){
  7. try {
  8. connection.setAutoCommit(false);
  9. }catch (Exception e){
  10. e.printStackTrace();
  11. }
  12. }
  13. // 提交事务
  14. public void commit(){
  15. try {
  16. connection.commit();
  17. }catch (Exception e){
  18. e.printStackTrace();
  19. }
  20. }
  21. // 回滚事务
  22. public void rollback(){
  23. try {
  24. connection.rollback();
  25. }catch (Exception e){
  26. e.printStackTrace();
  27. }
  28. }
  29. // 释放资源
  30. public void close(){
  31. try {
  32. connection.close();
  33. }catch (Exception e){
  34. e.printStackTrace();
  35. }
  36. }
  37. }

1.3 实现事务控制后的代码耦合问题

  1. // 账户的业务层实现
  2. @Service
  3. public class AccountServiceImpl_old implements AccountService {
  4. @Autowired
  5. private AccountDao accountDao;
  6. @Autowired
  7. private TransactionManager transactionManager;
  8. @Override
  9. public void save(Account account) {
  10. try {
  11. //开启事务
  12. transactionManager.begin();
  13. accountDao.save(account);
  14. //提交事务
  15. transactionManager.commit();
  16. }catch (Exception e){
  17. //回滚事务
  18. transactionManager.rollback();
  19. e.printStackTrace();
  20. }finally {
  21. //释放连接
  22. transactionManager.close();
  23. }
  24. }
  25. /**
  26. * @param sourceName 转出账户名称
  27. * @param targetName 转入账户名称
  28. * @param money 转账金额
  29. */
  30. @Override
  31. public void transfer(String sourceName, String targetName, Double money) {
  32. try {
  33. // 1.开启事务
  34. transactionManager.begin();
  35. //1.根据名称查询转出账户
  36. Account source = accountDao.findByName(sourceName);
  37. //2.根据名称查询转入账户
  38. Account target = accountDao.findByName(targetName);
  39. //3.转出账户减钱
  40. source.setMoney(source.getMoney() - money);
  41. //4.转入账户加钱
  42. target.setMoney(target.getMoney() + money);
  43. //5.更新转出账户
  44. accountDao.update(source);
  45. int i=1/0;//模拟转账异常
  46. //6.更新转入账户
  47. accountDao.update(target);
  48. // 2.提交事务
  49. transactionManager.commit();
  50. }catch (Exception e){
  51. // 3.回滚事务
  52. transactionManager.rollback();
  53. e.printStackTrace();
  54. }finally {
  55. // 4.释放连接
  56. transactionManager.close();
  57. }
  58. }
  59. }

1.4 基于动态代理的事务控制

  1. /**
  2. * 用于生产service代理对象的工厂
  3. * 此处我们只做入门,实现对AccountService的代理创建,同时加入事务
  4. */
  5. @Component
  6. public class ProxyServiceFactory {
  7. @Autowired
  8. private AccountService accountService;
  9. @Autowired
  10. private TransactionManager transactionManager;
  11. @Bean("proxyAccountService") // 返回的AccountService也会注入容器中,此时容器中就有两个AccountService对象
  12. public AccountService getProxyAccountService(){
  13. //1.创建代理对象。
  14. // newProxyInstance(类加载器(通常使用与被代理对象相同的类加载器), 被代理对象相同的行为(最少实现一个接口), 增强的方法)
  15. AccountService proxyAccountService = (AccountService)Proxy.newProxyInstance(accountService.getClass().getClassLoader(),
  16. accountService.getClass().getInterfaces(),
  17. new InvocationHandler() {
  18. @Override
  19. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  20. //1.定义返回值
  21. Object rtValue = null;
  22. try{
  23. //开始事务
  24. transactionManager.begin();
  25. //执行被代理对象的方法
  26. rtValue = method.invoke(accountService, args);
  27. //提交事务
  28. transactionManager.commit();
  29. }catch (Exception e){
  30. //回滚事务
  31. transactionManager.rollback();
  32. e.printStackTrace();
  33. }finally {
  34. //释放资源
  35. transactionManager.close();
  36. }
  37. //返回
  38. return rtValue;
  39. }
  40. });
  41. //2.返回
  42. return proxyAccountService;
  43. }
  44. }

image.png

2、A0P思想

在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。
image.png

3、实现原理

在上面的概念中描述出aop的实现原理是基于动态代理技术实现的。下面是针对动态代理的一些介绍:
特点:字节码随用随创建,随用随加载
分类:基于接口的动态代理,基于子类的动态代理
作用:不修改源码的基础上对方法增强
基于接口的动态代理:
提供者是:JDK官方
使用要求:被代理类最少实现一个接口。
涉及的类:Proxy
创建代理对象的方法:newProxyInstance
方法的参数:
ClassLoader:类加载器。用于加载代理对象的字节码的。和被代理对象使用相同的类加载器。固定写法。
Class[]:字节码数组。用于给代理对象提供方法。和被代理对象具有相同的方法。
被代理类是一个普通类:被代理类对象.getClass().getInterfaces();
被代理类是一个接口:new Class[]{被代理了.class},它也是固定写法
InvocationHanlder:要增强的方法。此处是一个接口,我们需要提供它的实现类。通常写的是匿名内部类。增强的代码谁用谁写。
基于子类的动态代理
提供者是:第三方cglib包,在使用时需要先导包(maven工程导入坐标即可)
使用要求:被代理类不能是最终类,不能被final修饰
涉及的类:Enhancer
创建代理对象的方法:create
方法的参数:
Class:字节码。被代理对象的字节码。可以创建被代理对象的子类,还可以获取被代理对象的类加载器。
Callback:增强的代码。谁用谁写。通常都是写一个接口的实现类或者匿名内部类。
Callback中没有任何方法,所以我们一般使用它的子接口:MethodInterceptor

4、Spring中AOP的术语

Joinpoint(连接点):
所谓连接点是指那些被拦截到的点。在spring中指的是方法,因为spring只支持方法类型的连接点
Pointcut(切入点):
所谓切入点是指我们要对哪些连接点进行拦截的定义。 规定了哪些连接点会被增强
Advice(通知/增强):
所谓通知是指拦截到Joinpoint之后所要做的事情就是通知。即增强处理
通知的类型:前置通知,后置通知,异常通知,最终通知,环绕通知。(按通知时机)
Introduction(引介):
引介是一种特殊的通知在不修改类代码的前提下, 可以在运行期为类动态地添加一些方法或Field。
Target(目标对象):代理的目标对象。即被代理对象
Weaving(织入):是指把增强应用到目标对象来创建新的代理对象的过程。
spring采用动态代理织入,而AspectJ采用编译期织入和类装载期织入。
Proxy(代理):一个类被AOP织入增强后,就产生一个结果代理类。
Aspect(切面):是切入点和通知(引介)的结合。

三、Spring注解驱动AOP开发入门

1、 写在最前

a. Spring的aop是基于ioc的。所以需要有spring的ioc基础。(本篇内容不对ioc进行讲解)
b. 本章节我们只是对aop的使用做基本功能展示,目的是为了以此讲解aop中的注解和执行原理分析。

2、 注解驱动入门案例介绍

需求: 实现在执行service方法时输出执行日志。(除了业务层外,表现层和持久层也可以实现)

3、 案例实现

  1. // 实体类
  2. public class User implements Serializable {
  3. private String id;
  4. private String username;
  5. private String password;
  6. private String email;
  7. private Date birthday;
  8. private String gender;
  9. private String mobile;
  10. private String nickname;
  11. }
  1. //spring的配置类
  2. @Configuration
  3. @ComponentScan("com.itheima")
  4. @EnableAspectJAutoProxy // 开启spring注解aop配置的支持
  5. public class SpringConfiguration {
  6. }
  1. // 业务层
  2. @Service("userService")
  3. public class UserServiceImpl implements UserService {
  4. // 模拟保存用户
  5. @Override
  6. public void saveUser(User user) {
  7. System.out.println("执行了保存用户" + user);
  8. }
  9. }
  1. // 记录日志的工具类
  2. @Component
  3. @Aspect // 表明当前类是一个切面类
  4. public class LogUtil {
  5. // 用于配置当前方法是一个前置通知
  6. @Before("execution(* com.itheima.service.impl.*.*(..))")
  7. public void printLog(){
  8. System.out.println("执行打印日志的功能");
  9. }
  10. }

测试执行:

  1. //1.创建容器
  2. AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SpringConfiguration.class);
  3. //2.获取对象
  4. UserService userService = ac.getBean("userService",UserService.class);
  5. //3.执行方法
  6. User user = new User();
  7. user.setId("1");
  8. user.setUsername("test");
  9. user.setNickname("泰斯特");
  10. userService.saveUser(user);
  11. System.out.println("新增用户成功.....");

image.png

四、AOP常用注解分析

1、用于开启注解AOP支持的

1.1、@EnableAspectJAutoProxy

1.1.1、源码

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Import(AspectJAutoProxyRegistrar.class)
  5. public @interface EnableAspectJAutoProxy {
  6. boolean proxyTargetClass() default false;
  7. boolean exposeProxy() default false;
  8. }

1、作用:
表示开启spring对注解aop的支持。它有两个属性,分别是指定采用的代理方式和是否暴露代理对象,通过AopContext可以进行访问。从定义可以看得出,它引入AspectJAutoProxyRegister.class对象,该对象是基于注解@EnableAspectJAutoProxy注册一个AnnotationAwareAspectJAutoProxyCreator,该对象通过调用AopConfigUtils.registerAspectJAnnotationAutoProxyCreatorIfNecessary(registry);注册一个aop代理对象生成器。关于AnnotationAwareAspectJAutoProxyCreator请参考第五章第二小节《
AnnotationAwareAspectJAutoProxyCreator对象的分析》
2、属性:
1)proxyTargetClass:
默认值是false,表示使用jdk的代理(要求被代理类必须实现一个接口)。
设置为true,表示采用cglib进行代理。但要求被代理类不能是最终类,不能被final修饰
实际开发过程中,通常采用默认的方式,基于接口的动态代理
image.png
2)exposeProxy:指定是否暴露代理对象(也会跟当前线程绑定),通过AopContext可以进行访问。
image.png
image.png
3、使用场景:
当我们注解驱动开发时,在需要使用aop实现某些功能的情况下,都需要用到此注解。

2、用于配置切面的

2.1、@Aspect

P73
2.1.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.TYPE)
  3. public @interface Aspect {
  4. public String value() default "";
  5. }

2.1.2、说明
1、作用: 声明当前类是一个切面类。
2、属性:
value:默认我们的切面类应该为单例的(正常情况也是单例的)。但是当切面类为一个多例类时,指定预处理的切入点表达式。用法是perthis(切入点表达式)。 它支持指定切入点表达式,或者是用@Pointcut修饰的方法名称(要求全限定方法名)
通常情况LogUtil是单例的,解析这个类的时候就会解析类中所有的通知,将通知加入一个方法拦截器链的容器数组中。加入容器中后,就会逐个链式调用,若LogUtil是多例的,每次使用时创建新的LogUtil
image.png
image.png
3、使用场景:此注解也是一个注解驱动开发aop的必备注解。
4、多个切面的执行顺序问题分析与解决
默认情况下,多个切面相同通知类型的方法执行顺序按照切面的英文顺序执行
image.png
可以通过@Order注解,手动控制不同切面,相同通知类型的方法的执行顺序
image.png
2.1.3、 示例

  1. // 记录日志的工具类
  2. @Component
  3. @Scope("prototype") //注意:通常情况下我们的切面类是不需要多例的。
  4. @Aspect(value="execution(* com.itheima.service.impl.*.*(..))")
  5. public class LogUtil {
  6. /**
  7. * 用于配置当前方法是一个前置通知
  8. */
  9. @Before("execution(* com.itheima.service.impl.*.*(..))")
  10. public void printLog(){
  11. System.out.println("执行打印日志的功能");
  12. }
  13. }

3、用于配置切入点表达式的

3.1、@Pointcut

3.1.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface Pointcut {
  4. String value() default "";
  5. String argNames() default "";
  6. }

3.1.2、说明
1、作用:此注解是用于指定切入点表达式的。
2、属性:
value:用于指定切入点表达式。表达式的配置详解请参考第五章节第三小节《切入点表达式的写法》
argNames:用于指定切入点表达式的参数。参数可以是execution中的,也可以是args中的。通常情况下不使用此属性也可以获得切入点方法参数。
3、使用场景:
在实际开发中,当我们的多个通知需要执行,同时增强的规则确定的情况下,就可以把切入点表达式通用化。此注解就是代替xml中的标签,实现切入点表达式的通用化。
image.png
3.1.3、示例

  1. // 记录日志的工具类
  2. @Component
  3. @Aspect
  4. public class LogUtil {
  5. /**
  6. * 1、用于定义通用的切入点表达式,当有多个通知方法时,每个方法上都需要指定通知类型的注解,每个注解内都需要指定切入点表达式
  7. * 如果切入点表达式对增强的部分是相同的配置,此时可以放到@Pointcut内指定
  8. * 2、argNames:获取切入点的参数,即public void saveUser(User user)中的user。要与形参的类型(public void pointcut2(User user))匹配
  9. * 3、execution中的..指定的是参数类型,而不是参数名称,若没有写..,表示不需要参数,那么就不会对有参数的方法进行增强
  10. * 4、execution是来控制方法执行的,args所指定的参数和切入点方法的形参名称必须一致,若指定了argNames,其参数也必须与形参名称一致
  11. * 5、@Pointcut和@Before均可以不指定argNames,程序照样正确执行
  12. */
  13. @Pointcut(value = "execution(* com.itheima.service.impl.*.*(..)) && args(user)", argNames = "user")
  14. public void pointcut2(User user){}
  15. // 前置通知
  16. // 通用切入点表达式@Pointcut的类名称pointcut1()。同时需要将切入点的参数传递给前置通知
  17. @Before(value = "pointcut2(user)", argNames = "user")
  18. public void printLog(User user){
  19. System.out.println("执行打印日志的功能" + user);
  20. }
  21. }
  1. @Component
  2. @Aspect
  3. public class LogUtil {
  4. /**
  5. * 通用切入点表达式
  6. * 在value属性的中使用了&&符号,表示并且的关系。
  7. * &&符号后面的args和execution一样,都是切入点表达式支持的关键字,表示匹配参数。指定的内容
  8. * 可以是全限定类名,或者是名称。当指定参数名称时,要求与方法中形参名称相同。
  9. * argNames属性,是定义参数的名称,该名称必须和args关键字中的名称一致。
  10. */
  11. @Pointcut(value = "execution(* com.itheima.service.impl.*.*(com.itheima.domain.User))&& args(user)",argNames = "user")
  12. private void pt1(User user){
  13. }
  14. }

image.png

4、用于配置通知的

image.png
image.png
image.png

4.1、@Before

4.1.1、 源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface Before {
  4. String value();
  5. String argNames() default "";
  6. }

4.1.2、说明
1、作用: 被此注解修饰的方法为前置通知。前置通知的执行时间点是在切入点方法执行之前。
2、属性:
value:用于指定切入点表达式。可以是表达式,也可以是表达式的引用。
argNames:用于指定切入点表达式参数的名称。它要求和切入点表达式中的参数名称一致。通常不指定也可以获取切入点方法的参数内容。
3、使用场景:
在实际开发中,我们需要对切入点方法执行之前进行增强, 此时就用到了前置通知。在通知(增强的方法)中需要获取切入点方法中的参数进行处理时,就要配合切入点表达式参数来使用。
image.png
4.1.3、示例

  1. /**
  2. * 前置通知
  3. */
  4. @Before(value = "pt1(user)",argNames = "user")
  5. public void beforeLog(User user){
  6. System.out.println("执行切入点方法前记录日志"+user);
  7. }

4.1.4、一个切面内相同类型通知的执行顺序分析
按照方法名称每个字母的ASCII码,值越小优先级越高,就先执行
image.png
image.png

4.2、@AfterReturning

4.2.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface AfterReturning {
  4. String value() default "";
  5. String pointcut() default "";
  6. String returning() default "";
  7. String argNames() default "";
  8. }

4.2.2、说明
1、作用:
用于配置后置通知。后置通知的执行是在切入点方法正常执行之后执行。需要注意的是,由于基于注解的配置时,spring创建通知方法的拦截器链时,后置通知在最终通知之后,所以会先执行@After注解修饰的方法
2、属性:
value:用于指定切入点表达式,可以是表达式,也可以是表达式的引用。
pointcut:它的作用和value是一样的。
returning:指定切入点方法返回值的变量名称。它必须和切入点方法返回值名称一致。
argNames:用于指定切入点表达式参数的名称。它要求和切入点表达式中的参数名称 一致。通常不指定也可以获取切入点方法的参数内容。
3、使用场景:
此注解是用于配置后置增强切入点方法的。被此注解修饰方法会在切入点方法正常执行之后执行。在我们实际开发中,像提交事务,记录访问日志,统计方法执行效率等等都可以利用后置通知实现。
image.png
4.2.3、示例

  1. 切入点方法:
  2. @Override
  3. public User findById(String id) {
  4. System.out.println("切入点方法开始执行。。。");
  5. User user = new User();
  6. user.setId(id);
  7. user.setUsername("heima");
  8. user.setNickname("黑马小王子");
  9. return user;
  10. }
  11. /**
  12. * 后置通知
  13. */
  14. @AfterReturning(value = "execution(* com.itheima.service.impl.*.* (..))&&args(param)",returning = "user")
  15. public void afterReturningLog(String param,Object user){
  16. System.out.println("正常执行切入点方法后记录日志,切入点方法的参数是:"+param);
  17. System.out.println("正常执行切入点方法后记录日志,切入点方法的返回值是:"+user);
  18. }

4.3、@AfterThrowing

4.3.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface AfterThrowing {
  4. String value() default "";
  5. String pointcut() default "";
  6. String throwing() default "";
  7. String argNames() default "";
  8. }

4.3.2、说明
1、作用:用于配置异常通知。
2、属性:
value:用于指定切入点表达式,可以是表达式,也可以是表达式的引用。
pointcut:它的作用和value是一样的。
throwing:指定切入点方法执行产生异常时的异常对象变量名称。它必须和异常变量名称一致。
argNames:用于指定切入点表达式参数的名称。它要求和切入点表达式中的参数名称一致。通常不指定也可以获取切入点方法的参数内容。
3、使用场景:用此注解修饰的方法执行时机是在切入点方法执行产生异常之后执行。
image.png
4.3.3、示例

  1. 切入点方法:
  2. @Override
  3. public User findById(String id) {
  4. System.out.println("切入点方法开始执行。。。");
  5. User user = new User();
  6. user.setId(id);
  7. user.setUsername("heima");
  8. user.setNickname("黑马小王子");
  9. int i=1/0;
  10. return user;
  11. }
  12. 通知方法:
  13. /**
  14. * 异常通知
  15. */
  16. @AfterThrowing(value = "execution(* com.itheima.service.impl.*.*(..))&&args(param)",throwing = "e")
  17. public void afterThrowingLog(String param,Throwable e){
  18. System.out.println("执行切入点方法产生异常后记录日志,切入点方法的参数是:"+param);
  19. System.out.println("执行切入点方法产生异常后记录日志,切入点方法的异常是:"+e);
  20. }

4.4、@After

4.4.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface After {
  4. String value();
  5. String argNames() default "";
  6. }

4.4.2、说明
1、作用:用于指定最终通知。
2、属性:
value:用于指定切入点表达式,可以是表达式,也可以是表达式的引用。
argNames:用于指定切入点表达式参数的名称。它要求和切入点表达式中的参数名称一致。通常不指定也可以获取切入点方法的参数内容。
3、使用场景:
最终通知的执行时机,是在切入点方法执行完成之后执行,无论切入点方法执行是否产生异常最终通知都会执行。所以被此注解修饰的方法,通常都是做一些清理操作。
image.png
4.4.3、示例

  1. /**
  2. * 最终通知
  3. */
  4. @After(value = "execution(* com.itheima.service.impl.*.*(..))")
  5. public void afterLog(){
  6. System.out.println("无论切入点方法执行是否有异常都记录日志");
  7. }

4.5、@Around

4.5.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface Around {
  4. String value();
  5. String argNames() default "";
  6. }

4.5.2、说明
1、作用:用于指定环绕通知。
2、属性:
value:用于指定切入点表达式,可以是表达式,也可以是表达式的引用。
argNames:用于指定切入点表达式参数的名称。它要求和切入点表达式中的参数名称一致。通常不指定也可以获取切入点方法的参数内容。
3、使用场景:
环绕通知有别于前面介绍的四种通知类型。它不是指定增强方法执行时机的,而是spring为我们提供的一种可以通过编码的方式手动控制增强方法何时执行的机制
4.5.3、示例

  1. /**
  2. * 环绕通知
  3. */
  4. @Around("execution(* com.itheima.service.impl.*.*(..))")
  5. public Object arountPrintLog(ProceedingJoinPoint pjp){
  6. //1.定义返回值
  7. Object rtValue = null;
  8. try{
  9. //前置通知
  10. System.out.println("执行切入点方法前记录日志");
  11. //2.获取方法执行所需的参数
  12. Object[] args = pjp.getArgs();
  13. //3.执行切入点方法
  14. rtValue = pjp.proceed(args);
  15. //后置通知
  16. System.out.println("正常执行切入点方法后记录日志");
  17. }catch (Throwable t){
  18. //异常通知
  19. System.out.println("执行切入点方法产生异常后记录日志");
  20. }finally {
  21. //最终通知
  22. System.out.println("无论切入点方法执行是否有异常都记录日志");
  23. }
  24. return rtValue;
  25. }

4.5.4 具体案例

1、业务层接口

  1. public interface UserService {
  2. @Description("保存用户")
  3. void saveUser(User user);
  4. @Description("根据ID查询用户")
  5. User findById(String id);
  6. @Description("更新用户")
  7. void update(User user);
  8. @Description("根据ID删除用户")
  9. void delete(String id);
  10. @Description("查询所有用户")
  11. List<User> findAll();
  12. }

2、业务层实现类

  1. @Service("userService")
  2. public class UserServiceImpl implements UserService {
  3. @Override
  4. public void saveUser(User user) {
  5. System.out.println("执行了保存用户" + user);
  6. }
  7. @Override
  8. public User findById(String id) {
  9. User user = new User();
  10. user.setId("1");
  11. user.setUsername("test");
  12. user.setNickname("泰斯特");
  13. return user;
  14. }
  15. @Override
  16. public void update(User user) {
  17. System.out.println("执行了更新用户"+user);
  18. }
  19. @Override
  20. public void delete(String id) {
  21. System.out.println("执行了删除用户"+id);
  22. }
  23. @Override
  24. public List<User> findAll() {
  25. List<User> users = new ArrayList<>();
  26. for(int i=1;i<10;i++){
  27. User user = new User();
  28. user.setId("1"+i);
  29. user.setUsername("test"+i);
  30. user.setNickname("泰斯特"+i);
  31. users.add(user);
  32. }
  33. return users;
  34. }
  35. }

3、系统日志的实体类

  1. // 系统日志的实体类
  2. @Data
  3. @ToString
  4. public class SystemLog implements Serializable {
  5. private String id; // 日志的主键
  6. private String method; // 当前执行的操作方法名称
  7. private String action; // 当前执行的操作方法说明
  8. private Date time; // 执行时间
  9. private String remoteIP; // 来访者IP
  10. }

4、记录日志的工具类

  1. @Component
  2. @Aspect //表明当前类是一个切面类
  3. public class LogUtil {
  4. /**
  5. * 用于增强业务层方法,在其执行时记录系统日志
  6. * @return
  7. */
  8. @Around("execution(* com.itheima.service.impl.*.*(..))")
  9. public Object aroundPrintLog(ProceedingJoinPoint pjp){
  10. //定义返回值对象
  11. Object rtValue = null;
  12. try {
  13. //创建系统日志对象
  14. SystemLog log = new SystemLog();
  15. //设置主键
  16. String id = UUID.randomUUID().toString().replace("-","").toUpperCase();
  17. log.setId(id);
  18. //设置来访者ip,由于我们是java工程,没有请求信息
  19. log.setRemoteIP("127.0.0.1");
  20. //设置执行时间
  21. log.setTime(new Date());
  22. // 设置当前执行的方法名称
  23. //1.使用ProceedingJoinPoint接口中的获取签名方法
  24. Signature signature = pjp.getSignature();
  25. //2.判断当前签名是否方法签名
  26. if(signature instanceof MethodSignature){
  27. //3.把签名转成方法签名
  28. MethodSignature methodSignature = (MethodSignature)signature;
  29. //4.获取当前执行的方法
  30. Method method = methodSignature.getMethod();
  31. //5.得到方法名称
  32. String methodName = method.getName();
  33. //6.给系统日志中方法名称属性赋值
  34. log.setMethod(methodName);
  35. // 设置当前执行的方法说明
  36. //7.判断当前方法上是否有@Description注解
  37. boolean isAnnotated = method.isAnnotationPresent(Description.class);
  38. if(isAnnotated){
  39. //8.得到当前方法上的Description注解
  40. Description description = method.getAnnotation(Description.class);
  41. //9.得到注解的value属性
  42. String value = description.value();
  43. //10.给系统日志的方法说明属性赋值
  44. log.setAction(value);
  45. }
  46. }
  47. System.out.println("环绕通知执行了记录日志:"+log);
  48. //获取切入点方法的参数
  49. Object[] args = pjp.getArgs();
  50. //切入点方法执行
  51. rtValue = pjp.proceed(args);
  52. return rtValue;
  53. }catch (Throwable e){
  54. throw new RuntimeException(e);
  55. }
  56. }
  57. }

5、测试执行

  1. public class SpringAroundTest {
  2. public static void main(String[] args) {
  3. //1.创建容器
  4. AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SpringConfiguration.class);
  5. //2.获取对象
  6. UserService userService = ac.getBean("userService",UserService.class);
  7. //3.执行方法
  8. //测试保存
  9. User user = new User();
  10. user.setId("1");
  11. user.setUsername("test");
  12. user.setNickname("泰斯特");
  13. userService.saveUser(user);
  14. System.out.println("-------------------------------------");
  15. //测试根据id查询
  16. User user1 = userService.findById("1");
  17. System.out.println("执行了根据id查询"+user1);
  18. System.out.println("-------------------------------------");
  19. //测试删除
  20. userService.delete("1");
  21. System.out.println("-------------------------------------");
  22. //测试更新
  23. userService.update(user);
  24. System.out.println("-------------------------------------");
  25. //测试查询所有
  26. List<User> users = userService.findAll();
  27. for(User user2 : users){
  28. System.out.println("执行了查询所有"+user2);
  29. }
  30. }
  31. }

6、执行结果
image.png

5、用于扩展目标类的

5.1、@DeclareParents

5.1.1、源码

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.FIELD)
  3. public @interface DeclareParents {
  4. String value();
  5. Class defaultImpl() default DeclareParents.class;
  6. }

5.1.2、说明
1、作用:用于给被增强的类提供新的方法。(实现新的接口)
2、属性:
value:用于指定目标类型的表达式。当在全限定类名后面跟上+时,表示当前类及其子类
defaultImpl:指定提供方法或者字段的默认实现类。
3、使用场景:
当我们已经完成了一个项目的某个阶段开发,此时需要对已完成的某个类加入一些新的方法,我们首先想到的是写一个接口,然后让这些需要方法的类实现此接口,但是如果目标类非常复杂,牵一发而动全身,改动的话可能非常麻烦。此时就可以使用此注解,然后建一个代理类,同时代理该类和目标类。
5.1.3、示例
1、已有业务层接口和实现类

  1. /**
  2. * 业务层接口
  3. */
  4. public interface UserService {
  5. /**
  6. * 模拟保存用户
  7. * @param user
  8. */
  9. void saveUser(User user);
  10. }
  1. @Service("userService")
  2. public class UserServiceImpl implements UserService {
  3. @Override
  4. public void saveUser(User user) {
  5. System.out.println("执行了保存用户" + user);
  6. }
  7. }

2、需要加入的新方法与实现类

  1. public interface ValidateService {
  2. boolean checkUser(User user);
  3. }
  1. public class ValidateServiceImpl implements ValidateService {
  2. @Override
  3. public boolean checkUser(User user) {
  4. if(user.getNickname().contains("孙子")){
  5. return false;
  6. }
  7. return true;
  8. }
  9. }

3、AOP切面类的配置

  1. // 记录日志的工具类
  2. @Component
  3. @Aspect
  4. public class LogUtil {
  5. @DeclareParents(value = "com.itheima.service.UserService+",defaultImpl = ValidateServiceImpl.class)
  6. private ValidateService validateService;
  7. /**
  8. * 用于配置当前方法是一个前置通知
  9. */
  10. @Before(value = "com.itheima.pointcuts.MyPointcut.pointcut1() && args(user) && this(validateService)")
  11. public void printLog(User user,ValidateService validateService){
  12. //第二种触发方式
  13. boolean check = validateService.checkUser(user);
  14. if(check) {
  15. System.out.println("执行打印日志的功能");
  16. }else {
  17. throw new IllegalStateException("名称非法");
  18. }
  19. }
  20. }

4、spring核心配置类

  1. @Configuration
  2. @ComponentScan("com.itheima")
  3. @EnableAspectJAutoProxy
  4. public class SpringConfiguration {
  5. }

5、测试类

  1. /**
  2. * 有两种触发方式:
  3. * 第一种触发方式:在使用时自行强转新引入接口类型,然后调用方法。例如:测试类中的代码
  4. * 第二种触发方式:在通知类中,使用this关键字,引入新目标类对象,调用方法触发。例如:切面类
  5. */
  6. public class SpringPointcutTest {
  7. public static void main(String[] args) {
  8. //1.创建容器
  9. AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SpringConfiguration.class);
  10. //2.获取对象
  11. UserService userService =
  12. ac.getBean("userService",UserService.class);
  13. //3.执行方法
  14. User user = new User();
  15. user.setId("1");
  16. user.setUsername("test");
  17. user.setNickname("孙子1");
  18. // 第一种触发方式
  19. // ValidateService validateService = (ValidateService)userService;
  20. // boolean check = validateService.checkUser(user);
  21. // if(check) {
  22. userService.saveUser(user);
  23. // }
  24. }
  25. }

5.2、@EnableLoadTimeWeaving

5.2.1、源码

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Import(LoadTimeWeavingConfiguration.class)
  5. public @interface EnableLoadTimeWeaving {
  6. AspectJWeaving aspectjWeaving() default AspectJWeaving.AUTODETECT;
  7. enum AspectJWeaving {
  8. ENABLED,
  9. DISABLED,
  10. AUTODETECT;
  11. }
  12. }

5.2.2、说明
1、作用:用于切换不同场景下实现增强。
2、属性:
aspectjWeaving:是否开启LTW的支持。
ENABLED:开启LTW
DISABLED:不开启LTW
AUTODETECT:如果类路径下能读取到META‐INF/aop.xml文件,则开启LTW,否则关闭
3、使用场景:
在Java 语言中,从织入切面的方式上来看,存在三种织入方式:编译期织入、类加载期织入和运行期织入。编译期织入是指在Java编译期,采用特殊的编译器,将切面织入到Java类中;而类加载期织入则指通过特殊的类加载器,在类字节码加载到JVM时,织入切面;运行期织入则是采用CGLib工具或JDK动态代理进行切面的织入。
AspectJ提供了两种切面织入方式,第一种通过特殊编译器,在编译期,将AspectJ语言编写的切面类织入到Java类中,可以通过一个Ant或Maven任务来完成这个操作;第二种方式是类加载期织入,也简称为LTW(Load Time Weaving)
5.2.3、示例
1、切面类

  1. //@Component
  2. @Aspect
  3. public class LoadTimeWeavingAspect {
  4. /**
  5. * 增强方法
  6. * @param pjp
  7. * @return
  8. * @throws Throwable
  9. */
  10. @Around("pointcut()")
  11. public Object profile(ProceedingJoinPoint pjp) throws Throwable {
  12. //1.创建秒表对象
  13. StopWatch sw = new StopWatch(getClass().getSimpleName());
  14. try {
  15. //2.记录执行
  16. sw.start(pjp.getSignature().getName());
  17. //3.调用切入点方法并返回
  18. return pjp.proceed();
  19. } finally {
  20. //4.停止计时
  21. sw.stop();
  22. //5.输出
  23. System.out.println(sw.prettyPrint());
  24. }
  25. }
  26. /**
  27. * 切入点表达式
  28. */
  29. @Pointcut("execution(* com.itheima.service.impl.*.*(..))")
  30. public void pointcut() {}
  31. }

2、配置类

  1. @Configuration
  2. @ComponentScan("com.itheima")
  3. //@EnableAspectJAutoProxy
  4. @EnableLoadTimeWeaving(aspectjWeaving =
  5. EnableLoadTimeWeaving.AspectJWeaving.ENABLED)
  6. public class SpringConfiguration {
  7. }

5.2.4、运行设置

五、AOP注解执行过程及核心对象的分析

1、执行过程分析

1.1 加载@EnableAspectJAutoproxy 注解

1.2、解析切入点表达式


spring在解析切入点表达式时,是通过一个类进行封装的。这个类是Pointcut接口的实现类。

  1. public interface Pointcut {
  2. ClassFilter getClassFilter();
  3. MethodMatcher getMethodMatcher();
  4. Pointcut TRUE = TruePointcut.INSTANCE;
  5. }

1.3、解析通知注解

1.3.1、初始化通知注解的Map
1.3.2、构建通知的拦截器链

1.4、执行方法

通过上一小节的分析,我们看到spring在初始化容器时已经把要执行的通知都存入了一个集合中。接下来当执行我们的切入点方法时,spring会按照通知的类型,顺序调用。

2AnnotationAwareAspectJAutoProxyCreator对象的分析

2.1、类视图

image.png

2.2、加载过程

2.2.1、 执行父类AbstractAutoProxyCreator中的postProcessAfterInitialization() 方法

  1. public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
  2. if (bean != null) {
  3. // 首先根据bean的class和name构建出key
  4. Object cacheKey = this.getCacheKey(bean.getClass(), beanName);
  5. // 判断是否需要创建指定的bean
  6. if (!this.earlyProxyReferences.contains(cacheKey)) {
  7. return this.wrapIfNecessary(bean, beanName, cacheKey);
  8. }
  9. }
  10. return bean;
  11. }
  12. 构建key的源码:
  13. protected Object getCacheKey(Class<?> beanClass, String beanName) {
  14. return beanClass.getName() + "_" + beanName;
  15. }

2.2.2、判断是否需要增强或已经被增强过了
2.2.3、判断是否为基础类(通知类)
2.2.4、获取增强的代码
2.2.5、根据增强创建代理对象
2.2.6、总结

  1. 首先进行创建cacheKey
  2. 判断是否已经处理过了
  3. 判断是不是不需要增强
  4. 判断是不是基础设施类或者是不是需要跳过的bean
  5. 获取增强器
  6. 根据增强器进行创建代理对象

3、切入点表达式总结

3.1、切入点表达式概念及作用

概念: 指的是遵循特定的语法用于捕获每一个种类的可使用连接点的语法。
作用: 用于对符合语法格式的连接点进行增强。

3.2、按照用途分类

主要的种类:
方法执行:execution(MethodSignature)
方法调用:call(MethodSignature)
构造器执行:execution(ConstructorSignature)
构造器调用:call(ConstructorSignature)
类初始化:staticinitialization(TypeSignature)
属性读操作:get(FieldSignature)
属性写操作:set(FieldSignature)
例外处理执行:handler(TypeSignature)
对象初始化:initialization(ConstructorSignature)
对象预先初始化:preinitialization(ConstructorSignature)

3.2、切入点表达式的关键字

支持的AspectJ切入点指示符如下:
execution:用于匹配方法执行的连接点;
within:用于匹配指定类型内的方法执行;
this:用于匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口也类型匹配;
target:用于匹配当前目标对象类型的执行方法;注意是目标对象的类型匹配,这样就不包括引入接口也类型匹配;
args:用于匹配当前执行的方法传入的参数为指定类型的执行方法;
@within:用于匹配所以持有指定注解类型内的方法;
@target:用于匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;
@args:用于匹配当前执行的方法传入的参数持有指定注解的执行;
@annotation:用于匹配当前执行方法持有指定注解的方法;
bean:Spring AOP扩展的,AspectJ没有对于指示符,用于匹配特定名称的Bean对象的执行方法;
reference pointcut:表示引用其他命名切入点,只有@ApectJ风格支持,Schema风格不支持。

3.3、切入点表达式的通配符

AspectJ类型匹配的通配符:
:匹配任何数量字符;
..:匹配任何数量字符的重复,如在类型模式中匹配任何数量子包;而在方法参数模式中匹配任何数量参数。
+:匹配指定类型的子类型;仅能作为后缀放在类型模式后边。
说明:
java.lang.String匹配String类型;
java.
.String 匹配java包下的任何“一级子包”下的String类型;
如匹配java.lang.String,但不匹配java.lang.ss.String
java.. 匹配java包及任何子包下的任何类型;
如匹配java.lang.String、java.lang.annotation.Annotation
java.lang.
ing 匹配任何java.lang包下的以ing结尾的类型;
java.lang.Number+ 匹配java.lang包下的任何Number的自类型;
如匹配java.lang.Integer,也匹配java.math.BigInteger

3.4、切入点表达式的逻辑条件

&& and
|| or
! not