静态代理设计模式

1.为什么需要代理设计模式

在JAVAEE分层开发中Service层对我们最重要.Servlce包含了哪些业务代码呢?

  • 核心功能,代码量比较多:业务运算,DAO调用
  • 额外功能,(附加代码,不属于业务,可有可无,代码量小):事务、日志、性能…

问题:额外功能书写在Service层好不好?

  • Service层的调用角度来说(Controller):需要在Servce层书写额外功能。
  • 软件设计者来说,Service不需要写额外功能。

具体例子房屋中介:
image.png引入一个房屋中介代理类,它的作用就是提供额外功能,调用目标类(原始类)核心功能

2.代理设计模式

概念:通过代理类,为原始类(目标类)增加额外功能
好处:利于原始类(目标类)的维护
名词解释
目标类/原始类:指的是业务类(核心功能—>业务运算、DA0调用)
目标方法/原始方法:目标类中的方法就是原始方法
额外功能/附加功能:日志、事务、性能……

代理开发的核心要素

代理类=目标类+额外功能+原始类实现相同的接口

  1. 房东 --- 目标类
  2. public interface UserService {
  3. m1
  4. m2
  5. }
  6. public UserServiceImpl implements UserServiceImpl {
  7. m1 ---> 业务运算、调用DAO
  8. m2
  9. }
  10. ----------------------------------------------------
  11. 中介 --- 代理类:要实现目标类相同的接口
  12. public UserServiceProxy implements UserService {
  13. m1
  14. m2
  15. }

静态代理的编码

静态代理:为每一个原始类,手工编写一个代理类(.java.class)

  1. public class User {}
  2. public interface UserService {
  3. void register(User user);
  4. boolean login(String name, String password);
  5. }
  6. public class UserServiceImpl implements UserService {
  7. @Override
  8. public void register(User user) {
  9. System.out.println("UserServiceImpl.register 业务运算 + DAO");
  10. }
  11. @Override
  12. public boolean login(String name, String password) {
  13. System.out.println("UserServiceImpl.login 业务运算 + DAO");
  14. return true;
  15. }
  16. }
  17. /**
  18. * 静态代理类编码实现
  19. */
  20. public class UserServiceProxy implements UserService { // 实现原始类相同的接口
  21. private UserService userService = new UserServiceImpl(); // 代理类中必须有原始类
  22. @Override
  23. public void register(User user) {
  24. System.out.println("---log---"); // 额外功能
  25. userService.register(user);
  26. }
  27. @Override
  28. public boolean login(String name, String password) {
  29. System.out.println("---log---"); // 额外功能
  30. return userService.login(name, password);
  31. }
  32. }

静态代理存在的问题
1.静态类文件数量过多,不利于项目管理
UserServiceImpl、UserServiceProxy
OrderServiceImpl、OrderServiceProxy

2.额外功能维护性差,在代理类中修改额外功能比较麻烦

Spring动态代理开发

概念:通过代理类为原始类(目标类)增加额外功能
好处:利于原始类(目标类)的维护

搭建环境开发(引入依赖)

  1. <dependency>
  2. <groupId>org.springframework</groupId>
  3. <artifactId>spring-aop</artifactId>
  4. <version>5.1.14.RELEASE</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.aspectj</groupId>
  8. <artifactId>aspectjrt</artifactId>
  9. <version>1.8.9</version>
  10. </dependency>
  11. <dependency>
  12. <groupId>org.aspectj</groupId>
  13. <artifactId>aspectjweaver</artifactId>
  14. <version>1.8.13</version>
  15. </dependency>

Spring动态代理的开发步骤(5步)

1.创建原始对象(目标对象)

  1. public interface UserService {
  2. void register(User user);
  3. boolean login(String name, String password);
  4. }
  5. public class UserServiceImpl implements UserService {
  6. @Override
  7. public void register(User user) {
  8. System.out.println("UserServiceImpl.register 业务运算 + DAO");
  9. }
  10. @Override
  11. public boolean login(String name, String password) {
  12. System.out.println("UserServiceImpl.login 业务运算 + DAO");
  13. return true;
  14. }
  15. }

