一个.NET Core下的开源插件框架Pluginfactory

插件模式历史悠久,各种中大型软件基本上都会实现插件机制,以此支持功能扩展,从开发部署层面,插件机制也可实现功能解耦,对于并行开发、项目部署、功能定制等都有比较大的优势。

    在.NET Core下,一般我们基于.NET Core扩展库进行开发,通常使用依赖注入、配置、设置(Options)等机制,如果将插件模式与依赖注入、配置、设置进行结合,将可以提供非常灵活的扩展机制。基于此,我们实现了一个开源的插件框架,本文将进行简单的介绍。

一、PluginFactory插件库

  • 项目地址:

  • Gitee:https://gitee.com/WuYeCai/pluginfactory

  • Github:https://github.com/xfrogcn/Xfrogcn.PluginFactory

  • Nuget包:

    Xfrogcn.PluginFactory 实现包,在主项目中引用

    Xfrogcn.PluginFactory.Abstractions 抽象包,在插件项目中引用,或者你可以

    全重新实现自己的插件机制

  • 主要功能:

  • 插件的自动载入

  • 通过插件的初始化接口可让插件控制主应用的依赖注入

  • 插件的启动及停止,此机制可与.NET Core的Hosting扩展结合,在宿主启动时自动启动插件

  • 抽象分离,你可以通过实现Xfrogcn.PluginFactory.Abstractions中的相关接口来完全实现自己的插件载入、启动等机制

  • 与.NET Core配置、设置、宿主等完美融合

  • 支持插件依赖程序集的多版本载入

二、主要概念

  • 插件载入器:对应IPluginLoader接口,负责从指定位置加载插件程序集

  • 插件工厂:对应IPluginFactory接口,负责插件的实例化及插件的启动和停止

  • 插件:对应IPlugin接口,所有插件需要实现此接口,实现插件的启动及停止机制

  • 可初始化插件:对应ISupportInitPlugin接口,通过此接口可以在依赖注入Provider构建之前向容器注入自定义的服务

  • 可配置插件:对应ISupportConfigPlugin接口,通过此接口可将插件配置与.NET Core的配置(Configuration)及设置(Options)机制集合

三、使用向导

    示例项目可参考:Xfrogcn.PluginFactory.Example Gitee地址 Github地址

1)安装

 在主程序项目中添加Xfrogcn.PluginFactory

 在插件项目中添加Xfrogcn.PluginFactory.Abstractions

2)在主程序中启用

    可通过以下两种方式来启用插件库,一是通过在Host层级的Use机制以及在依赖注入IServiceCollection层级的Add机制,以下分别说明:

1. 通过IHostBuilder的UsePluginFactory方法启用插件库

    UsePluginFactory具有多个重载版本,详细请查看API文档
默认配置下,将使用程序运行目录下的Plugins目录作为插件程序集目录, 使用宿主配置文件作为插件配置文件(通常为appsettings.json)
你也可以通过使用带有 Assembly 或 IEnumerable 参数的版本直接传入插件所在的程序集

2. 通过IServiceCollection的AddPluginFactory方法启用插件库

    AddPluginFactory具有多个重载版本,详细请查看API文档
默认配置下,将使用程序运行目录下的Plugins目录作为插件程序集目录

    注意: AddPluginFactory方法不会使用默认的配置文件作为插件配置,你需要显式地传入IConfiguration, 如果是在 ASP.NET Core 环境中,你可以在Startup类中直接获取到

3)编写插件

插件是实现了IPlugin接口的类,在插件库中也提供了PluginBase基类,一般从此类继承即可。标准插件具有启动和停止方法,通过IPluginFactory进行控制。

要编写插件,一般遵循以下步骤:

创建插件项目(.NET Core 类库),如TestPluginA

添加Xfrogcn.PluginFactory.Abstractions

创建插件类,如Plugin,从PluginBase继承

启动或停止方法中可通过context中的ServiceProvider获取注入服务

通过PluginAttribute特性设置插件的元数据

插件元数据以及插件载入的插件列表信息可以通过IPluginLoader.PluginList获取

4)插件启动

IPluginFactory本身实现了.NET Core扩展库的IHostedService机制,故如果你是在宿主环境下使用,如(ASP.NET Core),插件的启动及停止将自动跟随宿主进行,如果未使用宿主,可通过获取IPluginFactory实例调用相应方法来完成.

5)编写支持初始化的插件

