依赖注入那些事儿

写在前面的话

昨天在博客园上看到一篇博文,名为“什么是依赖注入?(来听一个笑话)”[点击这里访问]。可以看出,作者是想以一种轻松幽默的方式对依赖注入的思想进行一个阐述。不过在读完文章后,个人觉得文章过于浅薄,没有真正将依赖注入的思想解释清楚,也没有深入的分析和具体的示例,所用比喻也有点低俗(至少笔者读完文章后觉得胃里不是很舒服)。

但是,这篇博文启发了我。回想自己平常的学习和工作,依赖注入确实是软件架构和开发中一个十分重要的概念和技术,笔者参与的几乎每一个项目都用到了它,并且得到了很好的效果。于是,笔者萌发了写这篇文章的想法,意在将依赖注入这项概念本身结合笔者的实践经验及所感所想,做一个相对完整的综述,并总结于此文。一来可以和朋友们分享这项技术及个人心得,二来也是自己对这项技术做的一个总结。

目录

写在前面的话

目录

1 IGame游戏公司的故事

    1.1 讨论会

    1.2 实习生小李的实现方法

    1.3 架构师的建议

    1.4 小李的小结

2 探究依赖注入

    2.1 故事的启迪

    2.2 正式定义依赖注入

3 依赖注入那些事儿

    3.1 依赖注入的类别

        3.1.1 Setter注入

        3.1.2 Construtor注入

        3.1.3 依赖获取

    3.2 反射与依赖注入

    3.3 多态的活性与依赖注入

        3.3.1 多态性的活性

        3.3.2 不同活性多态性依赖注入的选择

4 IoC Container

    4.1 IoC Container出现的必然性

    4.2 IoC Container的分类

        4.2.1 重量级IoC Container

        4.2.2 轻量级IoC Container

    4.3 .NET平台上典型IoC Container推介

        4.3.1 Spring.NET

        4.3.2 Unity

参考文献

1 IGame游戏公司的故事

1.1 讨论会

话说有一个叫IGame的游戏公司,正在开发一款ARPG游戏(动作&角色扮演类游戏,如魔兽世界、梦幻西游这一类的游戏)。一般这类游戏都有一个基本的功能,就是打怪(玩家攻击怪物,借此获得经验、虚拟货币和虚拟装备),并且根据玩家角色所装备的武器不同,攻击效果也不同。这天,IGame公司的开发小组正在开会对打怪功能中的某一个功能点如何实现进行讨论,他们面前的大屏幕上是这样一份需求描述的ppt:

图1.1 需求描述ppt

各个开发人员,面对这份需求,展开了热烈的讨论,下面我们看看讨论会上都发生了什么。

1.2 实习生小李的实现方式

在经过一番讨论后,项目组长Peter觉得有必要整理一下各方的意见,他首先询问小李的看法。小李是某学校计算机系大三学生,对游戏开发特别感兴趣,目前是IGame公司的一名实习生。

经过短暂的思考,小李阐述了自己的意见:

“我认为,这个需求可以这么实现。HP当然是怪物的一个属性成员,而武器是角色的一个属性成员,类型可以使字符串,用于描述目前角色所装备的武器。角色类有一个攻击方法,以被攻击怪物为参数,当实施一次攻击时,攻击方法被调用,而这个方法首先判断当前角色装备了什么武器,然后据此对被攻击怪物的HP进行操作,以产生不同效果。”

而在阐述完后,小李也飞快的在自己的电脑上写了一个Demo,来演示他的想法,Demo代码如下。

Code:怪物

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLi
   7: {
   8:     /// <summary>
   9:     /// 怪物
  10:     /// </summary>
  11:     internal sealed class Monster
  12:     {
  13:         /// <summary>
  14:         /// 怪物的名字
  15:         /// </summary>
  16:         public String Name { get; set; }
  17:  
  18:         /// <summary>
  19:         /// 怪物的生命值
  20:         /// </summary>
  21:         public Int32 HP { get; set; }
  22:  
  23:         public Monster(String name,Int32 hp)
  24:         {
  25:             this.Name = name;
  26:             this.HP = hp;
  27:         }
  28:     }
  29: }

Code:角色

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLi
   7: {
   8:     /// <summary>
   9:     /// 角色
  10:     /// </summary>
  11:     internal sealed class Role
  12:     {
  13:         private Random _random = new Random();
  14:  
  15:         /// <summary>
  16:         /// 表示角色目前所持武器的字符串
  17:         /// </summary>
  18:         public String WeaponTag { get; set; }
  19:  
  20:         /// <summary>
  21:         /// 攻击怪物
  22:         /// </summary>
  23:         /// <param name="monster">被攻击的怪物</param>
  24:         public void Attack(Monster monster)
  25:         {
  26:             if (monster.HP <= 0)
  27:             {
  28:                 Console.WriteLine("此怪物已死");
  29:                 return;
  30:             }
  31:  
  32:             if ("WoodSword" == this.WeaponTag)
  33:             {
  34:                 monster.HP -= 20;
  35:                 if (monster.HP <= 0)
  36:                 {
  37:                     Console.WriteLine("攻击成功!怪物" + monster.Name + "已死亡");
  38:                 }
  39:                 else
  40:                 {
  41:                     Console.WriteLine("攻击成功!怪物" + monster.Name + "损失20HP");
  42:                 }
  43:             }
  44:             else if ("IronSword" == this.WeaponTag)
  45:             {
  46:                 monster.HP -= 50;
  47:                 if (monster.HP <= 0)
  48:                 {
  49:                     Console.WriteLine("攻击成功!怪物" + monster.Name + "已死亡");
  50:                 }
  51:                 else
  52:                 {
  53:                     Console.WriteLine("攻击成功!怪物" + monster.Name + "损失50HP");
  54:                 }
  55:             }
  56:             else if ("MagicSword" == this.WeaponTag)
  57:             {
  58:                 Int32 loss = (_random.NextDouble() < 0.5) ? 100 : 200;
  59:                 monster.HP -= loss;
  60:                 if (200 == loss)
  61:                 {
  62:                     Console.WriteLine("出现暴击!!!");
  63:                 }
  64:  
  65:                 if (monster.HP <= 0)
  66:                 {
  67:                     Console.WriteLine("攻击成功!怪物" + monster.Name + "已死亡");
  68:                 }
  69:                 else
  70:                 {
  71:                     Console.WriteLine("攻击成功!怪物" + monster.Name + "损失" + loss + "HP");
  72:                 }
  73:             }
  74:             else
  75:             {
  76:                 Console.WriteLine("角色手里没有武器,无法攻击!");
  77:             }
  78:         }
  79:     }
  80: }

