ASP.NET MVC 4 插件化架构简单实现-实例篇

最新推荐文章于 2022-10-20 17:13:26 发布
最新推荐文章于 2022-10-20 17:13:26 发布
阅读量6.4k 收藏 6
点赞数 1
分类专栏： ASP.NET C#
C# 同时被 2 个专栏收录
15 篇文章 0 订阅
订阅专栏
ASP.NET
9 篇文章 0 订阅
订阅专栏

先回顾一下上篇决定的做法：

1、定义程序集搜索目录（临时目录）。

2、将要使用的各种程序集（插件）复制到该目录。

3、加载临时目录中的程序集。

4、定义模板引擎的搜索路径。

5、在模板引擎的查找页面方法里，给指定插件的页面加上相应的程序集。

6、检测插件目录，有改变就自动重新加载。

--------------------------------------------我是分割线--------------------------------------------

先创建一个空的MVC4项目。


清理站点


新建一个 PluginMvc.Framework 类库，并创建插件接口(IPlugin)。


定义程序集搜索目录（临时目录）。


创建一个PluginLoader的静态类，做为插件的加载器，并设置好插件目录，临时目录。

临时目录就是之前在 Web.Config 中设置的程序集搜索目录。

插件目录就是存放插件的目录。

namespace PluginMvc.Framework
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using System.Reflection;
    using System.Web.Hosting;

    /// <summary>
    /// 插件加载器。
    /// </summary>
    public static class PluginLoader
    {
        /// <summary>
        /// 插件目录。
        /// </summary>
        private static readonly DirectoryInfo PluginFolder;

        /// <summary>
        /// 插件临时目录。
        /// </summary>
        private static readonly DirectoryInfo TempPluginFolder;

        /// <summary>
        /// 初始化。
        /// </summary>
        static PluginLoader()
        {
            PluginFolder = new DirectoryInfo(HostingEnvironment.MapPath("~/Plugins"));
            TempPluginFolder = new DirectoryInfo(HostingEnvironment.MapPath("~/App_Data/Dependencies"));
        }

        /// <summary>
        /// 加载插件。
        /// </summary>
        public static IEnumerable<PluginDescriptor> Load()
        {
            List<PluginDescriptor> plugins = new List<PluginDescriptor>();

            return plugins;
        }


    }
}

将程序集复制到临时目录。

 

1、先删除临时目录中的所有文件。

2、在把插件目录中的程序集复制到临时目录里。

<span style="white-space:pre">	</span>/// <summary>
        /// 程序集复制到临时目录。
        /// </summary>
        private static void FileCopyTo()
        {
            Directory.CreateDirectory(PluginFolder.FullName);
            Directory.CreateDirectory(TempPluginFolder.FullName);

            //清理临时文件。
            foreach (var file in TempPluginFolder.GetFiles("*.dll", SearchOption.AllDirectories))
            {
                try
                {
                    file.Delete();
                }
                catch (Exception)
                {

                }

            }

            //复制插件进临时文件夹。
            foreach (var plugin in PluginFolder.GetFiles("*.dll", SearchOption.AllDirectories))
            {
                try
                {
                    var di = Directory.CreateDirectory(TempPluginFolder.FullName);
                    File.Copy(plugin.FullName, Path.Combine(di.FullName, plugin.Name), true);
                }
                catch (Exception)
                {

                }
            }
        }

加载程序集。

 

1、先获取系统自动加载的程序集（即：bin 目录下的），通过反射获得其中的插件信息（程序集、插件接口的实现，对象类型，控制器类型等）。

2、使用 Assembly.LoadFile(fileName);方法，加载插件目录下的所有程序集。

<span style="white-space:pre">	</span>/// <summary>
        /// 加载插件。
        /// </summary>
        public static IEnumerable<PluginDescriptor> Load()
        {
            List<PluginDescriptor> plugins = new List<PluginDescriptor>();

            //程序集复制到临时目录。
            FileCopyTo();

            IEnumerable<Assembly> assemblies = null;

            //加载 bin 目录下的所有程序集。
            assemblies = AppDomain.CurrentDomain.GetAssemblies();

            plugins.AddRange(GetAssemblies(assemblies));

            //加载临时目录下的所有程序集。
            assemblies = TempPluginFolder.GetFiles("*.dll", SearchOption.AllDirectories).Select(x => Assembly.LoadFile(x.FullName));

            plugins.AddRange(GetAssemblies(assemblies));

            return plugins;
        }

