6 Star 63 Fork 22

yiyun / PluginCore

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
LGPL-3.0

PluginCore

PluginCore

English | 中文

🔌 适用于 ASP.NET Core 的轻量级插件框架 | Vue.js frontend | JavaScript SDK

repo size LICENSE CodeFactor downloads QQ Group Telegram Group

CLA assistant FOSSA Status

介绍

🔌 适用于 ASP.NET Core 的轻量级插件框架 | Vue.js frontend | JavaScript SDK

  • 简单 - 约定优于配置, 以最少的配置帮助你专注于业务
  • 开箱即用 - 前后端自动集成, 两行代码完成集成
  • 动态 WebAPI - 每个插件均可新增 Controller, 拥有独立路由
  • 插件隔离与共享 - 完善的插件隔离与类型共享
  • 插件前后端分离 - 可在插件 wwwroot 文件夹下放置前端文件 (index.html,...), 然后访问 /plugins/pluginId/index.html
  • 热插拔 - 上传、安装、启用、禁用、卸载、删除 均无需重启站点; 甚至可通过插件在运行时添加 HTTP request pipeline middleware, 也无需重启站点
  • 依赖注入 - 可在 实现 IPlugin 的插件类的构造方法上申请依赖注入项, 当然 Controller 构造方法上也可依赖注入
  • 模块化 - 过程模块化, 全程依赖注入, 轻松替换实现自定义插件机制
  • 易扩展 - 轻松编写插件SDK, 编写扩展插件 - 自定义插件钩子, 并应用
  • 插件依赖树 - 申明式依赖, 自动根据插件间依赖建立正确加载顺序
  • 生命周期 - 可控的插件生命周期, 完善的事件派发
  • 挂件 - 可在前端埋扩展点, 通过插件注入挂件, 挂件拥有完善的 HTML/CSS/JavaScript 支持, 优雅的事件派发
  • 无需数据库 - 无数据库依赖
  • 0侵入 - 近乎0侵入, 不影响你的现有系统
  • 极少依赖 - 只依赖于一个第三方包 ( 用于解压的 SharpZipLib )
  • 国际化 - 得益于 i18n 的国际化实现, 提供多语言切换支持

在线演示

技术栈

  • 后端: .NET/C#: .NET Standard & .NET Core & .NET & ASP.NET Core
  • 前端: Vue.js & vue-i18n & Vue Router & Vuex & Element UI
  • 前端: babel & mockjs & sass & autoprefixer & eslint & axios & npm

关联线上产品: https://120365.xyz

截图

一分钟集成

推荐使用 NuGet, 在你项目的根目录 执行下方的命令, 如果你使用 Visual Studio, 这时依次点击 Tools -> NuGet Package Manager -> Package Manager Console , 确保 "Default project" 是你想要安装的项目, 输入下方的命令进行安装.

在你的 ASP.NET Core 项目中集成

PM> Install-Package PluginCore.AspNetCore

在你的 ASP.NET Core 应用程序中修改代码

Startup.cs

using PluginCore.AspNetCore.Extensions;

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    // 1. 添加 PluginCore
    services.AddPluginCore();
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseHttpsRedirection();

    app.UseRouting();

    // 2. 使用 PluginCore
    app.UsePluginCore();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

现在访问 https://localhost:5001/PluginCore/Admin 即可进入 PluginCore Admin
https://localhost:5001 需改为你的地址

注意

请登录 PluginCore Admin 后,为了安全,及时修改默认用户名,密码:

App_Data/PluginCore.Config.json

{
	"Admin": {
		"UserName": "admin",
		"Password": "ABC12345"
	},
	"FrontendMode": "LocalEmbedded",
	"RemoteFrontend": "https://cdn.jsdelivr.net/gh/yiyungent/plugincore-admin-frontend@0.1.2/dist-cdn"
}

修改后,立即生效,无需重启站点,需重新登录 PluginCore Admin

Docker 体验

