引子 - 實現輕量的 ioc 容器

来源:https://www.cnblogs.com/blogure/archive/2023/01/28/intro-insni.html
-Advertisement-
Play Games

IoC 反轉控制原則也被叫做依賴註入 DI, 容器按照配置註入實例化的對象. 本文將實現一個輕量化的 IoC 容器, 完成對象的實例化和註入, 基於註解不依賴於任何庫. (註解參考 JSR-330) ...


IoC 反轉控制原則也被叫做依賴註入 DI, 容器按照配置註入實例化的對象.

假設 A 的相互依賴關係如下圖, 如何將 A 對象實例化並註入屬性.

本文將實現一個輕量化的 IoC 容器, 完成對象的實例化和註入, 基於註解不依賴於任何庫. (註解參考 JSR-330)

前提 JSR-330

註解 說明
@Inject 標識可註入的欄位
@Named 基於字元串的限定符, 表示需要 IoC 接管的類

JSR-330 遠比前提中提到的更多, 可以看下官方的解釋說明, 這裡只截取了本文目的需要開發的部分.

類定義

按照背景中的依賴關係圖, 先定義出來對象.

@Named("a")
public class A {
	@Inject
	public B b;
	@Inject
	public C c;
	// getter and setter
	// constructor
}

@Named("b")
public class B {
	@Value("hello world!")
	public String name;
	// getter and setter
	// constructor
}

@Named("c")
public class C {
	@Inject
	public A a;
	// getter and setter
	// constructor
}

為了清晰, 這裡省略了構造器和 setter 函數, 這些對於實現是必要的, 如果需要完整代碼可以參照項目 xnuc-insni.

先考慮簡單情況, AB 的相互依賴如何實現.

註解定義

註解定義參照 inject, 這裡只截取了需要的部分.

@Target(FIELD)
@Retention(RUNTIME)
public @interface Inject {}

@Target(TYPE)
@Retention(RUNTIME)
public @interface Named {
	String value() default "";
}

對於簡單類型, 可以提供一個設定的數值, 使用 Val 註解完成.

@Target(FIELD)
@Retention(RUNTIME)
public @interface Value {
	String value() default "";
}

容器定義

容器定義很簡單, 有一個實例的表和類定義的表.

public class Context {
	public HashMap<String, Object> instances; // 實例
	public HashMap<String, Class<?>> defineds; // 類定義
}

獲取類定義

獲取類定義用到反射和註解, 不瞭解相關知識的同學可以先補一下這部分. 如果要獲取類定義, 最簡單的方法就是找到全部類進行類載入. 首先獲取主類載入器, 找到全部 .class 路徑.

Enumeration<URL> resources = Main.class.getClassLoader().getResources(pkg.replace(".", "/"));
File file = new File(resources.nextElement().getFile());

獲取全部包下的全部類, 存在子包的情況, 可以用遞歸或者隊列, 最開始用的隊列, 但是發現隊列對於子包處理時非常複雜的, 需要根據隊列信息維護當前包名. 遞歸的系統棧會幫我們記錄下來自然就不需要我們自己維護了, 選擇遞歸的方式處理子包.

private void subdir(String pkg, File file, List<Class<?>> clzes) throws Exception {
	for (File f : file.listFiles()) {
		if (f.isFile()) { // 退出條件
			String clsName = String.format("%s.%s", pkg, f.getName().substring(0, f.getName().lastIndexOf(".")));
			clzes.add(Class.forName(clsName));
		}
		if (f.isDirectory())
			subdir(String.format("%s.%s", pkg, f.getName()), f, clzes);
	}
}

這裡選擇了參數傳返回值, 更好的方式還是直接內部將 list 構造出來, 返回出去.

拿到全部類後, 將有存在註解的類篩選出來. 放入 Contextdefineds.

for (Class<?> c : clzList) {
	if (c.getAnnotation(Named.class) != null) {
		defineds.put(c.getAnnotation(Named.class).value(), c);
	}
}

此時初始化完畢, 類定義獲取到. 另外, 其實這裡已經可以開始註入了, 但是真實情況下, 如果類定義比較多, 那麼初始化將非常耗時, 如果選擇用到再說的原則, 初始化就會快很.

用到再說

Context#get 用來獲取容器對象, 如果對象還沒有實例化, 就實例化. 實例化 instance 實現比較簡單, 找到定義的 filed 進行 set. 這也解釋了, 為什麼需要無參構造器和 setter. 對於基礎值也可以通過 @Value 主動賦予自定義的數值. 對於 @Inject 直接去 Context#get即可.