创建一个插件描述类，来保存插件的信息。


从程序集中反射获得插件的各种信息，并保存在插件描述中，如：插件接口的实现，控制器的类型等。

 

遍历传入的程序集集合，查找出所有实现了 IPlugin 接口的程序集，并把相关的所有信息保存到 PluginDescriptor 实体里，返回所有该实体的列表。

<span style="white-space:pre">	</span>/// <summary>
        /// 根据程序集列表获得该列表下的所有插件信息。
        /// </summary>
        /// <param name="assemblies">程序集列表</param>
        /// <returns>插件信息集合。</returns>
        private static IEnumerable<PluginDescriptor> GetAssemblies(IEnumerable<Assembly> assemblies)
        {
            IList<PluginDescriptor> plugins = new List<PluginDescriptor>();

            foreach (var assembly in assemblies)
            {
                var pluginTypes = assembly.GetTypes().Where(type => type.GetInterface(typeof(IPlugin).Name) != null && type.IsClass && !type.IsAbstract);

                foreach (var pluginType in pluginTypes)
                {
                    var plugin = GetPluginInstance(pluginType, assembly);

                    if (plugin != null)
                    {
                        plugins.Add(plugin);
                    }
                }
            }

            return plugins;
        }

<span style="white-space:pre">	</span>/// <summary>
        /// 获得插件信息。
        /// </summary>
        /// <param name="pluginType"></param>
        /// <param name="assembly"></param>
        /// <returns></returns>
        private static PluginDescriptor GetPluginInstance(Type pluginType, Assembly assembly)
        {
            if (pluginType != null)
            {
                var plugin = (IPlugin)Activator.CreateInstance(pluginType);

                if (plugin != null)
                {
                    return new PluginDescriptor(plugin, assembly, assembly.GetTypes());
                }
            }

            return null;
        }

创建一个PluginManager类，可对所有插件进行初始化、卸载与获取。 

namespace PluginMvc.Framework
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using System.Reflection;
    using System.Web.Hosting;

    /// <summary>
    /// 插件管理器。
    /// </summary>
    public static class PluginManager
    {
        /// <summary>
        /// 插件字典。
        /// </summary>
        private readonly static IDictionary<string, PluginDescriptor> _plugins = new Dictionary<string, PluginDescriptor>();

        /// <summary>
        /// 初始化。
        /// </summary>
        public static void Initialize()
        {
            //遍历所有插件描述。
            foreach (var plugin in PluginLoader.Load())
            {
                //卸载插件。
                Unload(plugin);
                //初始化插件。
                Initialize(plugin);
            }
        }

        /// <summary>
        /// 初始化插件。
        /// </summary>
        /// <param name="pluginDescriptor">插件描述</param>
        private static void Initialize(PluginDescriptor pluginDescriptor)
        {
            //使用插件名称做为字典 KEY。
            string key = pluginDescriptor.Plugin.Name;

            //不存在时才进行初始化。
            if (!_plugins.ContainsKey(key))
            {
                //初始化。
                pluginDescriptor.Plugin.Initialize();

                //增加到字典。
                _plugins.Add(key, pluginDescriptor);
            }
        }

        /// <summary>
        /// 卸载。
        /// </summary>
        public static void Unload()
        {
            //卸载所有插件。
            foreach (var plugin in PluginLoader.Load())
            {
                plugin.Plugin.Unload();
            }

            //清空插件字典中的所有信息。
            _plugins.Clear();
        }

        /// <summary>
        /// 卸载。
        /// </summary>
        public static void Unload(PluginDescriptor pluginDescriptor)
        {
            pluginDescriptor.Plugin.Unload();

            _plugins.Remove(pluginDescriptor.Plugin.ToString());
        }

        /// <summary>
        /// 获得当前系统所有插件描述。
        /// </summary>
        /// <returns></returns>
        public static IEnumerable<PluginDescriptor> GetPlugins()
        {
            return _plugins.Select(m => m.Value).ToList();
        }

        /// <summary>
        /// 根据插件名称获得插件描述。
        /// </summary>
        /// <param name="name">插件名称。</param>
        /// <returns>插件描述。</returns>
        public static PluginDescriptor GetPlugin(string name)
        {
            return GetPlugins().SingleOrDefault(plugin => plugin.Plugin.Name == name);
        }
    }
}
创建一个插件控制器工厂，来获得插件程序集中的控制器类型。
对 RazorViewEngine 的 FindPartialView 方法与 FindView 方法，根据插件来把该插件相关的程序集增加到 Razor 模板的编译项里。


