PHP程式碼審計分段講解（12）
阿新 • • 發佈：2020-07-26
目錄
1. 靜態代理設計模式
1.1 為什麼需要代理設計模式
- 在 JavaEE 分層開發開發中，哪個層次對於我們來講最重要？ Service 層
- Service 層中包含了哪些程式碼？
- 核心功能（程式碼量較多）：業務運算，DAO 呼叫
- 額外功n能（附加功能，不屬於業務，可有可無，程式碼量小）：事務、日誌、效能 …
- 額外功能書寫在 Service 層好不好?
- Service 層的呼叫者的角度（Controller)：需要在 Service 層書寫額外功能。
- 軟體設計者：Service 層不需要額外功能。
- 拿現實生活中的例子來做對比，解決方案是 引入一個代理.
img1
1.2 代理設計模式
概念：通過代理類，為原始類（⽬標類）增加額外的功能 好處：利於原始類（目標類）的維護
- 名詞解釋
- 目標類 / 原始類：指的是 業務類 (核心功能 –> 業務運算、DAO呼叫)
- 目標方法 / 原始方法：目標類（原始類）中的方法就是目標方法（原始方法）
- 額外功能 / 附加功能：日誌、事務、效能 …
代理開發的核心要素
- 代理類 = 目標類(原始類) + 額外功能 + 原始類(目標類)實現相同的介面
//房东 --- 目标类 public interface UserService { m1 m2 } public UserServiceImpl implements UserServiceImpl { m1 ---> 业务运算、调用DAO m2 } //---------------------------------------------------- // 中介 --- 代理类：要实现目标类相同的接口 public UserServiceProxy implements UserService { m1 m2 }
1.3 靜態代理編碼
靜態代理：為每⼀個原始類，手工編寫⼀個代理類（.java .class）
public class User {}
public interface UserService { void register(User user); boolean login(String name, String password); }
public class UserServiceImpl implements UserService { @Override public void register(User user) { System.out.println("UserServiceImpl.register 业务运算 + DAO"); } @Override public boolean login(String name, String password) { System.out.println("UserServiceImpl.login 业务运算 + DAO"); return true; } }
/** * 静态代理类编码实现 */ public class UserServiceProxy implements UserService { // 实现原始类相同的接口 private UserService userService = new UserServiceImpl(); // 代理类中必须有原始类 @Override public void register(User user) { System.out.println("---log---"); // 额外功能 userService.register(user); } @Override public boolean login(String name, String password) { System.out.println("---log---"); // 额外功能 return userService.login(name, password); } }
1.4 靜態代理存在的問題
- 靜態類檔案數量過多，不利於專案管理
- UserServiceImpl、UserServiceProxy
- OrderServiceImpl、OrderServiceProxy…
- 額外功能維護性差：在代理類中修改額外功能較為麻煩
2. Spring 動態代理開發
概念：通過代理類為原始類（目標類）增加額外功能 // 好處：利於原始類（目標類）的維護
2.1 搭建開發環境
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-aop</artifactId> <version>5.1.14.RELEASE</version> </dependency> <dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjrt</artifactId> <version>1.8.9</version> </dependency> <dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjweaver</artifactId> <version>1.8.13</version> </dependency>
2.2 Spring 動態代理的開發步驟(5步)
建立原始物件（目標物件）
public interface UserService { void register(User user); boolean login(String name, String password); }
public class UserServiceImpl implements UserService { @Override public void register(User user) { System.out.println("UserServiceImpl.register 业务运算 + DAO"); } @Override public boolean login(String name, String password) { System.out.println("UserServiceImpl.login 业务运算 + DAO"); return true; } }
額外功能 MethodBeforeAdvice 介面
public class Before implements MethodBeforeAdvice { /** * 作用: 把需要运行在原始方法执行之前运行的额外功能, 书写在 before 方法中 */ @Override public void before(Method method, Object[] objects, Object o) throws Throwable { System.out.println("---method before advice log---"); } }
<!-- 额外功能 --> <bean id="before" class="com.yusael.aop.Before"/>
定義 切入點：額外功能的加入 // ⽬的: 由程式設計師根據⾃⼰的需要，決定額外功能加入給哪個原始方法(register、login)
<!--切入点:额外功能的加入--> <!--⽬的: 由程序员根据⾃⼰的需要，决定额外功能加入给哪个原始方法(register、login)--> <!-- 简单的测试：所有方法都做为切入点，都加入额外的功能--> <aop:config> <aop:pointcut id="pc" expression="execution(* * (..))"/> </aop:config>
組裝（2、3 整合）
<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 http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd"> <bean id="userService" class="com.yusael.aop.UserServiceImpl"/> <!-- 额外功能 --> <bean id="before" class="com.yusael.aop.Before"/> <!--切入点:额外功能的加入--> <!--⽬的：由程序员根据⾃⼰的需要，决定额外功能加入给哪个原始方法(register、login)--> <!-- 简单的测试：所有方法都做为切入点，都加入额外的功能--> <aop:config> <aop:pointcut id="pc" expression="execution(* * (..))"/> <!--表达的含义: 所有的方法 都加入before的额外功能--> <aop:advisor advice-ref="before" pointcut-ref="pc"/> </aop:config> </beans>
- 呼叫
- 目的：獲得 Spring 工廠建立的動態代理物件，並進行呼叫
注意 ： Spring 的工廠通過原始物件的 id 值獲得的是代理物件 // 獲得代理物件後，可以通過宣告介面型別，進行物件的儲存
/** * 用于测试动态代理 */ @Test public void test1() { ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("/applicationContext.xml"); UserService userService = (UserService) ctx.getBean("userService"); userService.login("admin", "1234"); userService.register(new User()); }
2.3 動態代理細節分析
- Spring 建立的動態代理類在哪裡？
Spring 框架在執行時，通過動態位元組碼技術，在 JVM 建立的，執行在 JVM 內部，等程式結束後，會和 JVM 一起消失。 - 什麼是 動態位元組碼技術？
通過第三方動態位元組碼框架，在 JVM 中建立對應類的位元組碼，進而建立物件，當虛擬機器結束，動態位元組碼跟著消失。
結論：
- 動態代理不需要定義類檔案，都是 JVM 執行過程中動態建立的；
- 所以不會造成靜態代理的缺點：類⽂件數量過多，影響專案管理的問題。
img2
動態代理程式設計簡化代理的開發
在額外功能不改變的前提下，建立其他目標類（原始類）的代理物件時，只需要指定原始（目標）物件即可。
動態代理使得額外功能的維護性大大增強。
2.4 動態代理開發詳解
- 額外功能的詳解
MethodBeforeAdvice 分析
MethodBeforeAdvice 介面作用：額外功能執行在原始方法執行之前，進行額外功能操作。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---"); } }
- before 方法的 3 個引數在實戰中，該如何使用？
- before 方法的引數，在實戰中，會根據需要進行使用，不⼀定都會用到，也有可能都不用。
2.5 MethodInterceptor（方法攔截器）
methodinterceptor 介面：額外功能可以根據需要執行在原始方法執行 前、後、前後。
- 引數：MethodInvocation：額外功能所增加給的那個原始方法 (login, register)
- 返回值：Object：原始方法的返回值 (沒有就返回 null)
- invocation.proceed()：原始方法執行
額外功能執行在原始方法 之前：
public class Around implements MethodInterceptor { @Override public Object invoke(MethodInvocation methodInvocation) throws Throwable { System.out.println("---额外功能运行在原始方法执行之前---"); Object ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值 return ret; } }
額外功能執行在原始方法 之後：
public class Around implements MethodInterceptor { @Override public Object invoke(MethodInvocation methodInvocation) throws Throwable { Object ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值 System.out.println("---额外功能运行在原始方法执行之后---"); return ret; } }
額外功能執行在原始方法 之前、之後：
public class Around implements MethodInterceptor { @Override public Object invoke(MethodInvocation methodInvocation) throws Throwable { System.out.println("---额外功能运行在原始方法执行之前---"); Object ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值 System.out.println("---额外功能运行在原始方法执行之后---"); return ret; } }
額外功能執行在原始方法丟擲異常的時候：
public class Around implements MethodInterceptor { @Override public Object invoke(MethodInvocation methodInvocation) throws Throwable { Object ret = null; try { ret = methodInvocation.proceed(); // 原始方法运行, 获取原始方法的返回值 } catch (Throwable throwable) { System.out.println("---额外功能运行在原始方法抛异常的时候---"); } return ret; } }
MethodInterceptor 影響原始方法的返回值：
public class Around implements MethodInterceptor { @Override public Object invoke(MethodInvocation methodInvocation) throws Throwable { System.out.println("---log---"); Object ret = methodInvocation.proceed(); return false; } }
2.6 切入點詳解
切入點決定額外功能加入位置（方法）
<!--execution(* * (..)) 匹配了所有方法--> <aop:pointcut id="pc" expression="execution(* * (..))"/>
- execution()：切入點函式
- * *(..)：切入點表示式
2.7 切入點表示式
2.7.1 方法切入點
定义一个方法 public void add（int i, int j） * * ( .. )
* * (..) --> 所有方法 * ---> 修饰符 返回值 * ---> 方法名 () ---> 参数表 .. ---> 对于参数没有要求 (参数有没有，参数有⼏个都行，参数是什么类型的都行)
定義 login 、register 方法作為切入點：
<!-- 定义login作为切入点 --> <aop:pointcut id="pc" expression="execution(* login (..))"/> <!-- 定义register作为切入点 --> <aop:pointcut id="pc" expression="execution(* register (..))"/>
定義方法名為 login 且 有兩個字串型別的引數 作為切入點；
<aop:pointcut id="pc" expression="execution(* login (String,String))"/> <!-- ⾮ java.lang java.lang 包中的类型, 必须要写全限定名 --> <aop:pointcut id="pc" expression="execution(* register (com.yusael.proxy.User))"/> <!-- ..可以和具体的参数类型连用 --> <aop:pointcut id="pc" expression="execution(* login(String, ..))"/> <!-- === login(String), login(String,String), login(String,com.baizhi.edu.proxy.User) -->
精準方法切入點限定
<!-- 修饰符 返回值 包 类.方法(参数) --> <aop:pointcut id="pc" expression="execution(* com.yusael.proxy.UserServiceImpl.login(..))"/> <aop:pointcut id="pc" expression="execution(* com.yusael.proxy.UserServiceImpl.login(String, String))"/>
2.7.2 類切入點
指定 特定類作為切入點(額外功能加入的位置) ，這個類中的所有方法，都會加上對應的額外功能。
語法1
<!-- 类中所有的方法加入了额外功能 --> <aop:pointcut id="pc" expression="execution(* com.yusael.proxy.UserServiceImpl.*(..))"/>
語法2
<!-- # 忽略包 --> <!-- 1. 类只存在一级包 --> <aop:pointcut id="pc" expression="execution(* *.UserServiceImpl.*(..))"/> <!-- 2. 类存在多级包 --> <aop:pointcut id="pc" expression="execution(* *..UserServiceImpl.*(..))"/>
2.7.3 包切入點（實戰中用的多）
指定 包作為額外功能加入的位置 ，自然包中的所有類及其方法都會加入額外的功能。