SpringAOP

一.代理模式

什么是代理模式：基于接口的JDK动态代理与基于子类的CGLib动态代理两种动态代理的方式

二.简单转账功能

我们新建Maven项目名为“spring-aop“，设置好Maven版本、配置文件以及Maven仓库

准备数据

新增数据

insert into account (accountNum, money) values
(“622200001”,1000),(“622200002”,1000)

导入Spring基础包

导入操作数据库、连接数据库、测试需要的包

核心配置文件

配置自动扫包

<?xml version="1.0" encoding="UTF-8"?>

<!-- bean definitions here -->
<context:component-scan base-package="dao"/>
<context:component-scan base-package="services"/>
<context:component-scan base-package="utils"/>

配置数据源

代码编写

数据库连接工具类：ConnectionUtils.java
package utils;

@Component
public class ConnectionUtils {
private ThreadLocal tl = new ThreadLocal();
@Autowired
private ComboPooledDataSource dataSource;

/**
 * 获得当前线程绑定的连接
 *
 * @return
 */
public Connection getThreadConnection() {
    try {
        // 看线程是否绑了连接
        Connection conn = tl.get();
        if (conn == null) {
            // 从数据源获取一个连接
            conn = dataSource.getConnection();
            // 和线程局部变量  绑定
            tl.set(conn);
        }
        // 返回线程连接
        return tl.get();
    } catch (SQLException e) {
        throw new RuntimeException(e);
    }
}

/**
 * 把连接和当前线程进行解绑
 */
public void remove() {
    tl.remove();
}

}
Account模块实体类：Account.java
package entity;

public class Account {
private Integer id;
private String accountNum;
private Integer money;
// 省略getter&setter方法
}
Account模块Dao层：AccountDao.java
package dao;

public interface AccountDao {
/**
* 更新
*
* @param account
*/
void updateAccount(Account account);

/**
 * 根据编号查询账户
 *
 * @param accountNum
 * @return 如果没有结果就返回null，如果结果集超过一个就抛异常，如果有唯一的一个结果就返回
 */
Account findAccountByNum(String accountNum);

}
Account模块Dao层实现类：AccountDaoImpl.java

package dao.impl;

@Repository(“accountDao”)
public class AccountDaoImpl implements AccountDao {
// 数据库查询工具类
@Autowired
private QueryRunner runner;
// 数据库连接工具类
@Autowired
private ConnectionUtils connectionUtils;

/**
 * 更新
 *
 * @param account
 */
public void updateAccount(Account account) {
    try {
        runner.update(connectionUtils.getThreadConnection(),
                "update account set accountNum=?,money=? where id=?",
                account.getAccountNum(), account.getMoney(), account.getId());
    } catch (SQLException e) {
        throw new RuntimeException(e);
    }
}

/**
 * 根据编号查询账户
 *
 * @param accountNum
 * @return 如果没有结果就返回null，如果结果集超过一个就抛异常，如果有唯一的一个结果就返回
 */
public Account findAccountByNum(String accountNum) {
    List<Account> accounts = null;
    try {
        accounts = runner.query(connectionUtils.getThreadConnection(),
                "select * from account where accountNum = ? ",
                new BeanListHandler<Account>(Account.class),
                accountNum);
    } catch (SQLException e) {
        throw new RuntimeException(e);
    }
    if (accounts == null || accounts.size() == 0) {
        // 如果没有结果就返回null
        return null;
    } else if (accounts.size() > 1) {
        // 如果结果集超过一个就抛异常
        throw new RuntimeException("结果集不唯一，数据有问题");
    } else {
        // 如果有唯一的一个结果就返回
        return accounts.get(0);
    }
}

}
Account模块Service层：AccountService.java

package services;

public interface AccountService {
/**
* 转账
*
* @param sourceAccount 转出账户
* @param targetAccount 转入账户
* @param money 转账金额
*/
void transfer(String sourceAccount, String targetAccount, Integer money);
}
Account模块Service层实现类：AccountServiceImpl.java
package services.impl;