关键代码：

<span style="white-space:pre">	</span>/// <summary>
        /// 给运行时编译的页面加了引用程序集。
        /// </summary>
        /// <param name="pluginName"></param>
        private void CodeGeneration(string pluginName)
        {
            RazorBuildProvider.CodeGenerationStarted += (object sender, EventArgs e) =>
            {
                RazorBuildProvider provider = (RazorBuildProvider)sender;

                var plugin = PluginManager.GetPlugin(pluginName);

                if (plugin != null)
                {
                    provider.AssemblyBuilder.AddAssemblyReference(plugin.Assembly);
                }
            };
        }

到现在，该方法已经初步完成，现在就是把整个插件丢到插件目录下，重启就能加载了！

现在，就给它加上自动检测功能，FileSystemWatcher 类，设置当程序集发生修改、创建、删除和重命名时，自动重新加载插件。

namespace PluginMvc.Framework
{
    using System.IO;
    using System.Web.Hosting;

    /// <summary>
    /// 插件检测器。
    /// </summary>
    public static class PluginWatcher
    {
        /// <summary>
        /// 是否启用。
        /// </summary>
        private static bool _enable = false;

        /// <summary>
        /// 侦听文件系统。
        /// </summary>
        private static readonly FileSystemWatcher _fileSystemWatcher = new FileSystemWatcher();

        static PluginWatcher()
        {
            _fileSystemWatcher.Path = HostingEnvironment.MapPath("~/Plugins");
            _fileSystemWatcher.Filter = "*.dll";

            _fileSystemWatcher.Changed += _fileSystemWatcher_Changed;
            _fileSystemWatcher.Created += _fileSystemWatcher_Created;
            _fileSystemWatcher.Deleted += _fileSystemWatcher_Deleted;
            _fileSystemWatcher.Renamed += _fileSystemWatcher_Renamed;

            _fileSystemWatcher.IncludeSubdirectories = true;

            Enable = false;
        }

        /// <summary>
        /// 是否启用。
        /// </summary>
        public static bool Enable
        {
            get
            {
                return _enable;
            }
            set
            {
                _enable = value;

                _fileSystemWatcher.EnableRaisingEvents = _enable;
            }
        }

        /// <summary>
        /// 启动。
        /// </summary>
        public static void Start()
        {
            Enable = true;
        }

        /// <summary>
        /// 停止。
        /// </summary>
        public static void Stop()
        {
            Enable = false;
        }

        private static void _fileSystemWatcher_Changed(object sender, FileSystemEventArgs e)
        {
            ResetPlugin();
        }

        private static void _fileSystemWatcher_Deleted(object sender, FileSystemEventArgs e)
        {
            ResetPlugin();
        }

        private static void _fileSystemWatcher_Created(object sender, FileSystemEventArgs e)
        {
            ResetPlugin();
        }

        private static void _fileSystemWatcher_Renamed(object sender, RenamedEventArgs e)
        {
            ResetPlugin();
        }

        /// <summary>
        /// 重置插件。
        /// </summary>
        private static void ResetPlugin()
        {
            PluginManager.Unload();
            PluginManager.Initialize();
        }
    }
}

把该方法进行注册：


 又或者可以使用 System.Web.PreApplicationStartMethod 方法来启动（推荐）。

[assembly: System.Web.PreApplicationStartMethod(typeof(PluginMvc.Framework.Bootstrapper), "Initialize")]
namespace PluginMvc.Framework
{
    using System.Web.Mvc;