Code:测试代码

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLi
   7: {
   8:     class Program
   9:     {
  10:         static void Main(string[] args)
  11:         {
  12:             //生成怪物
  13:             Monster monster1 = new Monster("小怪A", 50);
  14:             Monster monster2 = new Monster("小怪B", 50);
  15:             Monster monster3 = new Monster("关主", 200);
  16:             Monster monster4 = new Monster("最终Boss", 1000);
  17:  
  18:             //生成角色
  19:             Role role = new Role();
  20:  
  21:             //木剑攻击
  22:             role.WeaponTag = "WoodSword";
  23:             role.Attack(monster1);
  24:  
  25:             //铁剑攻击
  26:             role.WeaponTag = "IronSword";
  27:             role.Attack(monster2);
  28:             role.Attack(monster3);
  29:  
  30:             //魔剑攻击
  31:             role.WeaponTag = "MagicSword";
  32:             role.Attack(monster3);
  33:             role.Attack(monster4);
  34:             role.Attack(monster4);
  35:             role.Attack(monster4);
  36:             role.Attack(monster4);
  37:             role.Attack(monster4);
  38:  
  39:             Console.ReadLine();
  40:         }
  41:     }
  42: }

 

程序运行结果如下:

图1.2 小李程序的运行结果

1.3 架构师的建议

小李阐述完自己的想法并演示了Demo后,项目组长Peter首先肯定了小李的思考能力、编程能力以及初步的面向对象分析与设计的思想,并承认小李的程序正确完成了需求中的功能。但同时,Peter也指出小李的设计存在一些问题,他请小于讲一下自己的看法。

小于是一名有五年软件架构经验的架构师,对软件架构、设计模式和面向对象思想有较深入的认识。他向Peter点了点头,发表了自己的看法:

“小李的思考能力是不错的,有着基本的面向对象分析设计能力,并且程序正确完成了所需要的功能。不过,这里我想从架构角度,简要说一下我认为这个设计中存在的问题。

首先,小李设计的Role类的Attack方法很长,并且方法中有一个冗长的if…else结构,且每个分支的代码的业务逻辑很相似,只是很少的地方不同

再者,我认为这个设计比较大的一个问题是,违反了OCP原则。在这个设计中,如果以后我们增加一个新的武器,如倚天剑,每次攻击损失500HP,那么,我们就要打开Role,修改Attack方法。而我们的代码应该是对修改关闭的,当有新武器加入的时候,应该使用扩展完成,避免修改已有代码

一般来说,当一个方法里面出现冗长的if…else或switch…case结构,且每个分支代码业务相似时,往往预示这里应该引入多态性来解决问题。而这里,如果把不同武器攻击看成一个策略,那么引入策略模式(Strategy Pattern)是明智的选择。

最后说一个小的问题,被攻击后,减HP、死亡判断等都是怪物的职责,这里放在Role中有些不当。”

Tip:OCP原则,即开放关闭原则,指设计应该对扩展开放,对修改关闭。

Tip:策略模式,英文名Strategy Pattern,指定义算法族,分别封装起来,让他们之间可以相互替换,此模式使得算法的变化独立于客户。

小于边说,边画了一幅UML类图,用于直观表示他的思想。

图1.3 小于的设计

Peter让小李按照小于的设计重构Demo,小李看了看小于的设计图,很快完成。相关代码如下:

Code:IAttackStrategy接口

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     internal interface IAttackStrategy
   9:     {
  10:         void AttackTarget(Monster monster);
  11:     }
  12: }

 

Code:木剑

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     internal sealed class WoodSword : IAttackStrategy
   9:     {
  10:         public void AttackTarget(Monster monster)
  11:         {
  12:             monster.Notify(20);
  13:         }
  14:     }
  15: }

 

Code:铁剑

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     internal sealed class IronSword : IAttackStrategy
   9:     {
  10:         public void AttackTarget(Monster monster)
  11:         {
  12:             monster.Notify(50);
  13:         }
  14:     }
  15: }

 

Code:魔剑

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     internal sealed class MagicSword : IAttackStrategy
   9:     {
  10:         private Random _random = new Random();
  11:  
  12:         public void AttackTarget(Monster monster)
  13:         {
  14:             Int32 loss = (_random.NextDouble() < 0.5) ? 100 : 200;
  15:             if (200 == loss)
  16:             {
  17:                 Console.WriteLine("出现暴击!!!");
  18:             }
  19:             monster.Notify(loss);
  20:         }
  21:     }
  22: }

 

