Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b7775cbe6c | ||
|
|
28c6d53f38 | ||
|
|
ebceb0a260 | ||
|
|
162b92a415 | ||
|
|
a859986a93 | ||
|
|
e1c6694e18 | ||
|
|
566b1d190b | ||
|
|
eb8c9732bd | ||
|
|
c8b78ce86d | ||
|
|
b2ec94e957 | ||
|
|
a8439c174c | ||
|
|
81e166ad45 | ||
|
|
d50d32f032 | ||
|
|
8ad43526fc | ||
|
|
e2d30c031d | ||
|
|
9dc4ef7bce | ||
|
|
d5eb7fe081 | ||
|
|
b04a7c86d7 | ||
|
|
8759b593db | ||
|
|
5a46a026a7 | ||
|
|
90124b6e67 | ||
|
|
2499912204 | ||
|
|
dd38f315d5 | ||
|
|
c448381f23 | ||
|
|
8d5b667c88 | ||
|
|
65451d7b80 | ||
|
|
c7373da691 |
@@ -9,16 +9,21 @@ jobs:
|
||||
publish:
|
||||
name: Publish Project to Nuget
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/checkout@v4
|
||||
- name: Setup .NET Core
|
||||
uses: actions/setup-dotnet@v1
|
||||
uses: actions/setup-dotnet@v5
|
||||
with:
|
||||
dotnet-version: "9.0.305"
|
||||
dotnet-version: "10.x.x"
|
||||
- name: NuGet login (OIDC → temp API key)
|
||||
uses: NuGet/login@v1
|
||||
id: login
|
||||
with:
|
||||
user: ${{ secrets.NUGET_USER }}
|
||||
- name: Publish
|
||||
run: |
|
||||
version=`git describe --tags`
|
||||
dotnet build --configuration release -p:Version=$version
|
||||
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
|
||||
env:
|
||||
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
|
||||
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${{steps.login.outputs.NUGET_API_KEY}} -s https://api.nuget.org/v3/index.json
|
||||
@@ -0,0 +1,20 @@
|
||||
using System;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using SimApi.ModelBinders;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Parameter)]
|
||||
public class AesBodyAttribute : ModelBinderAttribute
|
||||
{
|
||||
public Type KeyProvider { get; set; } = typeof(AesBodyProviderBase);
|
||||
public override BindingSource BindingSource => BindingSource.Body;
|
||||
|
||||
public AesBodyAttribute()
|
||||
{
|
||||
// 指定使用自定义的模型绑定器
|
||||
BinderType = typeof(AesBodyModelBinder);
|
||||
Name = KeyProvider.FullName;
|
||||
}
|
||||
}
|
||||
@@ -13,13 +13,13 @@ namespace SimApi.Attributes;
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
|
||||
public class SimApiAuthAttribute : ActionFilterAttribute
|
||||
{
|
||||
private string[] Types { get; }
|
||||
private string[]? Types { get; }
|
||||
|
||||
|
||||
//默认是user登录类型
|
||||
public SimApiAuthAttribute()
|
||||
{
|
||||
Types = new[] { "user" };
|
||||
Types = null;
|
||||
}
|
||||
|
||||
//只检测一种用户类型的快捷方式
|
||||
@@ -34,13 +34,6 @@ public class SimApiAuthAttribute : ActionFilterAttribute
|
||||
Types = types;
|
||||
}
|
||||
|
||||
//只检测一种用户类型的快捷方式
|
||||
public SimApiAuthAttribute(string type, string url)
|
||||
{
|
||||
Types = new[] { type };
|
||||
new HttpPostAttribute(url);
|
||||
}
|
||||
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
{
|
||||
var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"]!;
|
||||
@@ -49,6 +42,8 @@ public class SimApiAuthAttribute : ActionFilterAttribute
|
||||
{
|
||||
throw new SimApiException(401);
|
||||
}
|
||||
|
||||
if (Types == null) return;
|
||||
//检测用户类型
|
||||
if (!Types.Intersect(loginInfo.Type).Any())
|
||||
{
|
||||
|
||||
@@ -12,13 +12,28 @@ public class SimApiDocAttribute : SwaggerOperationAttribute
|
||||
/// <summary>
|
||||
/// 定义接口说明
|
||||
/// </summary>
|
||||
/// <param name="tag">接口分组</param>
|
||||
/// <param name="tags">接口分组列表</param>
|
||||
/// <param name="name">接口名称</param>
|
||||
public SimApiDocAttribute(string tag, string name)
|
||||
/// <param name="description">接口描述</param>
|
||||
public SimApiDocAttribute(string[] tags, string name, string? description = null)
|
||||
{
|
||||
Tags = [tag];
|
||||
Tags = tags;
|
||||
Summary = name;
|
||||
if (description != null)
|
||||
{
|
||||
Description = description;
|
||||
}
|
||||
// Consumes = new[] {"application/json"};
|
||||
// Produces = new[] {"application/json"};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 定义接口说明
|
||||
/// </summary>
|
||||
/// <param name="tag">接口分组</param>
|
||||
/// <param name="name">接口名称</param>
|
||||
/// <param name="description">接口描述</param>
|
||||
public SimApiDocAttribute(string tag, string name, string? description = null) : this([tag], name, description)
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,118 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Helpers;
|
||||
using SimApi.ModelBinders;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
|
||||
public class SimApiSignAttribute : ActionFilterAttribute
|
||||
{
|
||||
public Type KeyProvider { get; set; } = typeof(SimApiSignProviderBase);
|
||||
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
{
|
||||
if (context.HttpContext.RequestServices.GetService(KeyProvider) is not SimApiSignProviderBase keyProvider)
|
||||
{
|
||||
throw new SimApiException(400, "未配置签名器");
|
||||
}
|
||||
|
||||
string? appId = null;
|
||||
if (!string.IsNullOrEmpty(keyProvider.AppIdName))
|
||||
{
|
||||
appId = context.HttpContext.Request.Query[keyProvider.AppIdName]
|
||||
.FirstOrDefault() ?? context.HttpContext.Request.Headers[keyProvider.AppIdName]
|
||||
.FirstOrDefault();
|
||||
|
||||
if (string.IsNullOrEmpty(appId))
|
||||
{
|
||||
throw new SimApiException(400, $"获取{keyProvider.AppIdName}失败");
|
||||
}
|
||||
}
|
||||
|
||||
// 4. 通过接口获取密钥(解耦的核心:不再直接依赖数据库)
|
||||
var key = keyProvider.GetKey(appId);
|
||||
if (string.IsNullOrEmpty(key))
|
||||
{
|
||||
throw new SimApiException(400, "获取签名KEY失败");
|
||||
}
|
||||
|
||||
var timestamp = context.HttpContext.Request.Query[keyProvider.TimestampName]
|
||||
.FirstOrDefault() ?? context.HttpContext.Request.Headers[keyProvider.TimestampName]
|
||||
.FirstOrDefault();
|
||||
if (string.IsNullOrEmpty(timestamp))
|
||||
{
|
||||
throw new SimApiException(400, $"{keyProvider.TimestampName}不能为空");
|
||||
}
|
||||
|
||||
var nonce = context.HttpContext.Request.Query[keyProvider.NonceName]
|
||||
.FirstOrDefault() ?? context.HttpContext.Request.Headers[keyProvider.NonceName]
|
||||
.FirstOrDefault();
|
||||
if (string.IsNullOrEmpty(nonce))
|
||||
{
|
||||
throw new SimApiException(400, $"{keyProvider.NonceName}不能为空");
|
||||
}
|
||||
|
||||
if (!int.TryParse(timestamp, out var ts))
|
||||
{
|
||||
throw new SimApiException(400, $"{keyProvider.TimestampName}格式错误");
|
||||
}
|
||||
|
||||
if (keyProvider.QueryExpires != 0)
|
||||
{
|
||||
if (ts > SimApiUtil.TimestampNow + 2)
|
||||
{
|
||||
throw new SimApiException(400, "请校准本地时间");
|
||||
}
|
||||
|
||||
if (ts + keyProvider.QueryExpires < SimApiUtil.TimestampNow)
|
||||
{
|
||||
throw new SimApiException(400, "请求已过期");
|
||||
}
|
||||
|
||||
if (keyProvider.DuplicateRequestProtection)
|
||||
{
|
||||
var cache = context.HttpContext.RequestServices.GetRequiredService<IDistributedCache>();
|
||||
if (cache.GetString("SignQuery:" + nonce) == null)
|
||||
{
|
||||
cache.SetString("SignQuery:" + nonce, timestamp, new DistributedCacheEntryOptions()
|
||||
{
|
||||
SlidingExpiration = TimeSpan.FromSeconds(keyProvider.QueryExpires + 2)
|
||||
});
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new SimApiException(400, "重复请求");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var signStr = string.Empty;
|
||||
foreach (var item in keyProvider.SignFields)
|
||||
{
|
||||
signStr += $"{item}=";
|
||||
signStr += context.HttpContext.Request.Query[item]
|
||||
.FirstOrDefault() ?? context.HttpContext.Request.Headers[item]
|
||||
.FirstOrDefault();
|
||||
signStr += "&";
|
||||
}
|
||||
|
||||
if (!string.IsNullOrEmpty(keyProvider.AppIdName))
|
||||
{
|
||||
signStr += $"{keyProvider.AppIdName}={appId}&";
|
||||
}
|
||||
|
||||
signStr += $"{keyProvider.TimestampName}={ts}&{keyProvider.NonceName}={nonce}&{key}";
|
||||
var sign = context.HttpContext.Request.Query[keyProvider.SignName]
|
||||
.FirstOrDefault() ?? context.HttpContext.Request.Headers[keyProvider.SignName]
|
||||
.FirstOrDefault();
|
||||
if (SimApiUtil.Md5(signStr) != sign)
|
||||
{
|
||||
throw new SimApiException(400, "签名错误");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -7,6 +7,7 @@ using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Controllers;
|
||||
using SimApi.Helpers;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.CoceSdk;
|
||||
|
||||
|
||||
@@ -46,23 +46,15 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态内容分页
|
||||
/// 分页内容返回
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiBasePageResponse<T>() : SimApiBaseResponse
|
||||
public class PageResponse<T>
|
||||
{
|
||||
public T? List { get; set; }
|
||||
public int Page { get; set; } = 1;
|
||||
public int Count { get; set; } = 20;
|
||||
public int Total { get; set; }
|
||||
|
||||
public SimApiBasePageResponse(T list, int page, int count, int total) : this()
|
||||
{
|
||||
List = list;
|
||||
Page = page;
|
||||
Count = count;
|
||||
Total = total;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -7,7 +7,7 @@ namespace SimApi.Communications;
|
||||
/// </summary>
|
||||
public class SimApiLoginItem
|
||||
{
|
||||
public string Id { get; set; } = null!;
|
||||
public required string Id { get; set; }
|
||||
public string[] Type { get; set; } = ["user"];
|
||||
public Dictionary<string, string> Meta { get; set; } = [];
|
||||
public object? Extra { get; set; }
|
||||
|
||||
@@ -4,19 +4,37 @@ public class SimApiJobOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// WebUi地址,设置为null表示不启用
|
||||
/// 默认 /jobs
|
||||
/// </summary>
|
||||
public string? DashboardUrl { get; set; } = "/jobs";
|
||||
|
||||
/// <summary>
|
||||
/// webui 用户
|
||||
/// 默认 admin
|
||||
/// </summary>
|
||||
public string DashboardAuthUser { get; set; } = "admin";
|
||||
|
||||
/// <summary>
|
||||
/// webui 密码
|
||||
/// 默认 Admin@123!
|
||||
/// </summary>
|
||||
public string DashboardAuthPass { get; set; } = "Admin@123!";
|
||||
|
||||
/// <summary>
|
||||
/// 设置为null 使用默认redis配置
|
||||
/// </summary>
|
||||
public string? RedisConfiguration { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 设置为null 使用默认redis配置
|
||||
/// </summary>
|
||||
public int? Database { get; set; } = null;
|
||||
|
||||
public SimApiJobServerConfig[] Servers { get; set; } = [new()];
|
||||
}
|
||||
|
||||
public class SimApiJobServerConfig()
|
||||
{
|
||||
public string[] Queues { get; set; } = ["default"];
|
||||
public int WorkerNum { get; set; } = 50;
|
||||
public int WorkerNum { get; set; } = 5;
|
||||
}
|
||||
@@ -1,11 +1,12 @@
|
||||
using System.Collections.Generic;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
using static SimApiError;
|
||||
|
||||
public class SimApiAuthController(SimApiAuth auth) : SimApiBaseController
|
||||
{
|
||||
/// <summary>
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Communications;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using System.Linq;
|
||||
using SimApi.Exceptions;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
@@ -38,74 +37,4 @@ public class SimApiBaseController : Controller
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
protected static void Error(int code = 500, string message = "")
|
||||
{
|
||||
throw new SimApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhen([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenTrue([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
|
||||
{
|
||||
ErrorWhen(condition, code, message);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 如果condition是false 报错
|
||||
/// </summary>
|
||||
/// <param name="condition"></param>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
protected static void ErrorWhenFalse([DoesNotReturnIf(false)] bool condition, int code = 400, string message = "")
|
||||
{
|
||||
ErrorWhen(!condition, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测给定的变量是否为NUll
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenNull([NotNull] object? condition, int code = 404, string message = "请求的资源不存在")
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 上传文件
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
protected SimApiBaseResponse<string> UploadFile()
|
||||
{
|
||||
return new SimApiBaseResponse<string>();
|
||||
}
|
||||
}
|
||||
@@ -1,46 +0,0 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using SimApi.Attributes;
|
||||
|
||||
namespace SimApi.Helpers
|
||||
{
|
||||
public class SimApiAuthOperationFilter : IOperationFilter
|
||||
{
|
||||
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
||||
{
|
||||
// 检查接口或控制器是否标记了 [SimApiAuth] 特性
|
||||
var requiresAuth =
|
||||
// 方法上有 [SimApiAuth]
|
||||
context.MethodInfo.GetCustomAttributes<SimApiAuthAttribute>(true).Any()
|
||||
||
|
||||
// 控制器上有 [SimApiAuth](继承到所有方法)
|
||||
context.MethodInfo.DeclaringType?.GetCustomAttributes<SimApiAuthAttribute>(true).Any() == true;
|
||||
if (requiresAuth)
|
||||
{
|
||||
// 添加授权要求:关联步骤 2 中定义的 "SimApiAuth" 安全方案
|
||||
operation.Security = new List<OpenApiSecurityRequirement>
|
||||
{
|
||||
new OpenApiSecurityRequirement
|
||||
{
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Reference = new OpenApiReference
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "SimApiAuth" // 必须与 AddSecurityDefinition 的第一个参数一致
|
||||
}
|
||||
},
|
||||
[] // 无需指定作用域(scope)时留空
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
// 未标记 [SimApiAuth] 的接口:不添加安全要求,Swagger 不显示锁图标
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -7,6 +7,12 @@ public class SimApiCache(IDistributedCache cache)
|
||||
{
|
||||
private const string Prefix = "SimApi:Cache:";
|
||||
|
||||
/// <summary>
|
||||
/// 设置缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <param name="value"></param>
|
||||
/// <param name="options"></param>
|
||||
public void Set(string key, object value, DistributedCacheEntryOptions? options = null)
|
||||
{
|
||||
if (options is not null)
|
||||
@@ -19,11 +25,31 @@ public class SimApiCache(IDistributedCache cache)
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 移除缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
public void Remove(string key)
|
||||
{
|
||||
cache.Remove(Prefix + key);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取string类型缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
public string? Get(string key)
|
||||
{
|
||||
return cache.GetString(Prefix + key);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取特定类型缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public T? Get<T>(string key)
|
||||
{
|
||||
var data = cache.GetString(Prefix + key);
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public static class SimApiError
|
||||
{
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
public static void Error(int code = 500, string message = "")
|
||||
{
|
||||
throw new SimApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
public static void ErrorWhen([DoesNotReturnIf(true)] bool condition, int code = 400,
|
||||
string message = "")
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
public static void ErrorWhenTrue([DoesNotReturnIf(true)] bool condition, int code = 400,
|
||||
string message = "")
|
||||
{
|
||||
ErrorWhen(condition, code, message);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 如果condition是false 报错
|
||||
/// </summary>
|
||||
/// <param name="condition"></param>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
public static void ErrorWhenFalse([DoesNotReturnIf(false)] bool condition, int code = 400,
|
||||
string message = "")
|
||||
{
|
||||
ErrorWhen(!condition, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测给定的变量是否为NUll
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
public static void ErrorWhenNull([NotNull] object? condition, int code = 404,
|
||||
string message = "请求的资源不存在")
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测给定的泛型变量是否为Null(提供更精确的编译器 null 流分析)
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
public static void ErrorWhenNull<T>([NotNull] T? condition, int code = 404,
|
||||
string message = "请求的资源不存在") where T : class
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,120 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Net.Http;
|
||||
using System.Net.Http.Json;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiHttpClient(string? appId, string appKey, bool debug = false)
|
||||
{
|
||||
public string Server { get; init; } = string.Empty;
|
||||
public string SignName { get; init; } = "sign";
|
||||
public string TimestampName { get; init; } = "timestamp";
|
||||
public string NonceName { get; init; } = "nonce";
|
||||
public string? AppIdName { get; init; } = "appId";
|
||||
public string[] SignFields { get; init; } = [];
|
||||
|
||||
/// <summary>
|
||||
/// 发起签名请求
|
||||
/// </summary>
|
||||
/// <param name="url"></param>
|
||||
/// <param name="body"></param>
|
||||
/// <param name="queries"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public T? SignQuery<T>(string url, object? body = null, Dictionary<string, string>? queries = null)
|
||||
{
|
||||
url = Server + url;
|
||||
var queryUrl = SignFields.Aggregate(string.Empty,
|
||||
(current, signField) => current + $"{signField}={queries?[signField]}&");
|
||||
if (!string.IsNullOrEmpty(AppIdName))
|
||||
{
|
||||
queryUrl += $"{AppIdName}={appId}&";
|
||||
}
|
||||
|
||||
queryUrl += $"{TimestampName}={(int)SimApiUtil.TimestampNow}&{NonceName}={Guid.NewGuid()}";
|
||||
var signStr = $"{queryUrl}&{appKey}";
|
||||
var path = $"{url}?{queryUrl}&{SignName}={SimApiUtil.Md5(signStr)}";
|
||||
|
||||
if (queries != null)
|
||||
{
|
||||
path = queries.Where(q => !SignFields.Contains(q.Key))
|
||||
.Aggregate(path, (current, q) => current + $"&{q.Key}={q.Value}");
|
||||
}
|
||||
|
||||
return Query<T>(path, body);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 发起AES加密请求
|
||||
/// </summary>
|
||||
/// <param name="url"></param>
|
||||
/// <param name="body"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public T? AesQuery<T>(string url, object body)
|
||||
{
|
||||
url = Server + url;
|
||||
if (!string.IsNullOrEmpty(AppIdName))
|
||||
{
|
||||
url += $"?{AppIdName}={appId}";
|
||||
}
|
||||
|
||||
var req = new SimApiOneFieldRequest<string>
|
||||
{
|
||||
Data = SimApiAesUtil.Encrypt(SimApiUtil.Json(body), appKey)
|
||||
};
|
||||
return Query<T>(url, req);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 发起AES加密以及签名请求
|
||||
/// </summary>
|
||||
/// <param name="url"></param>
|
||||
/// <param name="body"></param>
|
||||
/// <param name="queries"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public T? AesSignQuery<T>(string url, object body, Dictionary<string, string>? queries = null)
|
||||
{
|
||||
var req = new SimApiOneFieldRequest<string>
|
||||
{
|
||||
Data = SimApiAesUtil.Encrypt(SimApiUtil.Json(body), appKey)
|
||||
};
|
||||
return SignQuery<T>(url, req, queries);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 发起请求
|
||||
/// </summary>
|
||||
/// <param name="url"></param>
|
||||
/// <param name="req"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
/// <exception cref="SimApiException"></exception>
|
||||
private T? Query<T>(string url, object? req)
|
||||
{
|
||||
var http = new HttpClient();
|
||||
if (debug)
|
||||
{
|
||||
Console.WriteLine($"[HTTPCLIENT请求] {url}\n{SimApiUtil.Json(req)}\n");
|
||||
}
|
||||
|
||||
var resp = http.PostAsJsonAsync(url, req).Result;
|
||||
if (debug)
|
||||
{
|
||||
Console.WriteLine($"[HTTPCLIENT响应] {resp.Content.ReadAsStringAsync().Result}\n");
|
||||
}
|
||||
|
||||
var res = resp.Content.ReadFromJsonAsync<SimApiBaseResponse<T>>().Result;
|
||||
if (res == null)
|
||||
{
|
||||
throw new SimApiException(500, "请求发生错误");
|
||||
}
|
||||
|
||||
return res.Code != 200 ? throw new SimApiException(res.Code, res.Message) : res.Data;
|
||||
}
|
||||
}
|
||||
@@ -11,7 +11,7 @@ public class SimApiJobWebAuth(string user, string pass) : IDashboardAuthorizatio
|
||||
public bool Authorize(DashboardContext context)
|
||||
{
|
||||
var httpContext = context.GetHttpContext();
|
||||
var authHeader = httpContext.Request.Headers["Authorization"].FirstOrDefault();
|
||||
var authHeader = httpContext.Request.Headers.Authorization.FirstOrDefault();
|
||||
if (authHeader != null && authHeader.StartsWith("Basic "))
|
||||
{
|
||||
var encodedUsernamePassword = authHeader.Split(' ', 2, StringSplitOptions.RemoveEmptyEntries)[1].Trim();
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using SimApi.Communications;
|
||||
@@ -20,47 +19,66 @@ public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExcep
|
||||
context.Response.Headers["Query-Id"] = header;
|
||||
}
|
||||
|
||||
SimApiBaseResponse response;
|
||||
try
|
||||
{
|
||||
await next(context);
|
||||
switch (context.Response.StatusCode)
|
||||
if (!context.Response.HasStarted)
|
||||
{
|
||||
case 200:
|
||||
case 301:
|
||||
case 302:
|
||||
break;
|
||||
case 404:
|
||||
throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
|
||||
default:
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
switch (context.Response.StatusCode)
|
||||
{
|
||||
case 200:
|
||||
case 301:
|
||||
case 302:
|
||||
break;
|
||||
case 404:
|
||||
throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
|
||||
default:
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (SimApiException ex)
|
||||
{
|
||||
response = string.IsNullOrEmpty(ex.Message)
|
||||
? new SimApiBaseResponse(ex.Code)
|
||||
: new SimApiBaseResponse(ex.Code, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
log.LogError("{Msg}", ex.Message);
|
||||
log.LogError("{Msg}", ex.StackTrace);
|
||||
response = new SimApiBaseResponse(500, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
// 解包异步异常
|
||||
ex = UnwrapAggregateException(ex);
|
||||
SimApiBaseResponse response;
|
||||
if (ex is SimApiException simEx)
|
||||
{
|
||||
response = string.IsNullOrEmpty(simEx.Message)
|
||||
? new SimApiBaseResponse(simEx.Code)
|
||||
: new SimApiBaseResponse(simEx.Code, simEx.Message);
|
||||
}
|
||||
else
|
||||
{
|
||||
log.LogError(ex, "服务器异常");
|
||||
response = new SimApiBaseResponse(500, "服务器错误");
|
||||
}
|
||||
|
||||
await ErrorResponseAsync(context, response);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异常抛出错误
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
/// <param name="response"></param>
|
||||
private static void ErrorResponse(HttpContext context, SimApiBaseResponse response)
|
||||
private static Exception UnwrapAggregateException(Exception ex)
|
||||
{
|
||||
while (ex is AggregateException aggEx && aggEx.InnerException != null)
|
||||
{
|
||||
ex = aggEx.InnerException;
|
||||
}
|
||||
|
||||
return ex;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异步输出错误响应(修复异步异常捕获核心)
|
||||
/// </summary>
|
||||
private static async Task ErrorResponseAsync(HttpContext context, SimApiBaseResponse response)
|
||||
{
|
||||
// 响应已开始则直接返回,不修改
|
||||
if (context.Response.HasStarted)
|
||||
return;
|
||||
|
||||
context.Response.StatusCode = 200;
|
||||
context.Response.Headers.Append("Content-Type", "application/json");
|
||||
context.Response.WriteAsync(response.ToString()).Wait();
|
||||
context.Response.ContentType = "application/json";
|
||||
await context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.ModelBinders;
|
||||
|
||||
public class AesBodyModelBinder : IModelBinder
|
||||
{
|
||||
public async Task BindModelAsync(ModelBindingContext bindingContext)
|
||||
{
|
||||
var request = bindingContext.HttpContext.Request;
|
||||
request.EnableBuffering();
|
||||
using var reader = new StreamReader(request.Body, leaveOpen: true);
|
||||
var requestBody = await reader.ReadToEndAsync();
|
||||
request.Body.Position = 0;
|
||||
|
||||
if (string.IsNullOrEmpty(requestBody))
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", "请求体不能为空");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
|
||||
SimApiOneFieldRequest<string>? aesRequest;
|
||||
try
|
||||
{
|
||||
aesRequest = JsonSerializer.Deserialize<SimApiOneFieldRequest<string>>(requestBody, SimApiUtil.JsonOption);
|
||||
}
|
||||
catch (JsonException ex)
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", $"请求体格式错误:{ex.Message}");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
|
||||
if (aesRequest == null || string.IsNullOrEmpty(aesRequest.Data))
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", "请求体缺少密文Data字段");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
|
||||
// 3. 根据配置获取appId(参考上一节代码)
|
||||
var keyProvider =
|
||||
bindingContext.HttpContext.RequestServices.GetService(Type.GetType(bindingContext.BinderModelName!)!) as
|
||||
AesBodyProviderBase;
|
||||
string? appId = null;
|
||||
if (!string.IsNullOrEmpty(keyProvider!.AppIdName))
|
||||
{
|
||||
appId = bindingContext.HttpContext.Request.Query[keyProvider.AppIdName]
|
||||
.FirstOrDefault() ?? bindingContext.HttpContext.Request.Headers[keyProvider.AppIdName]
|
||||
.FirstOrDefault();
|
||||
|
||||
if (string.IsNullOrEmpty(appId))
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("",
|
||||
$"未找到{keyProvider.AppIdName}");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// 4. 通过接口获取密钥(解耦的核心:不再直接依赖数据库)
|
||||
var key = keyProvider.GetKey(appId);
|
||||
if (string.IsNullOrEmpty(key))
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", "获取密钥失败(应用不存在或密钥未配置)");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
|
||||
// 5. 解密和反序列化(保持原有逻辑)
|
||||
try
|
||||
{
|
||||
var jsonStr = SimApiAesUtil.Decrypt(aesRequest.Data, key);
|
||||
if (string.IsNullOrEmpty(jsonStr))
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", "解密失败");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
|
||||
var targetType = bindingContext.ModelType;
|
||||
var deserializedModel = JsonSerializer.Deserialize(jsonStr, targetType, SimApiUtil.JsonOption);
|
||||
if (deserializedModel == null)
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", "反序列化失败");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
return;
|
||||
}
|
||||
|
||||
bindingContext.Result = ModelBindingResult.Success(deserializedModel);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
bindingContext.ModelState.AddModelError("", $"处理异常:{ex.Message}");
|
||||
bindingContext.Result = ModelBindingResult.Failed();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.ModelBinders;
|
||||
|
||||
/// <summary>
|
||||
/// 密钥提供器接口(抽象密钥获取逻辑)
|
||||
/// </summary>
|
||||
public abstract class AesBodyProviderBase
|
||||
{
|
||||
public virtual string? AppIdName { get; set; } = "appId";
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 根据appId获取对应的密钥
|
||||
/// </summary>
|
||||
/// <param name="appId">应用ID</param>
|
||||
/// <returns>密钥(返回null表示获取失败)</returns>
|
||||
public abstract string? GetKey(string? appId);
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.ModelBinders;
|
||||
|
||||
public abstract class SimApiSignProviderBase
|
||||
{
|
||||
/// <summary>
|
||||
/// appId字段的名称
|
||||
/// </summary>
|
||||
public virtual string? AppIdName { get; set; } = "appId";
|
||||
|
||||
/// <summary>
|
||||
/// 时间戳的字段名
|
||||
/// </summary>
|
||||
public virtual string TimestampName { get; set; } = "timestamp";
|
||||
|
||||
/// <summary>
|
||||
/// 随机字符串的字段名
|
||||
/// </summary>
|
||||
public virtual string NonceName { get; set; } = "nonce";
|
||||
|
||||
/// <summary>
|
||||
/// 签名的字段名
|
||||
/// </summary>
|
||||
public virtual string SignName { get; set; } = "sign";
|
||||
|
||||
/// <summary>
|
||||
/// 请求过期时间, 如果为0, 不校验timestamp
|
||||
/// </summary>
|
||||
public virtual int QueryExpires { get; set; } = 5;
|
||||
|
||||
/// <summary>
|
||||
/// 如果开启,必须配置redis, 每次请求将会缓存nonce
|
||||
/// </summary>
|
||||
public virtual bool DuplicateRequestProtection { get; set; } = true;
|
||||
|
||||
public virtual string[] SignFields { get; set; } = [];
|
||||
|
||||
/// <summary>
|
||||
/// 根据appId获取对应的密钥
|
||||
/// </summary>
|
||||
/// <param name="appId">应用ID</param>
|
||||
/// <returns>密钥(返回null表示获取失败)</returns>
|
||||
public abstract string? GetKey(string? appId);
|
||||
}
|
||||
+6
-20
@@ -1,5 +1,4 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
@@ -9,30 +8,17 @@
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>Simcu.SimApi</PackageId>
|
||||
<Nullable>enable</Nullable>
|
||||
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
|
||||
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Folder Include="Communications\"/>
|
||||
<Folder Include="Exceptions\"/>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.21" />
|
||||
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.22" />
|
||||
<PackageReference Include="Hangfire.Console" Version="1.4.3"/>
|
||||
<PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0"/>
|
||||
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="9.0.10" />
|
||||
<PackageReference Include="Minio" Version="6.0.5" />
|
||||
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="10.0.1" />
|
||||
<PackageReference Include="Minio" Version="7.0.0" />
|
||||
<PackageReference Include="MQTTnet" Version="5.0.1.1416"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.6" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="10.1.0" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.1.0" />
|
||||
</ItemGroup>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical"/>
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
</Project>
|
||||
|
||||
+79
-7
@@ -9,7 +9,7 @@ using Hangfire.Redis.StackExchange;
|
||||
using SimApi.Helpers;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using SimApi.Middlewares;
|
||||
using Microsoft.AspNetCore.HttpOverrides;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
@@ -19,6 +19,7 @@ using SimApi.Attributes;
|
||||
using SimApi.CoceSdk;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Logger;
|
||||
using SimApi.SwaggerFilters;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
@@ -122,8 +123,80 @@ public static class SimApiExtensions
|
||||
});
|
||||
}
|
||||
|
||||
x.CustomSchemaIds(type => type.FullName?.Replace("+", "."));
|
||||
x.OperationFilter<SimApiResponseSchemaFilter>();
|
||||
x.CustomSchemaIds(type =>
|
||||
{
|
||||
// 递归解析类型名称(处理嵌套泛型/数组/可空 + 保证唯一性)
|
||||
string GetSimpleTypeName(Type t, int depth = 0)
|
||||
{
|
||||
// 防止无限递归
|
||||
if (depth > 5) return t.Name.Split('`')[0];
|
||||
|
||||
// 处理数组类型
|
||||
if (t.IsArray)
|
||||
{
|
||||
var elementType = t.GetElementType();
|
||||
return $"{GetSimpleTypeName(elementType!, depth + 1)}[]";
|
||||
}
|
||||
|
||||
// 处理可空类型
|
||||
if (Nullable.GetUnderlyingType(t) != null)
|
||||
{
|
||||
var underlyingType = Nullable.GetUnderlyingType(t);
|
||||
return GetSimpleTypeName(underlyingType!, depth + 1);
|
||||
}
|
||||
|
||||
// 处理泛型类型(递归解析嵌套泛型)
|
||||
if (t.IsGenericType)
|
||||
{
|
||||
var genericBaseName = t.GetGenericTypeDefinition().Name.Split('`')[0];
|
||||
var genericArgs = t.GetGenericArguments()
|
||||
.Select(arg => GetSimpleTypeName(arg, depth + 1))
|
||||
.Where(arg => !string.IsNullOrEmpty(arg))
|
||||
.ToArray();
|
||||
return $"{genericBaseName}<{string.Join(",", genericArgs)}>";
|
||||
}
|
||||
|
||||
// 处理基础类型(小写)
|
||||
if (t.IsPrimitive || t == typeof(string) || t == typeof(DateTime) || t == typeof(Guid))
|
||||
{
|
||||
return t.Name switch
|
||||
{
|
||||
"String" => "string",
|
||||
"Int32" => "int",
|
||||
"Int64" => "long",
|
||||
"Boolean" => "boolean",
|
||||
"DateTime" => "datetime",
|
||||
"Guid" => "guid",
|
||||
_ => t.Name.ToLower()
|
||||
};
|
||||
}
|
||||
|
||||
// 核心修复:生成唯一名称(处理嵌套类/同名不同类)
|
||||
var typeName = t.Name;
|
||||
|
||||
// 步骤1:处理嵌套类(如 ApplicationDto+ApplicationEditRequest → ApplicationDto_ApplicationEditRequest)
|
||||
if (t.DeclaringType != null)
|
||||
{
|
||||
typeName = $"{GetSimpleTypeName(t.DeclaringType)}.{typeName}";
|
||||
}
|
||||
|
||||
// 步骤2:(可选)处理同命名空间下的同名类(拼接命名空间前缀,避免全局重复)
|
||||
// 如需更严格的唯一性,取消注释下面这行
|
||||
// typeName = $"{t.Namespace?.Replace(".", "_")}_{typeName}";
|
||||
|
||||
return typeName;
|
||||
}
|
||||
|
||||
// 根调用:解析当前类型
|
||||
var uniqueSchemaId = GetSimpleTypeName(type);
|
||||
// 可选:移除特殊字符(如 $、+),避免 Swagger 解析问题
|
||||
return uniqueSchemaId.Replace("$", "").Replace("+", "_");
|
||||
});
|
||||
x.OperationFilter<SimApiResponseOperationFilter>();
|
||||
x.OperationFilter<SimApiSignOperationFilter>();
|
||||
x.OperationFilter<AesBodyOperationFilter>();
|
||||
x.SchemaFilter<GlobalDynamicObjectSchemaFilter>();
|
||||
x.DocumentFilter<RemoveEmptyTagsFilter>();
|
||||
if (simApiOptions.EnableSimApiAuth)
|
||||
{
|
||||
x.OperationFilter<SimApiAuthOperationFilter>();
|
||||
@@ -153,11 +226,12 @@ public static class SimApiExtensions
|
||||
switch (auth)
|
||||
{
|
||||
case "SimApiAuth":
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
x.AddSecurityDefinition("SimApiAuth",
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header
|
||||
In = ParameterLocation.Header,
|
||||
Type = SecuritySchemeType.ApiKey
|
||||
});
|
||||
break;
|
||||
case "ClientCredentials":
|
||||
@@ -236,7 +310,6 @@ public static class SimApiExtensions
|
||||
if (simApiOptions.EnableSimApiResponseFilter)
|
||||
{
|
||||
builder.AddControllers(opt => opt.Filters.Add<SimApiResponseFilter>())
|
||||
.AddXmlSerializerFormatters()
|
||||
.AddJsonOptions(opt =>
|
||||
{
|
||||
opt.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
|
||||
@@ -389,7 +462,6 @@ public static class SimApiExtensions
|
||||
x.SwaggerEndpoint($"/swagger/{group.Id}.json", name: group.Name);
|
||||
}
|
||||
|
||||
x.EnableValidator();
|
||||
x.SupportedSubmitMethods(docOptions.SupportedMethod);
|
||||
x.DisplayRequestDuration();
|
||||
});
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.OpenApi;
|
||||
using SimApi.Attributes;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Reflection;
|
||||
|
||||
/// <summary>
|
||||
/// 自定义 Swagger 过滤器:将标注 [AesBody] 的参数显示在 Request Body 中
|
||||
/// </summary>
|
||||
public class AesBodyOperationFilter : IOperationFilter
|
||||
{
|
||||
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
||||
{
|
||||
foreach (var parameter in context.ApiDescription.ParameterDescriptions)
|
||||
{
|
||||
var hasAesBodyAttr = parameter.ParameterInfo()
|
||||
.GetCustomAttribute<AesBodyAttribute>() != null;
|
||||
if (!hasAesBodyAttr) continue;
|
||||
// 1. 移除默认的 Query 参数描述(如果存在)
|
||||
var queryParam = operation.Parameters!
|
||||
.FirstOrDefault(p => p.Name == parameter.Name);
|
||||
if (queryParam != null)
|
||||
{
|
||||
operation.Parameters!.Remove(queryParam);
|
||||
}
|
||||
|
||||
// 2. 添加 Body 参数描述
|
||||
// 获取参数类型的 Schema(Swagger 模型定义)
|
||||
var schema = context.SchemaGenerator.GenerateSchema(
|
||||
parameter.Type,
|
||||
context.SchemaRepository);
|
||||
|
||||
// 将参数添加到 Request Body
|
||||
operation.RequestBody = new OpenApiRequestBody
|
||||
{
|
||||
Content = new Dictionary<string, OpenApiMediaType>
|
||||
{
|
||||
{
|
||||
"application/json", // 假设使用 JSON 格式
|
||||
new OpenApiMediaType { Schema = schema }
|
||||
}
|
||||
},
|
||||
Description = "内容为加密前内容,需要转换为JSON后使用AES加密后提交,提交格式为 {\"data\":\"AES密文\"}",
|
||||
Required = true // 标记为必填
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
using System;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using System.Text.Json.Nodes;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
public class GlobalDynamicObjectSchemaFilter : ISchemaFilter
|
||||
{
|
||||
public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
|
||||
{
|
||||
if (!IsDynamicObjectType(context.Type)) return;
|
||||
var oaSchema = schema as OpenApiSchema;
|
||||
oaSchema!.AdditionalPropertiesAllowed = true;
|
||||
oaSchema.AdditionalProperties = new OpenApiSchema
|
||||
{
|
||||
Type = JsonSchemaType.Object, // 表示 value 可以是任意类型(兼容所有类型)
|
||||
};
|
||||
|
||||
// 2. 覆盖默认示例,使用包含多种类型的示例
|
||||
oaSchema.Example = CreateMultiTypeExample();
|
||||
}
|
||||
|
||||
// 判断是否为需要处理的“动态对象”类型
|
||||
private bool IsDynamicObjectType(Type? type)
|
||||
{
|
||||
if (type == null) return false;
|
||||
if (typeof(IDictionary).IsAssignableFrom(type) ||
|
||||
(type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Dictionary<,>)))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (type == typeof(object))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return type.Name.Contains("AnonymousType") && type.Namespace == null;
|
||||
}
|
||||
|
||||
// 创建包含多种类型的示例(覆盖默认的 string 示例)
|
||||
private JsonNode CreateMultiTypeExample()
|
||||
{
|
||||
return new JsonObject
|
||||
{
|
||||
// 字符串类型:JsonValue.Create 包装字符串
|
||||
["stringProp"] = JsonValue.Create("example string"),
|
||||
// 数字类型:支持 int/long/double 等,JsonValue 自动适配
|
||||
["numberProp"] = JsonValue.Create(123),
|
||||
// 布尔类型
|
||||
["boolProp"] = JsonValue.Create(true),
|
||||
// 嵌套对象:JsonObject 对应 OpenApiObject
|
||||
["objectProp"] = new JsonObject
|
||||
{
|
||||
["nestedKey"] = JsonValue.Create("nested value")
|
||||
},
|
||||
// 数组类型:JsonArray 对应 OpenApiArray
|
||||
["arrayProp"] = new JsonArray
|
||||
{
|
||||
JsonValue.Create(1), // 数组内数字
|
||||
JsonValue.Create("two") // 数组内字符串
|
||||
},
|
||||
// 可选:添加 null 值示例(若需要)
|
||||
["nullProp"] = null
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Linq;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
public class RemoveEmptyTagsFilter : IDocumentFilter
|
||||
{
|
||||
public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
|
||||
{
|
||||
// 步骤1:收集所有有接口的 Tag 名称
|
||||
var tagsWithOperations = swaggerDoc.Paths.Values
|
||||
.SelectMany(path => path.Operations!.Values)
|
||||
.SelectMany(op => op.Tags!.Select(t => t.Name))
|
||||
.Distinct()
|
||||
.ToList();
|
||||
|
||||
// 步骤2:移除无接口的空 Tag
|
||||
var emptyTags = swaggerDoc.Tags!.Where(t => !tagsWithOperations.Contains(t.Name)).ToList();
|
||||
foreach (var tag in emptyTags)
|
||||
{
|
||||
swaggerDoc.Tags!.Remove(tag);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using SimApi.Attributes;
|
||||
|
||||
namespace SimApi.SwaggerFilters
|
||||
{
|
||||
public class SimApiAuthOperationFilter : IOperationFilter
|
||||
{
|
||||
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
||||
{
|
||||
// 检查接口或控制器是否标记了 [SimApiAuth] 特性
|
||||
var requiresAuth =
|
||||
// 方法上有 [SimApiAuth]
|
||||
context.MethodInfo.GetCustomAttributes<SimApiAuthAttribute>(true).Any()
|
||||
||
|
||||
// 控制器上有 [SimApiAuth](继承到所有方法)
|
||||
context.MethodInfo.DeclaringType?.GetCustomAttributes<SimApiAuthAttribute>(true).Any() == true;
|
||||
if (!requiresAuth) return;
|
||||
operation.Security ??= new List<OpenApiSecurityRequirement>();
|
||||
operation.Security.Add(new OpenApiSecurityRequirement()
|
||||
{
|
||||
{ new OpenApiSecuritySchemeReference("SimApiAuth", context.Document), [] }
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
+4
-4
@@ -1,7 +1,7 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Reflection;
|
||||
using System.Threading.Tasks;
|
||||
@@ -9,9 +9,9 @@ using Microsoft.AspNetCore.Mvc;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
public class SimApiResponseSchemaFilter : IOperationFilter
|
||||
public class SimApiResponseOperationFilter : IOperationFilter
|
||||
{
|
||||
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
||||
{
|
||||
@@ -46,7 +46,7 @@ public class SimApiResponseSchemaFilter : IOperationFilter
|
||||
var schema = context.SchemaGenerator.GenerateSchema(wrappedType, context.SchemaRepository);
|
||||
|
||||
// 5. 替换 Swagger 文档中的响应类型(只保留 200 OK 的响应,匹配过滤器逻辑)
|
||||
operation.Responses.Clear(); // 清除默认响应(如 200 返回原始类型)
|
||||
operation.Responses!.Clear(); // 清除默认响应(如 200 返回原始类型)
|
||||
operation.Responses.Add("200", new OpenApiResponse
|
||||
{
|
||||
Description = "请求成功",
|
||||
@@ -0,0 +1,101 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.OpenApi;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.ModelBinders;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
public class SimApiSignOperationFilter(IServiceProvider serviceProvider) : IOperationFilter
|
||||
{
|
||||
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
||||
{
|
||||
// 1. 检查当前方法或类是否标注了 SimApiSignAttribute 及其子类
|
||||
var signAttribute = context.MethodInfo.GetCustomAttribute<SimApiSignAttribute>(inherit: true)
|
||||
?? context.MethodInfo.DeclaringType?.GetCustomAttribute<SimApiSignAttribute>(inherit: true);
|
||||
|
||||
if (signAttribute == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
var keyProviderType = signAttribute.KeyProvider;
|
||||
if (!typeof(SimApiSignProviderBase).IsAssignableFrom(keyProviderType))
|
||||
{
|
||||
throw new InvalidOperationException($"KeyProvider 必须继承自 {nameof(SimApiSignProviderBase)}");
|
||||
}
|
||||
|
||||
SimApiSignProviderBase? keyProvider;
|
||||
try
|
||||
{
|
||||
keyProvider =
|
||||
serviceProvider.CreateScope().ServiceProvider.GetService(keyProviderType) as SimApiSignProviderBase;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
throw new InvalidOperationException($"无法从 DI 容器获取 {keyProviderType.Name} 实例:{ex.Message}");
|
||||
}
|
||||
|
||||
if (keyProvider == null)
|
||||
{
|
||||
throw new InvalidOperationException($"{keyProviderType.Name} 未在 DI 容器中注册");
|
||||
}
|
||||
|
||||
var signStr = keyProvider.SignFields.Aggregate(string.Empty, (current, field) => current + $"{field}=xxx&");
|
||||
if (!string.IsNullOrEmpty(keyProvider.AppIdName))
|
||||
{
|
||||
signStr += $"{keyProvider.AppIdName}=xxx&";
|
||||
}
|
||||
|
||||
signStr += $"{keyProvider.TimestampName}=xxx&{keyProvider.NonceName}=xxx&签名密钥";
|
||||
|
||||
var signParameters = new List<(string Name, string Description, bool Required)>
|
||||
{
|
||||
(keyProvider.TimestampName, "时间戳(秒级)", true),
|
||||
(keyProvider.NonceName, "随机字符串", true),
|
||||
(keyProvider.SignName, $"MD5签名结果,签名MD5字符串: {signStr}", true)
|
||||
};
|
||||
if (keyProvider.AppIdName != null)
|
||||
{
|
||||
signParameters.Add((keyProvider.AppIdName, "应用标识", true));
|
||||
}
|
||||
|
||||
signParameters.AddRange(keyProvider.SignFields.Where(x => x != keyProvider.AppIdName)
|
||||
.Select(f => (f, string.Empty, true)));
|
||||
|
||||
operation.Parameters ??= new List<IOpenApiParameter>();
|
||||
|
||||
foreach (var (name, description, required) in signParameters)
|
||||
{
|
||||
if (operation.Parameters?.Any(p => p.Name == name) == true)
|
||||
{
|
||||
var tmp = operation.Parameters?.FirstOrDefault(p => p.Name == name);
|
||||
if (tmp is OpenApiParameter concreteParam)
|
||||
{
|
||||
// 重新赋值只读属性(通过实例化新对象覆盖,或直接修改具体类的可写属性)
|
||||
concreteParam.Required = required; // OpenApiParameter 的 Required 有 setter
|
||||
concreteParam.Description = description;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
operation.Parameters ??= new List<IOpenApiParameter>();
|
||||
operation.Parameters.Add(new OpenApiParameter
|
||||
{
|
||||
Name = name,
|
||||
In = ParameterLocation.Query, // 指定为 Query 参数
|
||||
Description = description,
|
||||
Required = required,
|
||||
Schema = new OpenApiSchema
|
||||
{
|
||||
Type = JsonSchemaType.String // 签名相关参数通常为字符串类型
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user