注解方式使用AOP

1. 概念

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

通俗点来讲，就是将代码中共用的模块抽取出来写成aop，通过配置的方式在指定的方法前后执行。

比如说需要在很多的方法前后打印日志。或者在方法前需要进行对称解密，秘钥在另一个微服务中。此时将这些公共的方法抽取出来，并通过配置告知spring需要在哪些方法的前/后执行。

1.1 主要功能

日志记录，性能统计，安全控制，事务处理，异常处理等等。

1.2 操作术语

• Aspect(切面)：把增强应用到具体方法上面，过程就称为切面
• Joinpoint(连接点)：类里面可以被增强的方法，这些方法成为连接点
• Pointcut(切入点)：在类里面可以有很多方法被增强，比如实际操作中，只是增强了类里面的add方法和update方法，实际增强的方法被成为切入点
• Advice(通知/增强)：增强的逻辑，称谓增强，比如扩展日志功能，这个日志功能成为增强

术语	注解	执行时间点
前置通知	@Before	在方法之前执行
后置通知	@After	在方法之后执行
异常通知	@AfterThrowing	方法出现异常时执行
最终通知	@AfterReturning	在方法返回后执行
环绕通知	@Around	在方法之前和之后执行

2. 使用

所需依赖

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

示例：假如说现在controller已经写好了两个类，每个类中均有一个接口

根据姓名获取电话接口

@RestController
public class UserController {

    /**
     * 根据姓名获取用户电话
     * @return
     */
    @RequestMapping(value = "/get/user/tel", method = RequestMethod.GET)
    public String getUserTel(String userName) {
        return "16666666666";
    }
}

根据商品名称获取数量接口

@RestController
public class CommodityController {

    /**
     * 根据商品名称获取数量
     * @param commodityName 商品名称
     * @return
     */
    @RequestMapping("/commodity/counts")
    public String getCommodityCounts(String commodityName) {
        return "100";
    }

}

此时需要在每个方法中打印入参，这时候需要用AOP在每个方法执行前打印参数

AOP类

@Aspect
@Component
public class LogAspect {

    @Before("execution(* com.yyhd.javap.aopcontroller.*.*(..))")
    public void  logAspect(JoinPoint joinPoint) {
        System.out.println(joinPoint.getSignature().getName() + "收到的参数为" + Arrays.toString(joinPoint.getArgs()));
    }

}

控制台测试结果

getUserTel收到的参数为[123456]
getCommodityCounts收到的参数为[矿泉水]

2.1 aop execution表达式

标识符	含义
execution()	表达式主体
第一个"*"符号	表示返回值的类型任意
com.yyhd.javap.aopcontroller	AOP所切的服务的包名，即需要进行横切的业务类
包名后面的"."	表示当前包及子包
第二个"*"	表示类名，*即所有的类
.*(…)	表示任何方法名，括号表示参数，两个点标识任何参数类型

接下来介绍几个实际中常用的匹配方法

2.1.1 通过方法名定义切入点

• 匹配所有getCommodity开头的方法

execution(* getCommodity*(..))

• 匹配指定包下的所有getCommodity开头的方法

execution(* com.yyhd.javap.aopcontroller..getCommodity*(..))

2.1.2 通过类定义切入点

execution(* com.yyhd.javap.aopcontroller.CommodityAopController.*(..))

2.1.3 通过包定义切入点

• 匹配service包中所有的方法

execution(* com.yyhd.javap.aopcontroller.*.*(..))

• 匹配service包及子包中所有的方法

execution(* com.yyhd.javap.aopcontroller..*.*(..))

2.1.4 通过方法入参定义切入点

假如一个类中重载两个方法

@RestController
public class CommodityAopController {

    @RequestMapping("/commodity/counts")
    public String getCommodityCounts(String commodityName) {
        return "100";
    }

    @RequestMapping("/commodity/counts2")
    public String getCommodityCounts (String commodityName, String abc) {
        return "";
    }

}

此时需要匹配入参为两个String类型的方法，则通过如下方式进行匹配

execution(* com.yyhd.javap.aopcontroller.CommodityAopController.getCommodityCounts(String, String))

匹配第一个入参为String，第二个入参为任意类型

execution(* com.yyhd.javap.aopcontroller.CommodityAopController.getCommodityCounts(String, *))

匹配第一个入参为String，后面可以有任意个入参且入参类型不限

execution(* com.yyhd.javap.aopcontroller.CommodityAopController.getCommodityCounts(String, ..))

匹配目标类中getCommodityCounts()方法，方法拥有一个入参，且入参是Object类型或该类的子类

execution(* com.yyhd.javap.aopcontroller.CommodityAopController.getCommodityCounts(Object+))

3. 通过自定义注解方式切面

实际项目中的包肯定比较多且杂乱，大多数都是接手别人之前写过的代码，接下来介绍一种自定义注解的方式来进行切面

先看一下最后的目录结构

首先自定义切面注解

@Documented//说明该注解将被包含在javadoc中
@Retention(RetentionPolicy.RUNTIME)// 注解会在class字节码文件中存在，在运行时可以通过反射获取到
@Target({ElementType.METHOD, ElementType.PARAMETER})//@Target：定义注解的作用目标，方法和方法参数
@Inherited//说明子类可以继承父类中的该注解
public @interface SysLog {
}

接下来定义切面

@Aspect
@Component
public class LogAspect {

    @Pointcut("@annotation(com.yyhd.javap.aop.SysLog)")
    public void sysLog() {}

    @Before("sysLog()")
    public void  logAspect(JoinPoint joinPoint) {
        System.out.println(joinPoint.getSignature().getName() + "收到的参数为" + Arrays.toString(joinPoint.getArgs()));
    }

}

接下来就在切入点加上注解即可，此时请求方法1就会打印日志，方法2不会

@RestController
public class CommodityAopController {

    @SysLog
    @RequestMapping("/commodity/counts")
    public String getCommodityCounts(String commodityName) {
        return "100";
    }

    @RequestMapping("/commodity/counts2")
    public String getCommodityCounts (String commodityName, String abc) {
        return "";
    }

}