Spring5【六】代理模式及 AOP

10、代理模式

AOP 的底层机制就是动态代理。

代理模式的分类：

静态代理
动态代理

10.1 静态代理

角色分析：

抽象角色 : 一般使用接口或者抽象类来实现
真实角色 : 被代理的角色
代理角色 : 代理真实角色，代理真实角色后 , 一般会做一些附属的操作
客户 : 访问代理对象的人，使用代理角色来进行一些操作

代码步骤：（租房子案例）

接口，抽象角色

// 出租房子
public interface Rent {
    public void rent();
}

真实角色

// 房东
public class Host implements Rent{
    public void rent() {
        System.out.println("房东要出租房子");
    }
}

代理角色

// 中介：帮房东出租房子
public class Proxy implements Rent{

    private Host host; //多用组合，少用继承

    public Proxy(){
    }

    public Proxy(Host host) {
        this.host = host;
    }

    public void rent() {
        seeHouse();
        host.rent();
        hetong();
        fare();
    }
    // 看房
    public void seeHouse(){
        System.out.println("中介带你看房");
    }
    // 签合同
    public void hetong(){
        System.out.println("签租赁合同");
    }
    //收中介费
    public void fare(){
        System.out.println("收中介费");
    }
}

客户端访问代理角色

// 租客，租房的人
public class Client {
    public static void main(String[] args) {
        // 房东要收房子
        Host host = new Host();
//        host.rent();//没有代理时直接访问房东       
        // 代理，中介帮房东租房子，但是代理角色一般会有一些附属操作
        Proxy proxy = new Proxy(host);
        // 不用面对房东，直接找中介租房即可
        proxy.rent();
    }
}

在这个过程中，租客直接接触的就是中介，就如同现实生活中的样子，你看不到房东，但是你依旧租到了房东的房子通过代理，这就是所谓的代理模式，

静态代理模式优缺点：

好处：
- 可以使得真实角色的操作更加纯粹，不用去关注一些公共的事情
- 公共的业务由代理来完成，实现了业务的分工
- 公共业务发生扩展时，方便集中管理
缺点：一个真实角色就会产生一个代理角色，代码量会翻倍，开发效率会变低

既想要静态代理的好处，又不想要静态代理的缺点，所以 , 就有了动态代理 !

加深理解：

创建一个抽象角色，比如平时做的用户业务，抽象起来就是增删改查

public interface UserService {
    public void add();
    public void delete();
    public void update();
    public void query();
}

需要一个真实对象来完成这些增删改查操作

// 真实对象
public class UserServiceImpl implements UserService {
    public void add() {
        System.out.println("增加了一个用户");
    }

    public void delete() {
        System.out.println("删除了一个用户");
    }

    public void update() {
        System.out.println("修改了一个用户");
    }

    public void query() {
        System.out.println("查询了一个用户");
    }

}

需求：需要增加一个日志功能，该怎么实现
- 思路1 ：在实现类上增加代码【麻烦！】
- 思路2：使用代理来做，能够不改变原来的业务情况下，实现此功能就是最好的

设置一个代理类来处理日志，即代理角色

public class UserServiceProxy implements UserService {

    private UserServiceImpl userService;

    public void setUserService(UserServiceImpl userService) {
        this.userService = userService;
    }

    // 日志方法
    public void log(String  msg){
        System.out.println("[debug]使用了" + msg + "方法");
    }
    
    public void add() {
        log("add");
        userService.add();
    }

    public void delete() {
        log("delete");
        userService.delete();
    }

    public void update() {
        log("update");
        userService.update();
    }

    public void query() {
        log("query");
        userService.query();
    }  
}

测试访问类：

public class Client {
    public static void main(String[] args) {
        UserServiceImpl userService = new UserServiceImpl();
//        userService.add();

        UserServiceProxy proxy = new UserServiceProxy();
        proxy.setUserService(userService);
        proxy.add();
    }
}

测试输出

[debug]使用了add方法
增加了一个用户

代理的思想：在不改变原来的代码的情况下，实现了对原有功能的增强，这是AOP中最核心的思想。

10.2 动态代理

动态代理的角色和静态代理的一样
动态代理的代理类是动态生成的，静态代理的代理类是我们提前写好的
动态代理分为两类 : 一类是基于接口动态代理 , 一类是基于类的动态代理
- 基于接口： JDK 动态代理【下面使用】
- 基于类： cglib
- java 字节码实现： javassist

