Spring中常見的設計模式——代理模式
一、代理模式的應用場景
生活中的中介，黃牛，等一系列幫助甲方做事的行為，都是代理模式的體現。代理模式（Proxy Pattern）是指為題物件提供一種代理，以控制對這個物件的訪問。代理物件在客戶端和目標物件之間起到中介作用，代理模式屬於結構型設計模式。使用代理模式主要有兩個目的：一是保護目標物件，二是增強目標物件。客戶端呼叫代理物件的方法，同時也呼叫被代理物件的方法，但是會在代理物件前後增加一些處理程式碼，在程式碼中，一般代理會被理解為程式碼增強，實際上就是在原始碼邏輯前後增加一些程式碼邏輯。代理模式屬於結構型模式，分為靜態代理和動態代理。
二、靜態代理
來看一個實際業務場景：在分散式業務場景中，通常會對資料庫進行分庫分表，可能需要配置多個數據源，通常會設定資料來源路由來動態切換資料來源。下面是實現過程：
/**
* 訂單類
*/
@Data
public class Order {
private Object orderInfo;
private Long createTime;
private String id;
}
/**
* 持久層
*/
@Compoment
public class OrderDao {
public int insert(Order order) {
System.out.println("OrderDao 建立 Order 成功！");
return 1;
}
}
public interface IOrderService {
int createOrder(Order order);
}@Service
public class OrderService implements IOrderService {
private OrderDao orderDao;
@Override
public int createOrder(Order order) {
return 0;
}
}
接下來使用靜態代理，主要完成功能：根據訂單建立時間自動按年進行分庫。根據開閉原則，我們修改原來寫好的程式碼邏輯，通過代理物件完成。先建立資料來源路由物件，使用ThredLocal的單利實現DynamicDataSoureEntry類：
/**
* 動態切換資料來源
*/
public class DynamicDataSoureEntry {
//預設資料來源
public final static String DEFAULT_SOURCE = null;
private final static ThreadLocal<String> local = new ThreadLocal<>();
//清空資料來源
public static void clear() {
local.remove();
}
//獲取當前正在使用的資料來源名字
public static String get() {
return local.get();
}
//還原當前切換的資料來源
public static void restore() {
local.set(DEFAULT_SOURCE);
}
//設定一直名字的資料來源
public static void set(String source) {
local.set(source);
}
//根據年份動態設定資料來源
public static void set(int year) {
local.set("DB_" + year);
}
}建立切換資料來源的代理類OrderServiceSaticProxy：
public class OrderServiceStaticProxy implements IOrderService {
private SimpleDateFormat yearFormat = new SimpleDateFormat("yyyy");
private IOrderService orderService;
@Override
public int createOrder(Order order) {
before();
Long time = order.getCreateTime();
Integer dbRouter = Integer.valueOf(yearFormat.format(new Date(time)));
System.out.println("靜態代理類自動分配到[DB_]" + dbRouter + "]資料來源處理資料");
DynamicDataSoureEntry.set(dbRouter);
orderService.createOrder(order);
after();
return 0;
}
private void before() {
System.out.println("Proxy before method.");
}
private void after() {
System.out.println("Proxy after method.");
}
}
三、動態代理
動態代理和靜態代理的基本思路是一致的，只不過動態代理功能更強大，隨業務的擴充套件性更強。
1.JDK實現方式（必須實現介面）
上面的例子改為動態代理：
public class OrderServiceDynamicProxy implements InvocationHandler {
private SimpleDateFormat yearFormat = new SimpleDateFormat("yyyy");
private Object target;
public Object getInstance(Object target) {
this.target = target;
Class<?> clazz = target.getClass();
//目標類必須要實現介面
return Proxy.newProxyInstance(clazz.getClassLoader(), clazz.getInterfaces(), this);
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
before(args[0]);
return null;
}
private void before(Object target) {
try {
System.out.println("Proxy before method.");
Long time = (Long) target.getClass().getMethod("getCreateTime").invoke(target);
Integer dbRouter = Integer.valueOf(yearFormat.format(new Date(time)));
System.out.println("靜態代理類自動分配到[DB_]" + dbRouter + "]資料來源處理資料");
DynamicDataSoureEntry.set(dbRouter);
after();
} catch (Exception e) {
e.printStackTrace();
}
}
private void after() {
System.out.println("Proxy after method.");
}
}
使用動態代理之後，不僅能實現Order的資料來源動態路由，還可以實現其他任何類的資料來源路由。
JDK代理是如何實現的呢？JDK動態代理採用位元組重組，重新生成物件來代替原始物件，以達到動態代理的目的。動態代理生成物件的步驟如下：
- 獲取被代理物件的引用，並且獲取它的所有介面，通過反射獲得。
- JDK動態代理類重新生成一個新的類，同時新的類要實現被代理類實現的所有介面。
- 動態生成Java程式碼，新加的業務邏輯方法有一定的邏輯程式碼呼叫（在程式碼中體現）。
- 編譯新生成的Java程式碼 .class檔案。
- 重新載入到JVM執行。
2.CGLib代理呼叫API及原理分析
public class CGLibTest implements MethodInterceptor {
public Object getInstance(Class<?> clazz) throws Exception {
Enhancer enhancer = new Enhancer();
//要把哪個設定為即將生成的新類的父類
enhancer.setSuperclass(clazz);
enhancer.setCallback(this);
return enhancer.create();
}
@Override
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
before();
Object object = methodProxy.invokeSuper(o, objects);
after();
return object;
}
private void before() {
System.out.println("before");
}
private void after() {
System.out.println("after");
}
}
CGLib代理的目標物件不需要事先任何介面，它是通過動態整合目標物件實現動態代理的。CGLib代理執行代理方法的效率之所以比JDK高，是因為CGLib採用了FastClass機制：為代理類和被代理類各生成一個類，這個類會為代理類或被代理類的方法分配一個index（int型別）;這個index當作一個入參，FastClass 就可以直接定位要呼叫的方法並直接進行呼叫，省去了反射呼叫，所以呼叫效率比JDK代理通過反射呼叫高。FastClass並不是跟代理類一起生成的，而是在第一次執行MethodProxy的invoke()或invokeSuper()方法時產生並放在快取中的。
3.CGLib和JDK動態代理對比
- JDK動態代理實現了被代理物件的介面，CGLib代理繼承了被代理物件。
- JDK動態代理和CGLib代理在執行期生成位元組碼，JDK動態代理直接寫Class位元組碼，CGLib代理使用ASM框架（位元組碼操控框架）寫Class位元組碼，CGLib代理實現更復雜，生成代理類比JDK動態代理效率低。
- JDK動態代理呼叫代理方法是通過反射機制呼叫的，CGLib代理是通過FastClass機制直接呼叫方法的，CGLib代理的執行效率更高。
4.代理模式與Spring
1.代理模式在Spring原始碼中的應用
先看ProxyFactoryBean核心方法getObject()
public Object getObject() throws BeansException {
this.initializeAdvisorChain();
if (this.isSingleton()) {
return this.getSingletonInstance();
} else {
if (this.targetName == null) {
this.logger.warn("Using non-singleton proxies with singleton targets is often undesirable. Enable prototype proxies by setting the 'targetName' property.");
}
return this.newPrototypeInstance();
}
}
在getObject()方法中，主要呼叫getSingletonInstance()和newPrototypeInstance()。在Spring的配置中如果不做任何配置，那麼Spring代理生成的Bean都是單例物件。如果修改scope,則每次建立新原型物件。newPrototypeInstance()裡面的邏輯比較複雜，後續再做研究。Spring利用動態代理實現AOP時有兩個非常重要的類：JDKDynamicAopProxy類和CGLibAopProxy類。
2.Spring中的代理選擇原則
- 當Bean有實現介面時，Spring就會用JDK動態代理
- 當Bean沒有實現介面時，Spring會選擇CGLib代理
- Spring可以通過配置強制使用CGLib代理，只需要在配置中加入<aop:aspectj-autoproxy roxy-target-clas="true">
四、靜態代理和動態代理的本質區別
- 靜態代理只能通過手動完成代理操作，如果被代理類增加新方法，代理類需要同步增加，違背開閉原則。
- 動態代理採用在執行時動態生成程式碼的方式，取消了被代理類的擴充套件限制，遵循開閉原則。
- 若動態代理要對目標類的增強邏輯進行擴充套件，結合策略模式，只需要新增策略類便可完成，無須修改代理類的程式碼。
五、代理模式的優缺點
優點：
- 代理模式將代理物件與真是被呼叫目標物件分離。
- 在一定程度上降低了系統的耦合性。擴充套件性好。
- 可以起到保護目標物件的作用。
- 可以增強目標物件的功能。
缺點：
- 代理模式會造成系統設計中類的數量增加。
- 在客戶端和目標物件中增加一個代理物件，會導致請求處理速度變慢。
- 增加了系統的複雜度。