Code:怪物

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     /// <summary>
   9:     /// 怪物
  10:     /// </summary>
  11:     internal sealed class Monster
  12:     {
  13:         /// <summary>
  14:         /// 怪物的名字
  15:         /// </summary>
  16:         public String Name { get; set; }
  17:  
  18:         /// <summary>
  19:         /// 怪物的生命值
  20:         /// </summary>
  21:         private Int32 HP { get; set; }
  22:  
  23:         public Monster(String name,Int32 hp)
  24:         {
  25:             this.Name = name;
  26:             this.HP = hp;
  27:         }
  28:  
  29:         /// <summary>
  30:         /// 怪物被攻击时,被调用的方法,用来处理被攻击后的状态更改
  31:         /// </summary>
  32:         /// <param name="loss">此次攻击损失的HP</param>
  33:         public void Notify(Int32 loss)
  34:         {
  35:             if (this.HP <= 0)
  36:             {
  37:                 Console.WriteLine("此怪物已死");
  38:                 return;
  39:             }
  40:  
  41:             this.HP -= loss;
  42:             if (this.HP <= 0)
  43:             {
  44:                 Console.WriteLine("怪物" + this.Name + "被打死");
  45:             }
  46:             else
  47:             {
  48:                 Console.WriteLine("怪物" + this.Name + "损失" + loss + "HP");
  49:             }
  50:         }
  51:     }
  52: }

 

Code:角色

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     /// <summary>
   9:     /// 角色
  10:     /// </summary>
  11:     internal sealed class Role
  12:     {
  13:         /// <summary>
  14:         /// 表示角色目前所持武器
  15:         /// </summary>
  16:         public IAttackStrategy Weapon { get; set; }
  17:  
  18:         /// <summary>
  19:         /// 攻击怪物
  20:         /// </summary>
  21:         /// <param name="monster">被攻击的怪物</param>
  22:         public void Attack(Monster monster)
  23:         {
  24:             this.Weapon.AttackTarget(monster);
  25:         }
  26:     }
  27: }

 

Code:测试代码

   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace IGameLiAdv
   7: {
   8:     class Program
   9:     {
  10:         static void Main(string[] args)
  11:         {
  12:             //生成怪物
  13:             Monster monster1 = new Monster("小怪A", 50);
  14:             Monster monster2 = new Monster("小怪B", 50);
  15:             Monster monster3 = new Monster("关主", 200);
  16:             Monster monster4 = new Monster("最终Boss", 1000);
  17:  
  18:             //生成角色
  19:             Role role = new Role();
  20:  
  21:             //木剑攻击
  22:             role.Weapon = new WoodSword();
  23:             role.Attack(monster1);
  24:  
  25:             //铁剑攻击
  26:             role.Weapon = new IronSword();
  27:             role.Attack(monster2);
  28:             role.Attack(monster3);
  29:  
  30:             //魔剑攻击
  31:             role.Weapon = new MagicSword();
  32:             role.Attack(monster3);
  33:             role.Attack(monster4);
  34:             role.Attack(monster4);
  35:             role.Attack(monster4);
  36:             role.Attack(monster4);
  37:             role.Attack(monster4);
  38:  
  39:             Console.ReadLine();
  40:         }
  41:     }
  42: }

 

编译运行以上代码,得到的运行结果与上一版本代码基本一致。

1.4 小李的小结

Peter显然对改进后的代码比较满意,他让小李对照两份设计和代码,进行一个小结。小李简略思考了一下,并结合小于对一次设计指出的不足,说道:

“我认为,改进后的代码有如下优点:

第一,虽然类的数量增加了,但是每个类中方法的代码都非常短,没有了以前Attack方法那种很长的方法,也没有了冗长的if…else,代码结构变得很清晰

第二,类的职责更明确了。在第一个设计中,Role不但负责攻击,还负责给怪物减少HP和判断怪物是否已死。这明显不应该是Role的职责,改进后的代码将这两个职责移入Monster内,使得职责明确,提高了类的内聚性。

第三,引入Strategy模式后,不但消除了重复性代码,更重要的是,使得设计符合了OCP。如果以后要加一个新武器,只要新建一个类,实现IAttackStrategy接口,当角色需要装备这个新武器时,客户代码只要实例化一个新武器类,并赋给Role的Weapon成员就可以了,已有的Role和Monster代码都不用改动。这样就实现了对扩展开发,对修改关闭。”

Peter和小于听后都很满意,认为小李总结的非常出色。

IGame公司的讨论会还在进行着,内容是非常精彩,不过我们先听到这里,因为,接下来,我们要对其中某些问题进行一点探讨。别忘了,本文的主题可是依赖注入,这个主角还没登场呢!让主角等太久可不好。

2 探究依赖注入

2.1 故事的启迪

我们现在静下心来,再回味一下刚才的故事。因为,这个故事里面隐藏着依赖注入的出现原因。我说过不只一次,想真正认清一个事物,不能只看“它是什么?什么样子?”,而应该先弄清楚“它是怎么来的?是什么样的需求和背景促使了它的诞生?它被创造出来是做什么用的?”。

回想上面的故事。刚开始,主要需求是一个打怪的功能。小李做了一个初步面向对象的设计:抽取领域场景中的实体(怪物、角色等),封装成类,并为各个类赋予属性与方法,最后通过类的交互完成打怪功能,这应该算是面向对象设计的初级阶段。