JDK 动态代理

需要了解两个类：Proxy 和 InvocationHandler

InvocationHandler：调用处理程序，并返回一个结果

InvocationHandler 是代理实例的调用处理程序 实现的接口。

每个代理实例都具有一个关联的调用处理程序。对代理实例调用方法时，将对方法调用进行编码并将其指派到它的调用处理程序的 invoke 方法。

Object invoke(Object proxy, Method method, Object[] args)；
//参数
//proxy - 调用该方法的代理实例
//method -所述方法对应于调用代理实例上的接口方法的实例。方法对象的声明类将是该方法声明的接口，它可以是代理类继承该方法的代理接口的超级接口。
//args -包含的方法调用传递代理实例的参数值的对象的阵列，或null如果接口方法没有参数。原始类型的参数包含在适当的原始包装器类的实例中，例如java.lang.Integer或java.lang.Boolean 。
//返回：从代理实例的方法调用返回的值。

Proxy：代理，生成动态代理实例

Proxy 提供用于创建动态代理类和实例的静态方法，它还是由这些方法创建的所有动态代理类的超类。

每个代理实例都有一个关联的调用处理程序 对象，它可以实现接口 InvocationHandler。

newProxyInstance 方法返回一个指定接口的代理类实例

Object Proxy.newProxyInstance(ClassLoader loader, 
                              Class<?>[] interfaces,InvocationHandler h)
//参数:
//loader - 定义代理类的类加载器
//interfaces - 代理类要实现的接口列表
//h - 指派方法调用的调用处理程序 
//返回：一个带有代理类的指定调用处理程序的代理实例，它由指定的类加载器定义，并实现指定的接口

代码实现（之前的租房案例）：

抽象角色和真实角色和之前一样

接口，抽象角色

// 出租房子
public interface Rent {
    public void rent();
}

真实角色

// 房东
public class Host implements Rent{
    public void rent() {
        System.out.println("房东要出租房子");
    }
}

代理角色 ProxyInvocationHandler.class

// 会用这个类自动生成代理类
public class ProxyInvocationHandler implements InvocationHandler{

    // 被代理的接口
    private Rent rent;

    public void setRent(Rent rent) {
        this.rent = rent;
    }

    // 生成得到代理类，重点是第二个参数，获取要代理的抽象角色，之前都是一个角色，现在可以代理一类角色
    public Object getProxy(){
        return Proxy.newProxyInstance(this.getClass().getClassLoader(),
                rent.getClass().getInterfaces(),this);
    }

    // 处理代理实例并返回结果
    // proxy : 代理类 method : 代理类的调用处理程序的方法对象
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        seeHouse();
        // 动态代理本质，就是使用反射机制实现
        Object result = method.invoke(rent, args);
        fare();
        return result;
    }
    
	//看房
    public void seeHouse(){
        System.out.println("中介带你看房子");
    }
    //收中介费
    public void fare(){
        System.out.println("收中介费");
    }
}

客户端

public class Client {
    public static void main(String[] args) {
        // 真实角色
        Host host = new Host();
        // 代理角色的调用处理程序
        ProxyInvocationHandler pih = new ProxyInvocationHandler();
        // 通过调用程序处理角色来处理我们要调用的接口对象（将真实角色放进去）
        pih.setRent(host);
        Rent proxy = (Rent) pih.getProxy(); // 动态生成对应的代理类
        proxy.rent();
    }
}

核心：一个动态代理 , 一般代理某一类业务 , 一个动态代理可以代理多个类，代理的是接口！

动态代理模板

以之前用户业务为例

// 会用这个类自动生成代理类
public class ProxyInvocationHandler implements InvocationHandler{

    // 被代理的接口
    private Object target;

    public void setTarget(Object target) {
        this.target = target;
    }
    
    // 生成得到代理类
    // proxy : 代理类
    // method : 代理类的调用处理程序的方法对象
    public Object getProxy(){
        return Proxy.newProxyInstance(this.getClass().getClassLoader(),
                target.getClass().getInterfaces(),this);
    }

