C# WebAPI 插件热插拔

铁佛  金牌会员 | 2025-1-23 16:20:27 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 877|帖子 877|积分 2631

背景

WebAPI 插件热插拔是指在不重启应用步伐的情况下，可以或许动态地加载、更新或卸载功能模块（即插件）的能力。这种设计模式在软件开发中非常有效，尤其是在必要频繁更新或扩展功能的大型系统中。通过实现插件架构，可以将系统的差异部分解耦，使得它们可以独立开发、测试和摆设。
对于WebAPI来说，这意味着服务端可以在运行时根据业务需求灵活调整其提供的API接口和服务逻辑，而无需担心每次修改都要重新启动整个应用，从而减少停机时间，进步系统的稳定性和灵活性。
步伐演示

我们启动步伐通过调用动态接口利用插件的增删改查等功能；，其中带{DynamicParam}的是你要利用的插件的名称；{funName}是你要利用插件的接口名称。
步伐运行界面


 
 
查询筛选接口

利用postman 进行查询筛选博客操作
 

 
 
 
插件新增接口

插件的新增博客接口，然后看数据库变化
 
 

 

 
 
 
插件更新接口

插件的更新博客接口

 

 
 
插件删除接口


 

 
插件上传文件接口


 
代码实现

前提准备

必要安装nuget步伐包：Newtonsoft.Json，SqlSugarCore。方便我们做类型转换和数据存储的相关功能；
1，首先我们创建一个webapi 的项目，然后界说一个插件IPluginDllApi.cs的接口（后续新增的类库必要继承用）
  1. using Microsoft.AspNetCore.Mvc;
  3. namespace DynamicPluginApiDemo.Utils
  4. {
  5.     public interface IPluginDllApi
  6.     {
  7.         string Name { get; }
  9.         IActionResult GetRequest(string funName, Dictionary<string, string> queryParameters);
  11.         IActionResult PostRequestForm(string funName, Dictionary<string, string> queryParameters, IFormCollection formData);
  13.         IActionResult PostRequestBody(string funName, Dictionary<string, string> queryParameters, object jsonData);
  15.     }
  16. }
复制代码
2，创建一个插件资助类和数据库资助类。
  1. using SqlSugar;
  3. namespace DynamicPluginApiDemo.Utils
  4. {
  5.     public static class DbHelper
  6.     {
  7.         public static SqlSugarClient Db;
  8.         static DbHelper()
  9.         {
  10.             if (Db == null)
  11.                 //创建数据库对象 (用法和EF Dappper一样通过new保证线程安全)
  12.                 Db = new SqlSugarClient(new ConnectionConfig()
  13.                 {
  14.                     ConnectionString = "server=192.168.1.61;Database=testdb;Uid=root;Pwd=MyNewPass@123;SslMode=None;AllowPublicKeyRetrieval=true;",
  15.                     DbType = SqlSugar.DbType.MySql,
  16.                     IsAutoCloseConnection = true
  17.                 },
  18.                db =>
  19.                {
  20.                    db.Aop.OnLogExecuting = (sql, pars) =>
  21.                    {
  22.                        //获取原生SQL推荐 5.1.4.63  性能OK
  23.                        Console.WriteLine(UtilMethods.GetNativeSql(sql, pars));
  24.                    };
  26.                });
  27.         }
  28.     }
  29. }
  34. using System.Runtime.Loader;
  36. namespace DynamicPluginApiDemo.Utils
  37. {
  38.     public class PluginDllHelper
  39.     {
  40.         public static List<IPluginDllApi> _labPlugins = new List<IPluginDllApi>();
  41.         private static string _pluginFolder = Path.Combine(Directory.GetCurrentDirectory(), "Plugins");
  44.         /// <summary>
  45.         /// 重新加载
  46.         /// </summary>
  47.         public static void ReLoadDll()
  48.         {
  49.             if (!Directory.Exists(_pluginFolder))
  50.                 Directory.CreateDirectory(_pluginFolder);
  52.             _labPlugins = new List<IPluginDllApi>();
  53.             foreach (var dllPath in Directory.GetFiles(_pluginFolder, "*.dll"))
  54.             {
  55.                 try
  56.                 {
  57.                     var assemblyLoadContext = new AssemblyLoadContext(Path.GetFileNameWithoutExtension(dllPath), true);
  58.                     var assembly = assemblyLoadContext.LoadFromAssemblyPath(dllPath);
  60.                     var pluginTypes = assembly.GetTypes()
  61.                         .Where(t => typeof(IPluginDllApi).IsAssignableFrom(t) && !t.IsInterface && !t.IsAbstract);
  63.                     foreach (var pluginType in pluginTypes)
  64.                     {
  65.                         if (Activator.CreateInstance(pluginType) is IPluginDllApi pluginInstance)
  66.                         {
  67.                             if (pluginInstance != null)
  68.                                 _labPlugins.Add((pluginInstance));
  69.                         }
  70.                     }
  71.                 }
  72.                 catch (Exception ex)
  73.                 {
  74.                     Console.WriteLine($"Failed to load assembly {dllPath}: {ex.Message}");
  75.                 }
  76.             }
  77.         }
  78.     }
  79. }
