.NET 用 Unity 依赖注入——概述注册和解析类型（1）

本文内容Unity 配置示意图Unity 的xml架构参考资料研究配置文件总是很麻烦，而且很可能因为版本问题，会稍有不同。如果你不确定 Unity 是否支持以及如何支持某个元素，就看下相关文档，或是看下 Unity 源代码中的 Unity.Configuration 项目，该项目中每个支持的元素都有一个类。

Unity XML 配置文件可以用来完成依赖注入的配置，即便不通过配置文件，也可以通过代码来完成，它们是等价的。

下载 Unity 3Unity 配置示意图

Unity 的 XML 架构下面列出用于配置UnityapplicationBlock（Unity）的元素和属性。配置文件具有如下 section-handler 声明：

<sectionname="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>

<containername="containerOne">

<types>

...

</types>

...

</instances>

...

</extensions>

...

</extensionConfig>

</container>

</containers>

</unity>

其具有如下子元素：

typeAliasescontainerstypeAliases 元素typeAliases元素包含可选类型别名的集合，使你可以轻松指定映射（mappings）、生命周期（lifetime）、实例（instances）、扩展（extensions），Unity 容器其他配置地方也能进行这些配置。当在扩展点（extensibility points），如typeConfig小节和自定义注入值上指定元素类型时，你不能使用类型别名。

该元素唯一可用的子元素是一个typeAlias元素的集合。

<typeAliasalias="singleton"

type="Microsoft.Practices.Unity.ContainerControlledLifetimeManager,

Microsoft.Practices.Unity"/>

<typeAliasalias="external"

type="Microsoft.Practices.Unity.ExternallyControlledLifetimeManager,

Microsoft.Practices.Unity"/>

<typeAliasalias="perThread"

type="Microsoft.Practices.Unity.PerThreadLifetimeManager,

Microsoft.Practices.Unity"/>

<typeAliasalias="IMyInterface"

type="MyApplication.MyTypes.MyInterface, MyApplication.MyTypes"/>

<typeAliasalias="MyRealObject"

type="MyApplication.MyTypes.MyRealObject, MyApplication.MyTypes"/>

<typeAliasalias="MyCustomLifetime"

type="MyApplication.MyLifetimeManager, MyApplication.MyTypes"/>

</typeAliases>

typeAlias 元素typeAlias元素定义一个单独的别名，你可以在配置的其他地方使用它。

typeAlias 元素的属性如表所示：

属性

描述

alias

可以在配置的其他地方使用的别名和速记名，指代指定的类型。该属性是必须的。

type

该别名的类型全名。该属性是必须的。

containers 元素containers元素包含 Unity 容器的集合。唯一的子元素是 container 元素的集合。

container 元素container元素包含一个单独容器的细节。

<containername="containerOne">

<types>

...

</types>

...

</instances>

...

</extensions>

...

</extensionConfig>

</container>

container元素具有如下表的属性：

属性

描述

name

容器的名称。该属性可选。

container元素具有如下子元素：

types 元素register 元素。看了几个 Unity 的 XML 配置文件，貌似register元素和type元素（types元素的子元素）的作用是一样的，只是由于版本问题，改变了名字。instances 元素extensions 元素extensionConfig 元素types 元素

types元素包含一个已注册type的集合。types 元素包含如下：

包含一系列 type元素，都是添加的单独type；包含描述如何完成注入的规范。元素的唯一子元素是type元素。

type 元素type元素定义 Unity 容器的类型映射。如果你指定name，那么name用于类型映射，否则，为指定类型创建一个默认映射。

你可以为每个映射指定lifetime管理。如果没有显式配置lifetime，将执行transient lifetime。

<types>

<typetype="Custom.MyBaseClass"mapTo="Custom.MyConcreteClass"/>

<typetype="IMyInterface"mapTo="MyRealObject"/>

<typetype="Custom.MyBaseClass"mapTo="Custom.MyConcreteClass">