    // 处理代理实例，并返回结果
    // proxy : 代理类
    // method : 代理类的调用处理程序的方法对象
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        log(method.getName());
        Object result = method.invoke(target, args);
        return result;
    }
	// 增加日志功能
    public void log(String msg){
        System.out.println("[debug]执行了"+ msg +"方法");
    }
}

测试：

public class Client {
    public static void main(String[] args) {
        // 真实角色
        UserServiceImpl userService = new UserServiceImpl();
        // 代理角色，不存在
        ProxyInvocationHandler pih = new ProxyInvocationHandler();
        // 设置要代理的对象
        pih.setTarget(userService);
        // 动态生成代理类
        UserService proxy = (UserService) pih.getProxy();
		
        proxy.delete();
    }
}

结果：

[debug]执行了delete方法
删除了一个用户

动态代理的好处：

不仅拥有静态代理的所有好处，还具有以下好处：

一个动态代理类代理的是一个接口，一般就是对应某一类业务
一个动态代理可以代理多个类，只要是实现了同一个接口即可

11、AOP

11.1 AOP 简介

AOP（Aspect Oriented Programming）意为：面向切面编程。

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

Spring 的 AOP 就是将公共的业务（日志 , 安全等）和领域业务结合起来，当执行领域业务时，将会把公共业务加进来，实现公共业务的重复利用，领域业务更纯粹，程序员专注领域业务。

其本质还是动态代理，即 Aop 在不改变原有代码的情况下 , 增加新的功能。

11.2 Aop在Spring中的作用

提供声明式事务；允许用户自定义切面

横切关注点：跨越应用程序多个模块的方法或功能。即是，与我们业务逻辑无关的，但是我们需要关注的部分，就是横切关注点。如日志 , 安全 , 缓存 , 事务等等 ....
切面（ASPECT）：横切关注点被模块化的特殊对象。即，它是一个类。【如 Log 类】
通知（Advice）：切面必须要完成的工作。即，它是类中的一个方法。【如 Log 类中的方法】
目标（Target）：被通知对象。
代理（Proxy）：向目标对象应用通知之后创建的对象。
切入点（PointCut）：切面通知执行的 “地点”的定义。
连接点（JointPoint）：与切入点匹配的执行点。

Spring AOP 中，通过 Advice 定义横切逻辑，Spring 中支持 5 种类型的 Advice：

通知类型	连接点	实现接口
前置通知	方法前	org.springframework.aop.MethodBeforeAdvice
后置通知	方法后	org.springframework.aop.AfterReturningAdvice
环绕通知	方法前后	org.aopalliance.intercept.MethodInterceptor
异常抛出通知	方法抛出异常	org.springframework.aop.ThrowsAdvice
引介通知	类中增加新的方法属性	org.springframework.aop.IntroductionInterceptor

11.3 使用 Spring 实现 AOP

准备工作：

使用AOP织入，需要导入一个依赖包

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.4</version>
</dependency>

Spring 的配置文件中要导入 aop 的约束

<?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:context="http://www.springframework.org/schema/context"
       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/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        https://www.springframework.org/schema/aop/spring-aop.xsd">

    <bean/>......
<beans>

目标业务接口：

public interface UserService {
    public void add();
    public void delete();
    public void update();
    public void query();
}

目标业务类：

public class UserServiceImpl implements UserService{
    public void add() {
        System.out.println("增加了一个用户");
    }
    public void delete() {
        System.out.println("删除了一个用户");
    }
    public void update() {
        System.out.println("修改了一个用户");
    }
    public void query() {
        System.out.println("查询了一个用户");
    }
}

测试类

public class MyTest {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        // 注意：动态代理代理的是接口
        UserService userService = (UserService) context.getBean("userService");
        userService.add();
    }
}

方式一：使用 Spring 的 API 接口实现

编写增强类，要实现通知接口

// 前置增强类
public class Log implements MethodBeforeAdvice {
    // method：要执行的目标对象的方法
    // objects：被调用的方法的参数
    // target：被调用的目标对象
    public void before(Method method, Object[] objects, Object target) throws Throwable {
        System.out.println(target.getClass().getName() + "的" + method.getName() + "被执行了");
    }
}
// 后置增强类
public class AfterLog implements AfterReturningAdvice {
	//returnValue 返回值
    public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
        System.out.println("执行了" + method.getName() + " 方法，返回结果为："+ returnValue);
    }
}

