Spring之AOP配置

AOP概述

什么是AOP

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

为什么要使用AOP

AOP最为典型的应用实际就是数据库事务的管控。例如,当我们需要保存一个用户时,可能要连同它的角色信息一并保存到数据库中,要么一起成功,要么一起失败,这时可能就需要AOP的管控,将具体的数据库操作织入事务中。

AOP还可以减少大量重复的工作,例如JDBC代码的简化。

动态代理

动态代理相关知识请移步Java反射机制和动态代理详解

不使用动态代理的项目

/**
 * 账户的业务层实现类
 */
public class AccountServiceImpl implements IAccountService{

    private IAccountDao accountDao;
    private TransactionManager txManager;

    public void setTxManager(TransactionManager txManager) {
        this.txManager = txManager;
    }

    public void setAccountDao(IAccountDao accountDao) {
        this.accountDao = accountDao;
    }

    @Override
    public List<Account> findAllAccount() {
        try {
            txManager.beginTransaction();
            List<Account> accounts = accountDao.findAllAccount();
            txManager.commit();
            return accounts;
        } catch (Exception e) {
            txManager.rollback();
            throw new RuntimeException(e);
        } finally {
            txManager.release();
        }
    }

    @Override
    public Account findAccountById(Integer accountId) {
        try {
            txManager.beginTransaction();
            Account account = accountDao.findAccountById(accountId);
            txManager.commit();
            return account;
        } catch (Exception e) {
            txManager.rollback();
            throw new RuntimeException(e);
        } finally {
            txManager.release();
        }
    }

    @Override
    public void saveAccount(Account account) {
        try {
            txManager.beginTransaction();
            accountDao.saveAccount(account);
            txManager.commit();
        } catch (Exception e) {
            txManager.rollback();
            throw new RuntimeException(e);
        } finally {
            txManager.release();
        }
    }

    @Override
    public void updateAccount(Account account) {
        try {
            txManager.beginTransaction();
            accountDao.updateAccount(account);
            txManager.commit();
        } catch (Exception e) {
            txManager.rollback();
            throw new RuntimeException(e);
        } finally {
            txManager.release();
        }
    }

    @Override
    public void deleteAccount(Integer acccountId) {
        try {
            txManager.beginTransaction();
            accountDao.deleteAccount(acccountId);
            txManager.commit();
        } catch (Exception e) {
            txManager.rollback();
            throw new RuntimeException(e);
        } finally {
            txManager.release();
        }
    }

    @Override
    public void transfer(String sourceName, String targetName, Float money) {
        try {
            txManager.beginTransaction();
            //1.根据名称查询转出账户
            Account source = accountDao.findAccountByName(sourceName);
            //2.根据名称查询转入账户
            Account target = accountDao.findAccountByName(targetName);
            //3.转出减钱
            source.setMoney(source.getMoney()-money);
            //4.转入加钱
            target.setMoney(target.getMoney()+money);
            //5.更新转出账户
            accountDao.updateAccount(source);

            int i = 10/0;

            //6.更新转入账户
            accountDao.updateAccount(target);
            txManager.commit();
        } catch (Exception e) {
            txManager.rollback();
            e.printStackTrace();
        } finally {
            txManager.release();
        }
    }
}

使用动态代理的项目

public class BeanFactory {
    private IAccountService accountService;
    private TransactionManager txManager;

    public void setTxManager(TransactionManager txManager) {
        this.txManager = txManager;
    }

    public final void setAccountService(IAccountService accountService){
        this.accountService = accountService;
    }

    /**
     * 获取Service代理对象
     * @return
     */
    public IAccountService getAccountService(){
        return (IAccountService) Proxy.newProxyInstance(accountService.getClass().getClassLoader(), accountService.getClass().getInterfaces(),
            new InvocationHandler() {
                @Override
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                    Object rtValue = null;
                    try {
                        txManager.beginTransaction();
                        method.invoke(accountService,args);
                        txManager.commit();
                        return rtValue;
                    } catch (Exception e) {
                        txManager.rollback();
                        throw new RuntimeException(e);
                    } finally {
                        txManager.release();
                    }
                }
            });
    }
}
/**
 * 账户的业务层实现类
 */
public class AccountServiceImpl implements IAccountService{

