StructureMap 学习笔记(1)

前言

一个偶然的机会接触到了StructureMap，当时客户要求让程序具有较好的测试性，自然而然就想到了IOC 容器。 之后就去Google了一下， 不经意间在StackOverFlow找到一篇帖子推荐使用StructureMap， 然后就稀里糊涂的引用到了项目中使用了。

依我看来，StructureMap很容易上手，照着官网(http://docs.structuremap.net/QuickStart.htm) 的例子，很快就能使用。 渐渐地也熟悉了StructureMap的用法，但只是会用，而没有深入的了解。 近段时间一直在学习设计模式，并且想看一些开源的项目， 于是乎就想深入了解StructureMap， 并且写博客总结梳理下。

由于本人语文是数学老师教的， 表达不当，请见谅！

快速入门

假设有这样一个场景，我们使用Repository Pattern作为数据访问层的设计模式， 为了降低它与业务逻辑层的耦合，使用StructureMap实现依赖注入，那么我们需要一个IRepository的接口

public interface IRepository
 {
        void SaveChanges();
 }

此外我们需要一个实现类

 public class Repository: IRepository
    {
        public Repository(string connectionString)
        {
        }

        public void SaveChanges()
        {
            return;
        }
    }

此时我们需要做的是让StructureMap实例化IRepository, 那么就必须对StructureMap进行配置

            ObjectFactory.Initialize(x =>
            {
                //以下调用只能用于Repository的构造函数只有1个String类型的参数， 否则抛错
                x.For<IRepository>().Use<Repository>().Ctor<string>().Is("Dely");

            });

本段代码的作用是配置接口与实现类的映射关系和构造函数参数的设置:

• x.For<IRepository>().Use<Repository> 是指如果用户请求IRepository的实例，那么StructureMap会调用Repository类的构造函数并返回此实例
• Ctor<string>().Is("Dely") 指将Repository构造函数的string类型参数的值设置为"Dely"

至此，就可以使用以下代码获取IRepository的实例

 var repository = ObjectFactory.GetInstance<IRepository>();

ObjectFactory会调用Repository的构造函数，并将字符串"Dely"传递给构造函数参数connectionString

注意: 如果Repository的构造方法有多个同类型的参数，ObjectFactory.GetInstance<IRepository>() 就会抛出配置错误的异常，例如，修改Repository的构造函数

 public Repository(string connectionString, string connectionString2)
        {
        }

要是先前的代码能够正常工作，我们必须要修改StructureMap的配置， 并显示的指定每一个参数的值

//如果Repository的构造函数有多个相同类型的参数，就必须使用Ctor([参数名])指定每一个参数的值， 否则抛错
x.For<IRepository>().Use<Repository>().Ctor<string>("connectionString").Is("Dely").Ctor<string>("connectionString2").Is("connection");

• Ctor<string>("connectionString").Is("Dely") 指定参数名为connectionString的string类型参数的值为"Dely"
• Ctor<string>("connectionString2").Is("connection")指定参数名为connectionString2的string类型参数的值为"connection"

ObjectFactory.GetInstance<IRepository>() 就可以使用以上的配置，实例化一个Repository， 但是是真实的场景中，这样的HardCode设置连接字符串是不合理的，通常会从配置文件中获取。那么 StructureMap 支持从配置文件中取数据并传递给构造函数么？ 答案是肯定的

//如果Repository的构造函数的某个参数需要来自于配置文件， 可以使用Ctor<>().EqualToAppSeting() 指定对应的AppSetting的Key/Value
x.For<IRepository>().Use<Repository>().Ctor<string>("connectionString").Is("Dely").Ctor<string>("connectionString2").EqualToAppSetting("connection");

• EqualToAppSetting() 方法是从配置文件(App.config, web.config)中的AppSettings节点获取对应的Key/Value

如果配置文件中包含

<appSettings>
    <add key="connection" value="Dely123"/>
  </appSettings>

那么StructureMap会将key="connection" 节点value属性的值传递到名为connectionString2函数参数

总结

此文叙述了StructureMap最基本的用法和注意事项，本人觉得最核心的就是

1. 配置构造函数参数的值

2. 使用Ctor<T>(), Is<T>() , For<T>(), Use<T>(), GetInstance<>(), EqualAppSetting() 等方法

下篇博文 我将深入StructureMap内部，对本文中所用的到API进行更深入的阐述， 谢谢！