<lifetimetype="singleton"/>

</type>

<typetype="IMyInterface"mapTo="MyRealObject"name="RealObject">

<lifetimetype="external"/>

</type>

<typetype="IMyInterface"mapTo="MyRealObject"name="RealObject">

<lifetimetype="perThread"/>

</type>

<typetype="Custom.MyBaseClass"mapTo="Custom.MyConcreteClass">

<lifetimevalue="sessionKey"

type="MyApplication.MyTypes.MyLifetimeManager,

MyApplication.MyTypes"/>

</type>

<typetype="IMyInterface"mapTo="MyRealObject"name="CustomSession">

<lifetimetype="MyCustomLifetime"value="ReverseKey"

typeConverter="MyApplication.MyTypes.MyTypeConverter,

MyApplication.MyTypes"/>

</type>

<typetype="IMyService"mapTo="MyDataService"name="DataService">

<paramname="connectionString"parameterType="string">

<valuevalue="AdventureWorks"/>

</param>

<paramname="dataService"parameterType="IMyService">

</param>

</constructor>

<propertyname="MyRealObject"propertyType="IMyInterface"/>

<methodname="Initialize">

<paramname="connectionString"parameterType="string">

<valuevalue="contoso"/>

</param>

<paramname="dataService"parameterType="IMyService">

</param>

</method>

</typeConfig>

</type>

</types>

下表列出type元素的属性：

属性

描述

name

注册类型时使用。该属性是可选的。

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 元素lifetime元素包含生命周期管理的细节。

<typetype="Custom.MyBaseClass"mapTo="Custom.MyConcreteClass">

<lifetimetype="singleton"/>

</type>

<typetype="Custom.MyBaseClass"mapTo="Custom.MyConcreteClass">

<lifetimetype="MyCustomLifetime"value="ReverseKey"

name="CustomSessionLifetime"

typeConverter="MyApplication.MyTypes.MyTypeConverter, MyApplication.MyTypes"/>

</type>

下表列出lifetime元素的属性：

属性

描述

name

注册生命周期管理时使用的名称。该属性是可选的。

type

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. 该属性是可选的。

typeConfig 元素该元素包含如下子元素：

constructor 元素property 元素method 元素（略）

调试程序时，提示不支持该属性。因此，也略过如下元素：constructor 元素、property 元素、method 元素、param 元素、value 元素、dependency 元素、array 元素。

register 元素register元素是任何配置的基本构建块。它使你能够为一个类型指定映射和注入配置。如果你指定一个 name，那么 name 用于类型映射。否则，它会创建一个指定类型的默认映射。你也可以为每个映射指定一个生命周期管理器。如果你没有为一个类型显式配置生命周期管理器，那么它会使用瞬态生命周期管理器（transient lifetime manager）。

下表列出 register 元素的属性：

属性

描述

type

The type that is being registered. This is the type that will be requested when calling the Resolve method. 该属性是必须的。

name

The name of the registration; if omitted the default registration for the type will be created. 该属性是可选的。

mapTo

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元素的一般用法：

<registertype="MyService">...</register>

<registertype="ILogger"mapTo="EventLogLogger"/>

<registertype="ILogger"mapTo="PageAdminLogger"name="emergency"/>

</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>();

lifetime 元素

constructor 元素

property 元素

method 元素instances 元素instances元素包含容器中已存在对象实例的集合。这些对象都是用RegisterInstance方法注册的。instances元素包含一系列添加单独实例的 add 元素。

<addname="MyInstance1"type="System.String"value="Some value"/>

<addname="MyInstance2"type="System.DateTime"value="2008-02-05T17:50:00"/>

</instances>

instances元素的唯一子元素是add元素的集合。

add元素定义了一个实例映射，插入到 Unity 容器中。

下表列出add元素的属性：

属性

描述

name

The name to use when registering this instance. 该属性是可选的。

type

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.

value

A string representation of the desired instance that is used to convert from one instance to another.该属性是必须的。

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. 该属性是可选的。