在小李的设计基础上,架构师小于指出了几点不足,如不符合OCP,职责划分不明确等等,并根据情况引入策略模式。这是更高层次的面向对象设计。其实就核心来说,小于只做了一件事:利用多态性,隔离变化。它清楚认识到,这个打怪功能中,有些业务逻辑是不变的,如角色攻击怪物,怪物减少HP,减到0怪物就会死;而变化的仅仅是不同的角色持有不同武器时,每次攻击的效用不一样。于是他的架构,本质就是把变化的部分和不变的部分隔离开,使得变化部分发生变化时,不变部分不受影响。

我们再仔细看看小于的设计图,这样设计后,有个基本的问题需要解决:现在Role不依赖具体武器,而仅仅依赖一个IAttackStrategy接口,接口是不能实例化的,虽然Role的Weapon成员类型定义为IAttackStrategy,但最终还是会被赋予一个实现了IAttackStrategy接口的具体武器,并且随着程序进展,一个角色会装备不同的武器,从而产生不同的效用。赋予武器的职责,在Demo中是放在了测试代码里。

这里,测试代码实例化一个具体的武器,并赋给Role的Weapon成员的过程,就是依赖注入!这里要清楚,依赖注入其实是一个过程的称谓!

2.2 正式定义依赖注入

下面,用稍微正式一点的语言,定义依赖注入产生的背景缘由和依赖注入的含义。在读的过程中,读者可以结合上面的例子进行理解。

依赖注入产生的背景:

随着面向对象分析与设计的发展,一个良好的设计,核心原则之一就是将变化隔离,使得变化部分发生变化时,不变部分不受影响(这也是OCP的目的)。为了做到这一点,要利用面向对象中的多态性,使用多态性后,客户类不再直接依赖服务类,而是依赖于一个抽象的接口,这样,客户类就不能在内部直接实例化具体的服务类。但是,客户类在运作中又客观需要具体的服务类提供服务,因为接口是不能实例化去提供服务的。就产生了“客户类不准实例化具体服务类”和“客户类需要具体服务类”这样一对矛盾。为了解决这个矛盾,开发人员提出了一种模式:客户类(如上例中的Role)定义一个注入点(Public成员Weapon),用于服务类(实现IAttackStrategy的具体类,如WoodSword、IronSword和MagicSword,也包括以后加进来的所有实现IAttackStrategy的新类)的注入,而客户类的客户类(Program,即测试代码)负责根据情况,实例化服务类,注入到客户类中,从而解决了这个矛盾。

依赖注入的正式定义:

依赖注入(Dependency Injection),是这样一个过程:由于某客户类只依赖于服务类的一个接口,而不依赖于具体服务类,所以客户类只定义一个注入点。在程序运行过程中,客户类不直接实例化具体服务类实例,而是客户类的运行上下文环境或专门组件负责实例化服务类,然后将其注入到客户类中,保证客户类的正常运行。

3 依赖注入那些事儿

上面我们从需求背景的角度,讲述了依赖注入的来源和定义。但是,如果依赖注入仅仅就只有这么点东西,那也没有什么值得讨论的了。但是,上面讨论的仅仅是依赖注入的内涵,其外延还是非常广泛的,从依赖注入衍生出了很多相关的概念与技术,下面我们讨论一下依赖注入的“那些事儿”。

3.1 依赖注入的类别

依赖注入有很多种方法,上面看到的例子中,只是其中的一种,下面分别讨论不同的依赖注入类型。

3.1.1 Setter注入

第一种依赖注入的方式,就是Setter注入,上面的例子中,将武器注入Role就是Setter注入。正式点说:

Setter注入(Setter Injection)是指在客户类中,设置一个服务类接口类型的数据成员,并设置一个Set方法作为注入点,这个Set方法接受一个具体的服务类实例为参数,并将它赋给服务类接口类型的数据成员。

图3.1 Setter注入示意

上图展示了Setter注入的结构示意图,客户类ClientClass设置IServiceClass类型成员_serviceImpl,并设置Set_ServiceImpl方法作为注入点。Context会负责实例化一个具体的ServiceClass,然后注入到ClientClass里。

下面给出Setter注入的示例代码。

Code:IServiceClass
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace SetterInjection
   7: {
   8:     internal interface IServiceClass
   9:     {
  10:         String ServiceInfo();
  11:     }
  12: }

 

Code:ServiceClassA
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace SetterInjection
   7: {
   8:     internal class ServiceClassA : IServiceClass
   9:     {
  10:         public String ServiceInfo()
  11:         {
  12:             return "我是ServceClassA";
  13:         }
  14:     }
  15: }

 

Code:ServiceClassB
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace SetterInjection
   7: {
   8:     internal class ServiceClassB : IServiceClass
   9:     {
  10:         public String ServiceInfo()
  11:         {
  12:             return "我是ServceClassB";
  13:         }
  14:     }
  15: }

 

Code:ClientClass
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace SetterInjection
   7: {
   8:     internal class ClientClass
   9:     {
  10:         private IServiceClass _serviceImpl;
  11:  
  12:         public void Set_ServiceImpl(IServiceClass serviceImpl)
  13:         {
  14:             this._serviceImpl = serviceImpl;
  15:         }
  16:  
  17:         public void ShowInfo()
  18:         {
  19:             Console.WriteLine(_serviceImpl.ServiceInfo());
  20:         }
  21:     }
  22: }

 

