NopCommerce源码架构详解--TypeFinder程序集类型自动查找及操作相关源码分析

今天我们来看看NopCommerce源码一个值得借鉴的设计，TypeFinder类型自动查找。它会自动去程序的bin目录或者AppDomain下查找满足指定类型的的所有类型的集合。比如：

var consumers = typeFinder.FindClassesOfType(typeof(IConsumer<>)).ToList();

上面代码就是查找实现接口所有的类。仅可以查找指定类型，还可以获取全部的程序集，如下：

typeFinder.GetAssemblies().ToArray()

利用以上两点就可以利用IoC容器对查找的类型进行遍历注册。下面是我从nopCommerce源码中找到关于IoC和TypeFinder使用的代码。

builder.RegisterControllers(typeFinder.GetAssemblies().ToArray());

var consumers = typeFinder.FindClassesOfType(typeof(IConsumer<>)).ToList();
foreach (var consumer in consumers)
{
builder.RegisterType(consumer)
.As(consumer.FindInterfaces((type, criteria) =>
{
var isMatch = type.IsGenericType && ((Type)criteria).IsAssignableFrom(type.GetGenericTypeDefinition());
return isMatch;
}, typeof(IConsumer<>)))
.InstancePerLifetimeScope();
}

从上面我们知道了Nop中TypeFinder的作用，那么它又是怎么实现的呢？下面我就来说说TypeFinder的原理。同样我们来看看这部分相关代码的类图：

TypeFinder相关的类及作用：

1、ITypeFinder：类型查找抽象接口

2、AppDomainTypeFinder：在当前运行中的AppDomain中查找相关类型的集合

3、WebAppTypeFinder：在当前的web App的bin查找相关类型的集合

4、DependencyRegistrar：依赖注册

5、NopEngine：Nop引擎

接下来我们来看看这些类的核心代码及作用。

Nop.Core.Infrastructure.ITypeFinder

public interface ITypeFinder
{
IList<Assembly> GetAssemblies();
IEnumerable<Type> FindClassesOfType(Type assignTypeFrom, bool onlyConcreteClasses = true);
IEnumerable<Type> FindClassesOfType(Type assignTypeFrom, IEnumerable<Assembly> assemblies, bool onlyConcreteClasses = true);
IEnumerable<Type> FindClassesOfType<T>(bool onlyConcreteClasses = true);
IEnumerable<Type> FindClassesOfType<T>(IEnumerable<Assembly> assemblies, bool onlyConcreteClasses = true);
}

Nop.Core.Infrastructure.AppDomainTypeFinder

