从零开始实现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。

例：

Copy

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"。

Copy

<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.

Copy

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

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

Copy

@{

}

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

最终项目文件目录如下：

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

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

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

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

Copy

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视图。

Copy

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插件功能，要想完善整个项目，后续还有很多工作要做

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

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

原文地址：https://www.cnblogs.com/luomingui/p/12573193.html

时间： 2024-10-15 06:30:21

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

从零开始实现ASP.NET Core MVC的插件式开发(四) - 插件安装

标题:从零开始实现ASP.NET Core MVC的插件式开发(四) - 插件安装 作者:Lamond Lu 地址:https://www.cnblogs.com/lwqlun/p/11343141.html 源代码:https://github.com/lamondlu/DynamicPlugins 前情回顾 从零开始实现ASP.NET Core MVC的插件式开发(一) - 使用Application Part动态加载控制器和视图 从零开始实现ASP.NET Core MVC的插件式开发(二

从零开始实现ASP.NET Core MVC的插件式开发(六) - 如何加载插件引用

标题:从零开始实现ASP.NET Core MVC的插件式开发(六) - 如何加载插件引用. 作者:Lamond Lu 地址:https://www.cnblogs.com/lwqlun/p/11717254.html 源代码:https://github.com/lamondlu/DynamicPlugins 前景回顾 从零开始实现ASP.NET Core MVC的插件式开发(一) - 使用Application Part动态加载控制器和视图 从零开始实现ASP.NET Core MVC的插件

从零开始实现ASP.NET Core MVC的插件式开发(五) - 插件的删除和升级

标题:从零开始实现ASP.NET Core MVC的插件式开发(五) - 使用AssemblyLoadContext实现插件的升级和删除作者:Lamond Lu地址:https://www.cnblogs.com/lwqlun/p/11395828.html源代码:https://github.com/lamondlu/Mystique 前景回顾: 从零开始实现ASP.NET Core MVC的插件式开发(一) - 使用Application Part动态加载控制器和视图 从零开始实现ASP.N

插件式换肤框架搭建 - 资源加载源码分析

1. 概述 大部分控件我们都会使用,但是我们未必知道其资源加载的原理,目前换肤的框架比较多我们可以随随便便拿过来用,但早在几年前这些资料是比较少的,如果想做一个换肤的框架那就只能自己一点一点啃源码. 如果说我们现在不去用第三方的开源框架,要做一个换肤的功能,摆在我们面前的其实只有一个问题需要解决,那就是如何读取另外一个皮肤apk中的资源. 所有分享大纲:2017Android进阶之路与你同行 视频讲解地址:http://pan.baidu.com/s/1bC3lAQ 2. 资源加载源码分析 2.

asp.net mvc5轻松实现插件式开发

在研究Nopcommece项目代码的时候,发现Nop.Admin是作为独立项目开发的,但是部署的时候却是合在一起的,感觉挺好 这里把他这个部分单独抽离出来, 主要关键点: 确保你的项目是MVC5 而不是MVC4或者以前的版本 至少我用MVC4没成功,而且折腾了蛮久, 自定义ViewEngine using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.

基于AppDomain的&quot;插件式&quot;开发

很多时候,我们都想使用(开发)USB式(热插拔)的应用,例如,开发一个WinForm应用,并且这个WinForm应用能允许开发人员定制扩展插件,又例如,我们可能维护着一个WinService管理系统,这个WinService系统管理的形形色色各种各样的服务,这些服务也是各个"插件式"的类库,例如: public interface IJob { void Run(DateTime time); } public class CollectUserInfo : IJob { public

Pro ASP.NET Core MVC 第6版 第一章

第一章 ASP.NET Core MVC 的前世今生 ASP.NET Core MVC 是一个微软公司开发的Web应用程序开发框架,它结合了MVC架构的高效性和简洁性,敏捷开发的思想和技术,和.NET 平台的最好的部分.在本章,我们将学习为什么微软创建ASP.NET Core MVC, 看看他和他的前辈的比较以及和其他类似框架的比较,最后,大概讲一下ASP.NET core MVC里面有什么新东西,还有本书中包括哪些内容. 了解ASP.NET Core MVC的历史 最开始的ASP.NET 诞生

【目录】开始使用ASP.NET Core MVC和Visual Studio

参照微软教程:Building your first ASP.NET Core MVC app with Visual Studio This series of tutorials will teach you the basics of building an ASP.NET Core MVC web app using Visual Studio. Getting started Adding a controller Adding a view Adding a model Workin

ASP.NET Core 入门教程 2、使用ASP.NET Core MVC框架构建Web应用

原文:ASP.NET Core 入门教程 2.使用ASP.NET Core MVC框架构建Web应用 一.前言 1.本文主要内容 使用dotnet cli创建基于解决方案(sln+csproj)的项目 使用Visual Studio Code开发基于解决方案(sln+csproj)的项目 Visual Studio Code Solution插件( vscode-solution-explorer)基础使用介绍 基于 .NET Core web项目模板构建 ASP.NET Core MVC We