    using PluginMvc.Framework;
    using PluginMvc.Framework.Mvc;

    /// <summary>
    /// 引导程序。
    /// </summary>
    public static class Bootstrapper
    {
        /// <summary>
        /// 初始化。
        /// </summary>
        public static void Initialize()
        {
            //注册插件控制器工厂。
            ControllerBuilder.Current.SetControllerFactory(new PluginControllerFactory());

            //注册插件模板引擎。
            ViewEngines.Engines.Clear();
            ViewEngines.Engines.Add(new PluginRazorViewEngine());

            //初始化插件。
            PluginManager.Initialize();

            //启动插件检测器。
            PluginWatcher.Start();
        }
    }
}

到这里，框架部分已经完成了！下面说下插件的开发。

 1、创建一个空的 ASP.NET MVC 4 项目，并清理好。


 2、定义一个实现 IPlugin 接口的类。


3、完成一个简单的页面显示功能。


将该插件站点发布。


将已发布的插件包含目录一起复制到站点的插件目录下即可。


完成了，现在不但可以把插件复制到插件目录就马上能使用，要调试什么的，也可以直接启动插件 WEB 项目了，具体的完善就不多说了！

不过，目前还有个小BUG，如果目录下没有任何插件的时候，插件检测将不会启动><。

注意！Views目录下必须要存在 Web.Config 文件，.NET 会根据该文件自动配置 cshtml 页面的基类等信息，假如没有该文件，编译页面时，会出现找不到基类错误。

源码：

点击下载