extensions 元素和 extensionConfig 元素（略）

调试程序时，提示不支持该属性。

interceptors 元素interceptors元素包含配置中的拦截器列表，其中包含了一系列的指定单独拦截器的interceptor元素。

interceptor 元素

interceptors元素中的每个interceptor元素指定了一个单独的拦截器配置。interceptor元素具有以下子元素：

keydefault定义interceptors的方式与定义 lifetime 管理一样。

下表列出 interceptor 元素的属性：

属性

描述

name

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.

type

The type of the interceptor. 该属性是必须的。

typeConverter

Value

Any value required to initialize the interceptor. 该属性是可选的。

default 元素default子元素设置一个类型的默认拦截器。它具有唯一的type属性。type属性指定interceptor的类型。

key 元素interceptor 元素的 key 子元素用于设置指定生成秘钥的 interceptor。

下表列出 key 元素的属性：

属性

描述

name

The name to use when registering the build key. 该属性是可选的。

type

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元素及其子元素。

<policyname="foot">

<matchingRulename="rule1">

<lifetimetype="singleton"/>

</matchingRule>

</matchingRules>

<callHandlername="handler1"type="GlobalCountCallHandler">

<lifetimetype="singleton"/>

</callHandler>

<callHandlername="handler2"type="GlobalCountCallHandler">

</callHandler>

</callHandlers>

</policy>

</policies>

policy Elementpolicies元素中的每个policy元素通过两个子元素matchingRules和callHandlers指定一个单独策略的完成配置。

下表列出 policy 元素的属性：

属性

描述

name

The name to use when registering this policy. This attribute is required.

type

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 元素的属性：

属性

描述

name

The name by which code in the application block and the configuration tools will refer to this matching rule.

type

The name of the matching rule class, the name of the containing assembly, the version, the culture information, and the public key token.

matchingRule 元素具有如下子元素：

injectionlifetimelifetime元素指定队形的生命周期行为。它具有唯一的 type 属性，指定生命周期管理。

下面 XML 说明 matchingRule 元素及其子元素。

<matchingRulename="rule1">

<lifetimetype="singleton"/>

</matchingRule>

</matchingRules>

injection 元素injection元素描述了如何在matchingRule元素的情况下，创建一个指定的元素。它很像 typeConfig 元素，除了injection元素配置一个实例的注入外，而 typeConfig 是一个扩展点。injection元素与typeConfig的默认情况具有相同的子元素。

callHandlers 元素callHandlers元素包含一个策略的调用句柄，其中包含一系列指定单独调用句柄的callHandler元素。

callHandler 元素callHandlers 元素中的每个 callHandler 元素指定一个单独调用句柄的细节。callHandler 元素具有 injection 和 lifetime 子元素。

下表列出 callHandler 元素的属性：

属性

描述

name

The name by which code in the application block and the configuration tools will refer to this call handler.

type

The type of the callhandler. Can be a user-defined alias specified in the typeAliases section of the configuration.

ChildcallHandler元素具有如下子元素：

injectionlifetime下面 XML 文件说明带injection子元素的callHandler元素。该例子注入一个属性。

<callHandlername="handler1"type="GlobalCountCallHandler">

<paramname="name"parameterType="string">

<valuevalue="handler1"/>

</param>

</constructor>

<--setsthepositionofthecallhandlers

<--withinthepolicyhandlerchain/>

<propertyname="Order"propertyType="int">

<valuevalue="10"type="int"/>

</property>

</injection>

</callHandler>

</callHandlers>

参考资料Unity Application Block 1.2 - October 2008Unity Application Block Methods（RegisterType、Resolve、BuildUp）Source Schema for the Unity Application Block The Unity Configuration Schema

以上链接虽然不再更新，但还是有一定参考价值。关于最新的 Unity 信息在 Unity Application Block site

下载 Unity 3

.NET 用 Unity 依赖注入——概述注册和解析类型（1）