SpringAOP

Cikian.

发布于 2023-08-09 19:11:21

1630

发布于 2023-08-09 19:11:21

文章被收录于专栏：Cikian技术站

一、SpringAOP

1. 简介

AOP（Aspect Oriented Programming）面向切面编程，一种编程范式，指导开发者如何组织程序结构 OOP（Object Oriented）面向对象编程
作用：在不改变原始设计的基础上为其进行功能增强
Spring理念：无侵入式编程
SpringAOP本质：代理模式

2. 核心概念

连接点（JoinPoint）：程序执行过程中的任意位置，粒度为执行方法、抛出异常、设置变量等
- 在SpringAOP中，理解为方法的执行
切入点（Pointcut）：匹配连接点的式子
- 在SpringAOP中，一个切入点可以只描述一个具体方法，也可以匹配多个方法
  - 一个具体方法：com.cikian.dao包下的BookDao接口中的无形参无返回值的save方法
  - 匹配多个方法：所有的save方法、所有get开头的方法、所有以Dao结尾的接口中的任意方法、所有带有一个参数的方法等
通知（Advice）：在切入点处执行的操作，也就是共性功能
- 在SpringAOP中，功能最终以方法的形式呈现
通知类：定义通知的类
切面（Aspect）：描述通知与切入点的对应关系

二、入门案例

e.g. 在接口执行前输出当前系统时间

步骤

导入关键坐标

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.4</version>
</dependency>

制作连接点方法（原始操作，Dao接口与实现类）

@Repository
public class BookDaoImpl implements BookDao {
    @Override
    public void save() {
        System.out.println("save book");
    };

    @Override
    public void update() {
        System.out.println("update book");
    };
};

制作共性功能（通知类与通知）

public void before() {
    System.out.println(System.currentTimeMillis());
};

定义切入点

@Pointcut("execution(void com.cikian.dao.BookDao.update())")
private void pt() {
};

说明：切入点定义依托一个不具有实际意义的方法进行，即无参数、无返回值、方法体无实际逻辑

绑定切入点与通知关系（切面）

@Compoent
@Aspect
@Before("pt()")
public void before() {
    System.out.println(System.currentTimeMillis());
};

使用@Compoent注解定义通知类受Spring容器管理，使用@Aspect注解告知Spring将此类以AOP方式处理在Spring配置类中： @Configuration @ComponentScan("com.cikian") c public class SpringConfig { }; 使用@EnableAspectJAutoProxy注解开启Spring对AOP注解驱动支持

三、AOP工作流程

Spring容器启动
读取所有切面配置中的切入点
初始化bean，判定bean对应的类中的方法是否匹配到任意切入点
- 匹配失败，创建对象
- 匹配成功，创建原始对象（目标对象）的代理对象
获取bean执行方法
- 若第3步匹配失败，获取bean，调用方法并执行，完成操作
- 若第3步匹配成功，获取的bean是代理对象时，根据代理对象的运行模式运行原始方法与增强的内容

AOP核心概念

目标对象（Target）：原始功能去掉共性功能对应的类产生的对象，这种对象是无法直接完成最终工作的
代理（Proxy）：目标对象无法直接完成工作，需要对其进行功能回填，通过原始对象的代理对象实现

四、AOP切入点表达式

切入点：要进行增强的方法

切入点表达式：要进行增强的方法的描述方式

1. 语法格式

切入点表达式标准格式： 动作关键字 (访问修饰符返回值包名.类/接口名.方法名(参数) 异常名)，如：

execution(User com.cikian.dao.BookDao.update(int))

其中：

动作关键字：描述切入点的行为动作，例如execution表示执行到指定切入点
访问修饰符：public，可以省略
返回值：User
包名：com.cikian.dao
类/接口名：BookDao
方法名：update()
参数：int
异常名：方法定义中抛出指定异常，可以省略

2.通配符

可以使用通配符描述切入点，快速描述

