ASP.NET Core 中类库被自动标记为ApplicationPart的问题解析

问题背景

在ASP.NET Core Razor应用开发中，开发人员经常会遇到一个特殊现象：当项目引用其他类库时，这些类库会被自动标记为[assembly: ApplicationPart]属性。这种现象在项目编译后生成的DLL中可以看到，比如Sample.RazorApp.dll中可能会包含类似[assembly: ApplicationPart("ClassLibrary.A")]的标记。

问题表现

当应用启动时，services.AddRazorPages()方法会尝试加载所有被标记为ApplicationPart的程序集。如果其中某个被引用的类库在生产环境中不可用（由于某些内部部署要求），就会导致应用启动失败，抛出类似以下的异常：

File name: 'ClassLibrary.A, Culture=neutral, PublicKeyToken=null'
at System.Reflection.RuntimeAssembly.InternalLoad(...)
at Microsoft.AspNetCore.Mvc.ApplicationParts.ApplicationPartManager...

技术原理

ASP.NET Core的MVC/Razor Pages框架使用ApplicationPart机制来发现和加载控制器、视图组件等MVC相关类型。默认情况下，编译系统会自动将引用的程序集标记为ApplicationPart，以便框架能够发现这些程序集中可能包含的MVC相关组件。

这种行为是通过MSBuild属性GenerateMvcApplicationPartsAssemblyAttributes控制的，该属性默认为true，导致所有引用的程序集都会被自动标记。

解决方案

对于不希望被自动标记为ApplicationPart的类库，可以通过以下方式解决：

1. 项目文件配置：在被引用的类库项目中，添加以下MSBuild属性：

<PropertyGroup>
  <GenerateMvcApplicationPartsAssemblyAttributes>false</GenerateMvcApplicationPartsAssemblyAttributes>
</PropertyGroup>

2. 主项目排除：在主项目中明确排除不需要的程序集：

services.AddRazorPages()
    .ConfigureApplicationPartManager(apm => {
        var parts = apm.ApplicationParts
            .Where(part => !part.Name.Contains("ClassLibrary.A"));
        apm.ApplicationParts.Clear();
        foreach (var part in parts)
        {
            apm.ApplicationParts.Add(part);
        }
    });

最佳实践

1. 对于纯工具类库（不包含任何MVC组件），建议始终设置GenerateMvcApplicationPartsAssemblyAttributes为false
2. 对于包含MVC组件的类库，保持默认设置即可
3. 在生产环境中，确保所有被标记为ApplicationPart的程序集都能被正确加载

总结

ASP.NET Core的自动ApplicationPart标记机制虽然方便，但在特定场景下可能带来问题。理解这一机制的工作原理，并掌握如何控制它，对于构建健壮的ASP.NET Core应用至关重要。通过适当的项目配置，可以灵活控制哪些程序集应该参与MVC组件发现过程，从而避免运行时加载问题。