插件式的 WebApi 开发,首要面对的问题就是程序集的发现。因为开发的过程中,都是在各自的解决方案下进行开发,部署后是分模块放在一个整体的的运行时网站下。

约定

这里我根据上一节的设定,把插件打包完成后的文件夹,放入网站 bin 目录下。重复一下这样做的好处:在插件的配置或者程序集发生变动后,网站会直接重新启动。

这是 IIS 的机制,和 WebApi 无关。

  • 约定插件的文件夹名称使用 00_Name 的形式,可以更方便的按照我们的要求排列插件。
  • 约定插件的配置文件为插件根目录 PluginConfig.xml 文件
  • 约定插件的配置文件如下(后续随着功能的添加会适当添加内容)
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration enabled="true">
  3. <description>授权支持插件</description>
  4. <assemblies>
  5. <add type="relative">bin/Intime.AuthorizationService.dll</add>
  6. <add type="relative">bin/Intime.AuthorizationService.Services.dll</add>
  7. <add type="relative">bin/Intime.AuthorizationService.Data.dll</add>
  8. <add type="relative">bin/Intime.AuthorizationService.Data.Repository.dll</add>
  9. </assembiles>
  10. </configuration>

解释一下 XML 配置文档的含义:

  • enabled="true" 表示当前插件的可用性,只有值为 true 的模块才会进行后续操作;否则不做任何操作。
  • description 子元素表示当前模块的自然语义名称,在程序上没有任何含义,面向自然人说明当前模块的作用。
  • assemblies 子元素表示当前模块下需要加载的程序集列表。
    • add 元素表示添加一个程序集文件:目前有且只有一个 add 元素受支持。
    • type 表示内含程序集路径的类型:
      • relative 表示相对路径,为程序集文件相对于当前配置文件的路径:比如第一个文件就是在当前目录的子目录 bin 目录下。
      • absolute 表示绝对路径,表示程序不必做额外工作就可以根据路径信息找到文件:此处没有栗子
    • 内含文本表示程序集的路径信息。

BuildManager 程序集加载规则

在实现程序集加载之前,我们有必要大概了解一下 BuildManager 类加载程序集的规则。

首先,是项目引用,被网站项目引用的 GAC 程序集,都会列入到引用列表中;其次,就是这个类很强大,只要你将程序集放入网站,它就能知道网站运行需要加载这个程序集;最后,还有个不常用的设置,Web.config 文件的 runtime 配置节点中引进的目录,也会被加载。所以我们要加载的程序集,必须是这三个地方所没有的程序集。

另外,就是程序集多版本的问题。这里我们约定更新的版本完全兼容老版本,否则就需要升级代码以适配这个功能。在网站运行出现多个版本存在的情况下,我们约定如下原则:

  • bin 目录是最先加载的路径,后续插件加载的程序集版本必须小于等于 bin 目录下程序集的版本。
  • 非 .Net 框架库自带的程序集,一律要拷贝到网站 bin 目录下:请使用 NuGet 管理第三方程序集。
  • 不要使用 Web.config 文件的 runtime 配置节点加载个性目录。

这样,我们可以定义包含这些元数据的类:配置文件信息、加载的程序集列表,在 PreApplicationStartMethodAttribute 程序集特性设定的方法内,将我们的程序集加到 BuildManager 管理的 程序集列表中。在程序运行时,.Net 就可以找到我们的这些程序集了。

部分源代码:自然语义

代码是在 Mac 下用文本编辑器写出来的,请自行脑补。

  1. public class DynamicModule
  2. {
  3. public static DynamicModule Instance
  4. {
  5. get{ return Instance == null ? (Instance = new DynamicModule()) : Instance; }
  6. }
  7. public string BaseDirectory { get; set; }
  8. public ModuleMetadata[] BaseDirectory { get; set; }
  9. ctor()
  10. {
  11. BaseDirectory = Path.Combine(App.BaseDirectory, "bin");
  12. var modules = Directory.GetFiles(BaseDirectory, "PlugConfig.xml", AllDirectory)
  13. .Where(p => p.Configuration.Enabled);
  14. bar baseAssemblies = AssemblyName.GetAssemblyNames(BaseDirectory, "*.dll", TopDirectory);
  15. var data = baseAssemblies.Intersect(modules.LoadedAssemblyNames)
  16. .Where(p => p.CodeBase != BaseDirectory);
  17. if(data.Any())
  18. throw new ModuleConfiguration(string.Format("程序集 {0} 装载出现异常!", string.Join(data)));
  19. modules.Foreach(p => p.LoadAssemblies());
  20. }
  21. }