复制代码
3，然后我们在步伐启动的时间进行调用

 
 4，接下来我们创建一个PluginController.cs控制器，这个控制器实现了动态的路由。代码如下：
  1. using DynamicPluginApiDemo.Utils;
  2. using Microsoft.AspNetCore.Http;
  3. using Microsoft.AspNetCore.Mvc;
  4. using Newtonsoft.Json.Linq;
  6. namespace DynamicPluginApiDemo.Controllers
  7. {
  8.     [Route("api/[controller]/{DynamicParam}")]
  9.     [ApiController]
  10.     public class PluginController : ControllerBase
  11.     {
  13.         /// <summary>
  14.         /// 动态插件的名称
  15.         /// </summary>
  16.         private readonly string _dynamicParam = string.Empty;
  17.         public PluginController(IHttpContextAccessor httpContextAccessor)
  18.         {
  19.             var dynamicParamKey = httpContextAccessor?.HttpContext?.GetRouteValue("DynamicParam");
  20.             if (dynamicParamKey != null)
  21.                 _dynamicParam = dynamicParamKey?.ToString() ?? string.Empty;
  22.         }
  27.         // GET: api/ApifulPlugin/apidll/GetRequest/Query?SearchName=AAA
  28.         [HttpGet("GetRequest/{functionName}")]
  29.         public IActionResult GetRequest(string functionName, [FromQuery] Dictionary<string, string> queryParameters)
  30.         {
  31.             var instance = PluginDllHelper._labPlugins.FirstOrDefault(x => x.Name == _dynamicParam);
  32.             if (instance == null)
  33.                 return NotFound();
  34.             return instance.GetRequest(functionName, queryParameters);
  35.         }
  39.         // POST: api/Dynamic/json
  40.         // Receives query parameters and JSON body
  41.         [HttpPost("PostRequestBody/{functionName}")]
  42.         public IActionResult PostRequestBody(string functionName, [FromQuery] Dictionary<string, string> queryParameters, [FromBody] object jsonData)
  43.         {
  44.             var instance = PluginDllHelper._labPlugins.FirstOrDefault(x => x.Name == _dynamicParam);
  45.             if (instance == null)
  46.                 return NotFound();
  47.             return instance.PostRequestBody(functionName, queryParameters, jsonData);
  48.         }
  50.         // POST: api/Dynamic/form
  51.         [HttpPost("PostRequestForm/{functionName}")]
  52.         public IActionResult PostRequestForm(string functionName, [FromQuery] Dictionary<string, string> queryParameters, IFormCollection formData)
  53.         {
  54.             var instance = PluginDllHelper._labPlugins.FirstOrDefault(x => x.Name == _dynamicParam);
  55.             if (instance == null)
  56.                 return NotFound();
  57.             return instance.PostRequestForm(functionName, queryParameters, formData);
  58.         }
  62.     }
  63. }