在 Spring 的配置文件中注册，实现 aop 切入

<!--注册bean-->
<bean id="userService" class="com.song.service.UserServiceImpl"/>
<bean id="log" class="com.song.log.Log"/>
<bean id="afterLog" class="com.song.log.AfterLog"/>

<!--方式一：使用原生的 Spring API 接口-->
<!--配置aop，需要导入 aop 的约束-->
<aop:config>
    <!--切入点 expression：表达式，execution(要执行的位置！* * * * *) -->
    <aop:pointcut id="pointcut" expression="execution(* com.song.service.UserServiceImpl.*(..))"/>
    <!--执行环绕增强！-->
    <aop:advisor advice-ref="log" pointcut-ref="pointcut"/>
    <aop:advisor advice-ref="afterLog" pointcut-ref="pointcut"/>
</aop:config>

测试结果

com.song.service.UserServiceImpl的add被执行了
增加了一个用户
执行了add 方法，返回结果为：null

方式二：自定义类来实现 AOP【主要是切面定义】

自定义一个切入类

public class DiyPointCut {
    public void before(){
        System.out.println("=======方法执行前=========");
    }

    public void after(){
        System.out.println("=======方法执行后=========");
    }
}

在 Spring 的配置文件中配置

<bean id="userService" class="com.song.service.UserServiceImpl"/>

<!--方式二：自定义类-->
<bean id="diy" class="com.song.diy.DiyPointCut"/>
<aop:config>
    <!--自定义切面，ref 要引用的类-->
    <aop:aspect ref="diy">
        <!--切入点-->
        <aop:pointcut id="pointcut" expression="execution(* com.song.service.UserServiceImpl.*(..))"/>
        <!--通知-->
        <aop:before method="before" pointcut-ref="pointcut"/>
        <aop:after method="after" pointcut-ref="pointcut"/>
    </aop:aspect>
</aop:config>

测试结果

=======方法执行前=========
增加了一个用户
=======方法执行后=========

方式三：使用注解实现

编写一个注解实现的增强类

// 使用注解方式实现 AOP

@Aspect //标注这个类是一个切面
public class AnnotionPointCut {

    @Before("execution(* com.song.service.UserService.*(..))")
    public void before(){
        System.out.println("=======方法执行前=========");
    }

    @After("execution(* com.song.service.UserService.*(..))")
    public void after(){
        System.out.println("=======方法执行后=========");
    }

    // 在环绕增强中，我们可以给定一个参数，代表我们要获取处理切入的点
    @Around("execution(* com.song.service.UserService.*(..))")
    public void around(ProceedingJoinPoint jp) throws Throwable {
        System.out.println("环绕前");
        // 执行方法
        Object proceed = jp.proceed();
        System.out.println("环绕后");

//        Signature signature = jp.getSignature();// 获得签名，类的信息
//        System.out.println("signature" + signature);

    }
}

Spring 配置

<!--方式三：使用注解实现-->
<bean id="annotationPointCut" class="com.song.diy.AnnotionPointCut"/>
<!--开启注解支持   
	JDK(默认 proxy-target-class="false")  cglib(proxy-target-class="true")
-->
<aop:aspectj-autoproxy proxy-target-class="true"/>

测试结果

环绕前
=======方法执行前=========
增加了一个用户
环绕后
=======方法执行后=========

注意，执行顺序为：环绕前 ----> 方法前 ----> 方法 ----> 环绕后 ----> 方法后

aop:aspectj-autoproxy说明：

通过 aop 命名空间的 <aop:aspectj-autoproxy /> 声明自动为 spring 容器中那些配置 @aspectJ 切面的 bean 创建代理，织入切面。当然，spring 在内部依旧采用 AnnotationAwareAspectJAutoProxyCreator 进行自动代理的创建工作，但具体实现的细节已经被 <aop:aspectj-autoproxy /> 隐藏起来了。
<aop:aspectj-autoproxy /> 有一个 proxy-target-class 属性：
- 默认为 false，表示使用 JDK 动态代理织入增强；
- 当配为 poxy-target-class="true" 时，表示使用 CGLib 动态代理技术织入增强；
- 不过即使 proxy-target-class 设置为 false，如果目标类没有声明接口，则 spring 将自动使用 CGLib 动态代理。