Code:Context
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace SetterInjection
   7: {
   8:     class Program
   9:     {
  10:         static void Main(string[] args)
  11:         {
  12:             IServiceClass serviceA = new ServiceClassA();
  13:             IServiceClass serviceB = new ServiceClassB();
  14:             ClientClass client = new ClientClass();
  15:  
  16:             client.Set_ServiceImpl(serviceA);
  17:             client.ShowInfo();
  18:             client.Set_ServiceImpl(serviceB);
  19:             client.ShowInfo();
  20:         }
  21:     }
  22: }

 

运行结果如下:

图3.2 Setter注入运行结果

3.1.2 构造注入

另外一种依赖注入方式,是通过客户类的构造函数,向客户类注入服务类实例。

构造注入(Constructor Injection)是指在客户类中,设置一个服务类接口类型的数据成员,并以构造函数为注入点,这个构造函数接受一个具体的服务类实例为参数,并将它赋给服务类接口类型的数据成员。

图3.3 构造注入示意

图3.3是构造注入的示意图,可以看出,与Setter注入很类似,只是注入点由Setter方法变成了构造方法。这里要注意,由于构造注入只能在实例化客户类时注入一次,所以一点注入,程序运行期间是没法改变一个客户类对象内的服务类实例的。

由于构造注入和Setter注入的IServiceClass,ServiceClassA和ServiceClassB是一样的,所以这里给出另外ClientClass类的示例代码。

Code:ClientClass
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace ConstructorInjection
   7: {
   8:     internal class ClientClass
   9:     {
  10:         private IServiceClass _serviceImpl;
  11:  
  12:         public ClientClass(IServiceClass serviceImpl)
  13:         {
  14:             this._serviceImpl = serviceImpl;
  15:         }
  16:  
  17:         public void ShowInfo()
  18:         {
  19:             Console.WriteLine(_serviceImpl.ServiceInfo());
  20:         }
  21:     }
  22: }

 

可以看到,唯一的变化就是构造函数取代了Set_ServiceImpl方法,成为了注入点。

3.1.3 依赖获取

上面提到的注入方式,都是客户类被动接受所依赖的服务类,这也符合“注入”这个词。不过还有一种方法,可以和依赖注入达到相同的目的,就是依赖获取。

依赖获取(Dependency Locate)是指在系统中提供一个获取点,客户类仍然依赖服务类的接口。当客户类需要服务类时,从获取点主动取得指定的服务类,具体的服务类类型由获取点的配置决定。

可以看到,这种方法变被动为主动,使得客户类在需要时主动获取服务类,而将多态性的实现封装到获取点里面。获取点可以有很多种实现,也许最容易想到的就是建立一个Simple Factory作为获取点,客户类传入一个指定字符串,以获取相应服务类实例。如果所依赖的服务类是一系列类,那么依赖获取一般利用Abstract Factory模式构建获取点,然后,将服务类多态性转移到工厂的多态性上,而工厂的类型依赖一个外部配置,如XML文件。

不过,不论使用Simple Factory还是Abstract Factory,都避免不了判断服务类类型或工厂类型,这样系统中总要有一个地方存在不符合OCP的if…else或switch…case结构,这种缺陷是Simple Factory和Abstract Factory以及依赖获取本身无法消除的,而在某些支持反射的语言中(如C#),通过将反射机制的引入彻底解决了这个问题(后面讨论)。

下面给一个具体的例子,现在我们假设有个程序,既可以使用Windows风格外观,又可以使用Mac风格外观,而内部业务是一样的。

图3.4 依赖获取示意

上图乍看有点复杂,不过如果读者熟悉Abstract Factory模式,应该能很容易看懂,这就是Abstract Factory在实际中的一个应用。这里的Factory Container作为获取点,是一个静态类,它的“Type构造函数”依据外部的XML配置文件,决定实例化哪个工厂。下面还是来看示例代码。由于不同组件的代码是相似的,这里只给出Button组件的示例代码,完整代码请参考文末附上的完整源程序。

Code:按钮接口
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     internal interface IButton
   9:     {
  10:         String ShowInfo();
  11:     }
  12: }

 

Code:Windows风格按钮
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     internal sealed class WindowsButton : IButton
   9:     {
  10:         public String Description { get; private set; }
  11:  
  12:         public WindowsButton()
  13:         {
  14:             this.Description = "Windows风格按钮";
  15:         }
  16:  
  17:         public String ShowInfo()
  18:         {
  19:             return this.Description;
  20:         }
  21:     }
  22: }

 

Code:Mac风格按钮
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     internal sealed class MacButton : IButton
   9:     {
  10:         public String Description { get; private set; }
  11:  
  12:         public MacButton()
  13:         {
  14:             this.Description = " Mac风格按钮";
  15:         }
  16:  
  17:         public String ShowInfo()
  18:         {
  19:             return this.Description;
  20:         }
  21:     }
  22: }

 

Code:工厂接口
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     internal interface IFactory
   9:     {
  10:         IWindow MakeWindow();
  11:  
  12:         IButton MakeButton();
  13:  
  14:         ITextBox MakeTextBox();
  15:     }
  16: }

 

Code:Windows组件工厂
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     internal sealed class WindowsFactory : IFactory
   9:     {
  10:         public IWindow MakeWindow()
  11:         {
  12:             return new WindowsWindow();
  13:         }
  14:  
  15:         public IButton MakeButton()
  16:         {
  17:             return new WindowsButton();
  18:         }
  19:  
  20:         public ITextBox MakeTextBox()
  21:         {
  22:             return new WindowsTextBox();
  23:         }
  24:     }
  25: }

 