复制代码
5，webapi项目的内容差不多了。接下来我们创建一个类库项目，名字叫做BlogPluginApi。然后项目引用一下主项目，而且创建一个BlogPluginApi.cs文件继承主项目的IPluginDllApi。
  1. using BlogPluginApi.Service;
  2. using DynamicPluginApiDemo.Utils;
  3. using Microsoft.AspNetCore.Http;
  4. using Microsoft.AspNetCore.Mvc;
  5. using Microsoft.SqlServer.Server;
  7. namespace BlogPluginApi
  8. {
  9.     public class BlogPluginApi : IPluginDllApi
  10.     {
  11.         public string Name => "BlogPluginApi";
  13.         public IActionResult GetRequest(string funName, Dictionary<string, string> queryParameters)
  14.         {
  15.             var result = string.Empty;
  16.             switch (funName)
  17.             {
  18.                 case "Query":
  19.                     result = BlogService.Query(queryParameters);
  20.                     break;
  21.             }
  22.             return new ContentResult
  23.             {
  24.                 StatusCode = 200,
  25.                 ContentType = "text/plain",
  26.                 Content = result
  27.             };
  28.         }
  30.         public IActionResult PostRequestBody(string funName, Dictionary<string, string> queryParameters, object jsonData)
  31.         {
  32.             var result = string.Empty;
  33.             switch (funName)
  34.             {
  35.                 case "Save":
  36.                     result = BlogService.Save(jsonData);
  37.                     break;
  38.                 case "Update":
  39.                     result = BlogService.Update(jsonData);
  40.                     break;
  41.                 case "Delete":
  42.                     result = BlogService.Delete(jsonData);
  43.                     break;
  44.             }
  45.             return new ContentResult
  46.             {
  47.                 StatusCode = 200,
  48.                 ContentType = "text/plain",
  49.                 Content = result
  50.             };
  51.         }
  53.         public IActionResult PostRequestForm(string funName, Dictionary<string, string> queryParameters, IFormCollection formData)
  54.         {
  55.             var result = string.Empty;
  56.             switch (funName)
  57.             {
  58.                 case "UploadFile":
  59.                     result = BlogService.UploadFile(queryParameters, formData);
  60.                     break;
  61.             }
  62.             return new ContentResult
  63.             {
  64.                 StatusCode = 200,
  65.                 ContentType = "text/plain",
  66.                 Content = result
  67.             };
  68.         }
  69.     }
  70. }