public class AppDomainTypeFinder : ITypeFinder
{
#region Fields
private bool ignoreReflectionErrors = true;
private bool loadAppDomainAssemblies = true;
//忽略一些系统程序集及其它特殊程序集
private string assemblySkipLoadingPattern = "^System|^mscorlib|^Microsoft|^AjaxControlToolkit|^Antlr3|^Autofac|^AutoMapper|^Castle|^ComponentArt|^CppCodeProvider|^DotNetOpenAuth|^EntityFramework|^EPPlus|^FluentValidation|^ImageResizer|^itextsharp|^log4net|^MaxMind|^MbUnit|^MiniProfiler|^Mono.Math|^mvcContrib|^Newtonsoft|^NHibernate|^nunit|^Org.Mentalis|^PerlRegex|^QuickGraph|^Recaptcha|^Remotion|^RestSharp|^Rhino|^Telerik|^Iesi|^TestDriven|^TestFu|^UserAgentStringLibrary|^VJSharpCodeProvider|^WebActivator|^WebDev|^WebGrease";
private string assemblyRestrictToLoadingPattern = ".*";
private IList<string> assemblyNames = new List<string>();
#endregion
#region Methods
public IEnumerable<Type> FindClassesOfType<T>(bool onlyConcreteClasses = true)
{
return FindClassesOfType(typeof(T), onlyConcreteClasses);
}
public IEnumerable<Type> FindClassesOfType(Type assignTypeFrom, bool onlyConcreteClasses = true)
{
return FindClassesOfType(assignTypeFrom, GetAssemblies(), onlyConcreteClasses);
}
public IEnumerable<Type> FindClassesOfType<T>(IEnumerable<Assembly> assemblies, bool onlyConcreteClasses = true)
{
return FindClassesOfType(typeof (T), assemblies, onlyConcreteClasses);
}
public IEnumerable<Type> FindClassesOfType(Type assignTypeFrom,
IEnumerable<Assembly> assemblies, bool onlyConcreteClasses = true)
{
var result = new List<Type>();
try
{
foreach (var a in assemblies)
{
Type[] types = null;
try
{
types = a.GetTypes();
}
catch
{
//Entity Framework 6 doesn't allow getting types (throws an exception)
if (!ignoreReflectionErrors)
{
throw;
}
}
if (types != null)
{
foreach (var t in types)
{
if (assignTypeFrom.IsAssignableFrom(t)
|| (assignTypeFrom.IsGenericTypeDefinition && DoesTypeImplementOpenGeneric(t, assignTypeFrom)))
{
if (!t.IsInterface)
{
if (onlyConcreteClasses)
{
if (t.IsClass && !t.IsAbstract)
{
result.Add(t);
}
}
else
{
result.Add(t);
}
}
}
}
}
}
}
catch (ReflectionTypeLoadException ex)
{
var msg = string.Empty;
foreach (var e in ex.LoaderExceptions)
msg += e.Message + Environment.NewLine;
var fail = new Exception(msg, ex);
Debug.WriteLine(fail.Message, fail);
throw fail;
}
return result;
}
/// <summary>获取指定类型的所有实现类</summary>
/// <returns>A list of assemblies that should be loaded by the Nop factory.</returns>
public virtual IList<Assembly> GetAssemblies()
{
var addedAssemblyNames = new List<string>();
var assemblies = new List<Assembly>();
if (LoadAppDomainAssemblies)
AddAssembliesInAppDomain(addedAssemblyNames, assemblies);
AddConfiguredAssemblies(addedAssemblyNames, assemblies);
return assemblies;
}
#endregion
#region Utilities
/// <summary>
/// 遍历AppDomain下的所有程序集并与指定类型进行比较，如果匹配就加入要返回的List中
/// </summary>
/// <param name="addedAssemblyNames"></param>
/// <param name="assemblies"></param>
private void AddAssembliesInAppDomain(List<string> addedAssemblyNames, List<Assembly> assemblies)
{
foreach (Assembly assembly in AppDomain.CurrentDomain.GetAssemblies())
{
if (Matches(assembly.FullName))
{
if (!addedAssemblyNames.Contains(assembly.FullName))
{
assemblies.Add(assembly);
addedAssemblyNames.Add(assembly.FullName);
}
}
}
}
/// <summary>
/// 添加特定程序集到到集合中
/// </summary>
/// <param name="addedAssemblyNames"></param>
/// <param name="assemblies"></param>
protected virtual void AddConfiguredAssemblies(List<string> addedAssemblyNames, List<Assembly> assemblies)
{
foreach (string assemblyName in AssemblyNames)
{
Assembly assembly = Assembly.Load(assemblyName);
if (!addedAssemblyNames.Contains(assembly.FullName))
{
assemblies.Add(assembly);
addedAssemblyNames.Add(assembly.FullName);
}
}
}
/// <summary>
/// Check if a dll is one of the shipped dlls that we know don't need to be investigated.
/// </summary>
/// <param name="assemblyFullName">
/// The name of the assembly to check.
/// </param>
/// <returns>
/// True if the assembly should be loaded into Nop.
/// </returns>
public virtual bool Matches(string assemblyFullName)
{
return !Matches(assemblyFullName, AssemblySkipLoadingPattern)
&& Matches(assemblyFullName, AssemblyRestrictToLoadingPattern);
}
/// <summary>
/// Check if a dll is one of the shipped dlls that we know don't need to be investigated.
/// </summary>
/// <param name="assemblyFullName">
/// The assembly name to match.
/// </param>
/// <param name="pattern">
/// The regular expression pattern to match against the assembly name.
/// </param>
/// <returns>
/// True if the pattern matches the assembly name.
/// </returns>
protected virtual bool Matches(string assemblyFullName, string pattern)
{
return Regex.IsMatch(assemblyFullName, pattern, RegexOptions.IgnoreCase | RegexOptions.Compiled);
}
/// <summary>
/// Makes sure matching assemblies in the supplied folder are loaded in the app domain.
/// </summary>
/// <param name="directoryPath">
/// The physical path to a directory containing dlls to load in the app domain.
/// </param>
protected virtual void LoadMatchingAssemblies(string directoryPath)
{
var loadedAssemblyNames = new List<string>();
foreach (Assembly a in GetAssemblies())
{
loadedAssemblyNames.Add(a.FullName);
}
if (!Directory.Exists(directoryPath))
{
return;
}
//获取指定目录下以.dll为结尾的文件
foreach (string dllPath in Directory.GetFiles(directoryPath, "*.dll"))
{
try
{
var an = AssemblyName.GetAssemblyName(dllPath);
if (Matches(an.FullName) && !loadedAssemblyNames.Contains(an.FullName))
{
App.Load(an);//加载程序集到当前AppDomain中
}
//old loading stuff
//Assembly a = Assembly.ReflectionOnlyLoadFrom(dllPath);
//if (Matches(a.FullName) && !loadedAssemblyNames.Contains(a.FullName))
//{
// App.Load(a.FullName);
//}
}
catch (BadImageFormatException ex)
{
Trace.TraceError(ex.ToString());
}
}
}
/// <summary>
/// Does type implement generic?
/// </summary>
/// <param name="type"></param>
/// <param name="openGeneric"></param>
/// <returns></returns>
protected virtual bool DoesTypeImplementOpenGeneric(Type type, Type openGeneric)
{
try
{
var genericTypeDefinition = openGeneric.GetGenericTypeDefinition();
foreach (var implementedInterface in type.FindInterfaces((objType, objCriteria) => true, null))
{
if (!implementedInterface.IsGenericType)
continue;
var isMatch = genericTypeDefinition.IsAssignableFrom(implementedInterface.GetGenericTypeDefinition());
return isMatch;
}
return false;
}catch
{
return false;
}
}
#endregion
}