@Service(“accountService”)
public class AccountServiceImpl implements AccountService {

@Autowired
private AccountDao accountDao;

/**
 * 转账
 *
 * @param sourceAccount 转出账户
 * @param targetAccount 转入账户
 * @param money         转账金额
 */
public void transfer(String sourceAccount, String targetAccount, Integer money) {
    // 查询原始账户
    Account source = accountDao.findAccountByNum(sourceAccount);
    // 查询目标账户
    Account target = accountDao.findAccountByNum(targetAccount);
    // 原始账号减钱
    source.setMoney(source.getMoney() - money);
    // 目标账号加钱
    target.setMoney(target.getMoney() + money);
    // 更新原始账号
    accountDao.updateAccount(source);
    // 更新目标账号
    accountDao.updateAccount(target);
    System.out.println("转账完毕");
}

}
Account模块测试类：AccountTest.java
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = “classpath:applicationContext.xml”)
public class AccountTest {

@Autowired
private AccountService accountService;

@Test
public void testTransfer() {
    accountService.transfer("622200001", "622200002", 100);
}

}

缺点分析

在业务层的代码加入一行异常代码 如下图所示：
// 造异常
int i = 1 / 0;
异常代码加在了出账账户金额修改之后，入账账户金额修改之前

执行报ArithmeticException错，如下图所示：
查看数据库中数据发现出账账户money的列值由原来的900变成了800，说明存款确实减少了100

但是由于在代码执行的过程中，出现了异常，导致入账账户并没有增加100
这就出现了数据的事务问题，破坏了数据的原子性和一致性

三.引入代理模式解决事务

实现思路介绍

创建一个工具类，目的是用于管理数据库的事务，提供事务的开启，提交，回滚等操作；
创建一个代理处理器类，目的是生成转账实现类的代理对象，对转账的业务方法提供增强，主要是在数据操作之前，和操作之后干点事。
在 Spring 的配置文件中，通过 xml 文件的标签实例化管理事务的工具类和生成代理对象的处理器类。
代码实现

事务管理器：TransactionManager.java

此工具类主要作用是对数据库连接实现事务的开启，提交以及回滚

至于何时开启、提交、回滚事务，根据业务场景需要调用该类的方法即可
package transaction;