如果你需要在本地体验 PluginCore, 那么这里有一个 例子(/examples)

docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name plugincore-aspnetcore3-1 yiyungent/plugincore-aspnetcore3-1

现在你可以访问 http://localhost:5004/PluginCore/Admin

补充:
若使用 Docker Compose, 可参考仓库根目录下的 docker-compose.yml

补充:
使用 ghcr.io

docker run -d -p 5004:80 -e ASPNETCORE_URLS="http://*:80" --name plugincore-aspnetcore3-1 ghcr.io/yiyungent/plugincore-aspnetcore3-1

使用

添加插件钩子, 并应用

1.例如,自定义插件钩子: ITestPlugin

using PluginCore.IPlugins;

namespace PluginCore.IPlugins
{
    public interface ITestPlugin : IPlugin
    {
        string Say();
    }
}

2.在需要激活的地方,应用钩子,这样所有启用的插件中,实现了 ITestPlugin 的插件,都将调用 Say()

using PluginCore;
using PluginCore.IPlugins;

namespace WebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class TestController : ControllerBase
    {
        private readonly PluginFinder _pluginFinder;

        public TestController(PluginFinder pluginFinder)
        {
            _pluginFinder = pluginFinder;
        }

        public ActionResult Get()
        {
            //var plugins = PluginFinder.EnablePlugins<BasePlugin>().ToList();
            // 所有实现了 ITestPlugin 的已启用插件
            var plugins2 = _pluginFinder.EnablePlugins<ITestPlugin>().ToList();

            foreach (var item in plugins2)
            {
                // 调用
                string words = item.Say();
                Console.WriteLine(words);
            }

            return Ok("");
        }
    }
}

自定义前端

PluginCore 支持3种前端文件加载方式

配置文件 App_Data/PluginCore.Config.jsonFrontendMode

  1. LocalEmbedded
  • 默认, 嵌入式资源,前端文件打包进dll, 此模式下, 不容易自定义前端文件,需要修改 PluginCore 源代码,重新编译,不建议
  1. LocalFolder
  • 在集成了 PluginCore 的 ASP.NET Core 项目中, 新建 PluginCoreAdmin, 将前端文件放入此文件夹
  1. RemoteCDN
  • 使用远程cdn资源, 可通过 配置文件中 RemoteFrontend 指定url

注意:
更新 FrontendMode, 需重启站点后, 才能生效

补充

补充

开发插件只需要, 添加对 PluginCore.IPlugins 包 (插件sdk) 的引用即可,

当然如果你需要 PluginCore , 也可以添加引用

规范

  1. 插件sdk

插件接口应当位于 PluginCore.IPlugins 命名空间,这是规范,不强求,但建议这么做,

程序集名不一定要与命名空间名相同,你完全在你的插件sdk程序集中,使用 PluginCore.IPlugins 命名空间。

  1. 插件

插件程序集名(一般=项目(Project)名) 与 插件 info.jsonPluginId 一致, 例如: Project: HelloWorldPlugin, PluginId: HelloWorldPlugin, 此项必须,否则插件无法加载 PluginId 为插件唯一标识

版本依赖

PluginCore.IPlugins-v0.8.0 起, PluginCore 项目重构, PluginCore 只包含核心插件逻辑, ASP.NET Core 需要使用 PluginCore.AspNetCore

PluginCore.IPlugins 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.8.0 0.9.0 0.9.0 0.9.0 0.9.0 0.9.1 0.9.1 0.9.1
PluginCore 1.0.0 1.0.0 1.0.0 1.0.0 2.0.0 2.0.0 2.0.1 2.0.1 2.0.1 2.0.2 2.0.2 2.1.0 2.2.0 2.2.1 2.2.2 2.2.2 2.2.3 2.2.3 2.2.4
PluginCore.IPlugins.AspNetCore 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.0.1 0.1.0 0.1.0 0.1.0 0.1.0 0.1.1 0.1.1 0.1.1
PluginCore.AspNetCore 0.0.2 0.0.3 0.0.4 0.0.5 0.0.5 1.0.0 1.0.1 1.0.2 1.0.3 1.0.4 1.1.0 1.2.0 1.3.1 1.3.2 1.3.2 1.3.3 1.3.4 1.4.0 1.4.1
plugincore-admin-frontend 0.1.0 - 0.3.1 0.1.0 - 0.3.1 0.1.0 - 0.3.1 0.1.0 - 0.3.1 0.1.0 - 0.3.1 0.1.0 - 0.3.1 0.1.0 - 0.3.1 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2 0.3.2
plugincore-js-sdk 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0 0.1.0 - 0.5.0