Nop.Core.Infrastructure.WebAppTypeFinder

WebAppTypeFinder是继承于类AppDomainTypeFinder

public class WebAppTypeFinder : AppDomainTypeFinder
{
#region Fields
private bool _ensureBinFolderAssembliesLoaded = true;
private bool _binFolderAssembliesLoaded = false;
#endregion
#region Ctor
public WebAppTypeFinder(NopConfig config)
{
this._ensureBinFolderAssembliesLoaded = config.DynamicDiscovery;
}
#endregion
#region Properties
/// <summary>
/// Gets or sets wether assemblies in the bin folder of the web application should be specificly checked for beeing loaded on application load. This is need in situations where plugins need to be loaded in the AppDomain after the application been reloaded.
/// </summary>
public bool EnsureBinFolderAssembliesLoaded
{
get { return _ensureBinFolderAssembliesLoaded; }
set { _ensureBinFolderAssembliesLoaded = value; }
}
#endregion
#region Methods
/// <summary>
/// Gets a physical disk path of \Bin directory
/// </summary>
/// <returns>The physical path. E.g. "c:\inetpub\wwwroot\bin"</returns>
public virtual string GetBinDirectory()
{
if (HostingEnvironment.IsHosted)
{
//hosted
return HttpRuntime.BinDirectory;
}
else
{
//not hosted. For example, run either in unit tests
return AppDomain.CurrentDomain.BaseDirectory;
}
}
public override IList<Assembly> GetAssemblies()
{
if (this.EnsureBinFolderAssembliesLoaded && !_binFolderAssembliesLoaded)
{
_binFolderAssembliesLoaded = true;
string binPath = GetBinDirectory();
//binPath = _webHelper.MapPath("~/bin");
LoadMatchingAssemblies(binPath);
}
return base.GetAssemblies();
}
#endregion
}

在Nop.Core.Infrastructure.NopEngine类中有以下方法：

protected virtual void RegisterDependencies(NopConfig config)
{
var builder = new ContainerBuilder();
var container = builder.Build();
//we create new instance of ContainerBuilder
//because Build() or Update() method can only be called once on a ContainerBuilder.
//dependencies
var typeFinder = new WebAppTypeFinder(config);
builder = new ContainerBuilder();
builder.RegisterInstance(config).As<NopConfig>().SingleInstance();
builder.RegisterInstance(this).As<IEngine>().SingleInstance();
//ITypeFinder接口用WebAppTypeFinder的单例对象注册绑定
builder.RegisterInstance(typeFinder).As<ITypeFinder>().SingleInstance();
builder.Update(container);
//register dependencies provided by other assemblies
builder = new ContainerBuilder();
var drTypes = typeFinder.FindClassesOfType<IDependencyRegistrar>();
var drInstances = new List<IDependencyRegistrar>();
foreach (var drType in drTypes)
drInstances.Add((IDependencyRegistrar) Activator.CreateInstance(drType));
//sort
drInstances = drInstances.AsQueryable().OrderBy(t => t.Order).ToList();
foreach (var dependencyRegistrar in drInstances)
dependencyRegistrar.Register(builder, typeFinder);
builder.Update(container);
this._containerManager = new ContainerManager(container);
//set dependency resolver
DependencyResolver.SetResolver(new AutofacDependencyResolver(container));
}