    private IAccountDao accountDao;

    public void setAccountDao(IAccountDao accountDao) {
        this.accountDao = accountDao;
    }

    @Override
    public List<Account> findAllAccount() {
        return accountDao.findAllAccount();
    }

    @Override
    public Account findAccountById(Integer accountId) {
        return accountDao.findAccountById(accountId);
    }

    @Override
    public void saveAccount(Account account) {
        accountDao.saveAccount(account);
    }

    @Override
    public void updateAccount(Account account) {
        accountDao.updateAccount(account);
    }

    @Override
    public void deleteAccount(Integer acccountId) {
        accountDao.deleteAccount(acccountId);
    }

    @Override
    public void transfer(String sourceName, String targetName, Float money) {

        //1.根据名称查询转出账户
        Account source = accountDao.findAccountByName(sourceName);
        //2.根据名称查询转入账户
        Account target = accountDao.findAccountByName(targetName);
        //3.转出减钱
        source.setMoney(source.getMoney()-money);
        //4.转入加钱
        target.setMoney(target.getMoney()+money);
        //5.更新转出账户
        accountDao.updateAccount(source);

        int i = 10/0;

        //6.更新转入账户
        accountDao.updateAccount(target);
    }
}

Spring中的AOP

AOP相关术语

JoinPoint(连接点):

所谓连接点是指那些被拦截到的点。在 spring 中,这些点指的是方法,因为 spring 只支持方法类型的连接点。

Pointcut(切入点):

所谓切入点是指我们要对哪些 Joinpoint 进行拦截的定义。

Advice(通知/增强):
所谓通知是指拦截到 Joinpoint 之后所要做的事情就是通知。
通知的类型:前置通知,后置通知,异常通知,最终通知,环绕通知。

Introduction(引介):
引介是一种特殊的通知在不修改类代码的前提下, Introduction 可以在运行期为类动态地添加一些方法或 Field。

Target(目标对象):

代理的目标对象。

Weaving(织入):

是指把增强应用到目标对象来创建新的代理对象的过程。
spring 采用动态代理织入,而 AspectJ 采用编译期织入和类装载期织入。

Proxy(代理):

一个类被 AOP 织入增强后,就产生一个结果代理类。

Aspect(切面):

是切入点和通知(引介)的结合。

maven配置

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.8.13</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.2.3.RELEASE</version>
</dependency>

编写业务层类

public class AccountServiceImpl implements IAccountService {
    @Override
    public void saveAccount() {
        System.out.println("执行了保存");
    }

    @Override
    public void updateAccount(int i) {
        System.out.println("执行了更新");
    }

    @Override
    public int deleteAccount() {
        System.out.println("执行了删除");
        return 0;
    }
}

编写通知类

public class Logger {

    /**
     * 用于打印日志,计划让其在切入点方法执行之前执行
     */
    public void printLog(){
        System.out.println("logger类中的printLog方法开始记录 日志");
    }
}

基于XML的Spring配置

配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/aop
        https://www.springframework.org/schema/aop/spring-aop.xsd">
    <!-- 配置Spring的IoC,把Service对象配置进来 -->
    <bean id="accountService" class="com.rhett.service.impl.AccountServiceImpl"></bean>

    <bean id="logger" class="com.rhett.utils.Logger"></bean>
    <aop:config>
        <!-- 配置切面 -->
        <aop:aspect id="logAdvice" ref="logger">
            <!-- 配置通知的类型,并且建立通知方法和切入点方法的关联 -->
            <aop:before method="printLog" pointcut="execution(public void com.rhett.service.impl.AccountServiceImpl.saveAccount())"></aop:before>
        </aop:aspect>
    </aop:config>
</beans>

Spring 中基于XML的AOP配置步骤
1. 把通知类也交给Spring来管理(配置logger类)
2. 使用aop:config标签表明开始AOP的配置
3. 使用aop:aspect标签表明配置切面
+ id属性: 给切面提供一个唯一标识
+ ref属性:指定通知类bean的id
4. 在aop:aspect标签的内部使用对应标签来配置通知的类型

通知的类型:

  • 前置通知:aop:before
    • method属性:指定一个方法作为前置通知
    • pointcut属性:切入点表达式,用于指定对业务层哪些方法增强
    • pointcut-ref属性:指定aop:pointcut配置的切入点表达式
  • 后置通知: aop:after-returning,在切入点方法正常执行后执行
  • 异常通知:aop:after-throwing,在切入点方法发生异常后执行
  • 最终通知:aop:after,无论是否发生异常,总会最后执行。

切入点表达式的写法:
+ 关键字:execution(表达式)
+ 表达式:访问修饰符 返回值 包名.类名.方法名(参数列表)
+ 全通配写法:* *..*.*(..)
+ 访问修饰符可以省略
+ 返回值可以使用通配符表示任意返回值
+ 包名可以使用通配符表示任意包,但是有几级包,就需要写几个*
+ 包名可以使用..表示当前包及其子包
+ 类名和方法名 都可以使用 * 通配
+ 参数列表:
- 可以直接写数据类型:
- 基本类型直接写名称
- 引用类型写包名.类名的方式
- 可以使用*表示任意类型
- 可以使用..表示有无参数均可
+ 可以使用aop:pointcut来配置复用表达式,可以写在aop:aspect内部只在该切面生效,也可以写在aop:aspect外面对所有切面生效

<aop:pointcut id="pt1" expression="execution(public void com.rhett.service.impl.AccountServiceImpl.saveAccount())"/>
<aop:after method="afterPrintLog" pointcut-ref="pt1"></aop:after>
  • 环绕通知:

环绕通知需要显式地调用切入点方法。

Spring框架为我们提供了一个接口,ProceedingJoinPoint,该接口有一个方法proceed(),此方法就相当于明确调用切入点方法。该接口可以作为环绕通知的方法参数,在程序执行时,spring框架会为我们提供该接口的实现类供我们使用。

编写通知方法:

public Object aroundPrintLog(ProceedingJoinPoint pjp){
    Object rtValue = null;
    try {
        //前置通知...
        Object[] args = pjp.getArgs();//得到方法执行所需的参数
        pjp.proceed(args);
        //后置通知...
        System.out.println("logger类中的aroundPrintLog方法开始记录日志");
    } catch (Throwable throwable) {
        //异常通知...
        throwable.printStackTrace();
    } finally {
        //最终通知...
    }
    return rtValue;
}

配置环绕通知:

<aop:pointcut id="pt1" expression="execution(public void com.rhett.service.impl.AccountServiceImpl.saveAccount())"/>
<aop:around method="aroundPrintLog" pointcut-ref="pt1"/>

基于注解的Spring配置

开启AOP注解:

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

或在配置类中配置:

@EnableAspectJAutoProxy

通知类:

@Component
@Aspect
public class Logger {
    //配置切入点表达式
    @Pointcut("execution(* com.rhett.service.impl.AccountServiceImpl.saveAccount())")
    private void pt1(){}

    /**
     * 前置通知
     */
    @Before("pt1()")
    public void beforePrintLog(){
        System.out.println("logger类中的beforePrintLog方法开始记录日志");
    }

    /**
     * 后置通知
     */
    @AfterReturning("pt1()")
    public void afterReturningLog(){
        System.out.println("logger类中的afterReturningLog方法开始记录日志");
    }

    /**
     * 异常通知
     */
    @AfterThrowing("pt1()")
    public void afterThrowingPrintLog(){
        System.out.println("logger类中的afterThrowingPrintLog方法开始记录日志");
    }

    /**
     * 最终通知
     */
    @After("pt1()")
    public void afterPrintLog(){
        System.out.println("logger类中的afterPrintLog方法开始记录日志");
    }
    @Around("pt1()")
    public Object aroundPrintLog(ProceedingJoinPoint pjp){
        Object rtValue = null;
        try {
            //前置通知...
            Object[] args = pjp.getArgs();//得到方法执行所需的参数
            pjp.proceed(args);
            //后置通知...
            System.out.println("logger类中的aroundPrintLog方法开始记录日志");
        } catch (Throwable throwable) {
            //异常通知...
            throwable.printStackTrace();
        } finally {
            //最终通知...
        }
        return rtValue;
    }
}

原创文章,作者:彭晨涛,如若转载,请注明出处:https://www.codetool.top/article/spring%e4%b9%8baop%e9%85%8d%e7%bd%ae/

发表评论

电子邮件地址不会被公开。