* ：单个独立的任意符号，可以独立出现，也可以作为前缀或者后缀的通配符出现 execution (public * com.cikian.*.BookDao.find*(*)) 匹配com.cikian包下的任意包中的BookDao类或接口中所有find开头的带有一个参数的方法
.. ：多个连续的任意符号，可以独立出现，常用于简化包名与参数的书写 execution (public User com..UserService.findById (..) 匹配com包下的任意包中的UserService类或接口中所有名称为findByld的方法
+ ：专用于匹配子类类型 execution(* *..*Service+.*(..))

3.书写技巧

所有代码按照标准规范开发，否则以下技巧全部失效

描述切入点通常描述接口，而不描述实现类
访问控制修饰符针对接口开发均采用public描述（可省略访问控制修饰符描述）
返回值类型对于增删改类使用精准类型加速匹配，对于查询类使用 * 通配快速描述
包名书写尽量不使用 .. 匹配，效率过低，常用 * 做单个包描述匹配，或精准匹配
接口名/类名书写名称与模块相关的采用 * 匹配，例如UserService书写成*Service，绑定业务层接口名
方法名书写以动词进行精准匹配，名词采用 * 匹配，例如getByld书写成getBy*，selectAll书写成selectAll
参数规则较为复杂，根据业务方法灵活调整
通常不使用异常作为匹配规侧

五、AOP通知类型

AOP通知描述了抽取的共性功能，根据共性功能抽取的位置不同，最终运行代码时要将其加入到合理的位置

AOP通知共分为5种类型：

前置通知

名称：@Before

类型：方法注解

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前运行

示例：

@Before("pt()")
public void before() {
    System.out.println("before advice");
};

相关属性：value(默认)：切入点方法名，格式为类名.方法名( )

后置通知

名称：@After

类型：方法注解

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法后运行

示例：

@After("pt()")
public void after() {
    System.out.println("after advice");
};

相关属性：value(默认)：切入点方法名，格式为类名.方法名( )

环绕通知（重点）

名称：@Around

类型：方法注解

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前后运行

示例：

@Around("pt()")
public Object aroundSelect(ProceedingJoinPoint pjp) throws Throwable {
    System.out.println("around before advice");
    Object o = pjp.proceed();
    System.out.println("around after advice");
    return o;
};

注意事项

环绕通知必须依赖形参ProceedingJoinPoint才能实现对原始方法的调用，进而实现原始方法调用前后同时添加通知
通知中如果未使用ProceedingJoinPoint对原始方法进行调用将跳过原始方法的执行
对原始方法的调用可以不接收返回值，通知方法设置成void即可，如果接收返回值，必须设定为Object类型
原始方法的返回值如果是void类型，通知方法的返回值类型可以设置成void，也可以设置成Object
由于无法预知原始方法运行后是否会抛出异常，因此环绕通知方法必须抛出Throwable对象
环绕通知中可以对原始方法调用过程中出现的异常进行处理

返回后通知（了解）

名称：@AfterReturning

类型：方法注解

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法正常执行完毕后运行

示例：

@AfterReturning("pt()")
public void afterReturning() {
    System.out.println("afterReturning advice");
};

相关属性：value(默认)：切入点方法名，格式为类名.方法名( )

抛出异常后通知（了解）

名称：@AfterThrowing

类型：方法注解

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法运行抛出异常后执行

示例：

@AfterThrowing("pt()")
public void afterThrowing() {
    System.out.println("afterThrowing advice");
};

相关属性：value(默认)：切入点方法名，格式为类名.方法名( )

六、AOP通知获取数据

1. 获取原始参数

获取切入点方法的参数

JoinPoint：适用于前置、后置、返回后、抛出异常后通知
Proceed]ointPoint：适用于环绕通知

示例：

@Pointcut("execution(* com.cikian.dao.*Dao.find(..))")
public void pt() {
};

@Before("pt()")
public void before(JoinPoint jp) {
    // 获取参数
    Object[] args = jp.getArgs();
    System.out.println(Arrays.toString(args));
};

@After("pt()")
public void after(JoinPoint jp) {
    Object[] args = jp.getArgs();
    System.out.println(Arrays.toString(args));
};

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    Object[] args = pjp.getArgs();
    System.out.println(Arrays.toString(args));
    args[0] = 2;
    return pjp.proceed(args);
};

环绕通知获取参数后，可对参数进行修改后在调用proceed( )方法时将修改后的参数数组作为参数传入

2. 获取原始返回值

获取切入点方法返回值

返回后通知

@AfterReturning(value = "pt()", returning = "ret")
public void afterReturning(JoinPoint jp, Object ret) {
    System.out.println("原始返回值：" + ret);
};

在@AfterReturning(value = "pt()", returning = "ret")注解中，需要另外一个参数returning，值与afterReturning方法的形参名相同。若在afterReturning方法中有多个参数，JoinPoint参数必须放在第一位

环绕通知

proceed( )方法返回值即为原始方法返回值

3. 获取异常

获取切入点方法运行异常信息

抛出异常后通知

@AfterThrowing(value = "pt()", throwing = "e")
public void afterThrowing(JoinPoint jp, Exception e) {
    System.out.println("异常信息："+e);
};