可以看到上面 typeFinder.FindClassesOfType<IDependencyRegistrar>()，查找依赖注入抽象接口的IDependencyRegistrar的全部实现类型的集合，并依次调用其方法Register。

Nop依赖注入相关原理分析看看我以前的文章NopCommerce源码架构详解--Autofac依赖注入分析

同样我们在Nop.Web.Framework.DependencyRegistrar看到下面使用ITypeFinder注册依赖对象，如下：

public virtual void Register(ContainerBuilder builder, ITypeFinder typeFinder)
{
//...省略其它代码
//controllers
builder.RegisterControllers(typeFinder.GetAssemblies().ToArray());
//...省略其它代码
//Register event consumers
var consumers = typeFinder.FindClassesOfType(typeof(IConsumer<>)).ToList();
foreach (var consumer in consumers)
{
builder.RegisterType(consumer)
.As(consumer.FindInterfaces((type, criteria) =>
{
var isMatch = type.IsGenericType && ((Type)criteria).IsAssignableFrom(type.GetGenericTypeDefinition());
return isMatch;
}, typeof(IConsumer<>)))
.InstancePerLifetimeScope();
}
}

蓝狐软件工作室 » NopCommerce源码架构详解--TypeFinder程序集类型自动查找及操作相关源码分析

NopCommerce源码架构详解--TypeFinder程序集类型自动查找及操作相关源码分析相关推荐

LNMP架构详解（2）——Mysql、PHP、Nginx源码编译过程
前言本文将介绍LNMP架构中Mysql.PHP.Nginx的源码编译过程:这时有人不仅会问:在我们使用的Linux系统中,可以从yum源中获得mysql.php,为什么要进行如此漫长复杂的过程进行编 ...
linux syslogd 源码,syslogd 详解二
相关博文: syslogd 详解一 syslogd 详解三 1. 前言上一篇博文中详细了分析了syslogd的架构,解析了syslogd的调用过程,以及syslog.conf 的详细使用方法,这一篇 ...
Android 源码编译详解【合集篇】
Android 源码编译详解[一]:服务器硬件配置及机型推荐做 Android系统开发多年,开发环境都是入职就搭建好了,入职时拿个账号密码就直接开始搞开发了,年初换了新公司,所有的项目都是刚起步,一 ...
Android四大组件之bindService源码实现详解
Android四大组件之bindService源码实现详解 Android四大组件源码实现详解系列博客目录: Android应用进程创建流程大揭秘 Android四大组件之bindServic ...
jsp漂亮的登录界面源码_【案例+源码】详解MVC框架模式及其应用
案例+源码]详解MVC框架模式及其应用写在开头: 首先我们需要知道,框架模式.模式.开发模式是三种不同的概念,但他们的目的都一样:解耦! 1.关于MVC框架模型 MVC是三个单词的缩写: M,Mod ...
详解非局部均值滤波原理以及用MATLAB源码实现
详解非局部均值滤波原理以及用MATLAB源码实现序言均值滤波.中值滤波.高斯滤波在滤除噪声的过程中,无可避免的使图像的边缘细节和纹理信息所被滤除.针对此问题,Buades[1]等人提出了非局部均值 ...
使用Gin框架集成JWT，源码、详解、面试问题
使用Gin框架集成JWT,源码.详解.面试问题一.什么是JWT Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准((RFC 7519). ...
区块链技术进阶-深入详解以太坊智能合约语言 solidity（含源码）-熊丽兵-专题视频课程...
区块链技术进阶-深入详解以太坊智能合约语言 solidity(含源码)-103人已学习课程介绍区块链开发技术进阶-深入详解以太坊智能合约语言 solidity视频培训教程:本课程是 ...
java调用webservice_笃学私教：Java开发网站架构演变过程-从单体应用到微服务架构详解...
原标题:笃学私教:Java开发网站架构演变过程-从单体应用到微服务架构详解 Java开发网站架构演变过程,到目前为止,大致分为5个阶段,分别为单体架构.集群架构.分布式架构.SOA架构和微服务架构.下 ...
Nginx 架构详解
Nginx 架构详解 nginx的下篇将会更加深入的介绍nginx的实现原理.上一章,我们了解到了如何设计一个高性能服务器,那这一章将会开始讲解,nginx是如何一步一步实现高性能服务器的. Ngin ...

NopCommerce源码架构详解--TypeFinder程序集类型自动查找及操作相关源码分析

NopCommerce源码架构详解--TypeFinder程序集类型自动查找及操作相关源码分析相关推荐

最新文章

热门文章