1 Star 0 Fork 23

少狐聪 / PluginCore

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

PluginCore

PluginCore

English | 中文

适用于 ASP.NET Core 的轻量级插件框架

repo size LICENSE CodeFactor downloads QQ Group Telegram Group

CLA assistant FOSSA Status

介绍

适用于 ASP.NET Core 的轻量级插件框架

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

在线演示

截图

一分钟集成

推荐使用 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
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
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
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
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
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

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

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 Apache-2.0 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 Apache-2.0 License.
Authored and maintained by yiyun with help from contributors (list).

GitHub @yiyungent Gitee @yiyungent

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

ASP.NET Core 轻量级 插件框架 - 一分钟集成 展开 收起
C#
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

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

搜索帮助

53164aa7 5694891 3bd8fe86 5694891