重温.NET下Assembly的加载过程

2022-12-28 07:36:51

最近在工作中牵涉到了.NET下的一个古老的问题：Assembly的加载过程。虽然网上有很多文章介绍这部分内容，很多文章也是很久以前就已经出现了，但阅读之后发现，并没能解决我的问题，有些点写的不是特别详细，让人看完之后感觉还是云里雾里。最后，我决定重新复习一下这个经典而古老的问题，并将所得总结于此，然后会有一个实例对这个问题进行演示，希望能够帮助到大家。

.NET下Assembly的加载过程

.NET下Assembly的加载，最主要的一步就是确定Assembly的版本。在.NET下，托管的DLL和EXE都称之为Assembly，Assembly由AssemblyName来唯一标识，AssemblyName也就是大家所熟悉的Assembly.FullName，它是由五部分：名称、版本、语言、公钥Token、处理器架构组成的，这一点相信大家都知道。有关Assembly Name的详细描述，请参考：https://docs.microsoft.com/en-us/dotnet/framework/app-domains/assembly-names。那么版本，就是AssemblyName中的一个重要组成部分。其它四部分相同，版本如果不同的话，就不能算作是同一个Assembly。设计这样一个Assembly的版本策略，微软本身就是为了解决最开始的DLL Hell的问题，在*上着关于这段黑历史的详细描述，地址是：https://en.wikipedia.org/wiki/DLL_Hell，在此也就不多啰嗦了。

Assembly版本的重定向和最终确定

.NET下Assembly的加载过程，其实也是Assembly版本的确定和Assembly文件的定位过程，步骤如下：

在一个Assembly被编译的时候，它所引用的Assembly的全名（FullName）就会被编译器强行写入Assembly的Metadata，这个值是死的，从ILSpy可以看到，每个Reference都有它的全名信息：

例如上图，System.Data依赖System.Xml，它所需要的版本是4.0.0.0，那么当CLR加载System.Data的时候，就可以暂且认为接下来需要加载的System.Xml版本是4.0.0.0。这里强调“暂且认为”，是因为这只是确定Assembly版本的第一步，那么最终System.Xml到底是不是使用4.0.0.0的版本呢？就需要看接下来这步的处理结果，也就是Assembly版本的重定向
首先，检查应用程序的配置文件，看是否存在Assembly版本重定向的设定。我们暂时先讨论应用程序配置文件就在AppDomain内的情况（如果在AppDomain之外，则需要首先下载配置文件，再继续，这里先不深入讨论）。应用程序配置文件常见的有.exe.config和web.config两种。在配置文件中，可以在runtime节点下的assemblyBinding中进行配置。例如：

在这个例子中，asm6 Assembly的版本号被重定向到2.0.0.0。那么假设这就是asm6的最终版本号，那么接下来当CLR开始加载asm6的时候，如果2.0.0.0的版本没有找到，则直接抛出FileLoadException（即使3.0.0.0的版本是存在的），整个Assembly加载过程结束。FileLoadException的详细信息类似于：Could not load file or assembly 'asm6, Version=3.0.0.0, Culture=neutral, PublicKeyToken=c0305c36380ba429' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference
如果在配置文件中找到了对应的版本重定向设定，那么，再接着查看Publisher Policy文件。Publisher Policy文件是一个仅包含配置文件的.NET Assembly，被安装到GAC里。它的Assembly版本重定向配置内容跟上面的应用程序配置文件的配置内容相同，不同的是，它的作用域是所有使用了该Assembly的应用程序。这种做法对于开发系统级通用框架的Assembly升级非常有用，比如.NET Framework。下面就是安装在GAC里的Publisher Policy文件的样本，需要注意：Publisher Policy会override应用程序配置信息中的版本重定向配置，而不是相反。换言之，假如asm6在上面这一步被确定为2.0.0.0，而所对应的Publisher Policy文件又将其确定为2.5.0.0，那么，暂且认为，CLR应该要加载2.5.0.0的版本。同理，“暂且认为”这个词表示，版本确定的过程还未结束
接下来，查找machine.config文件。同理，如果machine.config文件中存在版本重定向的设定，那么就会使用machine.config文件中的这个值，作为CLR应该去加载的Assembly的版本

