Spring AOP

案例

首先，看下面的一个案例：
转账案例：使用Spring框架整合DBUtils技术，实现用户转账功能。

• DAO层的实现 ```java @Repository(“accountDao”) //生成该类实例 存到IOC容器中 public class AccountDaoImpl implements AccountDao {

  @Autowired private QueryRunner queryRunner;

  /**

  • 转出操作 *
  • @param outUser

  • @param money */ @Override public void outUser(String outUser, Double money) { String sql = “update account set money = money - ? where name = ?”; try {

     queryRunner.update(sql, money, outUser);

    } catch (SQLException throwables) {

     throwables.printStackTrace();
    

    } }

    /**

  • 转入操作 *
  • @param inUser
  • @param money */ @Override public void inUser(String inUser, Double money) { String sql = “update account set money = money + ? where name = ?”; try {

     queryRunner.update(sql, money, inUser);
    

    } catch (SQLException throwables) {

     throwables.printStackTrace();
    

    } } }

- service层的实现
```java
@Service("accountService")
public class AccountServiceImpl implements AccountService {

    @Autowired
    private AccountDao accountDao;

    /**
     * 转账方法
     *
     * @param outUser
     * @param inUser
     * @param money
     */
    @Override
    public void transfer(String outUser, String inUser, Double money) {
        //转出操作
        accountDao.outUser(outUser, money);
        //转入操作
        accountDao.inUser(inUser, money);
    }
}

• 配置spring核心配置文件 ```xml <?xml version=”1.0” encoding=”UTF-8” ?>

- junit测试 转账操作
```java
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath:applicationContext.xml"})
public class AccountTest {

    @Autowired
    private AccountService accountService;

    @Test
    public void test() {
        accountService.transfer("tom", "jerry", 100d);
    }
}

但是上述存在着一个问题，每一条SQL都是在独立的事物中执行的。但实例开发中应该把业务逻辑控制在一个事物中。

复现问题：在转出和转入操作中间添加一个异常

    @Override
    public void transfer(String outUser, String inUser, Double money) {
        //转出操作
        accountDao.outUser(outUser, money);
        int i = 1/0;
        //转入操作
        accountDao.inUser(inUser, money);
    }

结果如下：tom的转出了100，但是Jerry并没有增加金额。所以我们需要在转出和转入操作在一个事务中执行，出现异常回滚事务即可。而不是两个单独的事务执行。

传统事务

传统事务：手动开启事务和手动提交/回滚事务需要修改dao层和service层代码，转账操作控制在同一个事务中。

1. 编写线程绑定工具类

连接工具类，从数据源中获取一个连接，并将实现和线程的绑定。
转入操作和转出操作都需要用到同一个connection

/**
 * 从数据源中获取一个连接，并且获取到的连接与线程绑定
 */
@Component //生成该类的实例 存到IOC容器中
public class ConnectionUtils {
    @Autowired
    private DataSource dataSource;

    //线程内部的存储类，可以在指定的线程内来存储数据 key:ThreadLocal value:任意类型的值
    private ThreadLocal<Connection> threadLocal = new ThreadLocal<>();

    /**
     * 获取当前线程绑定的连接，如果获取到的连接为空，那么从数据源中获取连接并且放到ThreadLocal中 绑定到当前线程中
     *
     * @return
     */
    public Connection getThreadConnection() {
        //1. 线程ThreadLocal上获取连接
        Connection connection = threadLocal.get();
        //2. 如果连接为空 则从数据源获取连接 存储到当前线程中
        if (connection == null) {
            try {
                connection = dataSource.getConnection();
                threadLocal.set(connection);
            } catch (SQLException throwables) {
                throwables.printStackTrace();
            }
        }
        return connection;
    }

    /**
     * 解除当前线程的连接绑定
     */
    public void removeThreadLocal(){
        threadLocal.remove();
    }
}