@Component
public class TransactionManager {
// 数据库连接工具类
@Autowired
private ConnectionUtils connectionUtils;

/**
 * 开启事务
 */
public void beginTransaction() {
    try {
        System.out.println("开启事务");
        connectionUtils.getThreadConnection().setAutoCommit(false);
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

/**
 * 提交事务
 */
public void commit() {
    try {
        System.out.println("提交事务");
        connectionUtils.getThreadConnection().commit();
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

/**
 * 回滚事务
 */
public void rollback() {
    try {
        System.out.println("回滚事务");
        connectionUtils.getThreadConnection().rollback();
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

/**
 * 释放连接
 */
public void release() {
    try {
        System.out.println("释放连接");
        connectionUtils.getThreadConnection().close();
    } catch (SQLException e) {
        e.printStackTrace();
    }
    connectionUtils.removeConnection();
}

}
事务代理工具类：TransactionProxyUtils

此类的核心代码是getAccountService方法，该方法返回代理业务类示例

在代理对象的invoke方法内部，实现对原始被代理对象的增强
package utils;

@Component
public class TransactionProxyUtils {
//被代理的业务类接口
@Autowired
private AccountService accountService;
//提供事务管理的工具类
@Autowired
private TransactionManager transactionManager;

/**
 * 获取AccountService代理对象
 *
 * @return
 */
public AccountService getAccountService() {
    return (AccountService) Proxy.newProxyInstance(
            accountService.getClass().getClassLoader(),
            accountService.getClass().getInterfaces(),
            new InvocationHandler() {
                /**
                 * 添加事务的支持
                 *
                 * @param proxy     被代理的对象实例本身
                 * @param method    被代理对象正在执行的方法对象
                 * @param args      正在访问的方法参数对象
                 * @return
                 * @throws Throwable
                 */
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

                    //
                    Object rtValue = null;
                    try {
                        // 执行操作前开启事务
                        transactionManager.beginTransaction();
                        // 执行操作
                        rtValue = method.invoke(accountService, args);
                        // 执行操作后提交事务
                        transactionManager.commit();
                        // 返回结果
                        return rtValue;
                    } catch (Exception e) {
                        // 捕捉到异常执行回滚操作
                        transactionManager.rollback();
                        throw new RuntimeException(e);
                    } finally {
                        // 最终释放连接
                        transactionManager.release();
                    }
                }
            });

}

}
核心配置文件：applicationContext.xml

添加事务管理bean
<context:component-scan base-package=“transaction”/>
配置代理Service

Account模块测试类：AccountTest.java

将原本引入的AccountService实例改为AccountService的事务代理对象

@Qualifier(“transactionProxyAccountService”)
执行结果

首先将数据库中两账户余额都改为1000
update account set money = 1000;
控制台打印结果
可以看到：在转账前后由开启、提交事务，最后有释放连接

表示事务代理已经对在不改变源代码的基础上对其做了增强

修改前数据库中值
修改后数据库中值
可以看到：两个账号的数据已经发生了改变，证明转账的动作确实已经完成

再次在出账账户金额修改之后，入账账户金额修改之前添加异常代码，如下图所示
可以看到：在捕捉到异常后进行了事务的回滚
查看数据库中数据发现并没有改变
说明引入代理模式解决了事务问题，保证了数据的原子性和一致性

缺点分析

自定义代理模式代码编写过于臃肿
侵入性比较强，代码不够优雅
控制事务的实现过于繁琐

四.引入AOP(XML)

相关概念

使用Spring的AOP替代代理类。先回顾下AOP的概念

AOP是一种编程设计模式，是一种编程技术，使用AOP后通过修改配置即可实现增加或者去除某些附加功能

学习AOP中的常用术语：

Join point（连接点）
所谓连接点是指那些可以被拦截到的点

在Spring中这些点指的是方法，可以看作正在访问的，或者等待访问的那些需要被增强功能的方法

Spring只支持方法类型的连接点

Pointcut（切入点）
切入点是一个规则，定义了我们要对哪些Joinpoint进行拦截

因为在一个程序中会存在很多的类，每个类又存在很多的方法，Pointcut来标记哪些方法会应用AOP对该方法做功能增强

Advice（通知）
所谓通知是指拦截到Joinpoint之后所要做的事情就是通知。也就是对方法做的增强功能。通知分为如下几类：

前置通知：在连接点之前运行的通知类型，它不会阻止流程进行到连接点，只是在到达连接点之前运行该通知内的行为

后置通知：在连接点正常完成后要运行的通知，正常的连接点逻辑执行完，会运行该通知

最终通知：无论连接点执行后的结果如何，正常还是异常，都会执行的通知

异常通知：如果连接点执行因抛出异常而退出，则执行此通知

环绕通知：环绕通知可以在方法调用之前和之后执行自定义行为

Target（目标）
Target指的是代理的目标对象，更通俗的解释就是：AOP对连接点方法做增强，底层是代理模式生成连接点所在类的代理对象，那么连接点所在的类，就是被代理的类称呼为Target

Aspect（切面）
切面本质是一个类，只不过是个功能类，作为整合AOP的切入点和通知。

一般来讲，需要在Spring的配置文件中配置，或者通过注解来配置

Weaving（织入）
织入是一种动作的描述，在程序运行时将增强的功能代码也就是通知，根据通知的类型（前缀后缀等…）放到对应的位置，生成代理对象

Proxy（代理）
一个类被AOP织入增强后，产生的结果就是代理类

代码实现

在执行原始业务类前对方法增强也就是SpringAOP中所谓的前置通知，对原始业务类中的方法执行之后的增强行为就是后置通知

而一旦出现异常，那么所做的动作就是异常通知。本案例使用几种通知，来实现事务的控制。

删除事务代理工具类：TransactionProxyUtils.java

导入aspectjweaver包

org.aspectj aspectjweaver 1.9.3 配置文件中添加 AOP 的相关配置 修改测试类代码 执行结果

控制台打印结果
可以看到：在转账前后由开启、提交事务，最后有释放连接

表示SpringAOP已经在不改变源代码的基础上对其做了增强

修改前数据库中值
修改后数据库中值
可以看到：两个账号的数据已经发生了改变，证明转账的动作确实已经完成

再次在出账账户金额修改之后，入账账户金额修改之前添加异常代码，如下图所示
可以看到：在捕捉到异常后进行了事务的回滚
查看数据库中数据发现并没有改变
说明SpringAOP配置的事务管理同样也解决了事务问题，保证了数据的原子性和一致性

通过在xml文件中配置SpringAOP相关配置，就可以实现对我们业务类中的方法实现了增强，无需自定义对业务类做代理实现

五.XML改注解(AOP)

使用注解介绍

@Aspect
此注解用于表明某个类为切面类，而切面类的作用我们之前也解释过，用于整合切入点和通知

@Pointcut
此注解用于声明一个切入点，表明哪些类的哪些方法需要被增强

@Before 前置通知
在连接点之前运行的通知类型，它不会阻止流程进行到连接点，只是在到达连接点之前运行该通知内的行为

@AfterReturning 后置通知
在连接点正常完成后要运行的通知，正常的连接点逻辑执行完，会运行该通知

@After 最终通知
无论连接点执行后的结果如何，正常还是异常，都会执行的通知

@AfterThrowing 异常通知
如果连接点执行因抛出异常而退出，则执行此通知

代码实现

删除XML中的AOPXML配置并注解代理模式

aop:aspectj-autoproxy</aop:aspectj-autoproxy>
注释事务管理器类：TransactionManager.java

package transaction;

@Component
@Aspect
public class TransactionManager {
// 数据库连接工具类
@Autowired
private ConnectionUtils connectionUtils;

@Pointcut("execution(* services.*.*(..))")
private void transactionPointcut() {
}

/**
 * 开启事务
 */
@Before("transactionPointcut()")
public void beginTransaction() {
    try {
        System.out.println("开启事务");
        connectionUtils.getThreadConnection().setAutoCommit(false);
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

/**
 * 提交事务
 */
@AfterReturning("transactionPointcut()")
public void commit() {
    try {
        System.out.println("提交事务");
        connectionUtils.getThreadConnection().commit();
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

/**
 * 回滚事务
 */
@AfterThrowing("transactionPointcut()")
public void rollback() {
    try {
        System.out.println("回滚事务");
        connectionUtils.getThreadConnection().rollback();
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

/**
 * 释放连接
 */
@After("transactionPointcut()")
public void release() {
    try {
        System.out.println("释放连接");
        connectionUtils.getThreadConnection().close();
    } catch (SQLException e) {
        e.printStackTrace();
    }
    connectionUtils.removeConnection();
}

}
执行结果

控制台打印结果
可以看到：在转账前后由开启、提交事务，最后有释放连接

表示SpringAOP已经在不改变源代码的基础上对其做了增强

修改前数据库中值
再次在出账账户金额修改之后，入账账户金额修改之前添加异常代码，如下图所示
可以看到：在捕捉到异常后进行了事务的回滚
查看数据库中数据发现并没有改变
说明SpringAOP注释的事务管理类同样也解决了事务问题，保证了数据的原子性和一致性

通过注解完成SpringAOP相关配置，就可以实现对我们业务类中的方法实现了增强

总结

SpringAOP的作用就是把程序中重复的代码抽取出来，在需要执行的时候，使用动态代理技术，在不修改源码的基础上，对已有方法进行增强

优势就是减少了重复代码，提高代码复用性，提高开发效率，使得代码的维护更加方便

在开发时通常将日志记录，数据库连接池的管理，系统统一的认证、权限管理等用面向切面的方式开发

来源老师，部分代码不全。个人理解