至此，Assembly的最终版本已被确定，接下来就是搜索Assembly文件并进行加载的过程了。

Assembly文件的搜索和加载过程

现在，CLR已经开始加载确定版本的Assembly了，接下来就是搜索Assembly文件的过程。这个过程也叫作Assembly Probing。CLR会做以下事情：

首先，查看所需的Assembly是否已经加载过，如果已经加载了，那就直接使用那个已经加载的Assembly的版本与当前所需的版本进行比对，如果匹配，则使用那个已经加载的Assembly，如果不匹配，则抛出FileLoadException，执行结束
然后，看Assembly是否已被强签名（Strongly Named），如果是，则去GAC里查找Assembly。如果找到，则直接加载，整个Assembly加载过程结束。如果没有找到，那么就进行下一步，继续搜索Assembly文件。当然，如果Assembly没有进行强签名，那么就跳过这一步，直接继续
接着，CLR开始搜索（Probing）可能的Assembly位置，这又要分多种情况：

首先，查看文件中是否有指定<codeBase>，codeBase配置允许应用程序针对Assembly的不同版本指定装载地址，遵循如下规律：

如果所指定的Assembly文件位于当前应用程序域的启动目录（或其子目录）下，则使用相对路径指定href的值
如果所指定的Assembly文件位于其它目录，或任何其它地方，则href必须给出全路径，并且Assembly必须强签名的

然后，CLR对应用程序域的根目录以及相关的子目录进行探索：

假设Assembly的名字是abc.dll，那么CLR会探索以下目录：

[appdomain_base]\abc.dll
[appdomain_base]\abc\abc.dll

假设abc.dll还有语言设置（culture不是neutral），那么CLR会探索以下目录：

[appdomain_base]\[culture]\abc.dll
[appdomain_base]\[culture]\abc\abc.dll

如果找到符合版本的Assembly，则加载，否则进入下一步

最后，CLR会查看应用程序配置文件中是否有<probling>节点，如果有，则按probling节点所指定的privatePath值进行逐一探索。这个过程也会考虑culture的因素，类似于上面这步这样，对相应的子目录进行搜索。如果找到对应的Assembly，则加载，否则抛出FileLoadException，整个加载过程结束。注意，这里“逐一探索”的过程，不是遍历并找最佳匹配的过程。CLR仅根据Assembly的名字（不带版本号的名字）在privatePath下查找Assembly的文件，找到第一个名字匹配但是版本不匹配的话，就抛异常并终止加载了，它不会继续搜索privatePath中余下的其它路径

在加载Assembly文件失败的时候，AppDomain会触发AssemblyResolve的事件，在这个事件的订阅函数中，允许客户程序自定义对加载失败的Assembly的处理方式，比如，可以通过Assembly.LoadFrom或者Assembly.LoadFile调用“手动地”将Assembly加载到AppDomain。

fuslogvw Assembly绑定日志查看器

在.NET SDK中带了一个fuslogvw.exe的应用程序，通过它可以查看详细的Assembly加载过程。使用方法非常简单，使用管理员身份启动Visual Studio 2017 Developer Command Prompt，然后在命令行输入fuslogvw.exe，即可启动日志查看器。启动之后，点击Settings按钮，以启用日志记录功能：

日志启动之后，点击Refresh按钮，然后启动你的.NET应用程序，就可以看到当前应用程序所依赖的Assembly的加载过程日志了：

接下来，我会做一个例子程序，然后使用这个工具来分析Assembly的加载过程。

插件系统的实现与Assembly加载过程的分析

理论结合实际，看看如何通过实际代码来诠释以上所述Assembly的加载过程。一个比较好的例子就是设计一个简单的插件系统，并通过观察系统加载插件的过程，来了解Assembly加载的来龙去脉。为了简单直观，我把这个插件系统称为PluginDemo。这个插件很简单，主体程序是一个控制台应用程序，然后我们实现两个插件：Earth和Mars，在不同的插件的Initialize方法中，会输出不同的字符串。

整个应用程序的项目结构如下：

该插件系统包含4个C#的项目：