1. 编写事务管理器 ```java /**

   • 事务管理器工具类：开启事务、提交事务、回滚事务、提交资源 */ @Component public class TransactionManager {

     //注入 连接工具类 @Autowired private ConnectionUtils connectionUtils;

     /**

     • 开启手动提交事务 */ public void beginTransaction() { Connection connection = connectionUtils.getThreadConnection(); try {

        connection.setAutoCommit(false);//手动提交事务
       

       } catch (SQLException throwables) {

        throwables.printStackTrace();
       

       } }

     /**

     • 提交事务 */ public void commit() { Connection connection = connectionUtils.getThreadConnection(); try {

        connection.commit();
       

       } catch (SQLException throwables) {

        throwables.printStackTrace();
       

       } }

     /**

     • 回滚事务 */ public void rollback() { Connection threadConnection = connectionUtils.getThreadConnection(); try {

        threadConnection.rollback();
       

       } catch (SQLException throwables) {

        throwables.printStackTrace();
       

       } }

     /**

     • 释放资源 */ public void release() { try {

        //1 将手动事务改回自动提交事务
        Connection connection = connectionUtils.getThreadConnection();
        connection.setAutoCommit(true);
        //2 将连接归还
        connectionUtils.getThreadConnection().close();
        //3 解除线程绑定
        connectionUtils.removeThreadLocal();
       

       } catch (SQLException throwables) {

        throwables.printStackTrace();
       

       } } }

3. 修改service代码
> 开启事务beginTransaction，这时候ConnectionUtils会从连接池中获取一个连接，并存储到当前的线程中

```java
@Service("accountService")
public class AccountServiceImpl implements AccountService {

    @Autowired
    private AccountDao accountDao;

    @Autowired
    private TransactionManager transactionManager;

    /**
     * 转账方法
     *
     * @param outUser
     * @param inUser
     * @param money
     */
    @Override
    public void transfer(String outUser, String inUser, Double money) {
        //手动开启事务
        transactionManager.beginTransaction();
        try {
            //转出操作
            accountDao.outUser(outUser, money);
            int i = 1 / 0;
            //转入操作
            accountDao.inUser(inUser, money);
            //提交事务
            transactionManager.commit();
        } catch (Exception e) {
            e.printStackTrace();
            //回滚事务
            transactionManager.rollback();
        } finally {
            //释放资源
            transactionManager.release();
        }
    }
}

1. 修改DAO层代码

   使转出操作和转入操作是同一个连接，保证处在同一个事物中，通过ConnectionUtils获取。

@Repository("accountDao") //生成该类实例 存到IOC容器中
public class AccountDaoImpl implements AccountDao {

    @Autowired
    private QueryRunner queryRunner;

    //获取连接 使转出操作和转入操作的连接是同一个连接
    @Autowired
    private ConnectionUtils connectionUtils;

    /**
     * 转出操作
     *
     * @param outUser
     * @param money
     */
    @Override
    public void outUser(String outUser, Double money) {
        String sql = "update account set money = money - ? where name = ?";
        try {
            queryRunner.update(connectionUtils.getThreadConnection(), sql, money, outUser);
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }
    }

    /**
     * 转入操作
     *
     * @param inUser
     * @param money
     */
    @Override
    public void inUser(String inUser, Double money) {
        String sql = "update account set money = money + ? where name = ?";
        try {
            queryRunner.update(connectionUtils.getThreadConnection(), sql, money, inUser);
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }
    }
}

再次执行代码，当转出操作之后出现了异常事务就会回滚，tom和jerry的金额没有变化。

通过上面的代码，对业务层进行了改造，可以实现事务控制了，但是由于添加了事务控制，导致了业务层的方法变的臃肿了，里面有很多事务相关的重复代码，并且事务和业务耦合在了一起，违背了开发思想，一般来说业务层只处理业务，并不该有事务控制相关的逻辑。

Proxy 动态代理优化

通过动态代理的方式将业务代码和事务代码进行拆分，对业务方法进行事务的增强。不会对业务层产生影响。

常用的动态代理技术

• JDK代理：基于接口的动态代理技术-利用拦截器(invocationHandler)加上反射机制生成一个代理接口的匿名类，在调用具体方法前调用invokeHandler处理，从而实现方法增强
• CGLIB代理：基于父类的动态代理技术-动态生成一个要代理的子类，子类重写要代理的类所有不是final的方法。在子类中采用方法拦截技术拦截所有父类方法的调用，顺势织入横切逻辑，对方法进行增强。

1. JDK动态代理方法

编写动态代理工厂类

/**
 * jdk动态代理工厂类
 */
@Component //对象存入IOC容器中
public class JdkProxyFactory {

    @Autowired //注入AccountService实例对象
    private AccountService accountService;

    @Autowired //注入TransactionManager实例对象
    private TransactionManager transactionManager;

    /**
     * 采用动态代理技术来生成目标类的代理对象
     * ClassLoader loader ： 类加载器，借助被代理对象获取类加载器
     * Class<?>[] interfaces：被代理类所需要实现的全部接口
     * InvocationHandler h ： 当代理对象代用代理接口的任意方法，都会执行invoke方法
     */
    public AccountService createAccountServiceProxy() {
        return (AccountService) Proxy.newProxyInstance(accountService.getClass().getClassLoader(),
                new Class[]{AccountService.class}, new InvocationHandler() {
                    //proxy:当前代理对象的引用
                    //method:被代理对象的原方法
                    //args：被调用目标方法的参数
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        //拦截方法
                        transactionManager.beginTransaction();
                        try {
                            method.invoke(accountService, args);//执行被代理对象的方法
                            transactionManager.commit();
                        } catch (Exception e) {
                            e.printStackTrace();
                            transactionManager.rollback();
                        } finally {
                            transactionManager.release();
                        }
                        return null;
                    }
                });
    }
}

Service层的事务相关代码就可以删除掉了

@Service("accountService")
public class AccountServiceImpl implements AccountService {

    @Autowired
    private AccountDao accountDao;

    /**
     * 转账方法
     *
     * @param outUser
     * @param inUser
     * @param money
     */
    @Override
    public void transfer(String outUser, String inUser, Double money) {
        //转出操作
        accountDao.outUser(outUser, money);
//        int i = 1 / 0;
        //转入操作
        accountDao.inUser(inUser, money);
    }
}

OK，下面我们测试一下：通过动态代理工厂就可以得到一个AccountService的代理对象，使用这个代理对象执行transfer方法

    @Autowired
    private JdkProxyFactory jdkProxyFactory;

    @Test/
    public void test() {
//        accountService.transfer("tom", "jerry", 100d);
        //代理对象
        AccountService serviceProxy = jdkProxyFactory.createAccountServiceProxy();
        serviceProxy.transfer("tom", "jerry", 100d);
    }

1. CGLIB动态代理实现

CGLIB的实现和JDK动态代理实现方法差不多是一样的

/**
 * 采用Cglib动态代理
 */
@Component
public class CglibProxyFactory {
    @Autowired
    private AccountService accountService;

    @Autowired
    private TransactionManager transactionManager;

    public AccountService createProxyAccountService() {
        //参数1：目标类的字节码对象
        //参数2：动作类 当代理对象调用目标对象中的原方法时，会执行intercept方法
        return (AccountService) Enhancer.create(accountService.getClass(), new MethodInterceptor() {
            //o : 代表生成的代理对象
            //method：调用目标方法的引用
            //objects: 方法入参
            //methodProxy:代理方法
            @Override
            public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
                transactionManager.beginTransaction();
                try {
                    method.invoke(accountService, objects);
                    transactionManager.commit();
                } catch (Exception e) {
                    e.printStackTrace();
                    transactionManager.rollback();
                } finally {
                    transactionManager.release();
                }
                return null;
            }
        });
    }
}

Spring AOP

AOP （Aspect Oriented Programming）：面向切面编程 AOP 是OOP(面向对象编程)的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高开发效率