2.额外功能MethodBeforeAdvice接口

  1. public class Before implements MethodBeforeAdvice {
  2. /**
  3. * 作用: 把需要运行在原始方法执行之前运行的额外功能, 书写在 before 方法中
  4. */
  5. @Override
  6. public void before(Method method, Object[] objects, Object o) throws Throwable {
  7. System.out.println("---method before advice log---");
  8. }
  9. }

3.定义切入点:额外功能的加入
目的:由程序员根据自己的需要,决定额外功能加入给哪个原始方法(register,login)

  1. <!--切入点:额外功能的加入-->
  2. <!--目的: 由程序员根据自己的需要,决定额外功能加入给哪个原始方法(registerlogin)-->
  3. <!-- 简单的测试:所有方法都做为切入点,都加入额外的功能-->
  4. <aop:config>
  5. <aop:pointcut id="pc" expression="execution(* * (..))"/>
  6. </aop:config>

4.组装(2,3整合)

  1. <beans xmlns="http://www.springframework.org/schema/beans"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns:aop="http://www.springframework.org/schema/aop"
  4. xsi:schemaLocation="http://www.springframework.org/schema/beans
  5. http://www.springframework.org/schema/beans/spring-beans.xsd
  6. http://www.springframework.org/schema/aop
  7. https://www.springframework.org/schema/aop/spring-aop.xsd">
  8. <bean id="userService" class="com.yusael.aop.UserServiceImpl"/>
  9. <!-- 额外功能 -->
  10. <bean id="before" class="com.yusael.aop.Before"/>
  11. <!--切入点:额外功能的加入-->
  12. <!--目的:由程序员根据自己的需要,决定额外功能加入给哪个原始方法(registerlogin)-->
  13. <!-- 简单的测试:所有方法都做为切入点,都加入额外的功能-->
  14. <aop:config>
  15. <aop:pointcut id="pc" expression="execution(* * (..))"/>
  16. <!--表达的含义: 所有的方法 都加入before的额外功能-->
  17. <aop:advisor advice-ref="before" pointcut-ref="pc"/>
  18. </aop:config>
  19. </beans>

5.调用
目的:获得Spring工厂创建的动态代理对象,并进行调用
注意:
1.Spring的工厂通过原始对象的id值获取的是代理对象
2.获得代理对象后,可以通过声明接口类型,进行对象的存醋。

  1. /**
  2. * 用于测试动态代理
  3. */
  4. @Test
  5. public void test1() {
  6. ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("/applicationContext.xml");
  7. UserService userService = (UserService) ctx.getBean("userService");
  8. userService.login("admin", "1234");
  9. userService.register(new User());
  10. }

动态代理细节分析

Spring创建的动态代理类在哪里?

  • Spring框架在运行时,通过动态字节码技术,在JVM创建的,运行在JVM内部,等程序结束后,会后JVM一起消失。

什么是动态字节码技术

  • 通过第三方动态字节码框架,在 JVM 中创建对应类的字节码,进而创建对象,当虚拟机结束,动态字节码跟着消失。

结论:

  • 动态代理不需要定义类文件,都是 JVM 运行过程中动态创建的;所以不会造成静态代理的缺点:类⽂件数量过多,影响项目管理的问题。

image.png
动态代理编程简化代理的开发

  • 在额外功能不改变的前提下,创建其他目标类(原始类)的代理对象时,只需要指定原始(目标)对象即可。

    动态代理使得 额外功能的维护性大大增强

    动态代理开发详解

    额外功能的详解

    MethodBeforeAdvice 分析

    1.MethodBeforeAdvice 接口作用:额外功能运行在原始方法执行之前,进行额外功能操作。
    ```java public class Before implements MethodBeforeAdvice { /**

    • 作用: 把需要运行在原始方法执行之前运行的额外功能, 书写在 before 方法中 *
    • Method: 额外功能所增加给的那个原始方法
    • login
    • register

    • showOrder *
    • Object[]: 额外功能所增加给的那个原始方法的参数
    • String name,String password
    • User

    *

    • Object: 额外功能所增加给的那个原始对象
    • UserServiceImpl

    • OrderServiceImpl */ @Override public void before(Method method, Object[] objects, Object o) throws Throwable { System.out.println(“—-new method before advice log—-“); }

}

  1. <a name="MZ3hh"></a>
  2. ### MethodInterceptor(方法拦截器)
  3. methodinterceptor 接口:额外功能可以根据需要运行在原始方法执行 **前、后、前后**。
  4. - 参数:MethodInvocation:额外功能所增加给的那个原始方法 (login, register)
  5. - 返回值:Object:原始方法的返回值 (没有就返回 null)
  6. - invocation.proceed():原始方法运行
  7. 额外功能运行在原始方法 **之前**:
  8. ```java
  9. public class Around implements MethodInterceptor {
  10. @Override
  11. public Object invoke(MethodInvocation methodInvocation) throws Throwable {
  12. System.out.println("---额外功能运行在原始方法执行之前---");
  13. Object ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值
  14. return ret;
  15. }
  16. }

