Unity Application Block 1.0系列(3): 属性/设值方法注入(Property/Setter Injection)

什么情况下使用Property (Setter) Injection

当实例化父对象时也能自动实例化所依赖的对象
通过简单的方式使得很容易做到在代码中查看每个类所依赖的项
父对象有很多相互之间有关联关系的构造器，导致在调试和维护时很不方便。
父对象包含有很多参数构造器，特别是参数类型相似的只能通过参数的位置来辨别的
让用户(将调用这些代码的程序)更方便的看到有哪些对象可以用，这在Constructor Injection里是没办法实现的。
通过修改依赖对象的代码来控制哪些对象可以被注入，而不用改动父对象或应用程序

准备工作

//歌曲类
public class Song
{
    //歌手
    public string Singer
    {
        get
        {
            return "Westlife";
        }
    }

    //歌曲名
    public string Name
    {
        get
        {
            return "My Love";
        }
    }
}

public abstract class Player
{
    [Dependency]
    public Song Song { get; set; }

    public abstract string Name { get; }

    public void Play()
    {
        Console.WriteLine(string.Format("{0}: Now Playing [{1}] Singing by ({2})", this.Name, this.Song.Name, this.Song.Singer));
    }
}

public class Mp3Player : Player
{
    public override string Name
    {
        get
        {
            return "Mp3 Player";
        }
    }
}

public class CDPlayer : Player
{
    public override string Name
    {
        get
        {
            return "CD Player";
        }
    }
}

开始

通过为类的属性贴上[Dependency]标签，使得Unity容器在获取类对象实例时，自动实例化该属性所依赖的对象，并注入到属性中。

看一个例子，Mp3Player类有一个Song属性，它被贴上[Dependency]标签。

[Dependency]
public Song Song { get; set; }

可以通过下面的方式来获取Mp3Player对象实例：

IUnityContainer container = new UnityContainer();
container.RegisterType<Player, Mp3Player>();

Player player = container.Resolve<Player>();
player.Play();

看看输出：



这里通过为Mp3Player类的Song属性贴上[Dependency]标签，来表示Unity容器装载对象时将自动实例化Song对象，然后注入到Mp3Player的Song属性里。

从输出结果可以看出，容器在装配Mp3Player对象时自动装载有加上[Dependency]标签的所依赖的属性对象。


还可以为[Dependency]特性指定Name，再看一个例子：

这是一个播放器商店类，为PopularPlayer属性贴上[Dependency]标签，同时指定Name为"Mp3Player"。

//播放器商店
public class PlayerStore
{
    //最受欢迎的播放器类型(Mp3Player、CDPlayer)
    [Dependency("Mp3Player")]
    public Player PopularPlayer { get; set; }
}

在Unity容器中为Player基类注册两个映射( Mp3Player 和 CDPlayer ), 分别指定映射的Name。可以通过下面的方式来获取PlayerStore对象实例,并输出该店最受欢迎的播放器名：

IUnityContainer container = new UnityContainer();
container.RegisterType<Player, Mp3Player>("Mp3Player");
container.RegisterType<Player, CDPlayer>("CDPlayer");

PlayerStore player = container.Resolve<PlayerStore>();
Console.WriteLine(player.PopularPlayer.Name);

输出：




由于Player映射到Mp3Player和CDPlayer中，通过为[Dependency] Attribute指定Name可以达到匹配对应的具体Player类的目的。

注入到已存在的对象实例

用Resolve方法来获取已存在的对象实例时不会做 Property Injection，因为该对象的创建没受到 Unity 容器的任何影响。可以使用BuildUp方法来强制实现 Property Injection。

关于BuildUp方法可参考：

Unity Application Block 1.0系列(5): 使用BuildUp让已存在对象实例也支持依赖注入

结束语

使用 Property / Setter Injection 需要特别注意不要有循环引用，否则可能会导致应用程序出错。

关于循环引用可以参考：

Unity Application Block 1.0系列(6): 杜绝循环引用

作者：Inrie (洪晓军)
出处：http://www.cnblogs.com/inrie