好处：

1. 程序运行期间，在不修改源码的情况下对方法进行功能增强
2. 逻辑清晰，开发核心业务的时候，不必关注增强业务的代码
3. 减少重复代码，提高开发效率，便于后期维护

AOP底层是通过spring提供的动态代理技术实现的，在运行期间，spring通过动态代理技术动态的生成代理对象，代理对象方法执行时进行增强功能的介入，在去调用目标对象的方法，从而完成功能的增强。

AOP 相关术语

• Target(目标对象)：代理的目标对象，被代理类
• Proxy（代理）：一个类被AOP织入增强后，就产生一个结果代理类，生成的代理对象
• Joinpoint（连接点）：所谓连接点是指可以被拦截到的点。在spring中这些点指的是方法，可以被拦截增强的方法
• Pointcut（切入点): 真正被拦截增强的方法
• Advice（通知/增强）: 增强的业务逻辑，所谓通知是指拦截到joinpoint之后所要做的事情就是通知。分为：前置通知、后置通知、异常通知、最终通知、环绕通知(spring提供一种可以让我们通过代码的方式来手动控制的类型)
• Aspect（切面）: 切入点和通知的结合
• Weaving（织入）：把增强应用到目标对象来创建新的代理对象的过程

AOP 开发注意事项

1. 编写核心业务代码(目标类的目标方法)
2. 把公用代码抽取出来，制作成通知（增强功能方法）
3. 在配置文件中，声明切入点与通知间的关系，即切面

运行阶段（Spring框架完成）：spring框架监控切入点方法的执行。一旦监控到切入点方法被运行，使用代理机制，动态创建目标对象的代理对象，根据通知类别，在代理对象的对应位置将通知对应的功能织入，完成完整的代码逻辑运行。

spring底层代理实现：根据目标类是否实现了接口来决定采用哪种动态代理的方式

• 当bean实现接口时，会用JDK代理模式
• 当bean没有实现接口，用cglib实现(可以强制使用cglib 在spring配置中加入” <aop:aspectj-autoproxy proxy-target-class="true"/>)

基于XML的AOP开发

快速入门：

1. 创建项目导入AOP相关依赖

   <dependencies>
        <!-- 导入spring的context坐标,context 依赖aop -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.1.5.RELEASE</version>
        </dependency>
        <!-- aspectj的织入(切点表达式需要用到该jar包) -->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.13</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>5.1.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
   

2. 创建目标接口和目标实现类(定义切入点)

目标类：

public class AccountServiceImpl implements AccountService {
    /**
     * 目标方法-切入点
     */
    @Override
    public void transfer() {
        System.out.println("转账方法执行了");
    }
}

1. 创建通知类及方法(定义通知)

   /**
   * 通知类
   */
   public class AccountAdvice {
    public void before() {
        System.out.println("前置通知，执行。。。。");
    }
   
    public void after() {
        System.out.println("后置通知，执行。。。。。");
    }
   }
   

2. 将目标类和通知类对象的创建权交给spring

3. 在spring核心配置文件配置织入关系(切面) ```xml <?xml version=”1.0” encoding=”UTF-8” ?>

    <!-- 配置切面：切入点+通知 -->
    <!--
    ref:通知类的bean id
    -->
    <aop:aspect ref="accountAdvice">
        <!--
            前置增强
            method:调用的通知类的哪个方法
            pointcut:配置目标类的transfer方法切点，当执行该方法的执行之前会执行before方法
        -->
        <aop:before method="before" pointcut="execution(public void com.example.impl.AccountServiceImpl.transfer())" ></aop:before>
    </aop:aspect>
   

6. 测试代码
```java
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath:applicationContext.xml"})
public class TestSpringAopXml {

    @Autowired
    private AccountService accountService;

    @Test
    public void test() {
        accountService.transfer();
    }
}

运行结果如下：

XML 配置AOP 详解

1. 切点表达式