WebApi 插件式构建方案:发现并加载程序集的更多相关文章

  1. WebApi 插件式构建方案:集成加载数据库连接字符串

    body { border: 1px solid #ddd; outline: 1300px solid #fff; margin: 16px auto; } body .markdown-body ...

  2. WebApi 插件式构建方案:重写的控制器获取工厂

    body { border: 1px solid #ddd; outline: 1300px solid #fff; margin: 16px auto; } body .markdown-body ...

  3. WebApi 插件式构建方案:IOC 容器初始化

    body { border: 1px solid #ddd; outline: 1300px solid #fff; margin: 16px auto; } body .markdown-body ...

  4. WebApi 插件式构建方案

    WebApi 插件式构建方案 WebApi 插件式构建方案 公司要推行服务化,不可能都整合在一个解决方案内,因而想到了插件式的构建方案.最终定型选择基于 WebApi 构建服务化,之所以不使用 WCF ...

  5. Winfom 插件式(Plugins)/模块化开发框架-动态加载DLL窗体-Devexpress

    插件式(AddIn)架构,不是一个新名词,应用程序采用插件式拼合,可以更好的支持扩展.很多著名的软件都采用了插件式的架构,如常见的IDE:Eclipse,Visual Studio,SharpDeve ...

  6. MVC中未能加载程序集System.Web.Http/System.Web.Http.WebHost

    ==================================== 需要检查项目的Microsoft.AspNet.WebApi版本是否最新,System.Web.Http 这个命名空间需要更新 ...

  7. 分享JQuery动画插件Velocity.js的六种列表加载特效

    分享JQuery动画插件Velocity.js的六种列表加载特效.在这款实例中给中六种不同的列表加载效果.分别为从上飞入.从右侧飞入.从左侧飞入.和渐显.一起看下效果图: 在线预览   源码下载 实现 ...

  8. .Net Core 通过依赖注入和动态加载程序集实现宿程序和接口实现类库完全解构

    网上很多.Net Core依赖注入的例子代码,例如再宿主程序中要这样写: services.AddTransient<Interface1, Class1>(); 其中Interface1 ...

  9. C#在使用Assembly加载程序集时失败

    错误现象: 进行插件读取时出现错误:"尝试从一个网络位置加载程序集,在早期版本的 .NET Framework 中,这会导致对该程序集进行沙盒处理.此发行版的 .NET Framework ...

随机推荐

  1. HTTP协议响应头之Transfer-Encoding:分块传输详解

    Http Connection有两种连接方式:短连接和长连接:短连接即一次请求对应一次TCP连接的建立和销毁过程,而长连接是多个请求共用同一个连接这样可以节省大量连接建立时间提高通信效率.目前主流浏览 ...

  2. python logging 重复写日志问题

    用Python的logging模块记录日志时,遇到了重复记录日志的问题,第一条记录写一次,第二条记录写两次,第三条记录写三次...很头疼,这样记日志可不行.网上搜索到了原因与解决方案: 原因:没有移除 ...

  3. 6_python之路之atm购物

    6_python之路之atm购物 1.程序说明:Readme.cmd supermarket 项目主目录 ├── access.log 日志文件 ├── atm atm程序 │?? ├── atm.p ...

  4. Go语言环境安装详细介绍

    工具链介绍 go有两套编译工具链,分别是从plant9移植过来的gc和依赖gcc的gccgo. 官方为gc工具链提供了二进制安装包和源码, 可以根据需要选择一种安装方式.gc工具链对操作系统和CPU类 ...

  5. Download/Attach source-code/java-docs with maven dependencies

    I am using Maven in my projects from last couple of years, and the automatically downloading the Jar ...

  6. css常用属性总结:关于word-spacing和letter-spacing的使用

    前端时间项目版本迭代,修改代码时发现使用了关于word-spacing和letter-spacing.先说下使用场景,以前的项目中,经常遇到某些字符间有一些间距,我看了一些同事的代码是这么实现的: & ...

  7. mysql添加表注释、字段注释、查看与修改注释

    1 创建表的时候写注释create table test1( field_name int comment '字段的注释')comment='表的注释'; 2 修改表的注释alter table te ...

  8. Golang之指针(point)再探索

    先记录代码 package main import "fmt" /* 声明指针 *T 是指向类型T的值的指针变量的类型 */ func main() { //b := 255 // ...

  9. Java 设计模式系列(二十)状态模式

    Java 设计模式系列(二十)状态模式 状态模式,又称状态对象模式(Pattern of Objects for States),状态模式是对象的行为模式.状态模式允许一个对象在其内部状态改变的时候改 ...

  10. BETTER SUPPORT FOR FUNCTIONAL PROGRAMMING IN ANGULAR 2

    In this blog post I will talk about the changes coming in Angular 2 that will improve its support fo ...