在很多场景,我们需要在插件中控制宿主的依赖注入,如注入新的服务等,这时候我们可通过实现支持初始化的插件(ISupportInitPlugin)来实现,该接口的Init方法将在依赖注入构建之前调用,通过方法参数IPluginInitContextServiceCollection可以控制宿主注入容器。

6)使用插件配置

插件支持 .NET Core 扩展库中的Options及Configuration机制,你只需要从SupportConfigPluginBase类继承实现插件即可,其中TOptions泛型为插件的配置类型。插件配置自动从宿主配置或启用插件工厂时传入的配置中获取,插件配置位于配置下的Plugins节点,该节点下以插件类名称或插件别名(通过PluginAttribute特性指定)作为键名,此键之下为插件的配置,如以下配置文件:

 扩展PluginA实现配置:

定义配置类,如PluginOptions

实现插件

注意:在插件初始化方法中也可使用注入的配置

跨插件配置

有些配置可能需要在多个插件中共享,此时你可通过Plugins下的_Share节点进行配置,此节点下配置将会被合并到插件配置中,可通过PluginOptions进行访问。

7)插件化 ASP.NET Core

    要让 ASP.NET Core 获取得到插件中的控制器,你只需要在插件的初始化方法Init中,向MVC注入插件程序集:

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/307031.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

谈谈.NET Core IServiceProvider

【导读】最近重构部分代码,因历史原因在静态类中需使用注入实例,构造函数注入则不再可取,此时只能构造全局IServiceProvider,所以本文稍微分析下IServiceProvider要构造全局使用IServiceProvider,我们都知道不能在Conf…

使用 Xunit.DependencyInjection 改造测试项目

使用 Xunit.DependencyInjection 改造测试项目Intro这篇文章拖了很长时间没写,之前也有介绍过 Xunit.DependencyInjection 这个项目,这个项目是由大师写的一个 Xunit 基于微软 GenericHost 和 依赖注入实现的一个扩展库,可以让你更方便更容易…

discuz mysql data_Discuz!显示 Database Error的原因和解决方法

今天打开Discuz搭建的论坛显示:原因一:数据库表太大比如mysql数据库的表内容太大,超过10G就有可能会影响discuz论坛的运行。Discuz! Database Error是什么原因,怎么修复这种情况可以通过对数据库分表的方法来解决。原因二&#xf…

项目开发中经常有一些被嫌弃的小数据,现在全丢给 FastDFS

在我们开发项目的时候,经常会遇到大块数据的问题(2M-100M),比如说保存报表中1w个人的ID号,说实话,这些数据存储在服务器哪里都被嫌弃,放在redis,mongodb中吧,一下子你就会…

java 反射 int_Java 反射由浅入深 | 进阶必备

原标题:Java 反射由浅入深 | 进阶必备一、Java 反射机制参考了许多博文,总结了以下个人观点,若有不妥还望指正:Java 反射机制在程序运行时,对于任意一个类,都能够知道这个类的所有属性和方法;对…

寻找性能更优秀的不可变小字典

Dictionary 是一个很常用的键值对管理数据结构。但是在性能要求严苛的情况下,字典的查找速度并不高。所以,我们需要更快的方案。需求说明 这里,我们需要一个 PropertyInfo 和委托对应的映射关系,这样我们就可以存储《寻找性能更优…

一款基于.NET Core的认证授权解决方案-葫芦藤1.0开源啦

背景18年公司准备在技术上进行转型,而公司技术团队是互相独立的,新技术的推动阻力很大。我们需要找到一个切入点。公司的项目很多,而各个系统之间又不互通,导致每套系统都有一套登录体系,给员工和客户都带来极大的不便…

.NET架构小技巧(8)——优待异常

天有不测风云,人有旦夕祸福,程序呢——会有异常错误。C#中用try,catch,finally来捕捉处理异常,捕捉谁的异常呢?一般都是系统类库或三方类库中抛出的异常,那如果我自己架构程序,异常也…

跟我一起学.NetCore之EF Core 实战入门,一看就会

前言还记得当初学习数据库操作时,用ADO.NET一步一步地进行数据操作及查询,对于查询到的数据还得对其进行解析,然后封装返回给应用层;遇到这种重复而繁琐的工作,总有一些大神或团队对其进行封装,从而出现了很…

java 声明变量构成_Java—变量