private Object instance(Object rto, Class<?> clz) throws Exception {
	for (Field field : clz.getFields()) {
		if (field.getAnnotation(Value.class) != null) {
			PropertyDescriptor descriptor = new PropertyDescriptor(field.getName(), clz);
			descriptor.getWriteMethod().invoke(rto, field.getAnnotation(Value.class).value());
		}
		if (field.getAnnotation(Inject.class) != null) {
			PropertyDescriptor descriptor = new PropertyDescriptor(field.getName(), clz);
			descriptor.getWriteMethod().invoke(rto, get(field.getName()));
		}
	}
	return rto;
}

寫完 instance 的邏輯, get 的邏輯就比較簡單了. 有返回, 沒有實例化.

public Object get(String objName) throws Exception {
	if (instances.get(objName) != null)
		return instances.get(objName);

	if (defineds.get(objName) == null)
		throw new Exception(String.format("objName %s undefined", objName));
	Class<?> clz = defineds.get(objName);
	instances.put(objName, instance(unreadyInstances.get(objName), clz));
	return instances.get(objName);
}

這樣只能解決 AB 的問題, 對於 AC 的問題這樣就會導致註入 A 時發現需要註入 C, 而註入 C 時又要去註入 A, 最終導致迴圈.

依賴迴圈

迴圈依賴解決方法很簡單, 只需要一個表記錄下我現在正在註入 A, 所以 C 註入 A 的時候直接把正在註入的 A 丟給 C 即可.

所以新增 Context 成員 public HashMap<String, Object> unreadyInstances

public class Context {

	public HashMap<String, Object> instances;
	++ public HashMap<String, Object> unreadyInstances;
	public HashMap<String, Class<?>> defineds;
}

註入前先把這個對象扔進去, 註入時如果其他對象有迴圈依賴, Context#get 可以直接返回這個對象.

public Object get(String objName) throws Exception {
	if (instances.get(objName) != null)
		return instances.get(objName);
	++ if (unreadyInstances.get(objName) != null)
	++	return unreadyInstances.get(objName);

	if (defineds.get(objName) == null)
		throw new Exception(String.format("objName %s undefined", objName));
	Class<?> clz = defineds.get(objName);

	++ unreadyInstances.put(objName, clz.getDeclaredConstructor().newInstance());
	instances.put(objName, instance(unreadyInstances.get(objName), clz));
	++ unreadyInstances.remove(objName);

	return instances.get(objName);
}

最終的代碼就是這樣了, 寫個 Main 類, 運行下.

public class Main {
	public static void main(String[] args) throws Exception {
		Context ioc = Context.run(Main.class);
		C c = (C) ioc.get("c");
		System.out.println(c.getA().getB().getName()); // >hello world!
	}
}

