解决程序集加载问题

.NET Framework 为需要对程序集加载进行更多控制的应用程序提供 AppDomain.AssemblyResolve 事件。 通过处理此事件,应用程序可从标准探测路径外将程序集加载到加载上下文中,从若干个程序集版本中选择要加载的程序集版本,发出动态程序集并返回它等。 本主题提供了用于处理 AssemblyResolve 事件的指南。

注意注意

若要在仅反射上下文中解决程序集加载,请改用 AppDomain.ReflectionOnlyAssemblyResolve 事件。

AssemblyResolve 事件的工作方式

当您为 AssemblyResolve 事件注册处理程序时,只要运行时无法按名称绑定到程序集,即调用该处理程序。 例如,从用户代码中调用下面的方法会导致引发 AssemblyResolve 事件:

事件处理程序执行的操作

AssemblyResolve 事件的处理程序在 ResolveEventArgs.Name 属性中接收要加载的程序集的显示名称。 如果处理程序无法识别程序集名称,它将返回 null(在 Visual Basic 中为 Nothing,在 Visual C++ 中为 nullptr)。

如果处理程序识别程序集名称,则可以加载并返回满足请求的程序集。 下面的列表介绍一些示例方案。

  • 如果处理程序了解程序集版本的位置,则可以使用 Assembly.LoadFromAssembly.LoadFile 方法加载程序集,并在成功后返回加载的程序集。

  • 如果处理程序可以访问存储为字节数组的程序集的数据库,则可以使用采用一个字节数组的 Assembly.Load 方法重载之一来加载字节数组。

  • 处理程序可以生成动态程序集并返回它。

注意注意

处理程序必须将程序集加载到加载位置上下文、加载上下文中,或没有上下文。如果处理程序使用 Assembly.ReflectionOnlyLoadAssembly.ReflectionOnlyLoadFrom 方法将程序集加载到仅反射上下文中,则引发 AssemblyResolve 事件的加载尝试将失败。

事件处理程序负责返回合适的程序集。 处理程序可通过将 ResolveEventArgs.Name 属性值传递给 AssemblyName(String) 构造函数来分析请求的程序集的显示名称。 从 .NET Framework 4 版开始,处理程序可以使用 ResolveEventArgs.RequestingAssembly 属性来确定当前请求是否为其他程序集的依赖项。 此信息可帮助标识将满足依赖项的程序集。

事件处理程序可以返回与请求的程序集版本不同的版本。

在大多数情况下,无论处理程序将程序集加载到哪个上下文中,处理程序返回的程序集都会出现在加载上下文中。 例如,如果处理程序使用 Assembly.LoadFrom 方法将程序集加载到加载位置上下文中,则当处理程序返回该程序集时,它将出现在加载上下文中。 但是,在下面的示例中,当处理程序返回程序集时,将显示程序集,但没有上下文:

有关上下文的信息,请参见 Assembly.LoadFrom(String) 方法重载。

可将同一程序集的多个版本加载到同一应用程序域中。 此做法会导致类型分配问题,因此不建议使用。 请参见适用于程序集加载的最佳做法

事件处理程序不应执行的操作

处理 AssemblyResolve 事件的主要规则是不应尝试返回无法识别的程序集。 当您编写处理程序时,应知道哪些程序集可能引发该事件。 您的处理程序应为其他程序集返回 null。

重要说明重要事项

从 .NET Framework 4 开始,会为附属程序集引发 AssemblyResolve 事件。如果处理程序尝试解决所有程序集加载请求,则此更改将影响为 .NET Framework 的早期版本编写的事件处理程序。忽略其无法识别的程序集的事件处理程序不受此更改的影响:它们返回 null,并执行标准回退机制。

加载程序集时,事件处理程序不能使用任何可能导致递归引发 AssemblyResolve 事件的 AppDomain.LoadAssembly.Load 方法重载,因为这会导致堆栈溢出。 (请参见本主题前面提供的列表。)即使为负载请求提供异常处理,也会出现这种情况,因为在所有事件处理程序都返回之前不会引发任何异常。 因此,如果找不到 MyAssembly,则下面的代码会导致堆栈溢出:

Imports System
Imports System.Reflection

Class BadExample

    Shared Sub Main()

        Dim ad As AppDomain = AppDomain.CreateDomain("Test")
        AddHandler ad.AssemblyResolve, AddressOf MyHandler

        Try
            Dim obj As object = ad.CreateInstanceAndUnwrap(
                "MyAssembly, version=1.2.3.4, culture=neutral, publicKeyToken=null",
                "MyType")
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Sub

    Shared Function MyHandler(ByVal source As Object, _
                              ByVal e As ResolveEventArgs) As Assembly
        Console.WriteLine("Resolving {0}", e.Name)
        Return Assembly.Load(e.Name)
    End Function
End Class

' This example produces output similar to the following:
'
'Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
'Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
'...
'Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
'Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
'
'Process is terminated due to StackOverflowException.
using System;
using System.Reflection;

class BadExample
{
    static void Main()
    {
        AppDomain ad = AppDomain.CreateDomain("Test");
        ad.AssemblyResolve += MyHandler;

        try
        {
            object obj = ad.CreateInstanceAndUnwrap(
                "MyAssembly, version=1.2.3.4, culture=neutral, publicKeyToken=null",
                "MyType");
        } 
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }

    static Assembly MyHandler(object source, ResolveEventArgs e) 
    {
        Console.WriteLine("Resolving {0}", e.Name);
        return Assembly.Load(e.Name);
    }
} 

/* This example produces output similar to the following:

Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
...
Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null

Process is terminated due to StackOverflowException.
 */
using namespace System;
using namespace System::Reflection;

ref class Example
{
internal:
    static Assembly^ MyHandler(Object^ source, ResolveEventArgs^ e) 
    {
        Console::WriteLine("Resolving {0}", e->Name);
        return Assembly::Load(e->Name);
    }
};

void main()
{
    AppDomain^ ad = AppDomain::CreateDomain("Test");
    ad->AssemblyResolve += gcnew ResolveEventHandler(&Example::MyHandler);

    try
    {
        Object^ obj = ad->CreateInstanceAndUnwrap(
            "MyAssembly, version=1.2.3.4, culture=neutral, publicKeyToken=null",
            "MyType");
    } 
    catch (Exception^ ex)
    {
        Console::WriteLine(ex->Message);
    }
}

/* This example produces output similar to the following:

Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
...
Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null
Resolving MyAssembly, Version=1.2.3.4, Culture=neutral, PublicKeyToken=null

Process is terminated due to StackOverflowException.
 */

请参见

其他资源

适用于程序集加载的最佳做法

使用应用程序域