Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5a46a026a7 | ||
|
|
90124b6e67 | ||
|
|
2499912204 | ||
|
|
dd38f315d5 | ||
|
|
c448381f23 | ||
|
|
8d5b667c88 | ||
|
|
65451d7b80 | ||
|
|
c7373da691 | ||
|
|
9a8d14142a | ||
|
|
cb89a1a003 | ||
|
|
462bce50cc | ||
|
|
fed44c6b49 | ||
|
|
c73aa1d2a8 | ||
|
|
af6bc86a0c | ||
|
|
fc7714198f | ||
|
|
d2b5f14e78 |
@@ -10,15 +10,15 @@ jobs:
|
|||||||
name: Publish Project to Nuget
|
name: Publish Project to Nuget
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v4
|
||||||
- name: Setup .NET Core
|
- name: Setup .NET Core
|
||||||
uses: actions/setup-dotnet@v1
|
uses: actions/setup-dotnet@v5
|
||||||
with:
|
with:
|
||||||
dotnet-version: "9.0.305"
|
dotnet-version: "10.x.x"
|
||||||
- name: Publish
|
- name: Publish
|
||||||
run: |
|
run: |
|
||||||
version=`git describe --tags`
|
version=`git describe --tags`
|
||||||
dotnet build --configuration release -p:PackageVersion=$version
|
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
|
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
|
||||||
env:
|
env:
|
||||||
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
|
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
|
||||||
|
|||||||
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -16,7 +16,7 @@ public class SimApiDocAttribute : SwaggerOperationAttribute
|
|||||||
/// <param name="name">接口名称</param>
|
/// <param name="name">接口名称</param>
|
||||||
public SimApiDocAttribute(string tag, string name)
|
public SimApiDocAttribute(string tag, string name)
|
||||||
{
|
{
|
||||||
Tags = new[] { tag };
|
Tags = [tag];
|
||||||
Summary = name;
|
Summary = name;
|
||||||
// Consumes = new[] {"application/json"};
|
// Consumes = new[] {"application/json"};
|
||||||
// Produces = new[] {"application/json"};
|
// Produces = new[] {"application/json"};
|
||||||
|
|||||||
@@ -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, "签名错误");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,13 +1,11 @@
|
|||||||
using System.ComponentModel.DataAnnotations;
|
namespace SimApi.Communications;
|
||||||
|
|
||||||
namespace SimApi.Communications;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 只有ID的请求
|
/// 只有ID的请求
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class SimApiIdOnlyRequest
|
public class SimApiIdOnlyRequest
|
||||||
{
|
{
|
||||||
[Required] public int Id { get; set; }
|
public required int Id { get; set; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -15,7 +13,7 @@ public class SimApiIdOnlyRequest
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public class SimApiStringIdOnlyRequest
|
public class SimApiStringIdOnlyRequest
|
||||||
{
|
{
|
||||||
[Required] public string? Id { get; set; }
|
public required string Id { get; set; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -24,7 +22,7 @@ public class SimApiStringIdOnlyRequest
|
|||||||
/// <typeparam name="T"></typeparam>
|
/// <typeparam name="T"></typeparam>
|
||||||
public class SimApiOneFieldRequest<T>
|
public class SimApiOneFieldRequest<T>
|
||||||
{
|
{
|
||||||
[Required] public T? Data { get; set; }
|
public required T Data { get; set; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -32,6 +30,6 @@ public class SimApiOneFieldRequest<T>
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public class SimApiBasePageRequest
|
public class SimApiBasePageRequest
|
||||||
{
|
{
|
||||||
[Required] public int Page { get; set; }
|
public required int Page { get; set; }
|
||||||
[Required] public int Count { get; set; }
|
public required int Count { get; set; }
|
||||||
}
|
}
|
||||||
@@ -13,6 +13,10 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
|
|||||||
public int Code { get; set; } = code;
|
public int Code { get; set; } = code;
|
||||||
public string Message { get; set; } = message;
|
public string Message { get; set; } = message;
|
||||||
|
|
||||||
|
public SimApiBaseResponse() : this(200, "成功")
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 默认错误代码对应提示信息
|
/// 默认错误代码对应提示信息
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ namespace SimApi.Communications;
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public class SimApiLoginItem
|
public class SimApiLoginItem
|
||||||
{
|
{
|
||||||
public string Id { get; set; } = null!;
|
public required string Id { get; set; }
|
||||||
public string[] Type { get; set; } = ["user"];
|
public string[] Type { get; set; } = ["user"];
|
||||||
public Dictionary<string, string> Meta { get; set; } = new();
|
public Dictionary<string, string> Meta { get; set; } = [];
|
||||||
public object? Extra { get; set; }
|
public object? Extra { get; set; }
|
||||||
};
|
};
|
||||||
@@ -6,22 +6,22 @@ namespace SimApi.Configurations;
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// 文档组配置
|
/// 文档组配置
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class SimApiDocGroupOption
|
public class SimApiDocGroupOption(string id, string name, string description = "")
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 文档标识
|
/// 文档标识
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Id { get; set; } = null!;
|
public string Id { get; set; } = id;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 文档名称
|
/// 文档名称
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Name { get; set; } = null!;
|
public string Name { get; set; } = name;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 文档描述
|
/// 文档描述
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string Description { get; set; } = null!;
|
public string Description { get; set; } = description!;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -29,7 +29,7 @@ public class SimApiDocGroupOption
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
public class SimApiAuthOption
|
public class SimApiAuthOption
|
||||||
{
|
{
|
||||||
public string[] Type { get; set; } = new[] { "SimApiAuth" };
|
public string[] Type { get; set; } = ["SimApiAuth"];
|
||||||
|
|
||||||
public string Description { get; set; } = "认证服务器颁发的AccessToken";
|
public string Description { get; set; } = "认证服务器颁发的AccessToken";
|
||||||
|
|
||||||
@@ -48,20 +48,15 @@ public class SimApiDocOptions
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// 文档组配置
|
/// 文档组配置
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
|
public SimApiDocGroupOption[] ApiGroups { get; set; } =
|
||||||
{
|
[
|
||||||
new SimApiDocGroupOption
|
new("api", "Api", "Api接口文档")
|
||||||
{
|
];
|
||||||
Id = "api",
|
|
||||||
Name = "Api",
|
|
||||||
Description = "Api接口文档"
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 授权配置
|
/// 授权配置
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
|
public SimApiAuthOption ApiAuth { get; set; } = new();
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 文档页面标题
|
/// 文档页面标题
|
||||||
@@ -71,5 +66,5 @@ public class SimApiDocOptions
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// 接口支持的调用方式
|
/// 接口支持的调用方式
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
|
public SubmitMethod[] SupportedMethod { get; set; } = [SubmitMethod.Post];
|
||||||
}
|
}
|
||||||
@@ -4,13 +4,30 @@ public class SimApiJobOptions
|
|||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// WebUi地址,设置为null表示不启用
|
/// WebUi地址,设置为null表示不启用
|
||||||
|
/// 默认 /jobs
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string? DashboardUrl { get; set; } = "/jobs";
|
public string? DashboardUrl { get; set; } = "/jobs";
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// webui 用户
|
||||||
|
/// 默认 admin
|
||||||
|
/// </summary>
|
||||||
public string DashboardAuthUser { get; set; } = "admin";
|
public string DashboardAuthUser { get; set; } = "admin";
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// webui 密码
|
||||||
|
/// 默认 Admin@123!
|
||||||
|
/// </summary>
|
||||||
public string DashboardAuthPass { get; set; } = "Admin@123!";
|
public string DashboardAuthPass { get; set; } = "Admin@123!";
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 设置为null 使用默认redis配置
|
||||||
|
/// </summary>
|
||||||
public string? RedisConfiguration { get; set; }
|
public string? RedisConfiguration { get; set; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 设置为null 使用默认redis配置
|
||||||
|
/// </summary>
|
||||||
public int? Database { get; set; } = null;
|
public int? Database { get; set; } = null;
|
||||||
public SimApiJobServerConfig[] Servers { get; set; } = [new()];
|
public SimApiJobServerConfig[] Servers { get; set; } = [new()];
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -74,6 +74,14 @@ public class SimApiOptions
|
|||||||
public bool EnableLowerUrl { get; set; } = true;
|
public bool EnableLowerUrl { get; set; } = true;
|
||||||
|
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 应用可以通过 /versions 显示出应用版本和SimApi包版本
|
||||||
|
/// default: true
|
||||||
|
/// </summary>
|
||||||
|
public bool EnableVersionUrl { get; set; } = true;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 启用格式化的 Console Logger
|
/// 启用格式化的 Console Logger
|
||||||
/// default: false
|
/// default: false
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
|
using SimApi.Attributes;
|
||||||
|
using SimApi.Communications;
|
||||||
|
using SimApi.Helpers;
|
||||||
|
|
||||||
|
namespace SimApi.Controllers;
|
||||||
|
|
||||||
|
public class SimApiAuthController(SimApiAuth auth) : SimApiBaseController
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// 检测用户登陆的控制器
|
||||||
|
/// </summary>
|
||||||
|
/// <returns></returns>
|
||||||
|
[HttpPost, SimApiDoc("认证", "检测登陆")]
|
||||||
|
public SimApiBaseResponse<string> CheckLogin()
|
||||||
|
{
|
||||||
|
ErrorWhenNull(LoginInfo, 401, "未登录");
|
||||||
|
return new SimApiBaseResponse<string>
|
||||||
|
{
|
||||||
|
Data = LoginInfo.Id
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 退出登陆
|
||||||
|
/// </summary>
|
||||||
|
/// <returns></returns>
|
||||||
|
[HttpPost, SimApiDoc("认证", "退出登陆")]
|
||||||
|
public SimApiBaseResponse Logout()
|
||||||
|
{
|
||||||
|
string? token = null;
|
||||||
|
|
||||||
|
if (Request.Headers.TryGetValue("Token", out var value))
|
||||||
|
{
|
||||||
|
token = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
auth.Logout(token!);
|
||||||
|
return new SimApiBaseResponse();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
[HttpPost, SimApiAuth]
|
||||||
|
public SimApiBaseResponse<SimApiLoginItem> UserInfo()
|
||||||
|
{
|
||||||
|
return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
using SimApi.Communications;
|
using System.Diagnostics.CodeAnalysis;
|
||||||
|
using SimApi.Communications;
|
||||||
using Microsoft.AspNetCore.Mvc;
|
using Microsoft.AspNetCore.Mvc;
|
||||||
using Microsoft.AspNetCore.Mvc.Filters;
|
using Microsoft.AspNetCore.Mvc.Filters;
|
||||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||||
@@ -13,6 +14,9 @@ namespace SimApi.Controllers;
|
|||||||
/// 2. 报错返回
|
/// 2. 报错返回
|
||||||
/// 3. 错误回馈页面
|
/// 3. 错误回馈页面
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
///
|
||||||
|
[Consumes("application/json")]
|
||||||
|
[Produces("application/json")]
|
||||||
public class SimApiBaseController : Controller
|
public class SimApiBaseController : Controller
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
@@ -53,7 +57,7 @@ public class SimApiBaseController : Controller
|
|||||||
/// <param name="condition">检测条件</param>
|
/// <param name="condition">检测条件</param>
|
||||||
/// <param name="code">错误代码</param>
|
/// <param name="code">错误代码</param>
|
||||||
/// <param name="message">错误描述</param>
|
/// <param name="message">错误描述</param>
|
||||||
protected static void ErrorWhen(bool condition, int code = 400, string message = "")
|
protected static void ErrorWhen([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
|
||||||
{
|
{
|
||||||
if (condition)
|
if (condition)
|
||||||
{
|
{
|
||||||
@@ -68,7 +72,7 @@ public class SimApiBaseController : Controller
|
|||||||
/// <param name="condition">检测条件</param>
|
/// <param name="condition">检测条件</param>
|
||||||
/// <param name="code">错误代码</param>
|
/// <param name="code">错误代码</param>
|
||||||
/// <param name="message">错误描述</param>
|
/// <param name="message">错误描述</param>
|
||||||
protected static void ErrorWhenTrue(bool condition, int code = 400, string message = "")
|
protected static void ErrorWhenTrue([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
|
||||||
{
|
{
|
||||||
ErrorWhen(condition, code, message);
|
ErrorWhen(condition, code, message);
|
||||||
}
|
}
|
||||||
@@ -80,7 +84,7 @@ public class SimApiBaseController : Controller
|
|||||||
/// <param name="condition"></param>
|
/// <param name="condition"></param>
|
||||||
/// <param name="code"></param>
|
/// <param name="code"></param>
|
||||||
/// <param name="message"></param>
|
/// <param name="message"></param>
|
||||||
protected static void ErrorWhenFalse(bool condition, int code = 400, string message = "")
|
protected static void ErrorWhenFalse([DoesNotReturnIf(false)] bool condition, int code = 400, string message = "")
|
||||||
{
|
{
|
||||||
ErrorWhen(!condition, code, message);
|
ErrorWhen(!condition, code, message);
|
||||||
}
|
}
|
||||||
@@ -91,7 +95,7 @@ public class SimApiBaseController : Controller
|
|||||||
/// <param name="condition">检测条件</param>
|
/// <param name="condition">检测条件</param>
|
||||||
/// <param name="code">错误代码</param>
|
/// <param name="code">错误代码</param>
|
||||||
/// <param name="message">错误描述</param>
|
/// <param name="message">错误描述</param>
|
||||||
protected static void ErrorWhenNull(object? condition, int code = 404, string message = "请求的资源不存在")
|
protected static void ErrorWhenNull([NotNull] object? condition, int code = 404, string message = "请求的资源不存在")
|
||||||
{
|
{
|
||||||
ErrorWhen(condition == null, code, message);
|
ErrorWhen(condition == null, code, message);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
using Microsoft.AspNetCore.Mvc;
|
using System.Collections.Generic;
|
||||||
using SimApi.Attributes;
|
using Microsoft.AspNetCore.Mvc;
|
||||||
using SimApi.Communications;
|
using SimApi.Communications;
|
||||||
using SimApi.Helpers;
|
using SimApi.Helpers;
|
||||||
|
|
||||||
namespace SimApi.Controllers;
|
namespace SimApi.Controllers;
|
||||||
public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
|
|
||||||
|
public class SimApiCommonController : SimApiBaseController
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 错误回馈页面
|
/// 错误回馈页面
|
||||||
@@ -18,41 +19,17 @@ public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
|
|||||||
return new SimApiBaseResponse(code);
|
return new SimApiBaseResponse(code);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// 检测用户登陆的控制器
|
[HttpPost, HttpGet]
|
||||||
/// </summary>
|
public SimApiBaseResponse<Dictionary<string, string>> Versions()
|
||||||
/// <returns></returns>
|
|
||||||
[HttpPost, SimApiDoc("认证", "检测登陆")]
|
|
||||||
public SimApiBaseResponse<string> CheckLogin()
|
|
||||||
{
|
{
|
||||||
ErrorWhenNull(LoginInfo, 401,"未登录");
|
return new SimApiBaseResponse<Dictionary<string, string>>()
|
||||||
return new SimApiBaseResponse<string>
|
|
||||||
{
|
{
|
||||||
Data = LoginInfo.Id
|
Data = new Dictionary<string, string>
|
||||||
|
{
|
||||||
|
{ "SimApi", SimApiUtil.SimApiVersion },
|
||||||
|
{ "App", SimApiUtil.AppVersion }
|
||||||
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// 退出登陆
|
|
||||||
/// </summary>
|
|
||||||
/// <returns></returns>
|
|
||||||
[HttpPost, SimApiDoc("认证", "退出登陆")]
|
|
||||||
public SimApiBaseResponse Logout()
|
|
||||||
{
|
|
||||||
string? token = null;
|
|
||||||
|
|
||||||
if (Request.Headers.TryGetValue("Token", out var value))
|
|
||||||
{
|
|
||||||
token = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
auth.Logout(token!);
|
|
||||||
return new SimApiBaseResponse();
|
|
||||||
}
|
|
||||||
|
|
||||||
[HttpPost,SimApiAuth]
|
|
||||||
public SimApiBaseResponse<SimApiLoginItem> UserInfo()
|
|
||||||
{
|
|
||||||
return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
using System;
|
||||||
|
using System.IO;
|
||||||
|
using System.Security.Cryptography;
|
||||||
|
using System.Text;
|
||||||
|
|
||||||
|
namespace SimApi.Helpers;
|
||||||
|
|
||||||
|
public static class SimApiAesUtil
|
||||||
|
{
|
||||||
|
// 密钥长度:256位 (32字节)
|
||||||
|
private const int KeySize = 256;
|
||||||
|
|
||||||
|
// 块大小:128位 (16字节)
|
||||||
|
private const int BlockSize = 128;
|
||||||
|
|
||||||
|
// 加密模式 - 重命名以避免与枚举类型冲突
|
||||||
|
private const CipherMode AesCipherMode = CipherMode.CBC;
|
||||||
|
|
||||||
|
// 填充模式 - 重命名以避免与枚举类型冲突
|
||||||
|
private const PaddingMode AesPaddingMode = PaddingMode.PKCS7;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// AES 加密
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="plainText">明文</param>
|
||||||
|
/// <param name="key">字符串密钥(将被处理为256位)</param>
|
||||||
|
/// <returns>加密后的Base64字符串(包含IV)</returns>
|
||||||
|
public static string Encrypt(string plainText, string key)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrEmpty(plainText))
|
||||||
|
throw new ArgumentNullException(nameof(plainText));
|
||||||
|
if (string.IsNullOrEmpty(key))
|
||||||
|
throw new ArgumentNullException(nameof(key));
|
||||||
|
|
||||||
|
// 处理密钥为指定长度
|
||||||
|
var keyBytes = ProcessKey(key);
|
||||||
|
// 生成随机IV
|
||||||
|
var iv = GenerateRandomIv();
|
||||||
|
|
||||||
|
using var aes = CreateAesProvider(keyBytes, iv);
|
||||||
|
using var encryptor = aes.CreateEncryptor(aes.Key, aes.IV);
|
||||||
|
using var ms = new MemoryStream();
|
||||||
|
// 先写入IV,解密时需要用到
|
||||||
|
ms.Write(iv, 0, iv.Length);
|
||||||
|
|
||||||
|
using (var cs = new CryptoStream(ms, encryptor, CryptoStreamMode.Write))
|
||||||
|
using (var sw = new StreamWriter(cs))
|
||||||
|
{
|
||||||
|
sw.Write(plainText);
|
||||||
|
}
|
||||||
|
|
||||||
|
return Convert.ToBase64String(ms.ToArray());
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// AES 解密
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="cipherText">加密后的Base64字符串</param>
|
||||||
|
/// <param name="key">字符串密钥(与加密时相同)</param>
|
||||||
|
/// <returns>解密后的明文</returns>
|
||||||
|
public static string Decrypt(string cipherText, string key)
|
||||||
|
{
|
||||||
|
if (string.IsNullOrEmpty(cipherText))
|
||||||
|
throw new ArgumentNullException(nameof(cipherText));
|
||||||
|
if (string.IsNullOrEmpty(key))
|
||||||
|
throw new ArgumentNullException(nameof(key));
|
||||||
|
|
||||||
|
var cipherBytes = Convert.FromBase64String(cipherText);
|
||||||
|
|
||||||
|
// 从加密数据中提取IV
|
||||||
|
var iv = new byte[BlockSize / 8];
|
||||||
|
Array.Copy(cipherBytes, 0, iv, 0, iv.Length);
|
||||||
|
|
||||||
|
// 处理密钥为指定长度
|
||||||
|
var keyBytes = ProcessKey(key);
|
||||||
|
|
||||||
|
using var aes = CreateAesProvider(keyBytes, iv);
|
||||||
|
using var decryptor = aes.CreateDecryptor(aes.Key, aes.IV);
|
||||||
|
using var ms = new MemoryStream(cipherBytes, iv.Length, cipherBytes.Length - iv.Length);
|
||||||
|
using var cs = new CryptoStream(ms, decryptor, CryptoStreamMode.Read);
|
||||||
|
using var sr = new StreamReader(cs);
|
||||||
|
return sr.ReadToEnd();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 处理密钥为指定长度(256位)
|
||||||
|
/// </summary>
|
||||||
|
private static byte[] ProcessKey(string key)
|
||||||
|
{
|
||||||
|
// 使用SHA256哈希处理密钥,确保得到32字节(256位)的密钥
|
||||||
|
return SHA256.HashData(Encoding.UTF8.GetBytes(key));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 生成随机初始化向量
|
||||||
|
/// </summary>
|
||||||
|
private static byte[] GenerateRandomIv()
|
||||||
|
{
|
||||||
|
using var aes = Aes.Create();
|
||||||
|
aes.BlockSize = BlockSize;
|
||||||
|
aes.GenerateIV();
|
||||||
|
return aes.IV;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 创建并配置AES加密服务提供器
|
||||||
|
/// </summary>
|
||||||
|
private static Aes CreateAesProvider(byte[] key, byte[] iv)
|
||||||
|
{
|
||||||
|
var aes = Aes.Create();
|
||||||
|
aes.KeySize = KeySize;
|
||||||
|
aes.BlockSize = BlockSize;
|
||||||
|
aes.Mode = AesCipherMode;
|
||||||
|
aes.Padding = AesPaddingMode;
|
||||||
|
aes.Key = key;
|
||||||
|
aes.IV = iv;
|
||||||
|
return aes;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -23,6 +23,18 @@ public class SimApiAuth(IDistributedCache cache)
|
|||||||
return token;
|
return token;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// 更新登陆信息
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="loginItem"></param>
|
||||||
|
/// <param name="token"></param>
|
||||||
|
/// <returns></returns>
|
||||||
|
public string Update(SimApiLoginItem loginItem, string token)
|
||||||
|
{
|
||||||
|
cache.SetString(token, JsonSerializer.Serialize(loginItem));
|
||||||
|
return token;
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 获取登陆信息
|
/// 获取登陆信息
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|||||||
@@ -0,0 +1,67 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Net.Http;
|
||||||
|
using System.Net.Http.Json;
|
||||||
|
using SimApi.Communications;
|
||||||
|
|
||||||
|
namespace SimApi.Helpers;
|
||||||
|
|
||||||
|
public class SimApiHttpClient(string? appId, string appKey)
|
||||||
|
{
|
||||||
|
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; } = [];
|
||||||
|
|
||||||
|
|
||||||
|
public T? SignQuery<T>(string url, object body, Dictionary<string, string>? queries = null)
|
||||||
|
{
|
||||||
|
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}");
|
||||||
|
}
|
||||||
|
|
||||||
|
var http = new HttpClient();
|
||||||
|
var resp = http.PostAsJsonAsync(path, body).Result;
|
||||||
|
return resp.Content.ReadFromJsonAsync<T>().Result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public T? AesQuery<T>(string url, object body)
|
||||||
|
{
|
||||||
|
if (!string.IsNullOrEmpty(AppIdName))
|
||||||
|
{
|
||||||
|
url += $"?{AppIdName}={appId}";
|
||||||
|
}
|
||||||
|
|
||||||
|
var req = new SimApiOneFieldRequest<string>
|
||||||
|
{
|
||||||
|
Data = SimApiAesUtil.Encrypt(SimApiUtil.Json(body), appKey)
|
||||||
|
};
|
||||||
|
var http = new HttpClient();
|
||||||
|
var resp = http.PostAsJsonAsync(url, req).Result;
|
||||||
|
return resp.Content.ReadFromJsonAsync<T>().Result;
|
||||||
|
}
|
||||||
|
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -11,7 +11,7 @@ public class SimApiJobWebAuth(string user, string pass) : IDashboardAuthorizatio
|
|||||||
public bool Authorize(DashboardContext context)
|
public bool Authorize(DashboardContext context)
|
||||||
{
|
{
|
||||||
var httpContext = context.GetHttpContext();
|
var httpContext = context.GetHttpContext();
|
||||||
var authHeader = httpContext.Request.Headers["Authorization"].FirstOrDefault();
|
var authHeader = httpContext.Request.Headers.Authorization.FirstOrDefault();
|
||||||
if (authHeader != null && authHeader.StartsWith("Basic "))
|
if (authHeader != null && authHeader.StartsWith("Basic "))
|
||||||
{
|
{
|
||||||
var encodedUsernamePassword = authHeader.Split(' ', 2, StringSplitOptions.RemoveEmptyEntries)[1].Trim();
|
var encodedUsernamePassword = authHeader.Split(' ', 2, StringSplitOptions.RemoveEmptyEntries)[1].Trim();
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
using System;
|
using System;
|
||||||
using System.IO;
|
using System.IO;
|
||||||
using System.Linq;
|
using System.Linq;
|
||||||
|
using System.Reflection;
|
||||||
using System.Security.Cryptography;
|
using System.Security.Cryptography;
|
||||||
using System.Text;
|
using System.Text;
|
||||||
using System.Text.Encodings.Web;
|
using System.Text.Encodings.Web;
|
||||||
@@ -30,6 +31,53 @@ public static class SimApiUtil
|
|||||||
// DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
|
// DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
|
||||||
};
|
};
|
||||||
|
|
||||||
|
public static string SimApiVersion
|
||||||
|
{
|
||||||
|
get
|
||||||
|
{
|
||||||
|
// 这里使用当前类(属于 NuGet 包)的程序集
|
||||||
|
var assembly = typeof(SimApiUtil).Assembly;
|
||||||
|
|
||||||
|
// 优先获取 AssemblyInformationalVersion(通常对应 NuGet 包版本,可能包含预发布标签)
|
||||||
|
var informationalVersion =
|
||||||
|
assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
|
||||||
|
if (!string.IsNullOrEmpty(informationalVersion))
|
||||||
|
{
|
||||||
|
return informationalVersion;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 若不存在,则获取 AssemblyVersion(编译时版本)
|
||||||
|
var version = assembly.GetName().Version?.ToString();
|
||||||
|
return version ?? "Unknown";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string AppVersion
|
||||||
|
{
|
||||||
|
get
|
||||||
|
{
|
||||||
|
// 获取外层应用的入口程序集(通常是启动项目的程序集)
|
||||||
|
var entryAssembly = Assembly.GetEntryAssembly();
|
||||||
|
if (entryAssembly == null)
|
||||||
|
{
|
||||||
|
// 特殊场景(如单元测试、某些宿主环境)下,入口程序集可能为 null,可尝试获取调用栈中的上层程序集
|
||||||
|
entryAssembly = Assembly.GetCallingAssembly(); // 或 Assembly.GetExecutingAssembly() 视场景调整
|
||||||
|
}
|
||||||
|
|
||||||
|
// 优先获取应用的 AssemblyInformationalVersion
|
||||||
|
var informationalVersion = entryAssembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()
|
||||||
|
?.InformationalVersion;
|
||||||
|
if (!string.IsNullOrEmpty(informationalVersion))
|
||||||
|
{
|
||||||
|
return informationalVersion;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 若不存在,则获取 AssemblyVersion
|
||||||
|
var version = entryAssembly.GetName().Version?.ToString();
|
||||||
|
return version ?? "Unknown";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 当前秒级时间戳
|
/// 当前秒级时间戳
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|||||||
@@ -24,6 +24,8 @@ public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExcep
|
|||||||
try
|
try
|
||||||
{
|
{
|
||||||
await next(context);
|
await next(context);
|
||||||
|
if (!context.Response.HasStarted)
|
||||||
|
{
|
||||||
switch (context.Response.StatusCode)
|
switch (context.Response.StatusCode)
|
||||||
{
|
{
|
||||||
case 200:
|
case 200:
|
||||||
@@ -36,6 +38,7 @@ public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExcep
|
|||||||
throw new SimApiException(context.Response.StatusCode);
|
throw new SimApiException(context.Response.StatusCode);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
catch (SimApiException ex)
|
catch (SimApiException ex)
|
||||||
{
|
{
|
||||||
response = string.IsNullOrEmpty(ex.Message)
|
response = string.IsNullOrEmpty(ex.Message)
|
||||||
|
|||||||
@@ -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);
|
||||||
|
}
|
||||||
+12
-18
@@ -3,34 +3,28 @@
|
|||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Library</OutputType>
|
<OutputType>Library</OutputType>
|
||||||
<PackOnBuild>true</PackOnBuild>
|
<PackOnBuild>true</PackOnBuild>
|
||||||
<Version>0.2.3</Version>
|
<IsPackable>true</IsPackable>
|
||||||
|
<Version>0.0.0</Version>
|
||||||
<Authors>xRain@SimcuTeam</Authors>
|
<Authors>xRain@SimcuTeam</Authors>
|
||||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||||
<PackageId>Simcu.SimApi</PackageId>
|
<PackageId>Simcu.SimApi</PackageId>
|
||||||
<IsPackable>true</IsPackable>
|
|
||||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
|
||||||
<IncludeSymbols>true</IncludeSymbols>
|
|
||||||
<ReleaseVersion>5.0.0</ReleaseVersion>
|
|
||||||
<SynchReleaseVersion>false</SynchReleaseVersion>
|
|
||||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
|
||||||
<PackageVersion>5.0.2</PackageVersion>
|
|
||||||
<Nullable>enable</Nullable>
|
<Nullable>enable</Nullable>
|
||||||
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
|
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
|
||||||
|
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Folder Include="Communications\"/>
|
<Folder Include="Communications\"/>
|
||||||
<Folder Include="Exceptions\"/>
|
<Folder Include="Exceptions\"/>
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.18" />
|
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.22" />
|
||||||
<PackageReference Include="Hangfire.Console" Version="1.4.3" />
|
<PackageReference Include="Hangfire.Console" Version="1.4.3"/>
|
||||||
<PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0" />
|
<PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0"/>
|
||||||
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="9.0.5" />
|
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="10.0.1" />
|
||||||
<PackageReference Include="Minio" Version="6.0.4" />
|
<PackageReference Include="Minio" Version="7.0.0" />
|
||||||
<PackageReference Include="MQTTnet" Version="5.0.1.1416" />
|
<PackageReference Include="MQTTnet" Version="5.0.1.1416"/>
|
||||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="8.1.1" />
|
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="10.0.1" />
|
||||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="8.1.1" />
|
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.0.1" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ProjectExtensions>
|
<ProjectExtensions>
|
||||||
<MonoDevelop>
|
<MonoDevelop>
|
||||||
|
|||||||
+49
-43
@@ -9,15 +9,17 @@ using Hangfire.Redis.StackExchange;
|
|||||||
using SimApi.Helpers;
|
using SimApi.Helpers;
|
||||||
using Microsoft.AspNetCore.Builder;
|
using Microsoft.AspNetCore.Builder;
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
using Microsoft.OpenApi.Models;
|
using Microsoft.OpenApi;
|
||||||
using SimApi.Middlewares;
|
using SimApi.Middlewares;
|
||||||
using Microsoft.AspNetCore.HttpOverrides;
|
using Microsoft.AspNetCore.HttpOverrides;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
using Microsoft.Extensions.Hosting;
|
using Microsoft.Extensions.Hosting;
|
||||||
using Microsoft.Extensions.Logging;
|
using Microsoft.Extensions.Logging;
|
||||||
using SimApi.Attributes;
|
using SimApi.Attributes;
|
||||||
using SimApi.CoceSdk;
|
using SimApi.CoceSdk;
|
||||||
using SimApi.Configurations;
|
using SimApi.Configurations;
|
||||||
using SimApi.Logger;
|
using SimApi.Logger;
|
||||||
|
using SimApi.SwaggerFilters;
|
||||||
|
|
||||||
namespace SimApi;
|
namespace SimApi;
|
||||||
|
|
||||||
@@ -121,30 +123,46 @@ public static class SimApiExtensions
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
x.CustomSchemaIds(type => type.FullName?.Replace("+", "."));
|
||||||
|
x.OperationFilter<SimApiResponseOperationFilter>();
|
||||||
|
x.OperationFilter<SimApiSignOperationFilter>();
|
||||||
|
x.OperationFilter<AesBodyOperationFilter>();
|
||||||
|
x.SchemaFilter<GlobalDynamicObjectSchemaFilter>();
|
||||||
|
if (simApiOptions.EnableSimApiAuth)
|
||||||
|
{
|
||||||
|
x.OperationFilter<SimApiAuthOperationFilter>();
|
||||||
|
}
|
||||||
|
|
||||||
|
x.DocInclusionPredicate((docName, apiDesc) =>
|
||||||
|
{
|
||||||
|
// 获取接口标记的 GroupName(未标记则为 null)
|
||||||
|
var actionGroupName = apiDesc.ActionDescriptor.EndpointMetadata
|
||||||
|
.OfType<ApiExplorerSettingsAttribute>()
|
||||||
|
.FirstOrDefault()?.GroupName;
|
||||||
|
|
||||||
|
// 情况1:接口未标记任何 GroupName(actionGroupName 为 null)
|
||||||
|
if (actionGroupName == null)
|
||||||
|
{
|
||||||
|
return docName == "api"; // 未分组接口只属于默认分组v1
|
||||||
|
}
|
||||||
|
|
||||||
|
return docName == actionGroupName;
|
||||||
|
});
|
||||||
|
|
||||||
x.EnableAnnotations();
|
x.EnableAnnotations();
|
||||||
var haveOauth = false;
|
var haveOauth = false;
|
||||||
var haveSimApiAuth = false;
|
|
||||||
var oauthFlows = new OpenApiOAuthFlows();
|
var oauthFlows = new OpenApiOAuthFlows();
|
||||||
foreach (var auth in docOptions.ApiAuth.Type)
|
foreach (var auth in docOptions.ApiAuth.Type)
|
||||||
{
|
{
|
||||||
switch (auth)
|
switch (auth)
|
||||||
{
|
{
|
||||||
case "SimApiAuth":
|
case "SimApiAuth":
|
||||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
x.AddSecurityDefinition("HeaderToken",
|
||||||
{
|
|
||||||
{
|
|
||||||
new OpenApiSecurityScheme
|
new OpenApiSecurityScheme
|
||||||
{
|
{
|
||||||
Reference = new OpenApiReference
|
Name = "Token",
|
||||||
{
|
In = ParameterLocation.Header
|
||||||
Type = ReferenceType.SecurityScheme,
|
|
||||||
Id = "HeaderToken"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
new[] { "readAccess", "writeAccess" }
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
haveSimApiAuth = true;
|
|
||||||
break;
|
break;
|
||||||
case "ClientCredentials":
|
case "ClientCredentials":
|
||||||
oauthFlows.ClientCredentials = new OpenApiOAuthFlow
|
oauthFlows.ClientCredentials = new OpenApiOAuthFlow
|
||||||
@@ -193,30 +211,6 @@ public static class SimApiExtensions
|
|||||||
Description = docOptions.ApiAuth.Description,
|
Description = docOptions.ApiAuth.Description,
|
||||||
In = ParameterLocation.Header
|
In = ParameterLocation.Header
|
||||||
});
|
});
|
||||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
|
||||||
{
|
|
||||||
{
|
|
||||||
new OpenApiSecurityScheme
|
|
||||||
{
|
|
||||||
Reference = new OpenApiReference
|
|
||||||
{
|
|
||||||
Type = ReferenceType.SecurityScheme,
|
|
||||||
Id = "oauth2"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
["SimApiAuth"]
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (haveSimApiAuth)
|
|
||||||
{
|
|
||||||
x.AddSecurityDefinition("HeaderToken",
|
|
||||||
new OpenApiSecurityScheme
|
|
||||||
{
|
|
||||||
Name = "Token",
|
|
||||||
In = ParameterLocation.Header
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -246,7 +240,6 @@ public static class SimApiExtensions
|
|||||||
if (simApiOptions.EnableSimApiResponseFilter)
|
if (simApiOptions.EnableSimApiResponseFilter)
|
||||||
{
|
{
|
||||||
builder.AddControllers(opt => opt.Filters.Add<SimApiResponseFilter>())
|
builder.AddControllers(opt => opt.Filters.Add<SimApiResponseFilter>())
|
||||||
.AddXmlSerializerFormatters()
|
|
||||||
.AddJsonOptions(opt =>
|
.AddJsonOptions(opt =>
|
||||||
{
|
{
|
||||||
opt.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
|
opt.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
|
||||||
@@ -264,6 +257,8 @@ public static class SimApiExtensions
|
|||||||
var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
|
var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
|
||||||
|
|
||||||
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
|
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
|
||||||
|
logger.LogInformation("主应用版本: {AppVersion}\nSimApi版本: {SimApiVersion}", SimApiUtil.AppVersion,
|
||||||
|
SimApiUtil.SimApiVersion);
|
||||||
|
|
||||||
if (options.RedisConfiguration != null)
|
if (options.RedisConfiguration != null)
|
||||||
{
|
{
|
||||||
@@ -333,19 +328,19 @@ public static class SimApiExtensions
|
|||||||
builder.MapControllerRoute(name: "GetUserInfo", pattern: "/user/info",
|
builder.MapControllerRoute(name: "GetUserInfo", pattern: "/user/info",
|
||||||
defaults: new
|
defaults: new
|
||||||
{
|
{
|
||||||
controller = "SimApiCommon",
|
controller = "SimApiAuth",
|
||||||
action = "UserInfo"
|
action = "UserInfo"
|
||||||
});
|
});
|
||||||
builder.MapControllerRoute(name: "CheckLogin", pattern: "/auth/check",
|
builder.MapControllerRoute(name: "CheckLogin", pattern: "/auth/check",
|
||||||
defaults: new
|
defaults: new
|
||||||
{
|
{
|
||||||
controller = "SimApiCommon",
|
controller = "SimApiAuth",
|
||||||
action = "CheckLogin"
|
action = "CheckLogin"
|
||||||
});
|
});
|
||||||
builder.MapControllerRoute(name: "Logout", pattern: "/auth/logout",
|
builder.MapControllerRoute(name: "Logout", pattern: "/auth/logout",
|
||||||
defaults: new
|
defaults: new
|
||||||
{
|
{
|
||||||
controller = "SimApiCommon",
|
controller = "SimApiAuth",
|
||||||
action = "Logout"
|
action = "Logout"
|
||||||
});
|
});
|
||||||
if (options.EnableCoceSdk)
|
if (options.EnableCoceSdk)
|
||||||
@@ -374,11 +369,22 @@ public static class SimApiExtensions
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (options.EnableVersionUrl)
|
||||||
|
{
|
||||||
|
builder.MapControllerRoute(name: "Versions", pattern: "/versions",
|
||||||
|
defaults: new
|
||||||
|
{
|
||||||
|
controller = "SimApiCommon",
|
||||||
|
action = "Versions"
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
if (options.EnableSimApiDoc)
|
if (options.EnableSimApiDoc)
|
||||||
{
|
{
|
||||||
logger.LogInformation("开始配置SimApiDoc...");
|
logger.LogInformation("开始配置SimApiDoc...");
|
||||||
var docOptions = options.SimApiDocOptions;
|
var docOptions = options.SimApiDocOptions;
|
||||||
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
|
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json")
|
||||||
|
.UseSwaggerUI(x =>
|
||||||
{
|
{
|
||||||
x.DocumentTitle = docOptions.DocumentTitle;
|
x.DocumentTitle = docOptions.DocumentTitle;
|
||||||
foreach (var group in docOptions.ApiGroups)
|
foreach (var group in docOptions.ApiGroups)
|
||||||
|
|||||||
@@ -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,41 @@
|
|||||||
|
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;
|
||||||
|
|
||||||
|
// 关键修复:正确构造 OpenApiSecuritySchemeReference(匹配键类型要求)
|
||||||
|
var securitySchemeRef = new OpenApiSecuritySchemeReference(
|
||||||
|
referenceId: "SimApiAuth", // 必须与 AddSecurityDefinition 的 ID 一致
|
||||||
|
hostDocument: null,
|
||||||
|
externalResource: null
|
||||||
|
);
|
||||||
|
|
||||||
|
// 给 Security 赋值(确保键类型是 OpenApiSecuritySchemeReference)
|
||||||
|
operation.Security ??= new List<OpenApiSecurityRequirement>();
|
||||||
|
operation.Security.Add(new OpenApiSecurityRequirement
|
||||||
|
{
|
||||||
|
{
|
||||||
|
securitySchemeRef,
|
||||||
|
[]
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using Microsoft.OpenApi;
|
||||||
|
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||||
|
using System.Reflection;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
|
using SimApi.Attributes;
|
||||||
|
using SimApi.Communications;
|
||||||
|
|
||||||
|
namespace SimApi.SwaggerFilters;
|
||||||
|
|
||||||
|
public class SimApiResponseOperationFilter : IOperationFilter
|
||||||
|
{
|
||||||
|
public void Apply(OpenApiOperation operation, OperationFilterContext context)
|
||||||
|
{
|
||||||
|
// 1. 跳过标记了 [OriginResponseAttribute] 的接口(不包装)
|
||||||
|
if (context.MethodInfo.DeclaringType?.GetCustomAttributes<OriginResponseAttribute>(true).Any() == true
|
||||||
|
|| context.MethodInfo.GetCustomAttributes<OriginResponseAttribute>(true).Any())
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. 获取控制器方法声明的“原始返回类型”(如 Task<UserDto> → UserDto)
|
||||||
|
var returnType = GetUnwrappedReturnType(context.MethodInfo.ReturnType, context);
|
||||||
|
if (IsAlreadyWrappedType(returnType))
|
||||||
|
{
|
||||||
|
return; // 保留原始返回类型的文档描述
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. 定义包装后的目标类型(泛型/非泛型)
|
||||||
|
Type wrappedType;
|
||||||
|
if (returnType == typeof(void) || returnType == typeof(EmptyResult))
|
||||||
|
{
|
||||||
|
// 无数据:用非泛型 SimApiBaseResponse
|
||||||
|
wrappedType = typeof(SimApiBaseResponse);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// 有数据:用泛型 SimApiBaseResponse<T>(T 为原始返回类型)
|
||||||
|
wrappedType = typeof(SimApiBaseResponse<>).MakeGenericType(returnType);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4. 让 Swagger 生成包装类型的 Schema
|
||||||
|
var schema = context.SchemaGenerator.GenerateSchema(wrappedType, context.SchemaRepository);
|
||||||
|
|
||||||
|
// 5. 替换 Swagger 文档中的响应类型(只保留 200 OK 的响应,匹配过滤器逻辑)
|
||||||
|
operation.Responses.Clear(); // 清除默认响应(如 200 返回原始类型)
|
||||||
|
operation.Responses.Add("200", new OpenApiResponse
|
||||||
|
{
|
||||||
|
Description = "请求成功",
|
||||||
|
Content = new Dictionary<string, OpenApiMediaType>
|
||||||
|
{
|
||||||
|
{
|
||||||
|
"application/json", // 只保留 JSON 格式(配合之前的全局配置)
|
||||||
|
new OpenApiMediaType
|
||||||
|
{
|
||||||
|
Schema = schema
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private static Type GetUnwrappedReturnType(Type returnType, OperationFilterContext context)
|
||||||
|
{
|
||||||
|
// 处理 Task<T>(异步方法)
|
||||||
|
if (returnType.IsGenericType && returnType.GetGenericTypeDefinition() == typeof(Task<>))
|
||||||
|
{
|
||||||
|
returnType = returnType.GetGenericArguments()[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
// 处理 IActionResult/ObjectResult(如 return Ok(userDto))
|
||||||
|
if (!typeof(IActionResult).IsAssignableFrom(returnType)) return returnType;
|
||||||
|
// 从方法返回语句中提取原始类型(需结合特性,或默认用 object)
|
||||||
|
// 更精准的方式:让控制器方法用 [ProducesResponseType(typeof(UserDto), 200)] 声明原始类型
|
||||||
|
var producesAttr = context.MethodInfo.GetCustomAttributes<ProducesResponseTypeAttribute>()
|
||||||
|
.FirstOrDefault(a => a.StatusCode == 200);
|
||||||
|
if (producesAttr?.Type != null && producesAttr.Type != typeof(void))
|
||||||
|
{
|
||||||
|
return producesAttr.Type;
|
||||||
|
}
|
||||||
|
|
||||||
|
return typeof(object); // 无法识别时默认用 object
|
||||||
|
}
|
||||||
|
|
||||||
|
// 辅助方法:判断类型是否已经是 SimApiBaseResponse 及其泛型
|
||||||
|
private static bool IsAlreadyWrappedType(Type type)
|
||||||
|
{
|
||||||
|
// 情况1:类型本身是 SimApiBaseResponse 或其泛型
|
||||||
|
if (type == typeof(SimApiBaseResponse) ||
|
||||||
|
(type.IsGenericType && type.GetGenericTypeDefinition() == typeof(SimApiBaseResponse<>)))
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 情况2:类型是 SimApiBaseResponse 的子类(非泛型)
|
||||||
|
if (type.IsSubclassOf(typeof(SimApiBaseResponse)))
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 情况3:类型是 SimApiBaseResponse<T> 的子类(泛型)
|
||||||
|
// 检查是否继承自泛型父类 SimApiBaseResponse<>(任意 T)
|
||||||
|
if (type.BaseType is { IsGenericType: true })
|
||||||
|
{
|
||||||
|
var genericBaseType = type.BaseType.GetGenericTypeDefinition();
|
||||||
|
if (genericBaseType == typeof(SimApiBaseResponse<>))
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 其他情况:不是包装类型或其子类
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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