本文内容
- Unity 配置示意圖
- Unity 的 XML 架構
- 參考資料
研究配置檔案總是很麻煩,而且很可能因為版本問題,會稍有不同。如果你不确定 Unity 是否支援以及如何支援某個元素,就看下相關文檔,或是看下 Unity 源代碼中的 Unity.Configuration 項目,該項目中每個支援的元素都有一個類。
Unity XML 配置檔案可以用來完成依賴注入的配置,即便不通過配置檔案,也可以通過代碼來完成,它們是等價的。
下載下傳 Unity 3
下面列出用于配置Unity Application Block(Unity)的元素和屬性。配置檔案具有如下 section-handler 聲明:
<configSections>
<section name="unity"
type="Microsoft.Practices.Unity.Configuration.UnityConfigurationSection,
Microsoft.Practices.Unity.Configuration, Version=1.2.0.0,
Culture=neutral, PublicKeyToken=31bf3856ad364e35" />
</configSections>
section-handler 聲明包含配置名稱和處理配置資料的類 Microsoft.Practices.Unity.Configuration.UnityConfigurationSection。
unity 元素
unity 元素指定 Unity Application Block 配置。該元素是必須的。
<unity>
<typeAliases>
...
</typeAliases>
<containers>
<container name="containerOne">
<types>
...
</types>
<instances>
...
</instances>
<extensions>
...
</extensions>
<extensionConfig>
...
</extensionConfig>
</container>
</containers>
</unity>
其具有如下子元素:
- typeAliases
- containers
typeAliases 元素
typeAliases 元素包含可選類型别名的集合,使你可以輕松指定映射(mappings)、生命周期(lifetime)、執行個體(instances)、擴充(extensions),Unity 容器其他配置地方也能進行這些配置。當在擴充點(extensibility points),如 typeConfig 小節和自定義注入值上指定元素類型時,你不能使用類型别名。
該元素唯一可用的子元素是一個 typeAlias 元素的集合。
<typeAliases>
<!-- Lifetime manager types -->
<typeAlias alias="singleton"
type="Microsoft.Practices.Unity.ContainerControlledLifetimeManager,
Microsoft.Practices.Unity" />
<typeAlias alias="external"
type="Microsoft.Practices.Unity.ExternallyControlledLifetimeManager,
Microsoft.Practices.Unity" />
<typeAlias alias="perThread"
type="Microsoft.Practices.Unity.PerThreadLifetimeManager,
Microsoft.Practices.Unity" />
<!-- User-defined type aliases -->
<typeAlias alias="IMyInterface"
type="MyApplication.MyTypes.MyInterface, MyApplication.MyTypes" />
<typeAlias alias="MyRealObject"
type="MyApplication.MyTypes.MyRealObject, MyApplication.MyTypes" />
<typeAlias alias="MyCustomLifetime"
type="MyApplication.MyLifetimeManager, MyApplication.MyTypes" />
</typeAliases>
typeAlias 元素
typeAlias 元素定義一個單獨的别名,你可以在配置的其他地方使用它。
typeAlias 元素的屬性如表所示:
屬性 | 描述 |
alias | 可以在配置的其他地方使用的别名和速記名,指代指定的類型。該屬性是必須的。 |
type | 該别名的類型全名。該屬性是必須的。 |
containers 元素
containers 元素包含 Unity 容器的集合 。唯一的子元素是 container 元素的集合。
container 元素
container 元素包含一個單獨容器的細節。
<container name="containerOne">
<types>
...
</types>
<instances>
...
</instances>
<extensions>
...
</extensions>
<extensionConfig>
...
</extensionConfig>
</container>
container 元素具有如下表的屬性:
name | 容器的名稱。該屬性可選。 |
container 元素具有如下子元素:
- types 元素
- register 元素。看了幾個 Unity 的 XML 配置檔案,貌似 register 元素 和 type 元素(types 元素的子元素)的作用是一樣的,隻是由于版本問題,改變了名字。
- instances 元素
- extensions 元素
- extensionConfig 元素
types 元素包含一個已注冊 type 的集合。types 元素包含如下:
- 包含一系列 type 元素,都是添加的單獨 type;
- 包含描述如何完成注入的規範。
元素的唯一子元素是 type 元素。
type 元素
type 元素定義 Unity 容器的類型映射。如果你指定 name,那麼 name 用于類型映射,否則,為指定類型建立一個預設映射。
你可以為每個映射指定 lifetime 管理。如果沒有顯式配置 lifetime,将執行 transient lifetime。
<types>
<!-- Type mapping with no lifetime — defaults to "transient" -->
<type type="Custom.MyBaseClass" mapTo="Custom.MyConcreteClass" />
<!-- Type mapping using aliases -->
<type type="IMyInterface" mapTo="MyRealObject" />
<!-- Lifetime managers specified using the type aliases -->
<type type="Custom.MyBaseClass" mapTo="Custom.MyConcreteClass">
<lifetime type="singleton" />
</type>
<type type="IMyInterface" mapTo="MyRealObject" name="RealObject">
<lifetime type="external" />
</type>
<type type="IMyInterface" mapTo="MyRealObject" name="RealObject">
<lifetime type="perThread" />
</type>
<!-- Lifetime manager specified using the full type name -->
<!-- Any initialization data specified for the lifetime manager -->
<!-- will be converted using the default type converter -->
<type type="Custom.MyBaseClass" mapTo="Custom.MyConcreteClass">
<lifetime value="sessionKey"
type="MyApplication.MyTypes.MyLifetimeManager,
MyApplication.MyTypes" />
</type>
<!-- Lifetime manager initialization using a custom TypeConverter -->
<type type="IMyInterface" mapTo="MyRealObject" name="CustomSession">
<lifetime type="MyCustomLifetime" value="ReverseKey"
typeConverter="MyApplication.MyTypes.MyTypeConverter,
MyApplication.MyTypes" />
</type>
<!-- type with injection parameters define in configuration -->
<!-- Type mapping using aliases defined above -->
<type type="IMyService" mapTo="MyDataService" name="DataService">
<typeConfig>
<constructor>
<param name="connectionString" parameterType="string">
<value value="AdventureWorks"/>
</param>
<param name="dataService" parameterType="IMyService">
<dependency />
</param>
</constructor>
<property name="MyRealObject" propertyType="IMyInterface" />
<method name="Initialize">
<param name="connectionString" parameterType="string">
<value value="contoso"/>
</param>
<param name="dataService" parameterType="IMyService">
<dependency />
</param>
</method>
</typeConfig>
</type>
</types>
下表列出 type 元素的屬性:
注冊類型時使用。該屬性是可選的。 | |
The source type to configure in the container. The type of the object to map from if this is a mapping registration or the type of the object if this is a singleton registration. Can be a user-defined alias specified in the typeAliases section of the configuration. 該屬性是必須的。 | |
mapTo | The destination type for type mapping. The type of the object to map to if this is a mapping registration. 該屬性是可選的。 |
type 元素具有如下子元素:
- lifetime 元素
- typeConfig 元素
lifetime 元素包含生命周期管理的細節。
<!-- Standard singleton lifetime manager specified using a type alias -->
<type type="Custom.MyBaseClass" mapTo="Custom.MyConcreteClass">
<lifetime type="singleton" />
</type>
<!-- Custom lifetime manager specified using a type alias -->
<!-- and initialized using a custom TypeConverter -->
<type type="Custom.MyBaseClass" mapTo="Custom.MyConcreteClass">
<lifetime type="MyCustomLifetime" value="ReverseKey"
name="CustomSessionLifetime"
typeConverter="MyApplication.MyTypes.MyTypeConverter, MyApplication.MyTypes" />
</type>
下表列出 lifetime 元素的屬性:
注冊生命周期管理時使用的名稱。該屬性是可選的。 | |
The type of the lifetime manager to use for this mapping. Can be a user-defined alias specified in the typeAliases section of the configuration or one of the default aliases singleton or external. 該屬性是必須的。 | |
value | 需要初始化生命周期管理的任何值。該屬性是可選的。 |
typeConverter | The type converter to use to convert the value provided to match the type of the instance. If not specified, the default converter for the specified type is used. Aliases are allowed. 該屬性是可選的。 |
該元素包含如下子元素:
- constructor 元素
- property 元素
- method 元素
(略)
調試程式時,提示不支援該屬性。是以,也略過如下元素:constructor 元素、property 元素、method 元素、param 元素、value 元素、dependency 元素、array 元素。
register 元素
register 元素是任何配置的基本建構塊。它使你能夠為一個類型指定映射和注入配置。如果你指定一個 name,那麼 name 用于類型映射。否則,它會建立一個指定類型的預設映射。你也可以為每個映射指定一個生命周期管理器。如果你沒有為一個類型顯式配置生命周期管理器,那麼它會使用瞬态生命周期管理器(transient lifetime manager)。
下表列出 register 元素的屬性:
The type that is being registered. This is the type that will be requested when calling the Resolve method. 該屬性是必須的。 | |
The name of the registration; if omitted the default registration for the type will be created. 該屬性是可選的。 | |
Type which will actually be created and returned when Resolve is called. This sets up a type mapping. It can be a user-defined alias or one of the default aliases. 該屬性是可選的。 |
下面 XML 文檔說明 register 元素的一般用法:
<container>
<register type="MyService"> ... </register> <!-- Default registration for type MyService -->
<register type="ILogger" mapTo="EventLogLogger" /> <!-- type mapping -->
<register type="ILogger" mapTo="PageAdminLogger" name="emergency" /> <!-- named registration -->
</container>
在運作時注冊類型,使用 RegisterType 方法。下面代碼段在運作時注冊 EventLogLogger 類:
// Register a default (un-named) type mapping with a transient lifetime
// Specify the registered type as an interface or object type
// and the target type you want returned for that type
myContainer.RegisterType<ILogger, EventLogLogger>();
register 元素具有如下子元素:
-
lifetime 元素
constructor 元素
property 元素
instances 元素包含容器中已存在對象執行個體的集合。這些對象都是用 RegisterInstance 方法注冊的。 instances 元素包含一系列添加單獨執行個體的 add 元素。
<instances>
<add name="MyInstance1" type="System.String" value="Some value" />
<add name="MyInstance2" type="System.DateTime" value="2008-02-05T17:50:00" />
</instances>
instances 元素的唯一子元素是 add 元素的集合。
add 元素定義了一個執行個體映射,插入到 Unity 容器中。
下表列出 add 元素的屬性:
The name to use when registering this instance. 該屬性是可選的。 | |
The type of this instance. This attribute is optional. Can be a user-defined alias specified in the typeAliases section of the configuration. If omitted, the assumed type is System.String. | |
A string representation of the desired instance that is used to convert from one instance to another.該屬性是必須的。 | |
The type converter to use to convert the value provided to match the type of the instance. If not specified, the default converter for the specified type is used. 該屬性是可選的。 |
extensions 元素和 extensionConfig 元素
調試程式時,提示不支援該屬性。
interceptors 元素
interceptors 元素包含配置中的攔截器清單,其中包含了一系列的指定單獨攔截器的 interceptor 元素。
interceptor 元素
interceptors 元素中的每個 interceptor 元素指定了一個單獨的攔截器配置。interceptor 元素具有以下子元素:
- key
- default
定義 interceptors 的方式與定義 lifetime 管理一樣。
下表列出 interceptor 元素的屬性:
The name to use when registering this interceptor. This attribute is required only when there are two or more entries for the same interceptor type. | |
The type of the interceptor. 該屬性是必須的。 | |
Value | Any value required to initialize the interceptor. 該屬性是可選的。 |
default 元素
default 子元素設定一個類型的預設攔截器。它具有唯一的 type 屬性。type 屬性指定 interceptor 的類型。
key 元素
interceptor 元素的 key 子元素用于設定指定生成秘鑰的 interceptor。
下表列出 key 元素的屬性:
The name to use when registering the build key. 該屬性是可選的。 | |
The type for the build key. The type of the object to map from if this is a mapping registration or the type of the object if this is a singleton registration. Can be a user-defined alias specified in the typeAliases section of the configuration. 該屬性是必須的。 |
policies 元素
policies 元素包含一系列政策清單,其包含了一系列指定單獨政策的 policy 元素。
下面 XML 例子說明 policies 元素及其子元素。
<policies>
<policy name="foot">
<matchingRules>
<matchingRule name="rule1">
<lifetime type="singleton" />
</matchingRule>
</matchingRules>
<callHandlers>
<callHandler name="handler1" type="GlobalCountCallHandler">
<lifetime type="singleton" />
</callHandler>
<callHandler name="handler2" type="GlobalCountCallHandler">
</callHandler>
</callHandlers>
</policy>
</policies>
policy Element
policies 元素中的每個 policy 元素通過兩個子元素 matchingRules 和 callHandlers 指定一個單獨政策的完成配置。
下表列出 policy 元素的屬性:
The name to use when registering this policy. This attribute is required. | |
The type of the policy. Can be a user-defined alias specified in the typeAliases section of the configuration. The extension must contain a class that can read the contents of the policy configuration. This attribute is required. |
matchingRules 元素
matchingRules 元素包含了一系列政策的比對規則,其中包含了一系列指定單獨比對規則的 matchingRule 元素。matchingRules 元素内的比對規則組合必須為 True才能應用。
matchingRule 元素
matchingRules 元素中的每個 matchingRule 元素指定一個單獨的比對規則的細節。matchingRule 元素具有 injection 和 lifetime 兩個子元素。
下表列出 matchingRule 元素的屬性:
The name by which code in the application block and the configuration tools will refer to this matching rule. | |
The name of the matching rule class, the name of the containing assembly, the version, the culture information, and the public key token. |
matchingRule 元素具有如下子元素:
- injection
- lifetime
lifetime 元素指定隊形的生命周期行為。它具有唯一的 type 屬性,指定生命周期管理。
下面 XML 說明 matchingRule 元素及其子元素。
<matchingRules>
<matchingRule name="rule1">
<lifetime type="singleton" />
</matchingRule>
</matchingRules>
injection 元素
injection 元素描述了如何在 matchingRule 元素的情況下,建立一個指定的元素。它很像 typeConfig 元素,除了 injection 元素配置一個執行個體的注入外,而 typeConfig 是一個擴充點。injection 元素與 typeConfig 的預設情況具有相同的子元素。
callHandlers 元素
callHandlers 元素包含一個政策的調用句柄,其中包含一系列指定單獨調用句柄的 callHandler 元素。
callHandler 元素
callHandlers 元素中的每個 callHandler 元素指定一個單獨調用句柄的細節。callHandler 元素具有 injection 和 lifetime 子元素。
下表列出 callHandler 元素的屬性:
The name by which code in the application block and the configuration tools will refer to this call handler. | |
The type of the callhandler. Can be a user-defined alias specified in the typeAliases section of the configuration. |
ChildcallHandler 元素具有如下子元素:
下面 XML 檔案說明帶 injection 子元素的 callHandler 元素。該例子注入一個屬性。
<callHandlers>
<callHandler name="handler1" type="GlobalCountCallHandler">
<injection>
<constructor>
<param name="name" parameterType="string">
<value value="handler1" />
</param>
</constructor>
<--sets the position of the callhandlers
<-- within the policy handler chain/>
<property name="Order" propertyType="int">
<value value="10" type="int"/>
</property>
</injection>
</callHandler>
</callHandlers>
- Unity Application Block 1.2 - October 2008
- Unity Application Block Methods(RegisterType、Resolve、BuildUp)
- Source Schema for the Unity Application Block
- The Unity Configuration Schema
以上連結雖然不再更新,但還是有一定參考價值。關于最新的 Unity 資訊在 Unity Application Block site