Code:Mac组件工厂
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     internal sealed class MacFactory : IFactory
   9:     {
  10:         public IWindow MakeWindow()
  11:         {
  12:             return new MacWindow();
  13:         }
  14:  
  15:         public IButton MakeButton()
  16:         {
  17:             return new MacButton();
  18:         }
  19:  
  20:         public ITextBox MakeTextBox()
  21:         {
  22:             return new MacTextBox();
  23:         }
  24:     }
  25: }

 

Code:获取点
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5: using System.Xml;
   6:  
   7: namespace DependencyLocate
   8: {
   9:     internal static class FactoryContainer
  10:     {
  11:         public static IFactory factory { get; private set; }
  12:  
  13:         static FactoryContainer()
  14:         {
  15:             XmlDocument xmlDoc = new XmlDocument();
  16:             xmlDoc.Load("http://www.cnblogs.com/Config.xml");
  17:             XmlNode xmlNode = xmlDoc.ChildNodes[1].ChildNodes[0].ChildNodes[0];
  18:  
  19:             if ("Windows" == xmlNode.Value)
  20:             {
  21:                 factory = new WindowsFactory();
  22:             }
  23:             else if ("Mac" == xmlNode.Value)
  24:             {
  25:                 factory = new MacFactory();
  26:             }
  27:             else
  28:             {
  29:                 throw new Exception("Factory Init Error");
  30:             }
  31:         }
  32:     }
  33: }
Code:测试代码
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5:  
   6: namespace DependencyLocate
   7: {
   8:     class Program
   9:     {
  10:         static void Main(string[] args)
  11:         {
  12:             IFactory factory = FactoryContainer.factory;
  13:             IWindow window = factory.MakeWindow();
  14:             Console.WriteLine("创建 " + window.ShowInfo());
  15:             IButton button = factory.MakeButton();
  16:             Console.WriteLine("创建 " + button.ShowInfo());
  17:             ITextBox textBox = factory.MakeTextBox();
  18:             Console.WriteLine("创建 " + textBox.ShowInfo());
  19:  
  20:             Console.ReadLine();
  21:         }
  22:     }
  23: }

 

这里我们用XML作为配置文件。配置文件Config.xml如下:

   1: <?xml version="1.0" encoding="utf-8" ?>
   2: <config>
   3:     <factory>Mac</factory>
   4: </config>

 

可以看到,这里我们将配置设置为Mac风格,编译运行上述代码,运行结果如下:

图3.5 配置Mac风格后的运行结果

现在,我们不动程序,仅仅将配置文件中的“Mac”改为Windows,运行后结果如下:

图3.6 配置为Windows风格后的运行结果

从运行结果看出,我们仅仅通过修改配置文件,就改变了整个程序的行为(我们甚至没有重新编译程序),这就是多态性的威力,也是依赖注入效果。

本节共讨论了三种基本的依赖注入类别,有关更多依赖注入类别和不同类别对比的知识,可以参考Martin Fowler的《Inversion of Control Containers and the Dependency Injection pattern》。

3.2 反射与依赖注入

回想上面Dependency Locate的例子,我们虽然使用了多态性和Abstract Factory,但对OCP贯彻的不够彻底。在理解这点前,朋友们一定要注意潜在扩展在哪里,潜在会出现扩展的地方是“新的组件系列”而不是“组件种类”,也就是说,这里我们假设组件就三种,不会增加新的组件,但可能出现新的外观系列,如需要加一套Ubuntu风格的组件,我们可以新增UbuntuWindow、UbuntuButton、UbuntuTextBox和UbuntuFactory,并分别实现相应接口,这是符合OCP的,因为这是扩展。但我们除了修改配置文件,还要无可避免的修改FactoryContainer,需要加一个分支条件,这个地方破坏了OCP。依赖注入本身是没有能力解决这个问题的,但如果语言支持反射机制(Reflection),则这个问题就迎刃而解。

我们想想,现在的难点是出在这里:对象最终还是要通过“new”来实例化,而“new”只能实例化当前已有的类,如果未来有新类添加进来,必须修改代码。如果,我们能有一种方法,不是通过“new”,而是通过类的名字来实例化对象,那么我们只要将类的名字作为配置项,就可以实现在不修改代码的情况下,加载未来才出现的类。所以,反射给了语言“预见未来”的能力,使得多态性和依赖注入的威力大增。

下面是引入反射机制后,对上面例子的改进:

图3.7 引入反射机制的Dependency Locate

可以看出,引入反射机制后,结构简单了很多,一个反射工厂代替了以前的一堆工厂,Factory Container也不需要了。而且以后有新组件系列加入时,反射工厂是不用改变的,只需改变配置文件就可以完成。下面给出反射工厂和配置文件的代码。