额外功能运行在原始方法 之后

  1. public class Around implements MethodInterceptor {
  2. @Override
  3. public Object invoke(MethodInvocation methodInvocation) throws Throwable {
  4. Object ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值
  5. System.out.println("---额外功能运行在原始方法执行之后---");
  6. return ret;
  7. }
  8. }

额外功能运行在原始方法 之前、之后

  1. public class Around implements MethodInterceptor {
  2. @Override
  3. public Object invoke(MethodInvocation methodInvocation) throws Throwable {
  4. System.out.println("---额外功能运行在原始方法执行之前---");
  5. Object ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值
  6. System.out.println("---额外功能运行在原始方法执行之后---");
  7. return ret;
  8. }
  9. }

image.png

AOP的底层实现原理

核心问题:
1.AOP如何创建动态代理类?
动态字节码技术

2.Spring工厂如何加工创建代理对象?
通过原始对象的id值,获得的是代理对象

动态代理类的创建

JDK的动态原理(原理+编码)

  • Proxy.newproxyInstance方法参数详解

image.png
image.png

  1. public class TestJDKProxy {
  2. public static void main(String[] args) {
  3. //创建原始对象
  4. UserService userService= new UserServiceimpl();
  5. //2.JDK动态代理
  6. InvocationHandler handler = new InvocationHandler() {
  7. @Override
  8. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  9. System.out.println("---- proxy log ----");
  10. //原始方法运行
  11. Object invoke = method.invoke(userService, args);
  12. System.out.println("...proxy log....");
  13. return invoke;
  14. }
  15. };
  16. UserService userServiceProxy = (UserService)Proxy.newProxyInstance(userService.getClass().getClassLoader(), userService.getClass().getInterfaces(), handler);
  17. userServiceProxy.login("123","456");
  18. }
  19. }

CGlib 的动态代理

CGlib 创建动态代理的原理:通过父子继承关系创建代理对象,原始类作为父类,代理类作为子类,这样既可以保证 2 者方法⼀致,同时在代理类中可以提供新的实现(额外功能+原始方法)。
image.png

  1. public static void main(String[] args) {
  2. //1.创建原始对象
  3. UserService1 userService = new UserService1();
  4. /**
  5. 2. 通过 cglib 方式创建动态代理对象
  6. 对比 jdk 动态代理 ---> Proxy.newProxyInstance(classLoader, interface, invocationHandler);
  7. Enhancer.setClassLoader()
  8. Enhancer.setSuperClass()
  9. Enhancer.setCallBack() ---> MethodInterceptor(cglib)
  10. Enhancer.createProxy() ---> 创建代理对象
  11. */
  12. Enhancer enhancer = new Enhancer();
  13. enhancer.setClassLoader(userService.getClass().getClassLoader());
  14. enhancer.setSuperclass(userService.getClass());
  15. MethodInterceptor methodInterceptor = new MethodInterceptor() {
  16. @Override
  17. public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
  18. System.out.println("额外功能");
  19. Object invoke = method.invoke(userService, objects);
  20. return invoke;
  21. }
  22. };
  23. enhancer.setCallback(methodInterceptor);
  24. UserService1 userServiceProxy = (UserService1)enhancer.create();
  25. userServiceProxy.login("222","34243");
  26. }
  27. }

总结:
1.JDK动态代理
Proxy.newProxyInstance:通过接口创建代理实现类
2.Cglib动态代理
Enhance:通过继承父类创建代理类