PluginDemo.Common：它定义了AddIn抽象类，所有的插件实现都需要继承于这个抽象类。此外，AddInDefinition类是一个用来保存插件Metadata的类。为了演示，插件的Metadata仅仅包含插件类型的Assembly Qualified Name
PluginDemo.App：插件系统的应用程序。这个程序执行的时候，会扫描程序目录下Modules目录中的DLL，并根据module.xml的Metadata信息，加载相应的插件对象，并执行Initialize方法
PluginDemo.Plugins.Earth：其中的一个插件实现
PluginDemo.Plugins.Mars：另一个插件实现

注意：除了PluginDemo.Common之外的其它三个项目，都对PluginDemo.Common有引用关系。而PluginDemo.App项目仅仅在项目本身依赖于PluginDemo.Plugins.Earth和PluginDemo.Plugins.Mars，它不会去引用这两个项目。目的就是为了当PluginDemo.App被编译时，其余两个插件项目也会同时被编译并输出到指定位置。

在Earth插件的CustomAddIn类中，我们实现了Initialize方法，并在此输出一个字符串：

public class CustomAddIn : AddIn

{

    public override string Name => "Earth AddIn";

    public override void Initialize()

    {

        Console.WriteLine("Earth Plugin initialized.");

    }

}

在Mars插件的CustomAddIn类中，我们也实现了Initialize方法，并在此输出一个字符串：

public class CustomAddIn : AddIn

{

    public override string Name => "Mars AddIn";

    public override void Initialize()

    {

        Console.WriteLine("Mars AddIn initialized.");

    }

}

那么，在插件系统主程序中，就会扫描Modules子目录下的module.xml文件，然后解析每个module.xml文件获得每个插件类的Assembly Qualified Name，然后通过Type.GetType方法获得插件类，进而创建实例、调用Initialize方法。代码如下：

static void Main()

{

    var directory = new DirectoryInfo("Modules");

    foreach(var file in directory.EnumerateFiles("module.xml", SearchOption.AllDirectories))

    {

        var addinDefinition = AddInDefinition.ReadFromFile(file.FullName);

        var addInType = Type.GetType(addinDefinition.FullName);

        var addIn = (AddIn)Activator.CreateInstance(addInType);

        Console.WriteLine($"{addIn.Id} - {addIn.Name}");

        addIn.Initialize();

    }

}

接下来，修改App.config文件，修改为：

<?xml version="1.0" encoding="utf-8" ?>

<configuration>

  <runtime>

    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">

      <probing privatePath="Modules\Earth;Modules\Mars;" />

    </assemblyBinding>

  </runtime>

</configuration>

此时，运行程序，可以得到：

目前没有什么问题。接下来，对两个AddIn分别做一些修改。让这两个AddIn依赖于不同版本的Newtonsoft.Json，比如，Earth依赖于7.0.0.0的版本，Mars依赖于6.0.0.0的版本，然后分别修改两个CustomAddIn的Initialize方法，在方法中各自调用一次JsonConvert.SerializeObject方法，以触发Newtonsoft.Json这个Assembly的加载。此时再次运行程序，你将看到下面的异常：

现在，刷新fuslogvw.exe，找到Newtonsoft.Json的日志：

双击打开日志，可以看到如下信息：

从整个过程可以看出：

PluginDemo.App.exe正在试图加载PluginDemo.Plugins.Mars Assembly
PluginDemo.Plugins.Mars开始调用Newtonsoft.Json
扫描应用程序配置文件、Host配置文件以及machine.config文件，均无找到Newtonsoft.Json的重定向信息，此时，Newtonsoft.Json版本确定为6.0.0.0
GAC扫描失败，继续查找文件
首先查找应用程序当前目录下有没有Newtonsoft.Json，以及Newtonsoft.Json子目录下有没有Newtonsoft.Json.dll，发现都没有，继续
然后，通过App.config中的probing的privatePath设定，首先查找Modules\Earth目录（因为这个目录放在privatePath的第一个），找到了一个叫做Newtonsoft.Json.dll的Assembly，于是，判断版本是否相同。结果，找到的是7.0.0.0，而它需要的却是6.0.0.0，版本不匹配，于是就抛出异常，退出程序

那么接下来，改一改App.config文件，将privatePath下的两个值换个位置呢？