Code:反射工厂
   1: using System;
   2: using System.Collections.Generic;
   3: using System.Linq;
   4: using System.Text;
   5: using System.Reflection;
   6: using System.Xml;
   7:  
   8: namespace DependencyLocate
   9: {
  10:     internal static class ReflectionFactory
  11:     {
  12:         private static String _windowType;
  13:         private static String _buttonType;
  14:         private static String _textBoxType;
  15:  
  16:         static ReflectionFactory()
  17:         {
  18:             XmlDocument xmlDoc = new XmlDocument();
  19:             xmlDoc.Load("http://www.cnblogs.com/Config.xml");
  20:             XmlNode xmlNode = xmlDoc.ChildNodes[1].ChildNodes[0];
  21:  
  22:             _windowType = xmlNode.ChildNodes[0].Value;
  23:             _buttonType = xmlNode.ChildNodes[1].Value;
  24:             _textBoxType = xmlNode.ChildNodes[2].Value;
  25:         }
  26:  
  27:         public static IWindow MakeWindow()
  28:         {
  29:             return Assembly.Load("DependencyLocate").CreateInstance("DependencyLocate." + _windowType) as IWindow;
  30:         }
  31:  
  32:         public static IButton MakeButton()
  33:         {
  34:             return Assembly.Load("DependencyLocate").CreateInstance("DependencyLocate." + _buttonType) as IButton;
  35:         }
  36:  
  37:         public static ITextBox MakeTextBox()
  38:         {
  39:             return Assembly.Load("DependencyLocate").CreateInstance("DependencyLocate." + _textBoxType) as ITextBox;
  40:         }
  41:     }
  42: }

 

配置文件如下:
   1: <?xml version="1.0" encoding="utf-8" ?>
   2: <config>
   3:     <window>MacWindow</window>
   4:     <button>MacButton</button>
   5:     <textBox>MacTextBox</textBox>
   6: </config>

 

反射不仅可以与Dependency Locate结合,也可以与Setter Injection与Construtor Injection结合。反射机制的引入,降低了依赖注入结构的复杂度,使得依赖注入彻底符合OCP,并为通用依赖注入框架(如Spring.NET中的IoC部分、Unity等)的设计提供了可能性。

3.3 多态的活性与依赖注入

重要声明:3.3节内容中诸多术语(包括但不限于“多态活性”、“高活多态性”、“中活多态性”、“低活多态性”、“多态时间空间稳定”)与诸多理论思想(包括但不限于“多态活性定义”、“根据活性分类多态”、“根据活性选择依赖注入类型”)均为笔者原创,所以,特声明以下两点:一、由于笔者水平所限,不保证其完全正确性和严格性,与前面诸多成熟理论相比,请批判性阅读;二、由于此节中诸多概念与思想理论已纳入笔者论文素材范畴,作为笔者原创成果,受法律保护。任何单位和个人不得擅自将此节内容部分或全部抄袭、改造、重新叙述成文进行公开发表。否则,笔者保留追究法律责任的权利。

3.3.1 多态性的活性

这一节我们讨论多态的活性及其与依赖注入类型选择间密切的关系。

首先说明,“多态的活性”这个术语是我个人定义的,因为我没有找到既有的概念名词可以表达我的意思,所以就自己造了一个词。这里,某多态的活性是指被此多态隔离的变化所发生变化的频繁程度,频繁程度越高,则活性越强,反之亦然。

上文说过,多态性可以隔离变化,但是,不同的变化,发生的频率是不一样的,这就使得多态的活性有所差别,这种差别影响了依赖注入的类型选择。

举例来说,本文最开始提到的武器多态性,其活性非常高,因为在那个程序中,Role在一次运行中可能更换多次武器。而现在我们假设Role也实现了多态性,这是很可能的,因为在游戏中,不同类型的角色(如暗夜精灵、牛头人、矮人等)很多属性和业务是想通的,所以很可能通过一个IRole或AbstractRole抽象类实现多态性,不过,Role在实例化后(一般在用户登录成功后),是不会变化的,很少有游戏允许同一个玩家在运行中变换Role类型,所以Role应该是一但实例化,就不会变化,但如果再实例化一个(如另一个玩家登录),则可能就变化了。最后,还有一种多态性是活性非常低的,如我们熟悉的数据访问层多态性,即使我们实现了SQL Server、Oracle和Access等多种数据库的访问层,并实现了依赖注入,但几乎遇不到程序运行着就改数据库或短期内数据库频繁变动的情况。

以上不同的多态性,不但特征不同,其目的一般也不同,总结如下:

高活多态性——指在客户类实例运行期间,服务类可能会改变的多态性。

中活多态性——指在客户类实例化后,服务类不会改变,但同一时间内存在的不同实例可能拥有不同类型的服务类。

低活多态性——指在客户类实例化后,服务类不会改变,且同一时间内所有客户类都拥有相同类型的服务类。

以上三种多态性,比较好的例子就是上文提到的武器多态性(高活)、角色多态性(中活)和数据访问层多态性(低活)。另外,我们说一种多态性是空间稳定的,如果同一客户类在同一时间内的所有实例都依赖相同类型的服务类,反之则叫做空间不稳定多态性。我们说一种多态性是时间稳定的,如果一个客户类在实例化后,所以来的服务类不能再次更改,反之则叫做时间不稳定多态性。显然,高活多态性时间和空间均不稳定;中活多态性是时间稳定的,但空间不稳定;低活多态性时间空间均稳定。

3.3.2 不同活性多态的依赖注入选择

一般来说,高活多态性适合使用Setter注入。因为Setter注入最灵活,也是唯一允许在同一客户类实例运行期间更改服务类的注入方式。并且这种注入一般由上下文环境通过Setter的参数指定服务类类型,方便灵活,适合频繁变化的高活多态性。

对于中活多态性,则适合使用Constructor注入。因为Constructor注入也是由上下文环境通过Construtor的参数指定服务类类型,但一点客户类实例化后,就不能进行再次注入,保证了其时间稳定性。

