NopCommerce架构分析之一----依赖类生成容器

时间:2021-02-12 11:57:51

NopCommerce为了实现松耦合的框架设计目的,使用了IOC框架:Autofac。据有人测试,Autofac是性能好的IOC工具

1、在IOC中,组件首先需要在IOC中注册,有通过配置文件注册的,像Spring.net,也有通过特性注册的,像StructureMap,也有通过代理来注册的,像Autofac。但是IOC讲究一个原则,就是接口和实现分离。所有IOC就是生命某个具体类实现了某个接口。然后在使用时,系统从IOC中获取接口的实现类,并创建对象。

2、下面来看NopCommerce如何使用Autofac实现松耦合的框架设计的。其实它的插件机制也是通过Autofac来实现的。

IOC的封装及灵活使用机制主要在Nop.Core.Infrastructure中封装的。在Autofac中,对象又称为组件。组件生命周期分为:单例、临时和生命周期域内,如下定义:

  1. namespace Nop.Core.Infrastructure.DependencyManagement
  2. {
  3. public enum ComponentLifeStyle
  4. {
  5. Singleton = 0,
  6. Transient = 1,
  7. LifetimeScope = 2
  8. }
  9. }

Autofac中有容器、并提供方法注册接口及其类型,还提供方法查找到注册的类型,以及自动创建对象。

3、类型查找器

为了支持插件功能,以及支持一些自动注册的功能。系统提供了类型查找器。ITypeFinder以及实现类就是提供此功能。通过类型查找器可以查找本程序域中的类,也可以查找整个bin目录下所有动态链接库中类,并把它们注册到类型反转容器中。ITypeFinder以及实现类如下:

4、类型注册

容器管理类:ContainerManager,管理通过Autofac生成的容器;

容器配置器:ContainerConfigurer:配置依赖反转容器,建立整个框架的类型依赖注册和类型查找类之间的关系。

在系统中有一个依赖类引擎上下文环境:EngineContext,可以根据配置文件生成引擎,此引擎是负责根据类型接口从容器中返回对象。

系统默认引擎NopEngine,若没有配置有效的引擎,即用默认引擎,生成的引擎保存在单例容器中。

它们的关系如下:

系统在类MvcApplication的方法Application_Start中初始化引擎上下文。并通过调用EngineContext.Initialize(false);实现所有反转依赖的注册功能;

5、容器注册类

系统注册接口为:IDependencyRegistrar,系统通过ContainerConfigurer注册此接口以及实现类的,并通过ITypeFinder类搜寻程序集里实现接口IDependencyRegistrar的类。代码如下:

  1. namespace Nop.Core.Infrastructure.DependencyManagement
  2. {
  3. /// <summary>
  4. /// Configures the inversion of control container with services used by Nop.
  5. /// </summary>
  6. public class ContainerConfigurer
  7. {
  8. public virtual void Configure(IEngine engine, ContainerManager containerManager, EventBroker broker, NopConfig configuration)
  9. {
  10. //other dependencies
  11. containerManager.AddComponentInstance<NopConfig>(configuration, "nop.configuration");
  12. containerManager.AddComponentInstance<IEngine>(engine, "nop.engine");
  13. containerManager.AddComponentInstance<ContainerConfigurer>(this, "nop.containerConfigurer");
  14. //type finder
  15. containerManager.AddComponent<ITypeFinder, WebAppTypeFinder>("nop.typeFinder");
  16. //register dependencies provided by other assemblies
  17. var typeFinder = containerManager.Resolve<ITypeFinder>();
  18. containerManager.UpdateContainer(x =>
  19. {
  20. var drTypes = typeFinder.FindClassesOfType<IDependencyRegistrar>();
  21. var drInstances = new List<IDependencyRegistrar>();
  22. foreach (var drType in drTypes)
  23. drInstances.Add((IDependencyRegistrar)Activator.CreateInstance(drType));
  24. //sort
  25. drInstances = drInstances.AsQueryable().OrderBy(t => t.Order).ToList();
  26. foreach (var dependencyRegistrar in drInstances)
  27. dependencyRegistrar.Register(x, typeFinder);
  28. });
  29. //event broker
  30. containerManager.AddComponentInstance(broker);
  31. }
  32. }
  33. }

而接口IDependencyRegistrar的内容如下:

  1. namespace Nop.Core.Infrastructure.DependencyManagement
  2. {
  3. public interface IDependencyRegistrar
  4. {
  5. /// <summary>
  6. /// 此方法在通过ContainerBuilder注册依赖关系。
  7. /// </summary>
  8. /// <param name="builder">容器管理者类</param>
  9. /// <param name="typeFinder">类型查找者接口</param>
  10. void Register(ContainerBuilder builder, ITypeFinder typeFinder);
  11. /// <summary>
  12. /// 注册排序序号
  13. /// </summary>
  14. int Order { get; }
  15. }
  16. }

6、单例类容器

单例类系列保存系统中与程序相同生命周期的单例对象,或者叫做单例类容器。

其中包括实体类,集合类和字典类的单例容器。

Singleton<T>,SingletonList<T>,SingletonDictionary<TKey, TValue>。EngineContext就是通过Singleton<T>类来管理引擎的。

7、MVC 服务提供类。

类型依赖获取器:NopDependencyResolver,通过继承mvc下的接口:IDependencyResolver,并在Application_Start方法中注册,使之在系统启动时调用。

  1. //set dependency resolver
  2. var dependencyResolver = new NopDependencyResolver();
  3. DependencyResolver.SetResolver(dependencyResolver);

8、其他

事件拦截类:EventBroker:过滤向系统发送的请求,防止由于临时的错误或异常导致系统崩溃。

系统启动时执行任务:IStartupTask,启动时执行的任务主要是数据库的初始化和加载。