表达式语法：execution([修饰符] 返回值类型 包名.类名.方法名(参数))

• 访问修饰符可以省略
• 返回值类型、包名、类名、方法名可以使用星号*代替，代表任意
• 包名与类名之间一个点，代表当前包下的类，两个点…表示当前包及其子包下的类
• 参数列表可以使用两个点..表示任意个数，任意类型的参数列表

execution(public void com.example.impl.AccountServiceImpl.transfer())
execution(public void com.example.impl.AccountServiceImpl.*(..))
execution(* com.example.impl.*.*(..))
execution(public void com.example.service..*.*(..))

切点表达式的抽取：
当多个增强的切点表达式相同时，可以将切点表达式进行抽取，在增强中使用pointcut-ref属性代替pointcut属性来引用抽取后的切点表达式

<aop:config>
        <!-- 配置切面：切入点+通知 -->
        <!-- 抽取切点表达式 -->
        <aop:pointcut id="accountPointcut"
                      expression="execution(public void com.example.impl.AccountServiceImpl.*(..))"/>
        <!--
        ref:通知类的bean id
        -->
        <aop:aspect ref="accountAdvice">
            <!--
                前置增强
                method:调用的通知类的哪个方法
                pointcut:配置目标类的transfer方法切点，当执行该方法的执行之前会执行before方法
            -->
            <aop:before method="before" pointcut-ref="accountPointcut"></aop:before>
            <!--
                后置增强
             -->
            <aop:after-returning method="after" pointcut-ref="accountPointcut"></aop:after-returning>
        </aop:aspect>
    </aop:config>

1. 通知类型详解

   通知的配置语法：

   <aop:通知类型 method="通知类中的方法" pointcut-ref="切点表达式" />
   

        <!--
        ref:通知类的bean id
        -->
        <aop:aspect ref="accountAdvice">
            <!--
                前置增强
                method:调用的通知类的哪个方法
                pointcut:配置目标类的transfer方法切点，当执行该方法的执行之前会执行before方法
            -->
            <aop:before method="before" pointcut-ref="accountPointcut"/>
            <!-- 后置通知-->
            <aop:after-returning method="after" pointcut-ref="accountPointcut"/>
            <!-- 异常通知 -->
            <aop:after-throwing method="afterThowing" pointcut-ref="accountPointcut"/>
            <!-- 最终通知 -->
            <aop:after method="finals" pointcut-ref="accountPointcut"/>
        </aop:aspect>

环绕通知，通常会单独使用，如下代码：

    /**
     * @param joinPoint 切入点
     * @return
     */
    public Object around(ProceedingJoinPoint joinPoint) {
        System.out.println("环绕通知");
        Object result = null;
        try {
            System.out.println("前置通知，，");
            result = joinPoint.proceed();//执行切点方法
            System.out.println("后置通知，，");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            System.out.println("异常通知，，");
        } finally {
            System.out.println("最终通知，，");
        }
        return result;
    }

配置环绕通知：

<aop:around method="around" pointcut-ref="accountPointcut"/>

基于注解的AOP开发

1. 快速入门

通知类中使用注解的方式，来配置织入关系

/**
 * 通知类 注解方式
 */
@Component
@Aspect //升级为切面类：配置切入点和通知的关系
public class AccountAdvice {
    @Before("execution(* com.example.impl.AccountServiceImpl.*(..))")//表达式
    public void before() {
        System.out.println("前置通知，执行。。。。");
    }

    @AfterReturning("execution(* com.example.impl.AccountServiceImpl.*(..))")
    public void after() {
        System.out.println("后置通知，执行。。。。。");
    }

    @AfterThrowing("execution(* com.example.impl.AccountServiceImpl.*(..))")
    public void afterThowing() {
        System.out.println("异常通知，执行");
    }

    @After("execution(* com.example.impl.AccountServiceImpl.*(..))")
    public void finals() {
        System.out.println("最终通知，执行");
    }

    /**
     * @param joinPoint 切入点
     * @return
     */
    @Around("execution(* com.example.impl.AccountServiceImpl.*(..))")
    public Object around(ProceedingJoinPoint joinPoint) {
        System.out.println("环绕通知");
        Object result = null;
        try {
            System.out.println("前置通知，，");
            result = joinPoint.proceed();//执行切点方法
            System.out.println("后置通知，，");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            System.out.println("异常通知，，");
        } finally {
            System.out.println("最终通知，，");
        }
        return result;
    }
}

配置文件中开启组件扫描和AOP自动代理

    <!-- IOC创建bean实例注解扫描 -->
    <context:component-scan base-package="com.example"/>

    <!-- AOP 注解方式 自动代理配置,spring 采用动态代理 完成织入增强
        expose-proxy
        proxy-target-class = true 强制使用cglib动态代理
    -->
    <aop:aspectj-autoproxy proxy-target-class="true"/>

注解方式的切点表达式的抽取：

    //抽取切点表达式
    @Pointcut("execution(* com.example.impl.AccountServiceImpl.*(..))")
    public void accountPointcut(){

    }

    @Before("AccountAdvice.accountPointcut()")//表达式
    public void before() {
        System.out.println("前置通知，执行。。。。");
    }

注意四个通知组合在一起的执行顺序： @Before->@After->@AfterReturnning （如果有异常：@AfterThrowing）

AOP纯注解配置

@Configuration
@ComponentScan("com.example") // IOC 注解扫描
@EnableAspectJAutoProxy //aop 自动代理
public class SpringConfig {
}

Spring AOP 优化转账案例

在开始的一个案例中，使用了Proxy进行了优化，下面我们使用Spring AOP来实现。
通知类：TransactionManager
切入点：AccountServiceImpl.transfer
通过XML的方式，配置AOP

    <!-- aop 配置 -->
    <aop:config>
        <!-- 切点表达式 -->
        <aop:pointcut id="myPointcut" expression="execution(* com.example.service.impl.AccountServiceImpl.*(..))"/>
        <!-- 切面配置 -->
        <aop:aspect ref="transactionManager">
            <aop:before method="beginTransaction" pointcut-ref="myPointcut"/>
            <aop:after-returning method="commit" pointcut-ref="myPointcut"/>
            <aop:after-throwing method="rollback" pointcut-ref="myPointcut"/>
            <aop:after method="release" pointcut-ref="myPointcut"/>
        </aop:aspect>
    </aop:config>

测试：直接使用accountService即可

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath:applicationContext.xml"})
public class AccountTest {

    @Autowired
    private AccountService accountService;

//    @Autowired
//    private JdkProxyFactory jdkProxyFactory;
//
//    @Autowired
//    private CglibProxyFactory cglibProxyFactory;

    @Test
    public void test() {
//        accountService.transfer("tom", "jerry", 100d);
        //代理对象
//        AccountService serviceProxy = jdkProxyFactory.createAccountServiceProxy();
//        AccountService serviceProxy = cglibProxyFactory.createProxyAccountService();
        accountService.transfer("tom", "jerry", 100d);
    }
}

通过注解的方式，配置AOP。在上述中通知类：TransactionManager 配置AOP注解

@Component
@Aspect //升级为切面类
public class TransactionManager {

    //注入 连接工具类
    @Autowired
    private ConnectionUtils connectionUtils;

    //切点表达式抽取
    @Pointcut("execution(* com.example.service.impl.AccountServiceImpl.*(..))")
    public void transactionPointcut() {

    }

    @Around("TransactionManager.transactionPointcut()")
    public Object around(ProceedingJoinPoint joinPoint) {
        Object result = null;
        try {
            beginTransaction();
            result = joinPoint.proceed();
            commit();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
            rollback();
        } finally {
            release();
        }
        return result;
    }
}

spring的核心配置中添加AOP的自动代理配置

<aop:aspectj-autoproxy></aop:aspectj-autoproxy>