每一個基于java的應用程序都有一個共同工作來展示給用戶看到的內容作為工作的應用幾個對象。當編寫一個復雜的Java應用程序,應用程序類應該盡可能獨立其他Java類來增加重復使用這些類,并獨立于其他類別的測試它們,而這樣做單元測試的可能性。依賴注入(或有時稱為布線)有助于粘合這些類在一起,同時保持他們的獨立。
考慮有其中有一個文本編輯器組件的應用程序,要提供拼寫檢查。標準的代碼將看起來像這樣:
1
2
3
4
5
6
|
public class TextEditor { private SpellChecker spellChecker; public TextEditor() { spellChecker = new SpellChecker(); } } |
我們在這里所做的就是創建文本編輯和拼寫檢查之間的依賴性。在控制方案中的反轉,我們反而會做這樣的事情:
1
2
3
4
5
6
|
public class TextEditor { private SpellChecker spellChecker; public TextEditor(SpellChecker spellChecker) { this .spellChecker = spellChecker; } } |
在這里,文本編輯不應該擔心拼寫檢查落實。拼寫檢查器將獨立實施,將提供給文本編輯在文本編輯實例化的時候,這整個過程是由Spring框架的控制。
在這里,我們已經刪除從文本編輯的全面控制,并保持它在其他地方(即XML配置文件)和依賴性(即類拼寫檢查)被注入到類文本編輯通過類構造函數。因此,流程控制已經“倒”通過依賴注入(DI),因為已經有效地委派依賴一些外部系統。
依賴注入的第二種方法是通過文本編輯類,我們將創建拼寫檢查實例的setter方法??,該實例將被用來調用setter方法??來初始化文本編輯的屬性。
因此,DI主要有兩種變體和下面的兩個子章將涵蓋兩者結合實例:
基于構造函數的依賴注入
當容器調用類的構造函數有多個參數,每個代表在其他類中的構造函數依賴關系為基礎的DI來完成。
例子:
下面的例子顯示了一個類文本編輯TextEditor 只能是依賴注入與構造函數注入。
我們使用Eclipse IDE,然后按照下面的步驟來創建一個Spring應用程序:
這里是TextEditor.java文件的內容:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
package com.yiibai; public class TextEditor { private SpellChecker spellChecker; public TextEditor(SpellChecker spellChecker) { System.out.println( "Inside TextEditor constructor." ); this .spellChecker = spellChecker; } public void spellCheck() { spellChecker.checkSpelling(); } } |
下面是另外一個相關的類文件SpellChecker.java內容:
1
2
3
4
5
6
7
8
9
10
11
12
|
package com.yiibai; public class SpellChecker { public SpellChecker(){ System.out.println( "Inside SpellChecker constructor." ); } public void checkSpelling() { System.out.println( "Inside checkSpelling." ); } } |
以下是MainApp.java文件的內容:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
package com.yiibai; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class MainApp { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext( "Beans.xml" ); TextEditor te = (TextEditor) context.getBean( "textEditor" ); te.spellCheck(); } } |
以下是配置文件beans.xml文件里面有配置為基于構造函數的注入:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> <!-- Definition for textEditor bean --> < bean id = "textEditor" class = "com.yiibai.TextEditor" > < constructor-arg ref = "spellChecker" /> </ bean > <!-- Definition for spellChecker bean --> < bean id = "spellChecker" class = "com.yiibai.SpellChecker" > </ bean > </ beans > |
創建源代碼和bean配置文件完成后,讓我們運行應用程序。如果一切順利將打印以下信息:
1
2
3
|
Inside SpellChecker constructor. Inside TextEditor constructor. Inside checkSpelling. |
構造函數的參數解析:
可能有歧義存在,而將參數傳遞給構造函數的情況下有一個以上的參數。要解決這種不確定性,其中的構造器參數在一個bean定義中定義的順序就是這些參數提供給適當的構造函數的順序。請考慮下面的類:
1
2
3
4
5
6
7
|
package x.y; public class Foo { public Foo(Bar bar, Baz baz) { // ... } } |
下面的配置工作正常:
1
2
3
4
5
6
7
8
9
|
<beans> <bean id= "foo" class = "x.y.Foo" > <constructor-arg ref= "bar" /> <constructor-arg ref= "baz" /> </bean> <bean id= "bar" class = "x.y.Bar" /> <bean id= "baz" class = "x.y.Baz" /> </beans> |
讓我們檢查一個更多情況下我們通過不同類型的構造函數。請考慮下面的類:
1
2
3
4
5
6
7
|
package x.y; public class Foo { public Foo( int year, String name) { // ... } } |
容器也可以使用類型匹配與簡單類型,如果你明確地指定使用type屬性的構造函數的參數類型。例如:
1
2
3
4
5
6
7
8
|
<beans> <bean id= "exampleBean" class = "examples.ExampleBean" > <constructor-arg type= "int" value= "2001" /> <constructor-arg type= "java.lang.String" value= "Zara" /> </bean> </beans> |
最后,并通過構造函數參數的最佳方法,使用索引屬性來顯式地指定一個構造器參數的索引。這里的索引是從0開始。例如:
1
2
3
4
5
6
7
8
|
<beans> <bean id= "exampleBean" class = "examples.ExampleBean" > <constructor-arg index= "0" value= "2001" /> <constructor-arg index= "1" value= "Zara" /> </bean> </beans> |
最后需要說明的,如果你傳遞一個引用到一個對象,需要使用<constructor-arg>標簽的ref屬性,如果是直接傳遞一個值,那么應該使用value屬性。
基于setter方法的依賴注入
基于setter DI由容器調用setter方法??對bean調用無參構造器或無參static工廠方法實例化bean之后完成。
這里是TextEditor.java文件的內容:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
package com.yiibai; public class TextEditor { private SpellChecker spellChecker; // a setter method to inject the dependency. public void setSpellChecker(SpellChecker spellChecker) { System.out.println( "Inside setSpellChecker." ); this .spellChecker = spellChecker; } // a getter method to return spellChecker public SpellChecker getSpellChecker() { return spellChecker; } public void spellCheck() { spellChecker.checkSpelling(); } } |
在這里,需要檢查setter方法??的命名約定。設置我們使用setSpellChecker()方法,這是非常類似于Java POJO類的變量的拼寫檢查器。讓我們創造另一個相關的類文件SpellChecker.java,內容如下:
1
2
3
4
5
6
7
8
9
10
11
12
|
package com.yiibai; public class SpellChecker { public SpellChecker(){ System.out.println( "Inside SpellChecker constructor." ); } public void checkSpelling() { System.out.println( "Inside checkSpelling." ); } } |
以下是MainApp.java文件的內容:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
package com.yiibai; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class MainApp { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext( "Beans.xml" ); TextEditor te = (TextEditor) context.getBean( "textEditor" ); te.spellCheck(); } } |
以下是配置文件beans.xml文件里面有配置為基于setter方法??注入:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> <!-- Definition for textEditor bean --> < bean id = "textEditor" class = "com.yiibai.TextEditor" > < property name = "spellChecker" ref = "spellChecker" /> </ bean > <!-- Definition for spellChecker bean --> < bean id = "spellChecker" class = "com.yiibai.SpellChecker" > </ bean > </ beans > |
應該注意在基于構造函數注入和setter注入定義beans.xml文件的差異。唯一的區別是,我們已經使用<constructor-arg>標簽為基于構造函數的注入和的<property>標簽為基于setter注入的<bean>元素內。
需要注意的第二個重要的一點是,如果傳遞一個引用到一個對象,需要使用<property>標簽的ref屬性,如果是直接傳遞一個值,那么應該使用value屬性。
創建源代碼和bean配置文件完成后,讓我們運行應用程序。如果一切順利,這將打印以下信息:
1
2
3
|
Inside SpellChecker constructor. Inside setSpellChecker. Inside checkSpelling. |
采用p名稱空間的XML配置:
如果你有很多的setter方法??則可以很方便地使用p名稱空間的XML配置文件中。讓我們查看他們的區別:
讓我們來用的<property>標簽標準的XML配置文件的例子:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> < bean id = "john-classic" class = "com.example.Person" > < property name = "name" value = "John Doe" /> < property name = "spouse" ref = "jane" /> </ bean > < bean name = "jane" class = "com.example.Person" > < property name = "name" value = "John Doe" /> </ bean > </ beans > |
上面的XML配置可重寫使用 p-namespace如下一個簡潔的方法:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<? 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:p = "http://www.springframework.org/schema/p" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> < bean id = "john-classic" class = "com.example.Person" p:name = "John Doe" p:spouse-ref = "jane" /> </ bean > < bean name = "jane" class = "com.example.Person" p:name = "John Doe" /> </ bean > </ beans > |
在這里,不應該在指定原始值和對空間對象引用的區別。-ref部分表示,這不是直鏈的值,而是一個引用到另一個bean中。