从零开始实现ASP.NET Core MVC的插件式开发(一) - 使用ApplicationPart动态加载控制器和视图

标题：从零开始实现ASP.NET Core MVC的插件式开发(一) - 使用Application Part动态加载控制器和视图
做者：Lamond Lu
地址：https://www.cnblogs.com/lwqlun/p/11137788.html
源代码：https://github.com/lamondlu/Mystique

前言

若是你使用过一些开源CMS的话，确定会用过其中的的插件化功能，用户能够经过启用或者上传插件包的方式动态添加一些功能，那么在ASP.NET Core MVC中如何实现插件化开发呢，下面咱们来探究一下。

本系列只是笔者的一些尝试，并不表示必定正确，只是为了分享一些思路，你们能够一块儿讨论一下，后续会不断更新。

什么是ApplicationPart?

在ASP.NET Core中进行插件话开发，就不得不说ApplicationPart。 ApplicationPart是ASP.NET Core一个重要组件，它是应用程序资源的一种抽象，经过它能够发现程序集中包含的控制器、视图组件、TagHelper和预编译Razor视图等MVC功能。

默认状况下，当一个ASP.NET Core MVC应用启动时，它只会尝试在当前应用启动的项目及引用的项目中加载控制器，若是想从未直接引用的程序集中加载控制器和预编译Razor视图，咱们就须要借助ApplicationPart了。

而ASP.NET Core MVC中，有一个ApplicaitonPartManager类, 经过ApplicationPartManager咱们能够来配置当前应用中使用哪一些ApplicationPart。

例：

var assembly = Assembly.LoadFile("demo.dll");

var assemblyPart = new AssemblyPart(assembly);

var mvcBuilders = services.AddMvc();

mvcBuilders.ConfigureApplicationPartManager(apm =>
{
    apm.ApplicationParts.Add(assemblyPart);
});

下面呢，咱们经过一个最简单的实例，给你们演示一下如何借助ApplicationPart，动态加载第三方程序集中的控制器和预编译视图。

建立项目

首先咱们建立一个ASP.NET Core MVC的站点，命名为DynamicPluginsDemoSite

而后咱们同时建立一个.NET Core Class Library项目，命名为DemoPlugin1, 同时对该项目引用

• Microsoft.AspNetCore.App
• Microsoft.AspNetCore.Razor
• Microsoft.AspNetCore.Razor.Design

注意： 针对以上3个程序集，须要保证DynamicPluginsDemoSite和DemoPluigin1使用的相同的版本。

这里为了保证Razor视图的预编译，咱们须要打开DemoPlugin1项目的工程文件DemoPlugin1.csproj。将项目使用的SDK从"Microsoft.NET.Sdk"改成"Microsoft.Net.Sdk.Razor"。

<Project Sdk="Microsoft.NET.Sdk.Razor">

  <PropertyGroup>
    <TargetFramework>netcoreapp2.2</TargetFramework>
  </PropertyGroup>

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
    <OutputPath>C:\Users\Lamond Lu\source\repos\DynamicPlugins\DynamicPluginsDemoSite\bin\Debug</OutputPath>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.App" Version="2.2.0" />
    <PackageReference Include="Microsoft.AspNetCore.Razor" Version="2.2.0" />
    <PackageReference Include="Microsoft.AspNetCore.Razor.Design" Version="2.2.0" />
  </ItemGroup>

</Project>

注：若是不作此修改，最后项目编译以后，不会产生预编译的Razor视图程序集。（这里若是有其余更优雅的修改方式，请你们留言， 我后续会先尝试先编写一个项目模板来避免这个重复操做）。

添加控制器和视图

下面咱们开始编写咱们的插件。

这里咱们首先建立一个Plugin1Controller.cs.

public class Plugin1Controller : Controller
    {
        public IActionResult HelloWorld()
        {
            return View();
        }
    }

而后咱们添加一个对应的视图文件HelloWorld.cshtml。

@{

}

<h1>This is Demo Plugin1.</h1>

最终项目文件目录以下：

最后咱们须要修改一个项目的输出目录，咱们须要将项目编译的dll发送到DynamicPluginsDemoSite项目的Debug目录中。

以上咱们就完成了第一个组件的全部修改，下面咱们开始修改DynamicPluginsDemoSite项目。

如何动态加载插件中的控制器?

因为DynamicPluginsDemoSite项目不能直接引用DemoPlugin1, 因此当项目启动时，不能自主发现DemoPlugin1项目中的控制器，因此这里咱们须要使用ApplicationPart将DemoPlugin1的程序集加载到当前的运行环境中。

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        // This lambda determines whether user consent for non-essential cookies is needed for a given request.
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });


    var assembly = Assembly.LoadFile(AppDomain.CurrentDomain.BaseDirectory + "DemoPlugin1.dll");
    var mvcBuilders = services.AddMvc();
    var controllerAssemblyPart = new AssemblyPart(assembly);

    mvcBuilders.ConfigureApplicationPartManager(apm =>
    {
        apm.ApplicationParts.Add(controllerAssemblyPart);
    });

    mvcBuilders.SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

代码解释:

• 因为前一步中， 咱们将DemoPlugin1的程序集输出到了DynamicPluginsDemoSite的Debug目录中，因此这里咱们可使用Assembly.LoadFile方法将它加载。
• 这里咱们使用AssemblyPart类，将加载程序集封装成一个ApplicationPart.
• mvcBuilders对象的ConfigureApplicationPartManager方法能够用来配置当前项目中使用的ApplicationPart

如何加载组件的预编译Razor视图？

加载完控制器以后，咱们还须要加载插件的预编译Razor视图。这里和以前的稍有不一样，咱们须要使用CompileRazorAssemblyPart来封装加载的预编译Razor视图。

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        // This lambda determines whether user consent for non-essential cookies is needed for a given request.
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });


    var assembly = Assembly.LoadFile(AppDomain.CurrentDomain.BaseDirectory + "DemoPlugin1.dll");
    var assemblyView = Assembly.LoadFile(AppDomain.CurrentDomain.BaseDirectory + "DemoPlugin1.Views.dll");
    var viewAssemblyPart = new CompiledRazorAssemblyPart(assemblyView);

    var controllerAssemblyPart = new AssemblyPart(assembly);
    var mvcBuilders = services.AddMvc();

    mvcBuilders.ConfigureApplicationPartManager(apm =>
    {
        apm.ApplicationParts.Add(controllerAssemblyPart);
        apm.ApplicationParts.Add(viewAssemblyPart);
    });

    mvcBuilders.SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

最终效果

如今咱们启动DynamicPluginsDemoSite，在浏览器中输入/Plugin1/HelloWorld, 咱们的插件就正常启用了。

注意：在启动DynamicPluginsDemoSite站点以前，请务必先编译DemoPlugin1项目，这样DemoPlugin1产生的程序集才会输出到DynamicPluginsDemoSite中。

总结

以上只是实现了一个最简单的MVC插件功能，要想完善整个项目，后续还有不少工做要作

• 须要建立一个插件模板，来避免一些重复操做。
• 须要将插件的模型和业务抽象出来。
• 须要改用数据库来保存插件信息。
• 须要支持实现插件的管理以及插件的升级。

后续我会慢慢实现以上功能，你们敬请期待。