下方为旧版依赖, 仅作存档

PluginCore.IPlugins 0.1.0 0.1.0 0.2.0 0.2.0 0.2.0 0.3.0 0.3.0 0.4.0 0.5.0 0.6.0 0.6.0 0.6.0 0.6.0 0.6.1 0.6.1 0.6.1 0.7.0 0.7.0 0.7.0 0.7.0
PluginCore 0.1.0 0.2.0 0.3.0 0.3.1 0.4.0 0.5.0 0.5.1 0.6.0 0.7.0 0.8.0 0.8.1 0.8.2 0.8.3 0.8.4 0.8.5 0.8.6 0.9.0 0.9.1 0.9.2 0.9.3
plugincore-admin-frontend 0.1.0 0.1.2 0.1.2 0.1.3 0.1.3 0.2.0 0.2.0 0.2.0 0.2.0 0.2.0 0.2.3 0.2.3 0.2.3 0.2.3 0.3.0 0.3.0 0.3.0 0.3.0 0.3.0 0.3.1
plugincore-js-sdk - - - - - - - - - - - - - - - - 0.1.0 0.1.0 0.1.0 0.1.0
PluginCore.IPlugins nuget downloads
PluginCore nuget downloads
PluginCore.IPlugins.AspNetCore nuget downloads
PluginCore.AspNetCore nuget downloads
PluginCore.Template nuget downloads
plugincore-admin-frontend NPM version NPM downloads
plugincore-js-sdk NPM version NPM downloads

Project structure

graph BT
    iplugins_aspnetcore(PluginCore.IPlugins.AspNetCore) --> iplugins(PluginCore.IPlugins)
    aspnetcore(PluginCore.AspNetCore) --> iplugins_aspnetcore
    plugincore(PluginCore) --> iplugins
    aspnetcore(PluginCore.AspNetCore) --> plugincore
    admin_frontend(plugincore-admin-frontend) --> aspnetcore
    jssdk(plugincore-js-sdk) --> aspnetcore

环境

  • 运行环境: .NET Core 3.1 (+)
  • 开发环境: Visual Studio Community 2019

相关项目

本项目组件

本项目前生/相关

使用本项目的项目

  • yiyungent/KnifeHub - 【PluginCore.AspNetCore 最佳实践】工具平台 | 日常生活/学习/工作/开发 工具集
  • yiyungent/Dragonfly - ASP.NET Core + Selenium 实现 Web 自动化

赞助者

TODO:

鸣谢

  • 插件系统设计参考自 CoolCat,感谢作者 lamondlu 的贡献
  • 设计参考自 nopCommerce,感谢作者 nopSolutions 的贡献

Donate

PluginCore is an GNU LGPLv3 licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.

We accept donations through these channels:

License

FOSSA Status

Author

PluginCore © yiyun, Released under the GNU LGPLv3 License.
Authored and maintained by yiyun with help from contributors (list).

GitHub @yiyungent Gitee @yiyungent

GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

简介

ASP.NET Core 轻量级 插件框架 - 一分钟集成 展开 收起
LGPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C#
1
https://gitee.com/yiyungent/PluginCore.git
git@gitee.com:yiyungent/PluginCore.git
yiyungent
PluginCore
PluginCore
main

搜索帮助

14c37bed 8189591 565d56ea 8189591