您的位置:首页 > 运维架构

NopCommerce是如何使用Autofac实现依赖注入的

2012-08-27 21:28 615 查看
IOC和DI

IOC中文名被称作控制反转(Inversion of Control),DI被称为依赖注入(Dependency Injection),可参考Martin Fowler的这篇文章来了解这两个概念:IoC容器和DependencyInjection模式。使用控制反转模式开发项目流程是先建立接口,然后再实现类,或许有人不习惯这样的开发方法,但在规模较大的软件架构中,这种方法却可以有效的降低类之间的互相依赖的情况,不但能增加架构的弹性,也能有效的降低软件的复杂度。

如果不考虑控制反转的情况,采用直接创建类,并直接在应用层调用该类,如此一来,应用层的对象就会与BLL(业务逻辑层)对象高度依赖,这样的依赖会导致这两个类无法拆开,从而增加了这个类的维护难度,同时导致了单元测试难以进行。为了解决耦合度问题,从而引入了控制反转的概念。

Autofac介绍

Autofac是一款IOC框架,比较于其他的IOC框架,如Spring.NET、Unity、Castle等,它更显得轻量级,同时保证了高性能。它具有以下优点:

和C#语言联系紧密,可以使用C#语言的很多特性,譬如Lambda表达式等;

较低的学习曲线,只需了解IoC和DI的概念以及在何时需要使用它们即可;

XML配置支持;

自动装配;

与ASP.NET MVC3集成;(Orchard也是使用Autofac实现IOC的)

在MVC3项目中使用Autofac

在MVC3工程中使用Autofac的最好也是最简单的方法是使用NuGet来安装Autofac.Mvc3,安装完成以后,在Global.asax的Application_Start方法中添加如下代码:

protected void Application_Start()
{
var builder = new ContainerBuilder();
builder.RegisterControllers(typeof(MvcApplication).Assembly);
var container = builder.Build();
DependencyResolver.SetResolver(new AutofacDependencyResolver(container));
// Other MVC setup...

这样就开启了Controller的依赖注入功能。其中的DependencyResolver是一个全局静态类,MVC3提供了对依赖注入的支持,SetResolver函数用于设置使用哪个Resolver(解析器)来进行依赖注入,这里使用的是Autofac的依赖注入解析器。如果要使用自己的解析器,必须在这里使用SetResolver函数设置。

1. 注册Controller

可以使用下面的方法对特定的Controller进行注册:

var builder =  new ContainerBuilder();
builder.RegisterType<HomeController>().InstancePerRequest();

同时可以使用Autofac提供的RegisterControllers扩展方法来对程序集中所有的Controller一次性的完成注册:

var builder = new ContainerBuilder();
builder.RegisterControllers(Assembly.GetExecutingAssembly());

2. 注册Model Binder

与控制器的注册类似,模型绑定也可以再Global.asax.cs中注册。您可以通过如下操作完成整个程序集的注册:

var builder = newContainerBuilder();
builder.RegisterModelBinders(Assembly.GetExecutingAssembly());
builder.RegisterModelBinderProvider();

您也必须记住使用RegisterModelBinderProvider扩展方法来注册RegisterModelBinderProvider。这个方法用是Autofac对IModelBinderProvider接口的实现。

因为RegisterModelBinders扩展方法通过扫描程序集来添加模型绑定的,所以您需要指定IModelBuilder注册的目标类是什么类型。

[ModelBinderType(typeof(string))]
public class StringBinder : IModelBinder
{
public override object BindModel(ControllerContext controllerContext,ModelBindingContext bindingContext)
{
//do implementation here
}
}

多行的ModelBuilderTypeAttribute实例可以添加到需要对个类型注册的类中。

3. 注入HTTP抽象类

MVC集成的Autofac模块将会为HTTP抽象类添加HTTP 请求的生命收起范围内的注册。包括依稀抽象类:

HttpContextBase

HttpRequestBase

HttpResponseBase

HttpServerUtilityBase

HttpSessionStateBase

HttpApplicationStateBase

HttpBrowserCapabilitiesBase

HttpCachePolicyBase

VirtualPathProvider

需要使用上面的抽象应该使用容器的RegisterModule方法来添加AutofacWebTypesModule

builder.RegisterModule(newAutofacWebTypesModule());


4. 注入View page

您可以通过在容器创建之前添加ViewRegistrationSource 到容器中使属性注入来使MVC页面可用。

builder.RegisterSource(newViewRegistrationSource());


您的viewpage必须继承MVC类中用于创建,当使用Razor试图引擎时将需要继承WebViewPage类:

public abstract class CustomViewPage : WebViewPage
{
public IDependencyDependency { get; set; }
}


当使用的是webform的试图引擎时,ViewPage,ViewMasterPage和ViewUserControl类都得到相应的支持。

public abstract class CustomViewPage : ViewPage
{
public IDependencyDependency { get; set; }
}


必须确保您实际的试图页面继承了您自定义的基类。在Razor视图引擎.cshtml中可以使用@inherits指令来实现:

@inherits Example.Views.Shared.CustomViewPage


使用webform时可以做如下设置

<%@ PageLanguage="C#" MasterPageFile="~/Views/Shared/Site.Master" Inherits="Example.Views.Shared.CustomViewPage" %>


5. 对Filter Attribute进行属性注入

为过滤器使用属性注入必须在容器创建之前调用RegisterFilterProvider方法,并将其传到AutofacDependencyResolver

ContainerBuilder builder = new ContainerBuilder();
builder.RegisterControllers(Assembly.GetExecutingAssembly());
builder.Register(c => new Logger()).As<ILogger>().InstancePerHttpRequest();
builder.RegisterFilterProvider();
IContainer container = builder.Build();
DependencyResolver.SetResolver(new AutofacDependencyResolver(container));


然后您就可以为您的过滤器添加属性了,并且

public class CustomActionFilter : ActionFilterAttribute
{
public ILogger Logger { get; set; }

public override void OnActionExecuting(ActionExecutingContext filterContext)
{
Logger.Log("OnActionExecuting");
}
}


下面是类似用户验证过滤器的自定义特性

public class CustomAuthorizeAttribute : AuthorizeAttribute
{
public ILogger Logger { get; set; }

protected override bool AuthorizeCore(HttpContextBase httpContext)
{
Logger.Log("AuthorizeCore");
return true;
}
}


应用如下:

[CustomActionFilter]
[CustomAuthorizeAttribute]
public ActionResult Index()
{
// ...
}

关于Autofac更多的信息,可以参考autofac在google code上的wiki文档:http://code.google.com/p/autofac/wiki/Mvc3Integration

NopCommerce是如何使用Autofac实现依赖注入的?


NopCommerce将所有和Autofac注入相关的工作都放到了EngineContext中,在Global.asax的Application_Start函数的第一句代码即是:


//initialize engine context
EngineContext.Initialize(false);


从这里开始EngineContext的初始化工作,初始化时会创建一个新的NopEngine,参数false指定当NopEngine不为空时是否重新生成一个新的NopEngine。


[MethodImpl(MethodImplOptions.Synchronized)]
public static IEngine Initialize(bool forceRecreate)
{
if (Singleton<IEngine>.Instance == null || forceRecreate)
{
var config = ConfigurationManager.GetSection("NopConfig") as NopConfig;
Debug.WriteLine("Constructing engine " + DateTime.Now);
Singleton<IEngine>.Instance = CreateEngineInstance(config);
Debug.WriteLine("Initializing engine " + DateTime.Now);
Singleton<IEngine>.Instance.Initialize(config);
}
return Singleton<IEngine>.Instance;
}


NopEngine使用单例模式,在整个程序运行期间存在一个实例,代码首先会判断NopEngine是否为空,为空的话则根据web.config中配置的NopConfig节点信息创建一个新的NopEngine实例,然后对该实例进行初始化操作。web.config中的配置信息如下:


<configSections>
<section name="NopConfig" type="Easy.Core.Configuration.NopConfig, Easy.Core" requirePermission="false" />
</configSections>
<NopConfig>
<DynamicDiscovery Enabled="true" />
<Engine Type="" />
<Themes basePath="~/Themes/" />
</NopConfig>

CreateEngineInstance函数中使用new NopEngine()创建了一个NopEngine实例,在NopEngine的构造函数处对Autofac的容器(Container)作了初始化,如下代码:

public NopEngine(EventBroker broker, ContainerConfigurer configurer)
{
var config = ConfigurationManager.GetSection("NopConfig") as NopConfig;
InitializeContainer(configurer, broker, config);
}

private void InitializeContainer(ContainerConfigurer configurer, EventBroker broker, NopConfig config)
{
var builder = new ContainerBuilder();

_containerManager = new ContainerManager(builder.Build());
configurer.Configure(this, _containerManager, broker, config);
}

NopCommerce通过ContainerManager对容器做了一层封装,方便对其他类型的IOC框架的扩充和支持。Configure函数完成了所有依赖的注入,同时查找所有实现了IDependencyRegistrar接口的类,并调用其Register方法,注册内容包括Http context、web helper、controller、data layer、plugin、cache manager、work context、services、settings、event consumers等等。

关于ContainerManager/ContainerConfigurer和IDependencyRegistrar是实现IOC的关键,下面对这两个部分做详细的讨论。

// todo:仍需继续分析具体实现


ContainerManager/ContainerConfigurer

ContainerManagerContainerManager对依赖注入中使用的容器做了一层封装,提供了这些函数:


AddComponent/AddComponentInstance/AddComponentWithParameters

Resolve/ResolveAll/ResovleUnregistered

UpdateContainer

DependencyRegistrar

web helper

controller

data layer

plugin

cache manager

work context

services

settings

event consumers

来源:http://www.iyiruan.com/Blog/Detail?id=43
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: