使用Unity 实现ASP.NET Web API 依赖注入

DI/IoC 的设计前面已经讲过好几次了，简单的一段话说明就是：「目标对象与外部相依的方式仅相依于 interface，而相依 interface 的 instance 透过 constructor 或 public property 来让外部可以注入相依实体」。而 DI framework 也是相当多种，这篇文章就简单介绍怎么在 Web API 项目中，简单快速地 adopt Enterprise Library 中的 Unity 。

步骤

先建立一个 ASP.NET MVC project, 选择 Web API ，会看到预设长出来的 Controller ，以 ValuesController 的 Get() 为例，程序代码如下所示：

// GET api/values
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

假设使用 IoC 的设计方式， ValuesController.Get() 方法是透过 IOrderService 这个接口来取值，那么先新增一个 ValuesController 的 constructor ，参数传入 IOrderService ，如下所示：

public class ValuesController : ApiController
{
    private IOrderService _orderService;
    public ValuesController(IOrderService orderService)
    {
        this._orderService = orderService;
    }
 
    // GET api/values
    public IEnumerable<string> Get()
    {
        //return new string[] { "value1", "value2" };
        return this._orderService.GetValues();
    }
 
}
 
public interface IOrderService
{
    IEnumerable<string> GetValues();
}

新增一个实作 IOrderService 的 concrete class, 称为 JoeyOrderService ，程序代码如下所示：

public class JoeyOrderService : IOrderService
{
    public IEnumerable<string> GetValues()
    {
        return new string[] { "joey1", "joey2" };
    }
}

假设需求是希望 ValuesController depend on IOrderService ，在实际上是注入 JoeyOrderService ，在使用时不需要再 new ValuesController(new JoeyOrderService) 这么麻烦，拿到 ValuesController 时相关的相依对象都已经被初始化好了，我们只需要使用 DI framework，注册 IOrderService 使用 JoeyOrderService 即可。

这边使用 Unity 来实作这一段，请在 NuGet 加载 Unity.WebAPI。

除了相关组件参考以外， NuGet 还加入了一支 Bootstrapper.cs ，打开来会看到程序代码如下：

using System.Web.Http;
using Microsoft.Practices.Unity;
 
namespace MvcUnitySample
{
    public static class Bootstrapper
    {
        public static void Initialise()
        {
            var container = BuildUnityContainer();
 
            GlobalConfiguration.Configuration.DependencyResolver = new Unity.WebApi.UnityDependencyResolver(container);
        }
 
        private static IUnityContainer BuildUnityContainer()
        {
            var container = new UnityContainer();
 
            // register all your components with the container here
            // e.g. container.RegisterType<ITestService, TestService>();            
 
            return container;
        }
    }
}

从批注可以看到，只需要加入 container.RegisterType<TFrom, TTo>() 即可，这边的例子只需要把 IOrderService 与 JoeyOrderService 注册在一起即可，如下所示：

public static class Bootstrapper
{
    public static void Initialise()
    {
        var container = BuildUnityContainer();
 
        GlobalConfiguration.Configuration.DependencyResolver = new Unity.WebApi.UnityDependencyResolver(container);
    }
 
    private static IUnityContainer BuildUnityContainer()
    {
        var container = new UnityContainer();
         
        container.RegisterType<IOrderService, JoeyOrderService>();
        return container;
    }
}

接着打开 Global.asax.cs ，在 Application_Start() 的时候，呼叫 Bootstrapper.Initialise() 即可，如下所示：

public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        Bootstrapper.Initialise();
        AreaRegistration.RegisterAllAreas();
 
        WebApiConfig.Register(GlobalConfiguration.Configuration);
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
    }
}

这样就大功告成了。我们只做了几件事：

把相依的 interface 拉到 constructor or public property ，供外部注入
透过 NuGet 加载 Unity.WebAPI
在 Bootstrapper 的 BuildUnityContainer() 中注册 interface 对应的 instance type
在 Global.asax 中，呼叫 Bootstrapper 的初始化。

来看一下实际的结果，如下图所示：

结论

为什么还需要透过 DI framework 来决定相依对象呢？原因如下：

这件事不属于 context 端负责，因为 context 端应该只负责用，而不负责生成目标对象。
当对象分割较为独立时，使用一个对象，其相关相依接口可能不少，而对应该接口的实体，也可能还有相依其它接口。因此可能得一大串的 new 之后，才能正常使用一个相依对象。透过 DI framework 的 auto-wiring，会在生成对象的同时，检查 constructor 所使用到的对象，或是标记需要注入的 public property，来产生对应的相依对象自动注入。这样可以节省相当多生成对象的动作。

上面的例子是透过 constructor, 如果希望透过 property 来做注入，也相当简单，只需要在 property 上标示：[Microsoft.Practices.Unity.Dependency]这个 Attribute 即可，程序代码如下所示：

public class ValuesController : ApiController
{
    //private IOrderService OrderService;
    //public ValuesController(IOrderService orderService)
    //{
    //    this._orderService = orderService;
    //}
 
    [Microsoft.Practices.Unity.Dependency]
    public IOrderService OrderService { get; set; }
 
    // GET api/values
    public IEnumerable<string> Get()
    {
        //return new string[] { "value1", "value2" };
        return this.OrderService.GetValues();
    }
}

这样子效果是一样的。现在 NuGet 已经相当方便了，如果已经有使用 IoC 的设计，就强烈建议使用方便的 DI framework 来解决生成对象跟相依对象的问题。

原文地址：http://www.it165.net/pro/html/201310/7485.html

posted @ 2016-08-02 09:31 .NET-蜕变阅读(1815) 评论(0) 编辑收藏举报

刷新页面返回顶部

.NET-蜕变

使用Unity 实现ASP.NET Web API 依赖注入

公告