全部代碼可以參考 xnuc - insni 喜歡可以幫忙點個 ⭐Star.


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 張建飛是阿裡巴巴高級技術專家,一直在致力於應用架構和代碼複雜度的治理。最近,他在看零售通商品域的代碼。面對零售通如此複雜的業務場景,如何在架構和代碼層面進行應對,是一個新課題。結合實際的業務場景,他沉澱了一套“如何寫複雜業務代碼”的方法論,在此分享給大家,相信同樣的方法論可以複製到大部分複雜業務場景... ...
  • *以下內容為本人的學習筆記,如需要轉載,請聲明原文鏈接 微信公眾號「englyf」https://mp.weixin.qq.com/s/2GFLTstDC7w6u3fTJxflNA 本文大概 1685 個字,閱讀需花 6 分鐘內容不多, 但也花了一些精力如要交流, 歡迎關註我然後評論區留言 謝謝你的 ...
  • 題目描述 運行 C 程式,輸出 100 至 200 之間的質數。 輸入描述 無 輸出描述 輸出 100 至 200 之間的質數,每行輸出一個質數,每個質數前面需要帶有序號。 輸出樣例 解題思路 在《一文解決如何使用 C 語言判斷質數(素數)》一文中,我詳細講解了質數以及如何使用 C 語言判斷質數,本 ...
  • 實現Spring底層機制-02 3.實現任務階段1 3.1知識拓展-類載入器 Java的類載入器有三種: Bootstrap類載入器 對應路徑 jre/lib Ext類載入器 對應路徑 jre/lib/ext App類載入器 對應路徑 classpath classpath 類路徑,就是java.e ...
  • 這篇文章主要討論在RPC框架下如何優雅關閉和啟動服務,包括服務提供方如何通知調用方服務關閉重啟信息,服務提供方如何在關閉後處理現有請求和心情求;服務啟動時,如何實現啟動預熱和延遲暴露。 ...
  • Collection常用方法彙總 Collection公共的方法 Collection是單列結合的祖宗介面,它的方法是所有單列集合都可以繼承使用的。 //把給定元素添加到集合中 public boolean add(E e) //把給定元素從集合中刪除 public boolean remove(E ...
  • 談談你對 Java 平臺的理解?“Java 是解釋執行”,這句話正確嗎? Java 本身是一種面向對象的語言,最顯著的特性有兩個方面,一是所謂的“一處編譯,處處運行”(Write once,run anywhere),能夠非常容易地獲得跨平臺能力;另外就是垃圾收集(GC,Garbage Collec ...
  • 首先我們來嘗試將分片的圖片複原為正常的圖片 這裡是六張切成小細條的圖片,原本是一張大圖的,現在我們用python將他們合併到一塊,題外話圖片來源於中華連環畫,*http://www.zhlhh.com/* 這個網站內有很多優秀的連環畫,而且大部分都是免費,推薦給大家 我的思路是用matlib讀圖片, ...
一周排行
    -Advertisement-
    Play Games
  • 下麵是一個標準的IDistributedCache用例: public class SomeService(IDistributedCache cache) { public async Task<SomeInformation> GetSomeInformationAsync (string na ...
  • 這個庫提供了在啟動期間實例化已註冊的單例,而不是在首次使用它時實例化。 單例通常在首次使用時創建,這可能會導致響應傳入請求的延遲高於平時。在註冊時創建實例有助於防止第一次Request請求的SLA 以往我們要在註冊的時候實例單例可能會這樣寫: //註冊: services.AddSingleton< ...
  • 最近公司的很多項目都要改單點登錄了,不過大部分都還沒敲定,目前立刻要做的就只有一個比較老的項目 先改一個試試手,主要目標就是最短最快實現功能 首先因為要保留原登錄方式,所以頁面上的改動就是在原來登錄頁面下加一個SSO登錄入口 用超鏈接寫的入口,頁面改造後如下圖: 其中超鏈接的 href="Staff ...
  • Like運算符很好用,特別是它所提供的其中*、?這兩種通配符,在Windows文件系統和各類項目中運用非常廣泛。 但Like運算符僅在VB中支持,在C#中,如何實現呢? 以下是關於LikeString的四種實現方式,其中第四種為Regex正則表達式實現,且在.NET Standard 2.0及以上平... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他們的程式記憶體會偶發性暴漲,自己分析了下是非托管記憶體問題,讓我幫忙看下怎麼回事?哈哈,看到這個dump我還是非常有興趣的,居然還有這種游戲幣自助機類型的程式,下次去大玩家看看他們出幣的機器後端是不是C#寫的?由於dump是linux上的程式,剛好win ...
  • 前言 大家好,我是老馬。很高興遇到你。 我們為 java 開發者實現了 java 版本的 nginx https://github.com/houbb/nginx4j 如果你想知道 servlet 如何處理的,可以參考我的另一個項目: 手寫從零實現簡易版 tomcat minicat 手寫 ngin ...
  • 上一次的介紹,主要圍繞如何統一去捕獲異常,以及為每一種異常添加自己的Mapper實現,並且我們知道,當在ExceptionMapper中返回非200的Response,不支持application/json的響應類型,而是寫死的text/plain類型。 Filter為二方包異常手動捕獲 參考:ht ...
  • 大家好,我是R哥。 今天分享一個爽飛了的面試輔導 case: 這個杭州兄弟空窗期 1 個月+,面試了 6 家公司 0 Offer,不知道問題出在哪,難道是杭州的 IT 崩盤了麽? 報名面試輔導後,經過一個多月的輔導打磨,現在成功入職某上市公司,漲薪 30%+,955 工作制,不咋加班,還不捲。 其他 ...
  • 引入依賴 <!--Freemarker wls--> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.30</version> </dependency> ...
  • 你應如何運行程式 互動式命令模式 開始一個互動式會話 一般是在操作系統命令行下輸入python,且不帶任何參數 系統路徑 如果沒有設置系統的PATH環境變數來包括Python的安裝路徑,可能需要機器上Python可執行文件的完整路徑來代替python 運行的位置:代碼位置 不要輸入的內容:提示符和註 ...