1.1 按数据类型分类1.1.1 基本数据类型(四类八种)☛ 引用数据类型的特点存的是地址值,可以为null值☛ 基本数据类型的特点存的是具体的值,不可以是null值☛ 整型整型取值范围字节数byte(字节)-128 ~ 1271byteshort(短整型)-2byteint(默认整型)-4bytelong(长整型)12345678L8byte…

寻找性能更优秀的动态 Getter 和 Setter 方案

反射获取 PropertyInfo 可以对对象的属性值进行读取或者写入&#xff0c;但是这样性能不好。所以&#xff0c;我们需要更快的方案。方案说明 就是用表达式编译一个Action<TObj,TValue>作为 Setter&#xff0c;编译一个Func<TObj,TValue>作为 Getter。然后把这些编译…

Newbe.ObjectVisitor 0.2.10 发布,更花里胡哨

更新内容 现在&#xff0c;你可以通过上下文修改属性的值了&#xff1a;//✔️ from 0.2 // 可以修改属性 o.V().ForEach((context) > ModifyData(context)).Run();public static void ModifyData(IObjectVisitorContext<Yueluo,string> context) {context.Value con…

.NET 5 和 C#9 /F#5 一起到来, 向实现 .NET 统一迈出了一大步

经过一年多的开发&#xff0c;Microsoft 于北京时间 11 月 11 日&#xff08;星期三&#xff09;发布了其 .NET 5软件开发平台&#xff0c;强调平台的统一&#xff0c;并引入了 C# 9 和 F# 5 编程语言&#xff0c;新平台朝着桌面、Web、移动、云和 IoT 目标统一 .NET 开发体验的…

.NetCore HttpClient发送请求的时候为什么自动带上了一个RequestId头部?

奇怪的问题最近在公司有个系统需要调用第三方的一个webservice。本来调用一个下很简单的事情&#xff0c;使用HttpClient构造一个SOAP请求发送出去拿到XML解析就是了。可奇怪的是我们的请求在运行一段时间后就会被服务器504给拒绝掉了。导致系统无法使用&#xff0c;用户叫苦连…

ASP.NETCore小技巧:使用测试用户中间件

哈喽大家好&#xff0c;这篇文章其实很早就想写了&#xff0c;因为一直会有小伙伴问到&#xff0c;但是我却始终拿不到好的方案&#xff0c;最近在录制《eShopOnContainer微服务架构》的视频&#xff0c;碰巧就看到了微软官方的代码中也有这方面的需求&#xff0c;而且和我的需…

【招聘(深圳)】华强方特文化科技集团 .NET工程师

.NET高级开发工程师&#xff08;18-25K&#xff09;岗位职责&#xff1a;负责系统需求分析与设计&#xff1b;根据业务确定实现方案&#xff1b;对现有系统缺陷提出优化方案&#xff1b;负责系统关键功能开发及维护&#xff0c;保障系统的正常运行&#xff1b;带领指导团队开发…

11座城市,58个.NET最新岗位速览,内推直通面试官!

十一月风雪客&#xff0c;十二月乘衣归&#xff01;各个大厂秋招进行时&#xff0c;你行动了吗&#xff1f;借着这阵风&#xff0c;今天为大家提供一批.NET开发岗位内推&#xff01;58个优质的.NET开发岗位年薪过万到百万不等&#xff0c;总有一个适合你&#xff01;包含全国各…

pdo mysql_PDO MySQL

PDO MySQL如果文章有成千上万篇&#xff0c;该怎样保存&#xff1f;数据保存有多种方式&#xff0c;比如单机文件、单机数据库(SQLite)、网络数据库(MySQL、MariaDB)等等。根据项目来选择&#xff0c;做Web一般采用MySQL&#xff0c;本书也以MySQL为例。自学&#xff1a;1天。假…

C# 8: 可变结构体中的只读实例成员

在之前的文章中我们介绍了 C# 中的 只读结构体&#xff08;readonly struct&#xff09;[1] 和与其紧密相关的 in 参数[2]。今天我们来讨论一下从 C# 8 开始引入的一个特性&#xff1a;可变结构体中的只读实例成员&#xff08;当结构体可变时&#xff0c;将不会改变结构体状态的…

部署Dotnet Core应用到Kubernetes(一)

最近闲了点&#xff0c;写个大活&#xff1a;部署Dotnet应用到K8s。写在前边的话一直想完成这个主题。但这个主题实在太大了&#xff0c;各种拖延症的小宇宙不时爆发一下&#xff0c;结果就拖到了现在。这个主题&#xff0c;会是一个系列。在这个系列中&#xff0c;我会讨论将应…