而对于低活多态性,则适合使用Dependency Locate并配合文件配置进行依赖注入,或Setter、Constructor配合配置文件注入,因为依赖源来自文件,如果要更改服务类,则需要更改配置文件,一则确保了低活多态性的时间和空间稳定性,二是更改配置文件的方式方便于大规模服务类替换。(因为低活多态性一旦改变行为,往往规模很大,如替换整个数据访问层,如果使用Setter和Construtor传参,程序中需要改变的地方不计其数)

本质上,这种选择是因为不同的依赖注入类型有着不同的稳定性,大家可以细细体会“活性”、“稳定性”和“依赖注入类型”之间密切的关系。

4 IoC Container

4.1 IoC Container出现的必然性

上面讨论了诸多依赖注入的话题。说道依赖注入,就不能不说IoC Container(IoC容器),那么到底什么是IoC容器?我们还是先来看看它的出现背景。

我们知道,软件开发领域有句著名的论断:不要重复发明轮子!因为软件开发讲求复用,所以,对于应用频繁的需求,总是有人设计各种通用框架和类库以减轻人们的开发负担。例如,数据持久化是非常频繁的需求,于是各种ORM框架应运而生;再如,对MVC的需求催生了Struts等一批用来实现MVC的框架。

随着面向对象分析与设计的发展和成熟,OOA&D被越来越广泛应用于各种项目中,然而,我们知道,用OO就不可能不用多态性,用多态性就不可能不用依赖注入,所以,依赖注入变成了非常频繁的需求,而如果全部手工完成,不但负担太重,而且还容易出错。再加上反射机制的发明,于是,自然有人开始设计开发各种用于依赖注入的专用框架。这些专门用于实现依赖注入功能的组件或框架,就是IoC Container。

从这点看,IoC Container的出现有其历史必然性。目前,最著名的IoC也许就是Java平台上的Spring框架的IoC组件,而.NET平台上也有Spring.NET和Unity等。

4.2 IoC Container的分类

前面曾经讨论了三种依赖注入方式,但是,想通过方式对IoC Container进行分类很困难,因为现在IoC Container都设计很完善,几乎支持所有依赖注入方式。不过,根据不同框架的特性和惯用法,还是可以讲IoC Container分为两个大类。

4.2.1 重量级IoC Container

所谓重量级IoC Container,是指一般用外部配置文件(一般是XML)作为依赖源,并托管整个系统各个类的实例化的IoC Container。这种IoC Container,一般是承接了整个系统几乎所有多态性的依赖注入工作,并承接了所有服务类的实例化工作,而且这些实例化依赖于一个外部配置文件,这种IoC Container,很像通过一个文件,定义整个系统多态结构,视野宏大,想要很好驾驭这种IoC Container,需要一定的架构设计能力和丰富的实践经验。

Spring和Spring.NET是重量级IoC Container的例子。一般来说,这种IoC Container稳定性有余而活性不足,适合进行低活多态性的依赖注入。

4.2.2 轻量级IoC Container

还有一种IoC Container,一般不依赖外部配置文件,而主要使用传参的Setter或Construtor注入,这种IoC Container叫做轻量级IoC Container。这种框架很灵活,使用方便,但往往不稳定,而且依赖点都是程序中的字符串参数,所以,不适合需要大规模替换和相对稳定的低活多态性,而对于高活多态性,有很好的效果。

Unity是一个典型的轻量级IoC Container。

4.3 .NET平台上典型IoC Container推介

4.3.1 Spring.NET

Spring.NET是Java平台上Spring对.NET平台的移植,使用方法和Spring很像,并且功能强大,是.NET平台上大中型开发IoC Container的首选之一。除了DI外,Spring.NET也包括AOP等诸多功能。

Spring.NET的官方网站是:http://www.springframework.net/

4.3.2 Unity

对于小型项目和讲求敏捷的团队,Spring.NET可能有点太重量级,那么可以选择轻量级的Unity。Unity是微软patterns & practices团队推出的轻量级框架,非常好用,目前最新版本是1.2。

Unity的官方网站是:http://unity.codeplex.com/

 

参考文献

[1]  Shivprasad koirala, Design pattern – Inversion of control and Dependency injection, http://www.codeproject.com/KB/aspnet/IOCDI.aspx

[2]  Martin Fowler, Inversion of Control Containers and the Dependency Injection pattern, http://www.martinfowler.com/articles/injection.html

[3]  Paul, IoC Types, http://docs.codehaus.org/display/PICO/IoC+Types

[4]  Eric Freeman, Elisabeth Freeman. Head First Design Patterns. O’Reilly Media, 2004. ISBN 0596007142

[5]  Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley, 1995. ISBN 0201633612

[6]  Patrick Smacchia 著,施凡等 译,C#和.NET2.0 平台、语言与框架。2008.1,人民邮电出版

[7]  Jeffrey Rechter 著,CLR via C#(影印版)。2008.8,人民邮电出版

 

示例代码下载:

 

Creative Commons License
阅读更多
想对作者说点什么? 我来说一句

CSS那些事儿.pdf 高清下载

2013年04月03日 34.76MB 下载

明朝那些事儿.mobi

2017年05月31日 4.34MB 下载

IT项目管理那些事儿.pdf

2015年01月29日 68.12MB 下载

黑金 FPGA那些事儿 (系列)

2018年03月17日 8.31MB 下载

UML那些事儿.pdf

2013年06月17日 29.62MB 下载

编程的那些事(包括很多内容)

2009年09月29日 2.12MB 下载

没有更多推荐了,返回首页

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