复制代码
6，然后我们增加blog表的实体，服务，模型等。当然这些可以放在主项目中，通过项目引用利用主项目的代码。

 
  1. using SqlSugar;
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Linq;
  5. using System.Text;
  6. using System.Threading.Tasks;
  8. namespace BlogPluginApi.Entitys.Blogs
  9. {
  10.     [SugarTable("BLOG", TableDescription = "博客")]
  11.     public class Blog
  12.     {
  13.         [SugarColumn(ColumnName = "ID", IsIdentity = true, IsPrimaryKey = true)]
  14.         public int Id { get; set; }
  16.         [SugarColumn(ColumnName = "Title")]
  17.         public string Title { get; set; }
  19.         [SugarColumn(ColumnName = "Context")]
  20.         public string Context { get; set; }
  22.         [SugarColumn(ColumnName = "UserId")]
  23.         public int UserId { get; set; }
  25.         [SugarColumn(ColumnName = "CreateTime")]
  27.         public DateTime CreateTime { get; set; }
  28.     }
  29. }
  32. using SqlSugar;
  33. using System;
  34. using System.Collections.Generic;
  35. using System.Linq;
  36. using System.Text;
  37. using System.Threading.Tasks;
  39. namespace BlogPluginApi.Models.Blogs
  40. {
  41.     public class BlogInputDto
  42.     {
  43.         public int? Id { get; set; }
  45.         public string? Title { get; set; }
  47.         public string? Context { get; set; }
  49.         public int? UserId { get; set; }
  52.         public DateTime? CreateTime { get; set; }
  53.     }
  54. }
  57. using System;
  58. using System.Collections.Generic;
  59. using System.Linq;
  60. using System.Text;
  61. using System.Threading.Tasks;
  63. namespace BlogPluginApi.Models.Blogs
  64. {
  65.     public class SearchDto
  66.     {
  67.         public string SearchName { get; set; }
  68.     }
  69. }
  72. using AutoMapper;
  73. using BlogPluginApi.Entitys.Blogs;
  74. using BlogPluginApi.Models.Blogs;
  75. using DynamicPluginApiDemo.Utils;
  76. using Microsoft.AspNetCore.Http;
  77. using Newtonsoft.Json;
  78. using System;
  79. using System.Collections.Generic;
  80. using System.Linq;
  81. using System.Text;
  82. using System.Threading.Tasks;
  84. namespace BlogPluginApi.Service
  85. {
  86.     public static class BlogService
  87.     {
  89.         public static string Query(Dictionary<string, string> queryParameters)
  90.         {
  91.             SearchDto searchBlogDto = new SearchDto();
  92.             if (queryParameters.TryGetValue("SearchName", out var searchName))
  93.             {
  94.                 searchBlogDto.SearchName = searchName;
  95.             }
  96.             var result = string.Join(",", DbHelper.Db.Queryable<Blog>().Select(s => s.Title).ToList());
  97.             return result;
  98.         }
  100.         public static string Delete(object param)
  101.         {
  102.             var strParam = param.ToString();
  103.             if (string.IsNullOrEmpty(strParam)) return string.Empty;
  104.             var deleteIds = JsonConvert.DeserializeObject<List<int>>(strParam);
  105.             if (deleteIds != null)
  106.             {
  107.                 var count = DbHelper.Db.Deleteable<Blog>().Where(x => deleteIds.Contains(x.Id)).ExecuteCommand();
  108.                 return count.ToString();
  109.             }
  110.             return string.Empty;
  112.         }
  114.         public static string Save(object param)
  115.         {
  116.             var strParam = param.ToString();
  117.             if (string.IsNullOrEmpty(strParam)) return string.Empty;
  118.             var inputDto = JsonConvert.DeserializeObject<Blog>(strParam);
  119.             if (inputDto != null)
  120.             {
  121.                 var count = DbHelper.Db.Insertable(inputDto).ExecuteCommand();
  122.             }
  123.             return "success";
  124.         }
  126.         public static string Update(object param)
  127.         {
  128.             var strParam = param.ToString();
  129.             if (string.IsNullOrEmpty(strParam)) return string.Empty;
  130.             var inputDto = JsonConvert.DeserializeObject<Blog>(strParam);
  131.             if (inputDto != null)
  132.             {
  133.                 var count = DbHelper.Db.Updateable(inputDto).ExecuteCommand();
  134.             }
  135.             return "success";
  136.         }
  138.         public static string UploadFile(Dictionary<string, string> queryParameters, IFormCollection formData)
  139.         {
  140.             string UploadId = string.Empty;
  141.             if (queryParameters.TryGetValue("uploadId", out var uploadId))
  142.             {
  143.                 UploadId = uploadId;
  144.             }
  146.             var file = formData.Files.FirstOrDefault();
  147.             if (file != null)
  148.                 return file.FileName;
  150.             return string.Empty;
  151.         }
  154.     }
  155. }
复制代码
 7，然后我们生成一下BlogPluginApi项目，把生成的dll文件放在放在主项目的Plugins文件夹下就可以了。
 留意：
系统必须被设计为可以或许识别和管理差异的插件版本，而且可以或许在运行时安全地切换这些版本。
结语

Web API插件的热插拔是一个复杂但非常有价值的功能，它不仅进步了系统的灵活性和可用性，还加强了用户体验。通过经心规划和技术实践，可以使这一特性成为现代Web应用和服务的一个亮点。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

铁佛

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表