在@AfterThrowing(value = "pt()", throwing = "e")注解中，需要另外一个参数throwing，值与afterThrowing方法的形参名相同。若在afterThrowing方法中有多个参数，JoinPoint参数必须放在第一位

环绕通知

将proceed( )方法使用try…catch…环绕即可对异常信息进行捕获、处理

七、案例

1. 测量业务层接口万次执行效率

AccountService接口：

public interface AccountService {
    void save(Account account);
    void delete(Integer id);
    void update(Account account);
    List<Account> findAll();
    Account findById(Integer id);
};

AccountService接口实现类：

@Service
public class AccountServiceImpl implements AccountService {
    @Autowired
    private AccountDao accountDao;

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

    @Override
    public void delete(Integer id) {
        accountDao.delete(id);
    };

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

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

    @Override
    public Account findById(Integer id) {
        return accountDao.findById(id);
    };
};

AccountDao：

public interface AccountDao {
    @Insert("insert into tb_account(name,money) values(#{name};,#{money};)")
    void save(Account account);

    @Delete("delete from tb_account where id=#{id};")
    void delete(Integer id);

    @Update("update tb_account set name=#{name};,money=#{money}; where id=#{id};")
    void update(Account account);

    @Select("select * from tb_account")
    List<Account> findAll();

    @Select("select * from tb_account where id=#{id};")
    Account findById(Integer id);
};

Account：

public class Account implements Serializable {
    private Integer id;
    private String name;
    private Float money;

    public Integer getId() {
        return id;
    };

    public void setId(Integer id) {
        this.id = id;
    };

    public String getName() {
        return name;
    };

    public void setName(String name) {
        this.name = name;
    };

    public Float getMoney() {
        return money;
    };

    public void setMoney(Float money) {
        this.money = money;
    };

    @Override
    public String toString() {
        return "Account{" +
                "id=" + id +
                ", name=" + name +
                ", money=" + money +
                '};';
    };
};

通知类Advice：

@Component
@Aspect
public class Advice {
    @Pointcut("execution(* com.cikian.service.*Service.*(..))")
    public void pointcut() {
    };

    @Around("pointcut()")
    public void runSpeed(ProceedingJoinPoint pjp) throws Throwable {
        Signature signature = pjp.getSignature();
        String className = signature.getDeclaringTypeName();
        String metName = signature.getName();
        long start = System.currentTimeMillis();
        for (int i = 0; i < 10000; i++) {
            pjp.proceed();
        };
        long end = System.currentTimeMillis();
        System.out.println(className + "接口的" + metName + "方法 " + "运行万次时间为：" + (end - start) + "毫秒");
    };
};

测试类：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringConfig.class)
public class AccountServiceTest {
    @Autowired
    private AccountService accountService;

    @Test
    public void testFindById() {
        accountService.findById(1);
    };

    @Test
    public void testFindAll() {
        accountService.findAll();
    };
};

2. 百度网盘密码数据兼容处理

需求：对百度网盘分享链接输入密码时尾部多输入的空格做兼容处理

分析：

在业务方法执行之前对所有的输入参数进行格式处理—trim()
使用处理后的参数调用原始方法—环绕通知中存在对原始方法的调用

实现：

ResourcesService接口：

public interface ResourcesService {
    boolean openURL(String url,String password);
};

ResourcesService接口实现类：

@Service
public class ResourcesServiceImpl implements ResourcesService {
    @Autowired
    private ResourcesDao resourcesDao;

    @Override
    public boolean openURL(String url, String password) {
        return resourcesDao.readResources(url, password);
    };
};

ResourcesDao接口：

public interface ResourcesDao {
    boolean readResources(String url, String password);
};

ResourcesDao接口实现类：

public class ResourcesDaoImpl implements ResourcesDao {
    @Override
    public boolean readResources(String url, String password) {
        //模拟校验
        return password.equals("abcd");
    };
};

通知类：

@Component
@Aspect
public class DataAdvice {
    @Pointcut("execution(* com.cikian.service.*Service.*(..))")
    private void servicePT() {
    };

    @Around("servicePT()")
    public Object trimString(ProceedingJoinPoint pjp) throws Throwable {
        Object[] args = pjp.getArgs();
        for (int i = 0; i < args.length; i++) {
            if (args[i].getClass().equals(String.class)) {
                args[i] = args[i].toString().trim();
            };
        };

        Object re = pjp.proceed(args);
        return re;
    };
};

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2023-08-05，如有侵权请联系 cloudcommunity@tencent.com 删除

public