hao_ds
关注
专栏目录
ASP.NET MVC 4项目实现插件化
12-11
本资源包中包含VS2013格式的示例源码，还有一个17页的PDF文档展示技术关键点。掌握本技术的前提是会用MEF，可以参考我写的《.NET 4.0面向对象编程漫谈（应用篇）》第22章。与本资源相关的网页在我的个人博客上：http://blog.csdn.net/bitfan/article/details/17260775，技术问题可以在那儿交流。
.Net插件开发开源框架
最新发布
hpx666的博客
08-17 443
.Net插件开发开源框架
ASP.NET MVC 插件化开发简化方案
weixin_33862993的博客
08-16 189
Web 管理系统可以庞大到不可想像的地方，如果想就在一个 Asp.Net MVC 项目中完成开发，这个工程将会变得非常庞大，协作起来也会比较困难。为了解决这个问题，Asp.Net MVC 引入了 Areas 的概念，将模块划分到 Area 中去——然而 Area 仍然是主项目的一部分，多人协作的时候仍然很容易造成 .csproj 项目文件...
MVC插件式开发
qq_43504861的博客
12-02 387
一、 1.自己定义的Controller不一定是写在Controllers下的； 2.我们写的控制器可以放在其他的地方 网站启动的时候，会进行网站初始化，会扫描控制器，保存控制器； 扫描控制器的规则：看是否继承自Controlle父类； 当请求来了，要真的是用这个控制器的时候，是从存储介质中取出来进行初始化的 可以把控制器的部分（逻辑计算的部分可以独立分开，放到一个类库中来）; 把一个大的业务逻辑，做拆分；每一个类库分别处理部分内容，每个内容当作一个插件来完成； 大项目–模块–独立出来做一个插件； 部署的时
MVC | 插件式编程
Fanbin168的专栏
03-19 2219
1> 首先创建主站，这个主站就是一个MVC项目，名字叫MVC.MainSite。然后再项目下添加一个Plugins目录文件夹。 然后创建一个插件，这个插件也是一个MVC项目名字叫MVC.Pluings.Man，在插件MVC中创建一个Home控制器，然后生成一下。这时候我们在主站MVC.MainSite的Plugins文件夹下再添加一个Man文件夹，用于存放插件MVC.Pluings.M
ASP.NET MVC 4 插件化架构简单实现
12-23
ASP.NET MVC 4 插件化架构简单实现 ASP.NET MVC 4 插件化架构简单实现-思路篇 ... ASP.NET MVC 4 插件化架构简单实现-实例篇 http://blog.csdn.net/hao_ds/article/details/42103111
Asp.net Mvc简易插件系统示例
05-07
在这个"简易插件系统示例"中，我们将探讨如何在Asp.NET MVC环境中创建一个可扩展、模块化的插件架构。 首先，让我们理解什么是插件系统。插件系统是一种允许应用程序通过安装额外的代码模块（即插件）来增加功能的...
ASP.NET MVC Server Explorer：第3部分-插件体系结构
04-08
ASP.NET MVC Server Explorer系列的第三部分主要探讨了插件架构，这是软件开发中的一个关键概念，特别是对于构建可扩展和灵活的应用程序。插件架构允许应用程序以模块化的方式工作，使得开发者可以轻松添加、更新或...
asp.net mvc 加载外部插件 插件化实现
07-28
如果想要深入学习，可以参考这个教程，结合理论知识和实践案例，逐步掌握ASP.NET MVC插件化的精髓。 总的来说，ASP.NET MVC的插件化设计提高了软件的灵活性和可维护性，让开发者能够快速响应需求变化。通过理解上述...
基于ASP.NET MVC的购物商城网站代码
06-03
ASP.NET MVC（Model-View-Controller）是微软提供的一种用于构建可测试、模块化Web应用程序的框架。它结合了ASP.NET的优势，并引入了MVC设计模式，使得开发人员能够更好地分离关注点，提高代码的可读性和可维护性。...
Asp.net MVC Chosen插件源码实例
03-06
asp.net MVC chosen插件源码实例 此项目可作为学习asp.net MVC项目 或学习chosen插件的实例 带有数据库 特色为运用了chosen插件 本项目中在Orders/Details/页面中Carton No和Article No为chosen插件的运用
ASP.NET MVC：模块化/插件式架构实现（转载）
weixin_34277853的博客
02-16 372
I’ve recently spent quite a lot of time researching and prototyping different ways to create a plugin engine in ASP.NET MVC3 and primarily finding a nice way to load plugins (DLLs) in from outside of ...
Asp.Net MVC 必备插件MVC Route Visualizer(Visual Studio 2012 版)
weixin_34417635的博客
10-16 119
感谢原作者cnlangzi,如果有谁认识麻烦转告他，让他升级这个插件，一年多没有升级了。 原版本地址：https://mvcroutevisualizer.codeplex.com/ 使用2010的同学可以直接在插件中安装,因为好多人都升级到了2012，所以在原版本的基础上增加了对Visual Studio 2012 的支持，现发布出来大家使用，有任何问题请在评论中留言。安装方法和使用...
MVC开发插件汇总
weixin_30851867的博客
05-08 69
T4MVC（页面路由连接）HelpPage（Api帮助页）Glimpse.Mvc4（跟踪调试） 转载于:https://www.cnblogs.com/justitis/p/4488789.html
ASP.NET MVC插件技术
热门推荐
bitfan（数字世界一凡人）的专栏
12-11 1万+
学海泛舟系列文章之《ASP.NET MVC插件技术》，介绍如何在ASP.NET MVC项目通过网页上传程序集（DLL）文件，系统使用MEF（ Managed Extensibility Framework）自动装载它们，从而实现不停机的在线系统更新特性。
.Net 桌面开发之插件开发
Thinking_calculus的博客
01-09 1155
.net 插件化开发 之前在编程时发现很多地方调用时都会使用到dll文件，例如arcgis/mapwingis二次开发中，都会使用到相应的dll文件，实际使用的原理是，编译接口时产生dll文件，将该文件放置在主项目的引用中，使用时通过文件查询进行调用 主文件内容 namespace plugin_main_test { public partial class Form1 : Form { public Form1() { Initia
ASP.NET：插件化机制
weixin_33958585的博客
03-14 175
概述 nopCommerce的插件机制的核心是使用BuildManager.AddReferencedAssembly将使用Assembly.Load加载的插件程序集添加到应用程序域的引用中。具体实现可以参考nopCommerce解决方案中Nop.Core项目的Plugins目录下的相关文件。其中PluginManager.cs文件是核心文件，包含了处理插件化的核心代码。nopCommerc...
.Net插件化开发自动生成插件描述文件
10-20 373
.net插件化开发自动生成插件描述文件
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值