Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e17b9d9eed | ||
|
|
80a05ea20b | ||
|
|
33f7cff11c | ||
|
|
c7a4395000 | ||
|
|
bf98792f96 | ||
|
|
8c5081d442 | ||
|
|
2ed4605a2c | ||
|
|
ceeea2c451 | ||
|
|
464878edce | ||
|
|
aaba8b8b73 | ||
|
|
6e2ae11c54 | ||
|
|
d0a5e996c9 | ||
|
|
3b405079c1 | ||
|
|
611808787e | ||
|
|
8ee297e819 | ||
|
|
bc4195e984 | ||
|
|
4a0caa1079 | ||
|
|
7a2ff896b2 | ||
|
|
aef62a3472 | ||
|
|
ec3004518f | ||
|
|
140e039d27 | ||
|
|
3b263b4563 | ||
|
|
fc7b38ac4e | ||
|
|
e3fc7db01c | ||
|
|
894d6930f7 | ||
|
|
106d3eec19 | ||
|
|
a8c7a20a64 | ||
|
|
b6dbcd6cee | ||
|
|
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 | ||
|
|
9a8d14142a | ||
|
|
cb89a1a003 | ||
|
|
462bce50cc | ||
|
|
fed44c6b49 | ||
|
|
c73aa1d2a8 | ||
|
|
af6bc86a0c | ||
|
|
fc7714198f | ||
|
|
d2b5f14e78 | ||
|
|
116cbcdc7f | ||
|
|
4e1b7d4845 | ||
|
|
71acb35df9 | ||
|
|
67cc7346dc | ||
|
|
8627ae61fa | ||
|
|
02523028db | ||
|
|
7d39ab5e0b | ||
|
|
87fda473d3 | ||
|
|
4ae72d2e6b | ||
|
|
afea9c82bd | ||
|
|
e53048a980 | ||
|
|
bbc2806995 | ||
|
|
404a638d5e | ||
|
|
e27d5e1c77 | ||
|
|
6af68da3eb | ||
|
|
7dc2ac6a86 | ||
|
|
8f6b853b6c | ||
|
|
e876486c00 | ||
|
|
e71226be4a | ||
|
|
bd674dcc31 | ||
|
|
141846d79d | ||
|
|
a4bae0226e | ||
|
|
15f74b6570 | ||
|
|
ac4619a789 | ||
|
|
4d0f801f21 | ||
|
|
683cf9176a | ||
|
|
1ee8d941e9 | ||
|
|
1d474f596a | ||
|
|
929ddaced3 | ||
|
|
82f7e0fc00 | ||
|
|
f4bc6dc080 | ||
|
|
56b0490d1e | ||
|
|
45e19c3561 | ||
|
|
04b2be1bb7 | ||
|
|
f78c3a0e0d | ||
|
|
506704fd90 | ||
|
|
786051ddbf |
@@ -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: "8.0.200"
|
||||
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:PackageVersion=$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 build --configuration release -p:Version=$version
|
||||
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${{steps.login.outputs.NUGET_API_KEY}} -s https://api.nuget.org/v3/index.json
|
||||
@@ -434,3 +434,7 @@ MigrationBackup/
|
||||
# Ionide (cross platform F# VS Code tools) working folder
|
||||
.ionide/
|
||||
|
||||
|
||||
# BitFun snapshot data - auto managed
|
||||
.bitfun/
|
||||
/.bitfun/search/flashgrep-index/
|
||||
|
||||
@@ -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;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class OriginResponseAttribute : Attribute
|
||||
{
|
||||
}
|
||||
@@ -1,9 +1,11 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Interfaces;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
@@ -13,13 +15,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,25 +36,19 @@ 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"];
|
||||
//检测是否登录
|
||||
if (loginInfo == null)
|
||||
var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"]!;
|
||||
var token = (string)context.HttpContext.Items["LoginToken"]!;
|
||||
ErrorWhenNull(loginInfo, 401);
|
||||
var checkers = context.HttpContext.RequestServices.GetServices<ISimApiAuthChecker>();
|
||||
foreach (var checker in checkers)
|
||||
{
|
||||
throw new SimApiException(401);
|
||||
checker.Run(loginInfo, token);
|
||||
}
|
||||
|
||||
if (Types == null) return;
|
||||
//检测用户类型
|
||||
if (!Types.Intersect(loginInfo.Type).Any())
|
||||
{
|
||||
throw new SimApiException(403);
|
||||
}
|
||||
ErrorWhenFalse(Types.Intersect(loginInfo.Type).Any(), 403);
|
||||
}
|
||||
}
|
||||
@@ -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 = new[] { 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, "签名错误");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,12 +3,7 @@ using System;
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class SynapseEventAttribute : Attribute
|
||||
public class SynapseEventAttribute(string? name = null) : Attribute
|
||||
{
|
||||
public string Name { get; }
|
||||
|
||||
public SynapseEventAttribute(string name)
|
||||
{
|
||||
Name = name;
|
||||
}
|
||||
public string? Name { get; } = name;
|
||||
}
|
||||
@@ -5,7 +5,7 @@ namespace SimApi.Attributes;
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class SynapseRpcAttribute : Attribute
|
||||
{
|
||||
public string Name { get; }
|
||||
public string? Name { get; }
|
||||
|
||||
public SynapseRpcAttribute()
|
||||
{
|
||||
|
||||
@@ -0,0 +1,226 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Net.Http;
|
||||
using System.Net.Http.Json;
|
||||
using SimApi.Communications;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.AuthSDK;
|
||||
|
||||
public class SimApiAuthCenter(SimApiAuthClient simapi)
|
||||
{
|
||||
public SimApiAuthClient Client { get; } = simapi;
|
||||
|
||||
#region 公共
|
||||
|
||||
/// <summary>
|
||||
/// 委托AuthCenter进行应用签名验证
|
||||
/// </summary>
|
||||
/// <param name="appId"></param>
|
||||
/// <param name="timestamp"></param>
|
||||
/// <param name="nonce"></param>
|
||||
/// <param name="sign"></param>
|
||||
public void VerifySign(string appId, string timestamp, string nonce, string sign)
|
||||
{
|
||||
var http = new HttpClient();
|
||||
var url = $"{Client.Server}/api/auth/sign/verify?appId={appId}×tamp={timestamp}&nonce={nonce}&sign={sign}";
|
||||
var result = http.PostAsJsonAsync(url, new { }).Result;
|
||||
var resp = result.Content.ReadFromJsonAsync<SimApiBaseResponse>().Result;
|
||||
ErrorWhenNull(resp, 400, "签名验证失败");
|
||||
ErrorWhenFalse(resp.Code == 200, 400, "签名验证失败");
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
|
||||
#region 群组相关
|
||||
|
||||
/// <summary>
|
||||
/// 根据profileId获取群组列表
|
||||
/// </summary>
|
||||
/// <param name="profileId"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.GroupRelatedItem[]? GroupRelated(string profileId)
|
||||
{
|
||||
return Client.SignQuery<SimApiAuthCenterDto.GroupRelatedItem[]>("/api/auth/group/related", new { profileId });
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 根据关键字搜索群组,输入群组ID精准搜索
|
||||
/// </summary>
|
||||
/// <param name="keyword"></param>
|
||||
/// <param name="skip"></param>
|
||||
/// <param name="take"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.AppAndProfileItem[]? GroupSearch(string keyword, int skip = 0, int take = 20)
|
||||
{
|
||||
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/group/search",
|
||||
new { keyword, skip, take });
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用组ID以及组内成员,管理员profile获取组的详细树结构
|
||||
/// </summary>
|
||||
/// <param name="profileId"></param>
|
||||
/// <param name="groupId"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.GroupDetailTreeNode? GroupDetail(string groupId, string profileId)
|
||||
{
|
||||
return Client.SignQuery<SimApiAuthCenterDto.GroupDetailTreeNode>("/api/auth/group/detail",
|
||||
new { profileId, groupId });
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取profile在本组的所有子组
|
||||
/// </summary>
|
||||
/// <param name="groupId"></param>
|
||||
/// <param name="profileId"></param>
|
||||
/// <returns></returns>
|
||||
public string[]? GroupRelatedIndex(string groupId, string profileId)
|
||||
{
|
||||
return Client.SignQuery<string[]>("/api/auth/internal/group/related-group-ids", new { groupId, profileId });
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Profile相关
|
||||
|
||||
/// <summary>
|
||||
/// 根据关键字,搜索用户Profile,参数支持精准ID,用户手机号,用户邮箱,Profile名称模糊搜索
|
||||
/// </summary>
|
||||
/// <param name="keyword"></param>
|
||||
/// <param name="skip"></param>
|
||||
/// <param name="take"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.AppAndProfileItem[]? ProfileSearch(string keyword, int skip = 0, int take = 20)
|
||||
{
|
||||
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/profile/search",
|
||||
new { keyword, skip, take });
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 通过id,可以批量获取用户的基本信息
|
||||
/// </summary>
|
||||
/// <param name="ids"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.AppAndProfileItem[]? ProfileList(string[] ids)
|
||||
{
|
||||
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/profile/list", new { ids });
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region AuthGate内部应用专用 - 注意: 只有内部应用可以调用
|
||||
|
||||
/// <summary>
|
||||
/// 获取是否为App的拥有者
|
||||
/// </summary>
|
||||
/// <param name="profileId"></param>
|
||||
/// <param name="applicationId"></param>
|
||||
/// <returns></returns>
|
||||
public bool CheckIsAppOwner(string profileId, string applicationId)
|
||||
{
|
||||
return Client.SignQuery<bool>("/api/auth/internal/app/check-owner", new
|
||||
{
|
||||
ProfileId = profileId,
|
||||
AppId = applicationId,
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取应用列表,根据用户profileId 和 提供的appIds
|
||||
/// </summary>
|
||||
/// <param name="profileId"></param>
|
||||
/// <param name="appIds"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.AppAndProfileItem[]? GetAppList(string profileId, IEnumerable<string> appIds)
|
||||
{
|
||||
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/internal/app/related", new
|
||||
{
|
||||
ProfileId = profileId,
|
||||
AllowedAppIds = appIds,
|
||||
});
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region 系统登录
|
||||
|
||||
/// <summary>
|
||||
/// 获取登录授权CODE
|
||||
/// </summary>
|
||||
/// <param name="scene"></param>
|
||||
/// <param name="data"></param>
|
||||
/// <param name="backUrl"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.GetCodeResponse GetLoginCode(string? scene = null,
|
||||
Dictionary<string, object>? data = null,
|
||||
string? backUrl = null)
|
||||
{
|
||||
var code = Client.SignQuery<string>("/api/auth/login/code",
|
||||
new { scene, data, backUrl });
|
||||
return new SimApiAuthCenterDto.GetCodeResponse()
|
||||
{
|
||||
Code = code!,
|
||||
Server = Client.Server,
|
||||
FullUrl = $"{Client.Server}/auth?code={code}"
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用code获取登录信息
|
||||
/// </summary>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="scene"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.LoginInfoResponse GetLoginInfo(string code, string? scene = null)
|
||||
{
|
||||
var resp = Client.SignQuery<SimApiAuthCenterDto.LoginInfoResponse>("/api/auth/login/get", new { code });
|
||||
ErrorWhenNull(resp, 400232, "登录信息获取失败");
|
||||
ErrorWhen(resp.Scene != scene, 403003, "登录场景不匹配");
|
||||
return resp;
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region 安全验证
|
||||
|
||||
/// <summary>
|
||||
/// 获取安全验证代码
|
||||
/// </summary>
|
||||
/// <param name="scene"></param>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="data"></param>
|
||||
/// <param name="backUrl"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.GetCodeResponse GetConfirmCode(string scene, string userId,
|
||||
Dictionary<string, object>? data = null,
|
||||
string? backUrl = null)
|
||||
{
|
||||
var code = Client.SignQuery<string>("/api/auth/confirm/code",
|
||||
new { scene, data, backUrl, profileId = userId });
|
||||
return new SimApiAuthCenterDto.GetCodeResponse()
|
||||
{
|
||||
Code = code!,
|
||||
Server = Client.Server,
|
||||
FullUrl = $"{Client.Server}/confirm?code={code}"
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用安全验证code 获取验证结果
|
||||
/// </summary>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="scene"></param>
|
||||
/// <param name="userId"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiAuthCenterDto.ConfirmResponse Confirm(string code, string scene, string? userId = null)
|
||||
{
|
||||
var resp = Client.SignQuery<SimApiAuthCenterDto.ConfirmResponse>("/api/auth/confirm/get", new { code });
|
||||
ErrorWhenNull(resp, 403001, "安全确认码无效");
|
||||
ErrorWhen(resp.ProfileId != userId, 403002, "安全确认身份不匹配");
|
||||
ErrorWhen(resp.Scene != scene, 403003, "安全确认场景不匹配");
|
||||
return resp;
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace SimApi.AuthSDK;
|
||||
|
||||
public class SimApiAuthCenterDto
|
||||
{
|
||||
public class AppAndProfileItem
|
||||
{
|
||||
public required string Id { get; set; }
|
||||
public required string Name { get; set; }
|
||||
public string? Image { get; set; }
|
||||
public string? Description { get; set; }
|
||||
}
|
||||
|
||||
public class ConfirmResponse
|
||||
{
|
||||
public required string ApplicationId { get; set; }
|
||||
public required string ProfileId { get; set; }
|
||||
public string? Scene { get; set; }
|
||||
public Dictionary<string, object>? Data { get; set; }
|
||||
}
|
||||
|
||||
public class LoginInfoResponse
|
||||
{
|
||||
public string? Scene { get; set; }
|
||||
public Dictionary<string, object>? Data { get; set; }
|
||||
public required string ProfileId { get; set; }
|
||||
public required string Name { get; set; }
|
||||
public string? Image { get; set; }
|
||||
public string? Description { get; set; }
|
||||
}
|
||||
|
||||
public class GetCodeResponse
|
||||
{
|
||||
public required string Code { get; set; }
|
||||
public required string Server { get; set; }
|
||||
public required string FullUrl { get; set; }
|
||||
}
|
||||
|
||||
public class GroupRelatedItem
|
||||
{
|
||||
public required string Id { get; set; }
|
||||
public required string Name { get; set; }
|
||||
public string? Image { get; set; }
|
||||
public string? Description { get; set; }
|
||||
public bool IsOwner { get; set; }
|
||||
public bool IsAdmin { get; set; }
|
||||
public bool IsMember { get; set; }
|
||||
}
|
||||
|
||||
public class GroupDetailTreeNode
|
||||
{
|
||||
public required string Id { get; set; }
|
||||
public required string Name { get; set; }
|
||||
public string? Image { get; set; }
|
||||
public string? Description { get; set; }
|
||||
public int Sort { get; set; }
|
||||
public List<GroupDetailTreeNode> Children { get; set; } = [];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.AuthSDK;
|
||||
|
||||
public class SimApiAuthCenterMiddleware(RequestDelegate next, ILogger<SimApiAuthCenterMiddleware> logger)
|
||||
{
|
||||
public Task Invoke(HttpContext httpContext, SimApiOptions simApiOptions)
|
||||
{
|
||||
if (httpContext.Request.Headers.TryGetValue("X-SimApi-Gate-Auth", out var auth) &&
|
||||
httpContext.Request.Headers.TryGetValue("X-SimApi-Gate-Time", out var time) &&
|
||||
httpContext.Request.Headers.TryGetValue("X-SimApi-Gate-Sign", out var sign))
|
||||
{
|
||||
var signStr =
|
||||
$"appId={simApiOptions.SimApiAuthCenterOptions.AppId}&auth={auth}&time={time}&appKey={simApiOptions.SimApiAuthCenterOptions.AppKey}";
|
||||
logger.LogDebug($"签名字符串 => {signStr}");
|
||||
if (SimApiUtil.Md5(signStr) == sign && !string.IsNullOrEmpty(auth))
|
||||
{
|
||||
var login = SimApiUtil.Base64Decode<SimApiLoginItem>(auth!);
|
||||
httpContext.Items.Add("LoginInfo", login);
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.LogDebug("签名不匹配");
|
||||
}
|
||||
}
|
||||
|
||||
return next(httpContext);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.AuthSDK;
|
||||
|
||||
public class SimApiAuthClient(SimApiOptions apiOptions, ILogger<SimApiAuthClient> logger)
|
||||
: SimApiHttpClient(apiOptions, logger)
|
||||
{
|
||||
public override string Server { get; init; } = apiOptions.SimApiAuthCenterOptions.Server ?? string.Empty;
|
||||
public override string AppId { get; init; } = apiOptions.SimApiAuthCenterOptions.AppId ?? string.Empty;
|
||||
public override string AppKey { get; init; } = apiOptions.SimApiAuthCenterOptions.AppKey ?? string.Empty;
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
using Microsoft.Extensions.Logging;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.AuthSDK;
|
||||
|
||||
public class SimApiAuthIam(SimApiAuthClient simapi, ILogger<SimApiAuthIam> logger)
|
||||
{
|
||||
/// <summary>
|
||||
/// 向Iam注册权限
|
||||
/// </summary>
|
||||
/// <param name="permissions"></param>
|
||||
public void RegisterPermissions(SimApiAuthIamDto.PermissionItem[] permissions)
|
||||
{
|
||||
var log = $"检测到 {permissions.Length} 个权限接口,正在注册..: ";
|
||||
foreach (var permission in permissions)
|
||||
{
|
||||
log += $"\n |- {permission.Identifier} => [{permission.Group}]{permission.Name} ({permission.Description})";
|
||||
}
|
||||
|
||||
logger.LogInformation(log);
|
||||
simapi.SignQuery<string>("/api/iam/permission/register", new { permissions });
|
||||
logger.LogInformation("权限注册完成");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取拥有的权限标识数组
|
||||
/// </summary>
|
||||
/// <param name="profileId"></param>
|
||||
/// <param name="groupId"></param>
|
||||
/// <returns></returns>
|
||||
public string[] GetPermissionOwned(string profileId, string? groupId = null)
|
||||
{
|
||||
return simapi.SignQuery<string[]>("/api/iam/permission/owned", new { profileId, groupId }) ?? [];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测profileId是否有这个权限
|
||||
/// </summary>
|
||||
/// <param name="profileId"></param>
|
||||
/// <param name="permission"></param>
|
||||
/// <param name="groupId"></param>
|
||||
public void CheckPermission(string profileId, string permission, string? groupId = null)
|
||||
{
|
||||
var ok = simapi.SignQuery<bool>("/api/iam/permission/check", new { profileId, permission, groupId });
|
||||
ErrorWhen(!ok, 403, "没有该权限");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
namespace SimApi.AuthSDK;
|
||||
|
||||
public class SimApiAuthIamDto
|
||||
{
|
||||
public class PermissionItem
|
||||
{
|
||||
public required string Identifier { get; init; }
|
||||
public required string Name { get; init; }
|
||||
public required string Group { get; init; }
|
||||
public required string Description { get; init; }
|
||||
}
|
||||
}
|
||||
@@ -1,13 +1,11 @@
|
||||
using System.ComponentModel.DataAnnotations;
|
||||
|
||||
namespace SimApi.Communications;
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 只有ID的请求
|
||||
/// </summary>
|
||||
public class SimApiIdOnlyRequest
|
||||
{
|
||||
[Required] public int Id { get; set; }
|
||||
public required int Id { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -15,7 +13,7 @@ public class SimApiIdOnlyRequest
|
||||
/// </summary>
|
||||
public class SimApiStringIdOnlyRequest
|
||||
{
|
||||
[Required] public string Id { get; set; }
|
||||
public required string Id { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -24,7 +22,7 @@ public class SimApiStringIdOnlyRequest
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiOneFieldRequest<T>
|
||||
{
|
||||
[Required] public T Data { get; set; }
|
||||
public required T Data { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -32,6 +30,6 @@ public class SimApiOneFieldRequest<T>
|
||||
/// </summary>
|
||||
public class SimApiBasePageRequest
|
||||
{
|
||||
[Required] public int Page { get; set; }
|
||||
[Required] public int Count { get; set; }
|
||||
public required int Page { get; set; }
|
||||
public required int Count { get; set; }
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Communications;
|
||||
|
||||
@@ -12,6 +13,10 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
|
||||
public int Code { get; set; } = code;
|
||||
public string Message { get; set; } = message;
|
||||
|
||||
public SimApiBaseResponse() : this(200, "成功")
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 默认错误代码对应提示信息
|
||||
/// </summary>
|
||||
@@ -22,11 +27,11 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
|
||||
{ 400, "参数错误" },
|
||||
{ 401, "需要登录" },
|
||||
{ 403, "无权访问" },
|
||||
{ 404, "接口不存在" },
|
||||
{ 404, "请求资源不存在" },
|
||||
{ 500, "服务器错误" }
|
||||
};
|
||||
|
||||
public SimApiBaseResponse(int code) : this(code, MsgBox.GetValueOrDefault(code, "未知错误"))
|
||||
public SimApiBaseResponse(int code) : this(code, MsgBox.GetValueOrDefault(code, "未知错误代码"))
|
||||
{
|
||||
}
|
||||
|
||||
@@ -36,36 +41,20 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
|
||||
/// <returns></returns>
|
||||
public override string ToString()
|
||||
{
|
||||
return JsonSerializer.Serialize(this, new JsonSerializerOptions
|
||||
{
|
||||
IgnoreReadOnlyProperties = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
Converters =
|
||||
{
|
||||
new JsonStringEnumConverter()
|
||||
}
|
||||
});
|
||||
return SimApiUtil.Json(this);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态内容分页
|
||||
/// 分页内容返回
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiBasePageResponse<T>() : SimApiBaseResponse
|
||||
public class PageResponse<T>
|
||||
{
|
||||
public T List { get; set; }
|
||||
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>
|
||||
@@ -74,7 +63,7 @@ public class SimApiBasePageResponse<T>() : SimApiBaseResponse
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiBaseResponse<T>() : SimApiBaseResponse
|
||||
{
|
||||
public T Data { get; set; }
|
||||
public T? Data { get; set; }
|
||||
|
||||
public SimApiBaseResponse(T data) : this()
|
||||
{
|
||||
|
||||
@@ -5,4 +5,10 @@ namespace SimApi.Communications;
|
||||
/// <summary>
|
||||
/// 登录信息中间件
|
||||
/// </summary>
|
||||
public record SimApiLoginItem(string Id, string[] Type,Dictionary<string,string> Meta = null);
|
||||
public class SimApiLoginItem
|
||||
{
|
||||
public required string Id { get; set; }
|
||||
public string[] Type { get; set; } = ["user"];
|
||||
public Dictionary<string, string> Meta { get; set; } = [];
|
||||
public Dictionary<string, object?> Extra { get; set; } = [];
|
||||
};
|
||||
@@ -0,0 +1,15 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiAuthCenterOptions
|
||||
{
|
||||
public string? Server { get; set; }
|
||||
public string? AppId { get; set; }
|
||||
public string? AppKey { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 开启则使用内部网关透传的Middleware
|
||||
/// 注意: 只有内部应用需要开启这个,也就是api通过内部网关代理后
|
||||
/// </summary>
|
||||
public bool UseMiddleware { get; set; }
|
||||
public bool UseIam { get; set; }
|
||||
}
|
||||
@@ -6,22 +6,22 @@ namespace SimApi.Configurations;
|
||||
/// <summary>
|
||||
/// 文档组配置
|
||||
/// </summary>
|
||||
public class SimApiDocGroupOption
|
||||
public class SimApiDocGroupOption(string id, string name, string description = "")
|
||||
{
|
||||
/// <summary>
|
||||
/// 文档标识
|
||||
/// </summary>
|
||||
public string Id { get; set; }
|
||||
public string Id { get; set; } = id;
|
||||
|
||||
/// <summary>
|
||||
/// 文档名称
|
||||
/// </summary>
|
||||
public string Name { get; set; }
|
||||
public string Name { get; set; } = name;
|
||||
|
||||
/// <summary>
|
||||
/// 文档描述
|
||||
/// </summary>
|
||||
public string Description { get; set; }
|
||||
public string Description { get; set; } = description!;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -29,15 +29,15 @@ public class SimApiDocGroupOption
|
||||
/// </summary>
|
||||
public class SimApiAuthOption
|
||||
{
|
||||
public string[] Type { get; set; } = new[] { "SimApiAuth" };
|
||||
public string[] Type { get; set; } = ["SimApiAuth"];
|
||||
|
||||
public string Description { get; set; } = "认证服务器颁发的AccessToken";
|
||||
|
||||
public string AuthorizationUrl { get; set; }
|
||||
public string AuthorizationUrl { get; set; } = null!;
|
||||
|
||||
public string TokenUrl { get; set; }
|
||||
public string TokenUrl { get; set; } = null!;
|
||||
|
||||
public Dictionary<string, string> Scopes { get; set; }
|
||||
public Dictionary<string, string> Scopes { get; set; } = null!;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -48,20 +48,15 @@ public class SimApiDocOptions
|
||||
/// <summary>
|
||||
/// 文档组配置
|
||||
/// </summary>
|
||||
public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
|
||||
{
|
||||
new SimApiDocGroupOption
|
||||
{
|
||||
Id = "api",
|
||||
Name = "Api",
|
||||
Description = "Api接口文档"
|
||||
}
|
||||
};
|
||||
public SimApiDocGroupOption[] ApiGroups { get; set; } =
|
||||
[
|
||||
new("api", "Api", "Api接口文档")
|
||||
];
|
||||
|
||||
/// <summary>
|
||||
/// 授权配置
|
||||
/// </summary>
|
||||
public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
|
||||
public SimApiAuthOption ApiAuth { get; set; } = new();
|
||||
|
||||
/// <summary>
|
||||
/// 文档页面标题
|
||||
@@ -71,5 +66,5 @@ public class SimApiDocOptions
|
||||
/// <summary>
|
||||
/// 接口支持的调用方式
|
||||
/// </summary>
|
||||
public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
|
||||
public SubmitMethod[] SupportedMethod { get; set; } = [SubmitMethod.Post];
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiExceptionOptions
|
||||
{
|
||||
public int[] SkipStatusCodes = [200, 301, 302];
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiHttpClientOptions
|
||||
{
|
||||
public string Server { get; set; } = string.Empty;
|
||||
public string AppId { get; set; } = string.Empty;
|
||||
public string AppKey { get; set; } = string.Empty;
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
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; } = 5;
|
||||
}
|
||||
+105
-18
@@ -1,26 +1,69 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// 启用全部Cors,对于开发前后分离的时候很有用。
|
||||
/// default: true
|
||||
/// Redis配置
|
||||
/// </summary>
|
||||
public bool EnableCors { get; set; } = true;
|
||||
public string? RedisConfiguration { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 原样返回给前端的配置信息
|
||||
/// </summary>
|
||||
public Dictionary<string, object>? WebConfig { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// WebConfig返回是否包含版本信息
|
||||
/// </summary>
|
||||
public bool WebConfigIncludeVersion { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 是否启用后台任务系统 *基于Hangfire
|
||||
/// </summary>
|
||||
public bool EnableJob { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 启用SimApiAuth,一个简单的基于Header Token的认证方式。
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableSimApiAuth { get; set; } = false;
|
||||
public bool EnableSimApiAuth { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 启用Cache功能
|
||||
/// </summary>
|
||||
public bool EnableSimApiCache { get; set; } = true;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 启用SimApi网关授权, 基于上层网关透传的身份令牌验证
|
||||
/// </summary>
|
||||
public bool EnableSimApiAuthGate { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 开启S3兼容的存储系统。
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableSimApiStorage { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 启用在线文档,启用后 访问 /swagger 可以查看对应的api文档。
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableSimApiDoc { get; set; } = false;
|
||||
public bool EnableSimApiDoc { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 是否启用Synapse
|
||||
/// </summary>
|
||||
public bool EnableSynapse { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 启用全部Cors,对于开发前后分离的时候很有用。
|
||||
/// default: true
|
||||
/// </summary>
|
||||
public bool EnableCors { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 启用异常拦截,启用后,所有的异常将被通过json反馈。
|
||||
@@ -29,10 +72,15 @@ public class SimApiOptions
|
||||
public bool EnableSimApiException { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 开启S3兼容的存储系统。
|
||||
/// 启用返回结果拦截
|
||||
/// </summary>
|
||||
public bool EnableSimApiResponseFilter { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 启用请求日志中间件
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableSimApiStorage { get; set; } = false;
|
||||
public bool EnableRequestLog { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 开启ForwardHeaders,开启后可以透传负载均衡的Headers
|
||||
@@ -50,13 +98,17 @@ public class SimApiOptions
|
||||
/// 启用格式化的 Console Logger
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableLogger { get; set; } = false;
|
||||
public bool EnableLogger { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 是否启用Synapse
|
||||
/// 是否启用SimApiHttpClient
|
||||
/// </summary>
|
||||
public bool EnableSynapse { get; set; } = false;
|
||||
public bool EnableSimApiHttpClient { get; set; } = false;
|
||||
|
||||
/// <summary>
|
||||
/// 配置Job
|
||||
/// </summary>
|
||||
public SimApiJobOptions SimApiJobOptions { get; set; } = new();
|
||||
|
||||
/// <summary>
|
||||
/// Swagger文档相关配置,需要启用 EnableSimApiDoc
|
||||
@@ -70,23 +122,58 @@ public class SimApiOptions
|
||||
|
||||
public SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new();
|
||||
|
||||
public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions> options = null)
|
||||
public SimApiAuthCenterOptions SimApiAuthCenterOptions { get; set; } = new();
|
||||
|
||||
public SimApiHttpClientOptions SimApiHttpClientOptions { get; set; } = new();
|
||||
|
||||
public SimApiExceptionOptions SimApiExceptionOptions { get; set; } = new();
|
||||
|
||||
public SimApiRouteOptions SimApiRouteOptions { get; set; } = new();
|
||||
|
||||
public SimApiRequestLogOptions SimApiRequestLogOptions { get; set; } = new();
|
||||
|
||||
public void ConfigureSimApiRoute(Action<SimApiRouteOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiRouteOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiException(Action<SimApiExceptionOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiExceptionOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiHttpClient(Action<SimApiHttpClientOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiHttpClientOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiSynapseOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiSynapse(SimApiSynapseOptions options)
|
||||
{
|
||||
SimApiSynapseOptions = options;
|
||||
}
|
||||
|
||||
public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null)
|
||||
public void ConfigureSimApiDoc(Action<SimApiDocOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiDocOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiStorage(Action<SimApiStorageOptions> options = null)
|
||||
public void ConfigureSimApiStorage(Action<SimApiStorageOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiStorageOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiJob(Action<SimApiJobOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiJobOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiAuthCenter(Action<SimApiAuthCenterOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiAuthCenterOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiRequestLog(Action<SimApiRequestLogOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiRequestLogOptions);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiRequestLogOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// 是否打印完整的请求Header
|
||||
/// </summary>
|
||||
public bool ShowFullHeader { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 是否打印完整的响应体
|
||||
/// </summary>
|
||||
public bool ShowFullResponse { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 请求字段显示最长长度
|
||||
/// </summary>
|
||||
public int RequestStringLogLength { get; set; } = 0;
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiRouteOptions
|
||||
{
|
||||
public string? LogoutRoute = "/auth/logout";
|
||||
public string? UserInfoRoute = "/user/info";
|
||||
public string? WebConfigRoute = "/config";
|
||||
}
|
||||
@@ -5,19 +5,19 @@ public class SimApiStorageOptions
|
||||
/// <summary>
|
||||
/// S3 服务器入口地址
|
||||
/// </summary>
|
||||
public string Endpoint { get; set; }
|
||||
public string? Endpoint { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// S3 服务器文件访问地址
|
||||
/// </summary>
|
||||
public string ServeUrl { get; set; }
|
||||
public string? ServeUrl { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// S3服务 Bucket
|
||||
/// </summary>
|
||||
public string Bucket { get; set; }
|
||||
public string? Bucket { get; set; }
|
||||
|
||||
public string AccessKey { get; set; }
|
||||
public string? AccessKey { get; set; }
|
||||
|
||||
public string SecretKey { get; set; }
|
||||
public string? SecretKey { get; set; }
|
||||
}
|
||||
@@ -2,29 +2,24 @@ namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiSynapseOptions
|
||||
{
|
||||
public string MqHost { get; set; }
|
||||
|
||||
public int MqPort { get; set; }
|
||||
|
||||
public string MqUser { get; set; }
|
||||
|
||||
public string MqPass { get; set; }
|
||||
|
||||
public string MqVHost { get; set; } = "/";
|
||||
|
||||
public string SysName { get; set; }
|
||||
|
||||
public string AppName { get; set; }
|
||||
|
||||
public string AppId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Mqtt服务器的Websocket地址
|
||||
/// </summary>
|
||||
public string? Websocket { get; set; }
|
||||
public string? Username { get; set; }
|
||||
public string? Password { get; set; }
|
||||
public string? SysName { get; set; }
|
||||
public string? AppName { get; set; }
|
||||
public string? AppId { get; set; }
|
||||
public int RpcTimeout { get; set; } = 3;
|
||||
|
||||
public ushort EventProcessorNum { get; set; } = 20;
|
||||
|
||||
public ushort RpcProcessorNum { get; set; } = 20;
|
||||
|
||||
/// <summary>
|
||||
/// Event是否使用负载均衡
|
||||
/// 也就是订阅$queue主题,消息会分发给不同的AppId
|
||||
/// 如果false,多个AppId都可以同时收到消息
|
||||
/// </summary>
|
||||
public bool EventLoadBalancing { get; set; } = false;
|
||||
public bool EnableConfigStore { get; set; } = true;
|
||||
public bool DisableEventClient { get; set; } = false;
|
||||
|
||||
public bool DisableRpcClient { get; set; } = false;
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
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 void Logout()
|
||||
{
|
||||
if (Request.Headers.TryGetValue("Token", out var value))
|
||||
{
|
||||
auth.Logout(value!);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,7 +3,7 @@ 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;
|
||||
|
||||
@@ -13,12 +13,17 @@ namespace SimApi.Controllers;
|
||||
/// 2. 报错返回
|
||||
/// 3. 错误回馈页面
|
||||
/// </summary>
|
||||
///
|
||||
[Consumes("application/json")]
|
||||
[Produces("application/json")]
|
||||
public class SimApiBaseController : Controller
|
||||
{
|
||||
/// <summary>
|
||||
/// 当前登录用户的ID
|
||||
/// </summary>
|
||||
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
|
||||
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"]!;
|
||||
|
||||
protected string LoginToken => (string)HttpContext.Items["LoginToken"]!;
|
||||
|
||||
/// <summary>
|
||||
/// 验证请求参数
|
||||
@@ -26,84 +31,12 @@ public class SimApiBaseController : Controller
|
||||
/// <param name="context"></param>
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
{
|
||||
if (!context.ModelState.IsValid)
|
||||
if (context.ModelState.IsValid) return;
|
||||
foreach (var item in context.ModelState.Values.Where(item =>
|
||||
item.ValidationState == ModelValidationState.Invalid))
|
||||
{
|
||||
foreach (var item in context.ModelState.Values.Where(item =>
|
||||
item.ValidationState == ModelValidationState.Invalid))
|
||||
{
|
||||
Error(400, item.Errors.First().ErrorMessage);
|
||||
break;
|
||||
}
|
||||
Error(400, item.Errors.First().ErrorMessage);
|
||||
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(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(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(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(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,12 +1,16 @@
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Helpers;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
[ApiExplorerSettings(GroupName = "api")]
|
||||
public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
|
||||
public class SimApiCommonController(SimApiOptions simApiOptions) : SimApiBaseController
|
||||
{
|
||||
/// <summary>
|
||||
/// 错误回馈页面
|
||||
@@ -15,46 +19,36 @@ public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
|
||||
/// <returns></returns>
|
||||
[HttpGet("exception/{code:int}")]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
public SimApiBaseResponse ExceptionHandler(int code)
|
||||
public void ExceptionHandler(int code)
|
||||
{
|
||||
return new SimApiBaseResponse(code);
|
||||
Error(code);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测用户登陆的控制器
|
||||
/// 给前端的自定义信息
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
|
||||
public SimApiBaseResponse<string> CheckLogin()
|
||||
[HttpPost, HttpGet]
|
||||
public Dictionary<string, object> WebConfig()
|
||||
{
|
||||
ErrorWhenNull(LoginInfo, 401);
|
||||
return new SimApiBaseResponse<string>
|
||||
var resp = simApiOptions.WebConfig!.ToDictionary();
|
||||
if (simApiOptions.WebConfigIncludeVersion)
|
||||
{
|
||||
Data = LoginInfo.Id
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
|
||||
public SimApiBaseResponse Logout()
|
||||
{
|
||||
string token = null;
|
||||
|
||||
if (Request.Headers.TryGetValue("Token", out var value))
|
||||
{
|
||||
token = value;
|
||||
resp.Add("Versions", new Dictionary<string, string>
|
||||
{
|
||||
{ "SimApi", SimApiUtil.SimApiVersion },
|
||||
{ "App", SimApiUtil.AppVersion }
|
||||
});
|
||||
}
|
||||
|
||||
auth.Logout(token!);
|
||||
return new SimApiBaseResponse();
|
||||
}
|
||||
|
||||
[HttpPost("/logined"),SimApiAuth]
|
||||
public SimApiBaseResponse<SimApiLoginItem> UserInfo()
|
||||
{
|
||||
return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);
|
||||
return resp;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 获取已登录用户信息
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost, SimApiAuth, SimApiDoc("认证", "获取已登录用户信息")]
|
||||
public SimApiLoginItem UserInfo() => 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;
|
||||
}
|
||||
}
|
||||
+167
-40
@@ -1,62 +1,86 @@
|
||||
#nullable enable
|
||||
using System;
|
||||
using System.Collections.Concurrent;
|
||||
using System.Collections.Generic;
|
||||
using System.Text.Json;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using SimApi.Communications;
|
||||
using StackExchange.Redis;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
/// <summary>
|
||||
/// 认证助手
|
||||
/// 认证助手(支持 Redis 和 InMemory 两种模式)
|
||||
/// </summary>
|
||||
public class SimApiAuth(IDistributedCache cache)
|
||||
public class SimApiAuth
|
||||
{
|
||||
/// <summary>
|
||||
/// 产生一个Token记录并返回Token
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <param name="meta"></param>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(string id, Dictionary<string, string>? meta = null, string type = "user", string? token = null)
|
||||
private const string TokenCacheKey = "SimApi:Auth:Token:{token}";
|
||||
private const string TokenSetCacheKey = "SimApi:Auth:User:{userId}";
|
||||
|
||||
private readonly IDistributedCache _cache;
|
||||
private readonly IDatabase? _redisDb;
|
||||
|
||||
// InMemory 模式:用户 → Token集合
|
||||
private readonly ConcurrentDictionary<string, ConcurrentDictionary<string, byte>> _userTokens = new();
|
||||
|
||||
public SimApiAuth(IDistributedCache cache, IServiceProvider sp)
|
||||
{
|
||||
return Login(id, meta, new[] { type }, token);
|
||||
_cache = cache;
|
||||
_redisDb = sp.GetService<IConnectionMultiplexer>()?.GetDatabase();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 产生一个Token并记录用户ID角色[多角色]
|
||||
/// 登录信息
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <param name="meta"></param>
|
||||
/// <param name="uuid"></param>
|
||||
/// <param name="loginItem"></param>
|
||||
/// <param name="expireTime"></param>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
// ReSharper disable once MemberCanBePrivate.Global
|
||||
public string Login(string id, Dictionary<string, string>? meta, string[] type, string? uuid = null)
|
||||
public string Login(SimApiLoginItem loginItem, TimeSpan? expireTime = null, string? token = null)
|
||||
{
|
||||
uuid ??= Guid.NewGuid().ToString();
|
||||
var loginItem = new SimApiLoginItem(id, type, meta);
|
||||
cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
|
||||
return uuid;
|
||||
expireTime ??= TimeSpan.FromDays(7);
|
||||
token ??= Guid.NewGuid().ToString();
|
||||
var cacheKey = TokenCacheKey.Replace("{token}", token);
|
||||
var setCacheKey = TokenSetCacheKey.Replace("{userId}", loginItem.Id);
|
||||
|
||||
_cache.SetString(cacheKey, SimApiUtil.Json(loginItem),
|
||||
new DistributedCacheEntryOptions { SlidingExpiration = expireTime });
|
||||
|
||||
if (_redisDb != null)
|
||||
{
|
||||
_redisDb.SetAdd(setCacheKey, token);
|
||||
_redisDb.KeyExpire(setCacheKey, expireTime.Value);
|
||||
}
|
||||
else
|
||||
{
|
||||
var tokens = _userTokens.GetOrAdd(loginItem.Id, _ => new ConcurrentDictionary<string, byte>());
|
||||
tokens.TryAdd(token, 0);
|
||||
}
|
||||
|
||||
return token;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 设置登录的Meta信息
|
||||
/// 更新登陆信息
|
||||
/// </summary>
|
||||
/// <param name="loginItem"></param>
|
||||
/// <param name="token"></param>
|
||||
/// <param name="meta"></param>
|
||||
/// <returns></returns>
|
||||
public bool SetMeta(string token, Dictionary<string, string> meta)
|
||||
public string Update(SimApiLoginItem loginItem, string token)
|
||||
{
|
||||
var login = GetLogin(token);
|
||||
if (login == null) { return false; }
|
||||
var newLogin = new SimApiLoginItem(login.Id, login.Type, login.Meta);
|
||||
cache.SetString(token,JsonSerializer.Serialize(newLogin));
|
||||
return true;
|
||||
var cacheKey = TokenCacheKey.Replace("{token}", token);
|
||||
_cache.SetString(cacheKey, SimApiUtil.Json(loginItem));
|
||||
|
||||
if (_redisDb != null)
|
||||
{
|
||||
var ttl = _redisDb.KeyTimeToLive(cacheKey);
|
||||
var setCacheKey = TokenSetCacheKey.Replace("{userId}", loginItem.Id);
|
||||
_redisDb.KeyExpire(setCacheKey, ttl);
|
||||
}
|
||||
|
||||
return token;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 获取登陆信息
|
||||
/// </summary>
|
||||
@@ -64,19 +88,122 @@ public class SimApiAuth(IDistributedCache cache)
|
||||
/// <returns></returns>
|
||||
public SimApiLoginItem? GetLogin(string token)
|
||||
{
|
||||
var login = cache.GetString(token);
|
||||
return login != null ? JsonSerializer.Deserialize<SimApiLoginItem>(login) : default;
|
||||
var cacheKey = TokenCacheKey.Replace("{token}", token);
|
||||
var login = _cache.GetString(cacheKey);
|
||||
var resp = login != null ? SimApiUtil.FromJson<SimApiLoginItem>(login) : null;
|
||||
|
||||
if (resp != null && _redisDb != null)
|
||||
{
|
||||
var ttl = _redisDb.KeyTimeToLive(cacheKey);
|
||||
var setCacheKey = TokenSetCacheKey.Replace("{userId}", resp.Id);
|
||||
_redisDb.KeyExpire(setCacheKey, ttl);
|
||||
}
|
||||
|
||||
return resp;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取所有的登录token
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiLoginItem[] GetAllLogins(string userId)
|
||||
{
|
||||
if (_redisDb != null)
|
||||
{
|
||||
var setCacheKey = TokenSetCacheKey.Replace("{userId}", userId);
|
||||
var allLogins = _redisDb.SetMembers(setCacheKey).ToStringArray();
|
||||
var resp = new List<SimApiLoginItem>();
|
||||
foreach (var login in allLogins)
|
||||
{
|
||||
if (login != null)
|
||||
{
|
||||
var item = GetLogin(login);
|
||||
if (item != null)
|
||||
resp.Add(item);
|
||||
else
|
||||
_redisDb.SetRemove(setCacheKey, login);
|
||||
}
|
||||
}
|
||||
|
||||
return resp.ToArray();
|
||||
}
|
||||
else
|
||||
{
|
||||
if (!_userTokens.TryGetValue(userId, out var tokens))
|
||||
return [];
|
||||
|
||||
var resp = new List<SimApiLoginItem>();
|
||||
foreach (var token in tokens.Keys)
|
||||
{
|
||||
var item = GetLogin(token);
|
||||
if (item != null)
|
||||
resp.Add(item);
|
||||
else
|
||||
tokens.TryRemove(token, out _);
|
||||
}
|
||||
|
||||
return resp.ToArray();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出所有登录
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
public void LogoutAll(string userId)
|
||||
{
|
||||
if (_redisDb != null)
|
||||
{
|
||||
var setCacheKey = TokenSetCacheKey.Replace("{userId}", userId);
|
||||
var allLogins = _redisDb.SetMembers(setCacheKey).ToStringArray();
|
||||
foreach (var login in allLogins)
|
||||
{
|
||||
if (login != null)
|
||||
{
|
||||
var cacheKey = TokenCacheKey.Replace("{token}", login);
|
||||
_cache.Remove(cacheKey);
|
||||
}
|
||||
}
|
||||
|
||||
_redisDb.KeyDelete(setCacheKey);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (_userTokens.TryRemove(userId, out var tokens))
|
||||
{
|
||||
foreach (var token in tokens.Keys)
|
||||
{
|
||||
var cacheKey = TokenCacheKey.Replace("{token}", token);
|
||||
_cache.Remove(cacheKey);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <param name="uuid">登陆标识</param>
|
||||
public void Logout(string uuid)
|
||||
/// <param name="token">登陆标识</param>
|
||||
public void Logout(string token)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(uuid))
|
||||
var item = GetLogin(token);
|
||||
|
||||
if (_redisDb != null)
|
||||
{
|
||||
cache.Remove(uuid);
|
||||
if (item != null)
|
||||
{
|
||||
var setCacheKey = TokenSetCacheKey.Replace("{userId}", item.Id);
|
||||
_redisDb.SetRemove(setCacheKey, token);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
if (item != null && _userTokens.TryGetValue(item.Id, out var tokens))
|
||||
tokens.TryRemove(token, out _);
|
||||
}
|
||||
|
||||
var cacheKey = TokenCacheKey.Replace("{token}", token);
|
||||
_cache.Remove(cacheKey);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
using System.Text.Json;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiCache(IDistributedCache cache)
|
||||
{
|
||||
private const string Prefix = "SimApi:Cache:";
|
||||
|
||||
/// <summary>
|
||||
/// 设置缓存 (值不能为null)
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <param name="value"></param>
|
||||
/// <param name="options"></param>
|
||||
public void Set(string key, object value, DistributedCacheEntryOptions? options = null)
|
||||
{
|
||||
SimApiError.ErrorWhenNull(value, 400, "缓存值不能为null");
|
||||
if (options is not null)
|
||||
{
|
||||
cache.SetString(Prefix + key, SimApiUtil.Json(value), options);
|
||||
}
|
||||
else
|
||||
{
|
||||
cache.SetString(Prefix + key, SimApiUtil.Json(value));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 移除缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
public void Remove(string key)
|
||||
{
|
||||
cache.Remove(Prefix + key);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 缓存Key是否存在
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
public bool HasKey(string key)
|
||||
{
|
||||
return Get<string>(key) != null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取string类型缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
public string? Get(string key)
|
||||
{
|
||||
return Get<string>(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);
|
||||
return data == null ? default : SimApiUtil.FromJson<T>(data);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
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>
|
||||
[DoesNotReturn]
|
||||
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);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,116 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Net.Http;
|
||||
using System.Net.Http.Json;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHttpClient>? logger = null)
|
||||
{
|
||||
public virtual string Server { get; init; } = apiOptions?.SimApiHttpClientOptions.Server ?? string.Empty;
|
||||
public virtual string AppId { get; init; } = apiOptions?.SimApiHttpClientOptions.AppId ?? string.Empty;
|
||||
public virtual string AppKey { get; init; } = apiOptions?.SimApiHttpClientOptions.AppKey ?? string.Empty;
|
||||
|
||||
public virtual string SignName { get; init; } = "sign";
|
||||
public virtual string TimestampName { get; init; } = "timestamp";
|
||||
public virtual string NonceName { get; init; } = "nonce";
|
||||
public virtual string? AppIdName { get; init; } = "appId";
|
||||
public virtual 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}";
|
||||
}
|
||||
logger?.LogDebug($"[HTTPCLIENT请求][加密前BODY] {url}\n{SimApiUtil.Json(body)}\n");
|
||||
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)
|
||||
{
|
||||
logger?.LogDebug($"[HTTPCLIENT请求][加密前BODY] {url}\n{SimApiUtil.Json(body)}\n");
|
||||
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();
|
||||
logger?.LogDebug($"[HTTPCLIENT请求] {url}\n{SimApiUtil.Json(req)}\n");
|
||||
var resp = http.PostAsJsonAsync(url, req).Result;
|
||||
logger?.LogDebug($"[HTTPCLIENT响应] {resp.Content.ReadAsStringAsync().Result}\n");
|
||||
SimApiError.ErrorWhenFalse(resp.IsSuccessStatusCode, (int)resp.StatusCode, $"HTTP ERROR: {resp.StatusCode}");
|
||||
var res = resp.Content.ReadFromJsonAsync<SimApiBaseResponse<T>>().Result;
|
||||
SimApiError.ErrorWhenNull(res, 500, "请求发生错误");
|
||||
SimApiError.ErrorWhen(res.Code != 200, res.Code, res.Message);
|
||||
return res.Data!;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using Hangfire.Dashboard;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiJobWebAuth(string user, string pass) : IDashboardAuthorizationFilter
|
||||
{
|
||||
public bool Authorize(DashboardContext context)
|
||||
{
|
||||
var httpContext = context.GetHttpContext();
|
||||
var authHeader = httpContext.Request.Headers.Authorization.FirstOrDefault();
|
||||
if (authHeader != null && authHeader.StartsWith("Basic "))
|
||||
{
|
||||
var encodedUsernamePassword = authHeader.Split(' ', 2, StringSplitOptions.RemoveEmptyEntries)[1].Trim();
|
||||
var decodedUsernamePassword = Encoding.UTF8.GetString(Convert.FromBase64String(encodedUsernamePassword));
|
||||
var username = decodedUsernamePassword.Split(':', 2)[0];
|
||||
var password = decodedUsernamePassword.Split(':', 2)[1];
|
||||
|
||||
if (username == user && password == pass)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
httpContext.Response.StatusCode = 401;
|
||||
httpContext.Response.Headers.WWWAuthenticate = "Basic realm=\"SimApiBasicAuth\"";
|
||||
httpContext.Response.WriteAsync("").Wait();
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiResponseFilter : IResultFilter
|
||||
{
|
||||
public void OnResultExecuting(ResultExecutingContext context)
|
||||
{
|
||||
if (context.ActionDescriptor.EndpointMetadata.Any(meta => meta is OriginResponseAttribute))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
context.Result = context.Result switch
|
||||
{
|
||||
// 检查结果是否为 null
|
||||
null => new OkObjectResult(new SimApiBaseResponse()),
|
||||
ObjectResult { Value: SimApiBaseResponse simApiBaseResponse } =>
|
||||
new OkObjectResult(simApiBaseResponse),
|
||||
ObjectResult objectResult => new OkObjectResult(new SimApiBaseResponse<object>(objectResult.Value!)),
|
||||
EmptyResult => new OkObjectResult(new SimApiBaseResponse()),
|
||||
_ => context.Result
|
||||
};
|
||||
}
|
||||
|
||||
public void OnResultExecuted(ResultExecutedContext context)
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -3,15 +3,16 @@ using System;
|
||||
using System.IO;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Minio;
|
||||
using Minio.DataModel.Args;
|
||||
using SimApi.Configurations;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public class SimApiStorage
|
||||
{
|
||||
private MinioClient Mc { get; }
|
||||
private IMinioClient Mc { get; }
|
||||
|
||||
public MinioClient Client => Mc;
|
||||
public IMinioClient Client => Mc;
|
||||
|
||||
private string ServeUrl { get; }
|
||||
|
||||
@@ -25,10 +26,10 @@ public class SimApiStorage
|
||||
{
|
||||
var options = apiOptions.SimApiStorageOptions;
|
||||
HttpContextAccessor = httpContextAccessor;
|
||||
Endpoint = options.Endpoint;
|
||||
Endpoint = options.Endpoint!;
|
||||
var useSsl = false;
|
||||
string endpoint;
|
||||
if (options.Endpoint.StartsWith("http://"))
|
||||
if (options.Endpoint!.StartsWith("http://"))
|
||||
{
|
||||
endpoint = options.Endpoint.Replace("http://", string.Empty);
|
||||
}
|
||||
@@ -42,9 +43,9 @@ public class SimApiStorage
|
||||
throw new Exception("SimApiStorage: Error Endpoint");
|
||||
}
|
||||
|
||||
ServeUrl = options.ServeUrl;
|
||||
ServeUrl = options.ServeUrl!;
|
||||
if (ServeUrl.EndsWith('/')) throw new Exception("SimApiStorage: ServeUrl must not end with /");
|
||||
Bucket = options.Bucket;
|
||||
Bucket = options.Bucket!;
|
||||
var mcb = new MinioClient().WithEndpoint(endpoint)
|
||||
.WithCredentials(options.AccessKey, options.SecretKey);
|
||||
if (useSsl)
|
||||
@@ -111,10 +112,11 @@ public class SimApiStorage
|
||||
/// <param name="path"></param>
|
||||
/// <returns></returns>
|
||||
/// <exception cref="Exception"></exception>
|
||||
public string FullUrl(string path)
|
||||
public string? FullUrl(string? path)
|
||||
{
|
||||
if (string.IsNullOrEmpty(path)) return path;
|
||||
if(path.StartsWith("http://") || path.StartsWith("https://")) return path;
|
||||
if (!(path.StartsWith('/') || path.StartsWith("~/"))) throw new Exception("path must start with / or ~/");
|
||||
if (!(path.StartsWith('/') || path.StartsWith("~/"))) return path;
|
||||
var httpRequest = HttpContextAccessor.HttpContext?.Request;
|
||||
var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
|
||||
if (string.IsNullOrEmpty(path))
|
||||
@@ -125,6 +127,27 @@ public class SimApiStorage
|
||||
return path.StartsWith('~') ? string.Concat(url, path.AsSpan(1, path.Length - 1)) : $"{ServeUrl}{path}";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取一个Path得访问URL
|
||||
/// </summary>
|
||||
/// <param name="path"></param>
|
||||
/// <returns></returns>
|
||||
public string? GetUrl(string? path)
|
||||
{
|
||||
if (string.IsNullOrEmpty(path)) return path;
|
||||
if (path.StartsWith("~/"))
|
||||
{
|
||||
var httpRequest = HttpContextAccessor.HttpContext?.Request;
|
||||
var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
|
||||
return string.Concat(url, path.AsSpan(1, path.Length - 1));
|
||||
}
|
||||
if (path.StartsWith('/'))
|
||||
{
|
||||
return $"{ServeUrl}{path}";
|
||||
}
|
||||
return path;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 从URL中获取相对路径 (如果url不是当前服务器的url,则原样返回)
|
||||
/// </summary>
|
||||
@@ -132,7 +155,7 @@ public class SimApiStorage
|
||||
/// <returns></returns>
|
||||
public string? GetPath(string? url)
|
||||
{
|
||||
return url?.Replace($"{Endpoint}/{Bucket}", string.Empty);
|
||||
return url?.Replace($"{Endpoint}/{Bucket}", string.Empty).Replace(ServeUrl,string.Empty);
|
||||
}
|
||||
|
||||
private void CheckPath(string path)
|
||||
|
||||
+160
-2
@@ -1,5 +1,8 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Net.Mail;
|
||||
using System.Reflection;
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
using System.Text.Encodings.Web;
|
||||
@@ -7,6 +10,7 @@ using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Text.Unicode;
|
||||
using System.Xml.Serialization;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
@@ -22,11 +26,59 @@ public static class SimApiUtil
|
||||
/// </summary>
|
||||
public static JsonSerializerOptions JsonOption => new()
|
||||
{
|
||||
// ReferenceHandler = ReferenceHandler.Preserve,
|
||||
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
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>
|
||||
@@ -43,6 +95,25 @@ public static class SimApiUtil
|
||||
return regex.IsMatch(cell);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 判断是否是Email地址
|
||||
/// </summary>
|
||||
/// <param name="email"></param>
|
||||
/// <returns></returns>
|
||||
public static bool CheckEmail(string email)
|
||||
{
|
||||
try
|
||||
{
|
||||
var m = new MailAddress(email);
|
||||
return m.Address == email;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// MD5加密字符串
|
||||
/// </summary>
|
||||
@@ -62,16 +133,103 @@ public static class SimApiUtil
|
||||
return stringBuilder.ToString();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// sha1加密字符串
|
||||
/// </summary>
|
||||
/// <param name="source">源字符串</param>
|
||||
/// <param name="mode">加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位</param>
|
||||
/// <returns></returns>
|
||||
public static string Sha1(string source, string mode = "x2")
|
||||
{
|
||||
var hash = SHA1.HashData(Encoding.UTF8.GetBytes(source));
|
||||
var sb = new StringBuilder(hash.Length * 2);
|
||||
foreach (var b in hash)
|
||||
{
|
||||
sb.Append(b.ToString(mode));
|
||||
}
|
||||
|
||||
return sb.ToString();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 字符串Base64编码
|
||||
/// </summary>
|
||||
/// <param name="str"></param>
|
||||
/// <returns></returns>
|
||||
public static string Base64Encode(string str)
|
||||
{
|
||||
var bytes = Encoding.UTF8.GetBytes(str);
|
||||
return Convert.ToBase64String(bytes);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 从Base64中解码字符串
|
||||
/// </summary>
|
||||
/// <param name="base64Str"></param>
|
||||
/// <returns></returns>
|
||||
public static string Base64Decode(string base64Str)
|
||||
{
|
||||
var bytes = Convert.FromBase64String(base64Str);
|
||||
return Encoding.UTF8.GetString(bytes);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 把对象Base64编码
|
||||
/// </summary>
|
||||
/// <param name="obj"></param>
|
||||
/// <returns></returns>
|
||||
public static string Base64Encode(object obj)
|
||||
{
|
||||
var json = Json(obj);
|
||||
return Base64Encode(json);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 从Base64中解析对象
|
||||
/// </summary>
|
||||
/// <param name="base64Str"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public static T? Base64Decode<T>(string base64Str)
|
||||
{
|
||||
var json = Base64Decode(base64Str);
|
||||
return FromJson<T>(json);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 将XML字符串序列化为对象
|
||||
/// </summary>
|
||||
/// <param name="source"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public static T XmlDeserialize<T>(string source)
|
||||
{
|
||||
var xmlConvertor = new XmlSerializer(typeof(T));
|
||||
using var reader = new StringReader(source);
|
||||
return (T)xmlConvertor.Deserialize(reader)!;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 将对象序列化成JSON (控制台输出中文不会被编码)
|
||||
/// </summary>
|
||||
/// <param name="obj"></param>
|
||||
/// <returns></returns>
|
||||
public static string Json(object obj)
|
||||
public static string Json(object? obj)
|
||||
{
|
||||
return JsonSerializer.Serialize(obj, JsonOption);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 将JSON解析为对象(控制台输出中文不会被编码)
|
||||
/// </summary>
|
||||
/// <param name="jsonString"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public static T? FromJson<T>(string jsonString)
|
||||
{
|
||||
return JsonSerializer.Deserialize<T>(jsonString, JsonOption);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 分页
|
||||
/// </summary>
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
using SimApi.Communications;
|
||||
|
||||
namespace SimApi.Interfaces;
|
||||
|
||||
public interface ISimApiAuthChecker
|
||||
{
|
||||
public void Run(SimApiLoginItem loginItem, string token);
|
||||
}
|
||||
+13
-5
@@ -1,16 +1,14 @@
|
||||
using System;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLogger(string name) : ILogger
|
||||
{
|
||||
public IDisposable BeginScope<TState>(TState state) => default!;
|
||||
|
||||
public IDisposable BeginScope<TState>(TState state) where TState : notnull => default!;
|
||||
public bool IsEnabled(LogLevel logLevel) => true;
|
||||
|
||||
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception,
|
||||
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception,
|
||||
Func<TState, Exception, string> formatter)
|
||||
{
|
||||
Console.ForegroundColor = logLevel switch
|
||||
@@ -23,12 +21,22 @@ public class SimApiLogger(string name) : ILogger
|
||||
_ => ConsoleColor.White
|
||||
};
|
||||
var message =
|
||||
$"[ {name} ][ {DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
|
||||
$"[ {name} ][ {DateTime.Now:yyyy-MM-dd HH:mm:ss:ffff} ][ {logLevel.ToString()} ]\n{state}\n";
|
||||
if (exception != null)
|
||||
{
|
||||
message += $"{exception}\n";
|
||||
}
|
||||
|
||||
Console.WriteLine(message);
|
||||
Console.ResetColor();
|
||||
}
|
||||
}
|
||||
|
||||
public class EmptyDisposable : IDisposable
|
||||
{
|
||||
public static EmptyDisposable Instance { get; } = new EmptyDisposable();
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLoggerConfiguration
|
||||
{
|
||||
public int EventId { get; set; }
|
||||
|
||||
public Dictionary<LogLevel, ConsoleColor> LogLevels { get; set; } = new()
|
||||
{
|
||||
[LogLevel.Information] = ConsoleColor.Green
|
||||
};
|
||||
}
|
||||
@@ -1,8 +1,6 @@
|
||||
using System.Text.Json;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Middlewares;
|
||||
@@ -12,21 +10,18 @@ namespace SimApi.Middlewares;
|
||||
/// </summary>
|
||||
public class SimApiAuthMiddleware(RequestDelegate next)
|
||||
{
|
||||
public Task Invoke(HttpContext httpContext, IDistributedCache cache, SimApiAuth auth)
|
||||
public Task Invoke(HttpContext httpContext, SimApiAuth auth)
|
||||
{
|
||||
string token = null;
|
||||
if (httpContext.Request.Headers.TryGetValue("Token", out var header))
|
||||
{
|
||||
token = header;
|
||||
}
|
||||
var token =
|
||||
httpContext.Request.Headers["Token"].FirstOrDefault()
|
||||
?? httpContext.Request.Query["token"].FirstOrDefault();
|
||||
|
||||
if (!string.IsNullOrEmpty(token))
|
||||
if (string.IsNullOrEmpty(token)) return next(httpContext);
|
||||
var login = auth.GetLogin(token);
|
||||
if (login != null)
|
||||
{
|
||||
var login = auth.GetLogin(token);
|
||||
if (login != null)
|
||||
{
|
||||
httpContext.Items.Add("LoginInfo", login);
|
||||
}
|
||||
httpContext.Items.Add("LoginToken", token);
|
||||
httpContext.Items.Add("LoginInfo", login);
|
||||
}
|
||||
|
||||
return next(httpContext);
|
||||
|
||||
@@ -4,14 +4,19 @@ using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using SimApi.Communications;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Middlewares;
|
||||
|
||||
/// <summary>
|
||||
/// 异常处理中间件
|
||||
/// </summary>
|
||||
public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
|
||||
public class SimApiExceptionMiddleware(
|
||||
RequestDelegate next,
|
||||
ILogger<SimApiExceptionMiddleware> log,
|
||||
SimApiOptions simApiOptions)
|
||||
{
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
@@ -20,50 +25,63 @@ 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:
|
||||
break;
|
||||
case 404:
|
||||
throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
|
||||
case 301:
|
||||
case 302:
|
||||
break;
|
||||
default:
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
SimApiError.ErrorWhenFalse(
|
||||
simApiOptions.SimApiExceptionOptions.SkipStatusCodes.Contains(context.Response.StatusCode),
|
||||
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);
|
||||
if (context.Response.StatusCode == 404)
|
||||
{
|
||||
response.Message = "接口不存在";
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
log.LogError(ex, ex.Message);
|
||||
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)
|
||||
{
|
||||
if (context.Response.HasStarted) return;
|
||||
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());
|
||||
context.Response.ContentType = "application/json";
|
||||
context.Response.ContentLength = null; // 清除可能已设置的 Content-Length
|
||||
await context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,124 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Runtime.ExceptionServices;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Middlewares;
|
||||
|
||||
/// <summary>
|
||||
/// 请求日志中间件
|
||||
/// </summary>
|
||||
public class SimApiRequestLogMiddleware(
|
||||
RequestDelegate next,
|
||||
ILogger<SimApiRequestLogMiddleware> log,
|
||||
SimApiRequestLogOptions options)
|
||||
{
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
var sw = Stopwatch.StartNew();
|
||||
var fullUrl =
|
||||
$"{context.Request.Scheme}://{context.Request.Host}{context.Request.Path}{context.Request.QueryString}";
|
||||
|
||||
var logMessage = new StringBuilder();
|
||||
logMessage.AppendLine($"[{context.Request.Method}] {fullUrl}");
|
||||
|
||||
if (options.ShowFullHeader)
|
||||
{
|
||||
logMessage.AppendLine("*( RequestHeaders [Full] ) =>");
|
||||
var headersDict = new Dictionary<string, string>();
|
||||
foreach (var header in context.Request.Headers)
|
||||
{
|
||||
headersDict[header.Key] = header.Value.ToString();
|
||||
}
|
||||
|
||||
logMessage.AppendLine(JsonSerializer.Serialize(headersDict));
|
||||
}
|
||||
else
|
||||
{
|
||||
logMessage.AppendLine("*( RequestHeaders ) =>");
|
||||
var token = context.Request.Headers["Token"].FirstOrDefault() ?? "";
|
||||
var queryId = context.Request.Headers["Query-Id"].FirstOrDefault() ?? "";
|
||||
logMessage.AppendLine($"Token: {token} QueryId: {queryId}");
|
||||
}
|
||||
|
||||
context.Request.EnableBuffering();
|
||||
var requestBodyText = await new StreamReader(context.Request.Body).ReadToEndAsync();
|
||||
context.Request.Body.Seek(0, SeekOrigin.Begin);
|
||||
logMessage.AppendLine("*( RequestBody ) =>");
|
||||
if (options.RequestStringLogLength == 0)
|
||||
{
|
||||
logMessage.AppendLine(requestBodyText);
|
||||
}
|
||||
else
|
||||
{
|
||||
var reqLogs = SimApiUtil.FromJson<Dictionary<string, object>>(requestBodyText);
|
||||
foreach (var reqLog in reqLogs)
|
||||
{
|
||||
if (reqLog.Value is not JsonElement { ValueKind: JsonValueKind.String } je) continue;
|
||||
var str = je.GetString();
|
||||
if (str?.Length > options.RequestStringLogLength)
|
||||
{
|
||||
reqLogs[reqLog.Key] = str[..options.RequestStringLogLength] + $"...({str.Length})";
|
||||
}
|
||||
}
|
||||
|
||||
logMessage.AppendLine(SimApiUtil.Json(reqLogs));
|
||||
}
|
||||
|
||||
var originalBodyStream = context.Response.Body;
|
||||
using var responseBody = new MemoryStream();
|
||||
context.Response.Body = responseBody;
|
||||
|
||||
ExceptionDispatchInfo? edi = null;
|
||||
|
||||
try
|
||||
{
|
||||
await next(context);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
edi = ExceptionDispatchInfo.Capture(ex);
|
||||
}
|
||||
finally
|
||||
{
|
||||
sw.Stop();
|
||||
|
||||
responseBody.Seek(0, SeekOrigin.Begin);
|
||||
var responseText = await new StreamReader(responseBody).ReadToEndAsync();
|
||||
|
||||
logMessage.AppendLine($"*( Response [{context.Response.StatusCode}] ) =>");
|
||||
if (options.ShowFullResponse)
|
||||
{
|
||||
logMessage.Append(responseText);
|
||||
}
|
||||
else
|
||||
{
|
||||
var truncated = responseText.Length > 200 ? responseText[..200] : responseText;
|
||||
logMessage.Append(truncated);
|
||||
}
|
||||
|
||||
if (edi != null)
|
||||
{
|
||||
logMessage.Append(Environment.NewLine);
|
||||
logMessage.Append($"Exception: {edi.SourceException}");
|
||||
}
|
||||
|
||||
responseBody.Seek(0, SeekOrigin.Begin);
|
||||
await responseBody.CopyToAsync(originalBodyStream);
|
||||
context.Response.Body = originalBodyStream;
|
||||
|
||||
log.LogInformation(logMessage.ToString());
|
||||
}
|
||||
|
||||
edi?.Throw();
|
||||
}
|
||||
}
|
||||
@@ -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 = SimApiUtil.FromJson<SimApiOneFieldRequest<string>>(requestBody);
|
||||
}
|
||||
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);
|
||||
}
|
||||
@@ -20,7 +20,7 @@ public class SimApiBaseModel
|
||||
public void MapData<TS>(TS source, bool mapAll = false)
|
||||
{
|
||||
//获取要赋值的源数据不为null的项目
|
||||
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
|
||||
var sourceProps = source!.GetType().GetProperties().Where(x => x.GetValue(source) != null)
|
||||
.Select(x => new
|
||||
{
|
||||
x.Name,
|
||||
@@ -49,7 +49,7 @@ public class SimApiBaseModel
|
||||
public void MapData<TS>(TS source, string[] mapFields)
|
||||
{
|
||||
//获取要赋值的源数据不为null的项目
|
||||
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
|
||||
var sourceProps = source!.GetType().GetProperties().Where(x => x.GetValue(source) != null)
|
||||
.Select(x => new
|
||||
{
|
||||
x.Name,
|
||||
|
||||
@@ -1,55 +1,700 @@
|
||||
# SimApi 基于.Net的一个基础辅助包
|
||||
# SimApi for .NET
|
||||
|
||||
[](https://github.com/simcu/simapi-net/actions/workflows/nuget-publish.yml)
|
||||
### 包含了以下组件:
|
||||
> NuGet: `Simcu.SimApi` | 目标框架: `net8.0` / `net9.0` / `net10.0`
|
||||
> 作者: xRain@SimcuTeam
|
||||
|
||||
1. 统一的参数检测,基础认证服务
|
||||
所有的控制器需要继承 YYApi.Controllers.BaseController
|
||||
ASP.NET Core API 基础框架库,提供统一异常拦截、响应封装、Token 认证、Swagger 文档、S3 存储、MQTT 通信、Hangfire 任务调度、Auth Center 网关鉴权与 IAM 权限管理。
|
||||
|
||||
```C#
|
||||
using Models;
|
||||
using SimApi.Controllers;
|
||||
---
|
||||
|
||||
namespace Controllers
|
||||
## 快速开始
|
||||
|
||||
```csharp
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
builder.Services.AddSimApi(options =>
|
||||
{
|
||||
public class BaseController : SimApiBaseController
|
||||
// RedisConfiguration 可选:配置则使用 Redis,不配则自动使用 InMemory
|
||||
options.RedisConfiguration = "localhost:6379";
|
||||
options.EnableSimApiAuth = true;
|
||||
options.EnableSimApiDoc = true;
|
||||
|
||||
options.ConfigureSimApiDoc(doc =>
|
||||
{
|
||||
/// <summary>
|
||||
/// 获取登录用户信息
|
||||
/// </summary>
|
||||
protected SimApiLoginInfoItem LoginInfo => (SimApiLoginInfoItem) HttpContext.Items["LoginInfo"];
|
||||
}
|
||||
doc.DocumentTitle = "我的API";
|
||||
doc.ApiGroups = [new("api", "公共接口"), new("admin", "管理接口")];
|
||||
});
|
||||
});
|
||||
|
||||
var app = builder.Build();
|
||||
app.UseSimApi();
|
||||
app.Run();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 核心概念
|
||||
|
||||
### 统一响应格式
|
||||
|
||||
所有接口输出 JSON,HTTP 状态码始终 `200`,错误信息在 `code` 字段:
|
||||
|
||||
| code | 含义 |
|
||||
| ---- | ---------- |
|
||||
| 200 | 成功 |
|
||||
| 204 | 无数据 |
|
||||
| 400 | 参数错误 |
|
||||
| 401 | 需要登录 |
|
||||
| 403 | 无权访问 |
|
||||
| 404 | 资源不存在 |
|
||||
| 500 | 服务器错误 |
|
||||
|
||||
### 异常处理流程
|
||||
|
||||
```
|
||||
请求 → SimApiExceptionMiddleware(全异常捕获→HTTP 200+JSON)
|
||||
→ SimApiAuthMiddleware(Token→LoginInfo)
|
||||
→ [SimApiSign] Filter(签名)
|
||||
→ [SimApiAuth] Filter(登录检查)
|
||||
→ OnActionExecuting(模型验证→code 400)
|
||||
→ Action
|
||||
→ SimApiResponseFilter(封装响应)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
SimApi/
|
||||
├── Attributes/ # [SimApiAuth] [SimApiDoc] [SimApiSign] [AesBody] [SynapseEvent] [SynapseRpc] [OriginResponse]
|
||||
├── AuthSDK/ # Auth Center & IAM SDK
|
||||
│ ├── SimApiAuthClient.cs HTTP 客户端(签名调用 Auth Center)
|
||||
│ ├── SimApiAuthCenter.cs Auth Center API 封装
|
||||
│ ├── SimApiAuthCenterDto.cs 数据模型
|
||||
│ ├── SimApiAuthCenterMiddleware.cs 网关鉴权中间件
|
||||
│ ├── SimApiAuthIam.cs IAM 权限管理 API
|
||||
│ └── SimApiAuthIamDto.cs IAM 数据模型
|
||||
├── Communications/ # SimApiBaseResponse, PageResponse<T>, SimApiLoginItem, SimApiBaseRequest
|
||||
├── Configurations/ # SimApiOptions + 各模块 Option 类
|
||||
├── Controllers/ # SimApiBaseController, SimApiCommonController, SimApiAuthController
|
||||
├── Helpers/ # SimApiError, SimApiAuth, SimApiCache, SimApiHttpClient, SimApiStorage, SimApiUtil, SimApiAesUtil
|
||||
├── Interfaces/ # ISimApiAuthChecker
|
||||
├── Middlewares/ # SimApiExceptionMiddleware, SimApiAuthMiddleware
|
||||
├── Synapse/ # MQTT Pub/Sub + RPC + Config Store
|
||||
├── Exceptions/ # SimApiException
|
||||
├── Models/ # SimApiBaseModel
|
||||
├── SwaggerFilters/ # 文档自动过滤器
|
||||
├── ModelBinders/ # AesBody, SimApiSign
|
||||
├── Logger/ # 彩色控制台日志
|
||||
└── SimApiExtensions.cs # AddSimApi + UseSimApi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 1. 错误处理 — SimApiError
|
||||
|
||||
独立静态类 `SimApi.Helpers.SimApiError`。所有错误最终 → `throw new SimApiException(code, message)` → 中间件捕获。
|
||||
|
||||
**使用**: 文件顶部加 `using static SimApi.Helpers.SimApiError;`
|
||||
|
||||
### 完整方法签名
|
||||
|
||||
```csharp
|
||||
// 直接抛错
|
||||
void Error(int code = 500, string message = "");
|
||||
|
||||
// condition 为 true 时抛错 (code 默认 400)
|
||||
void ErrorWhen([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "");
|
||||
|
||||
// 同上(别名)
|
||||
void ErrorWhenTrue([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "");
|
||||
|
||||
// condition 为 false 时抛错
|
||||
void ErrorWhenFalse([DoesNotReturnIf(false)] bool condition, int code = 400, string message = "");
|
||||
|
||||
// obj 为 null 时抛错 (code 默认 404)
|
||||
void ErrorWhenNull([NotNull] object? condition, int code = 404, string message = "");
|
||||
```
|
||||
|
||||
### 示例
|
||||
|
||||
```csharp
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
var user = db.Users.Find(id);
|
||||
ErrorWhenNull(user, 404, "用户不存在");
|
||||
ErrorWhen(amount <= 0, 400, "金额无效");
|
||||
ErrorWhenFalse(hasPermission, 403, "无权操作");
|
||||
Error(500, "服务器内部错误");
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. 控制器 — SimApiBaseController
|
||||
|
||||
```csharp
|
||||
public class SimApiBaseController : Controller
|
||||
{
|
||||
// 当前登录信息(需 EnableSimApiAuth)
|
||||
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"]!;
|
||||
protected string LoginToken => (string)HttpContext.Items["LoginToken"]!;
|
||||
|
||||
// OnActionExecuting 自动验证 ModelState → 无效时抛 code 400
|
||||
}
|
||||
```
|
||||
|
||||
**内建**: `[Consumes("application/json")]` + `[Produces("application/json")]`
|
||||
|
||||
统一配置,现在只需要进行AddSimApi的配置, Configure中直接 UseSimApi即可。
|
||||
```C#
|
||||
services.AddSimApi(options =>
|
||||
### 自动路由
|
||||
|
||||
| 路由 | 方法 | 条件 | 说明 |
|
||||
| ----------------------- | -------- | -------------------------------------------- | ------------------------ |
|
||||
| `/versions` | GET/POST | `VersionRoute != null`(默认) | 返回 SimApi/App 版本 |
|
||||
| `/user/info` | POST | `EnableSimApiAuth` + `UserInfoRoute != null` | 需登录,返回 LoginInfo |
|
||||
| `/auth/logout` | POST | `EnableSimApiAuth` + `LogoutRoute != null` | 退出登录(可自定义路由) |
|
||||
| `/swagger` | GET | `EnableSimApiDoc` | Swagger UI |
|
||||
| `/jobs` | GET | `EnableJob` + `DashboardUrl != null` | Hangfire 控制台 |
|
||||
| `/exception/{code:int}` | GET | 始终 | 错误反馈页面 |
|
||||
|
||||
### 返回值规范
|
||||
|
||||
| 场景 | 返回类型 |
|
||||
| ---------- | ------------------------- |
|
||||
| 写操作 | `void` |
|
||||
| 单条查询 | 直接 Entity |
|
||||
| 列表查询 | `Entity[]` |
|
||||
| 分页 | `PageResponse<Entity[]>` |
|
||||
| 自定义状态 | `SimApiBaseResponse` |
|
||||
| 跳封装 | 方法加 `[OriginResponse]` |
|
||||
|
||||
---
|
||||
|
||||
## 3. 认证系统 — SimApiAuth
|
||||
|
||||
```csharp
|
||||
string Login(SimApiLoginItem loginItem, TimeSpan? expireTime = null, string? token = null); // 默认7天
|
||||
string Update(SimApiLoginItem loginItem, string token);
|
||||
SimApiLoginItem? GetLogin(string token);
|
||||
SimApiLoginItem[] GetAllLogins(string userId);
|
||||
void Logout(string token);
|
||||
void LogoutAll(string userId);
|
||||
```
|
||||
|
||||
```csharp
|
||||
// LoginItem 结构
|
||||
public class SimApiLoginItem {
|
||||
required string Id;
|
||||
string[] Type = ["user"];
|
||||
Dictionary<string, string> Meta = [];
|
||||
Dictionary<string, object?> Extra = [];
|
||||
}
|
||||
```
|
||||
|
||||
**Token 传参**: Header `Token: <value>`
|
||||
|
||||
### 存储模式
|
||||
|
||||
`SimApiAuth` 内部自动判断,无需手动配置:
|
||||
|
||||
| 条件 | 存储后端 | 用户↔Token 映射 |
|
||||
|------|---------|-----------------|
|
||||
| 配置了 `RedisConfiguration` | Redis(`IDistributedCache` + Set) | Redis Set |
|
||||
| 未配置 `RedisConfiguration` | InMemory(`DistributedMemoryCache`) | `ConcurrentDictionary` |
|
||||
|
||||
- **Redis 模式**:支持多实例共享,Token 持久化,适合生产环境
|
||||
- **InMemory 模式**:零配置即可启用 `EnableSimApiAuth`,适合开发/测试/单实例场景。注意重启后所有登录态丢失
|
||||
|
||||
```csharp
|
||||
// 不配 Redis 也能用 Auth
|
||||
builder.Services.AddSimApi(options =>
|
||||
{
|
||||
options.ConfigureSimApiDoc(options =>
|
||||
{
|
||||
options.ApiGroups = new[]
|
||||
{
|
||||
new SimApiDocGroupOption
|
||||
{Id = "admin", Name = "后台管理接口", Description = "本接口调用需要Scope:sac.api.admin"},
|
||||
new SimApiDocGroupOption
|
||||
{Id = "user-v1", Name = "用户中心接口", Description = "本接口调用需要Scope:sac.api.user"}
|
||||
};
|
||||
options.ApiAuth = new SimApiAuthOption
|
||||
{
|
||||
Type = new[] {"ClientCredentials", "Implicit", "AuthorizationCode"},
|
||||
Scopes = new Dictionary<string, string>
|
||||
{
|
||||
{"sac.api.user", "用户信息接口权限"},
|
||||
{"sac.api.admin", "后台管理API"}
|
||||
},
|
||||
AuthorizationUrl = "/connect/authorize",
|
||||
TokenUrl = "/connect/token"
|
||||
};
|
||||
});
|
||||
options.EnableSimApiStorage = true;
|
||||
options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>();
|
||||
options.EnableSimApiAuth = true; // 自动使用 InMemory
|
||||
});
|
||||
```
|
||||
基于S3的存储,基于RabbitMq的事件RPC调用,自定义Logger格式,自定义响应格式
|
||||
|
||||
### 认证后处理 Hook — ISimApiAuthChecker
|
||||
|
||||
```csharp
|
||||
public interface ISimApiAuthChecker {
|
||||
void Run(SimApiLoginItem loginItem, string token);
|
||||
}
|
||||
// 实现后自动注册为 Scoped,每次认证后调用
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. AuthSDK — Auth Center 网关 & IAM
|
||||
|
||||
启用: `EnableSimApiAuthGate = true`
|
||||
|
||||
### 4.1 配置
|
||||
|
||||
```csharp
|
||||
options.EnableSimApiAuthGate = true;
|
||||
options.ConfigureSimApiAuthCenter(gate =>
|
||||
{
|
||||
gate.Server = "https://auth.coce.cc";
|
||||
gate.AppId = "your-app-id";
|
||||
gate.AppKey = "your-app-key";
|
||||
gate.UseMiddleware = true; // 内部应用启用,解析 X-SimApi-Gate-Auth Header
|
||||
gate.UseIam = true; // 启用 IAM
|
||||
});
|
||||
```
|
||||
|
||||
### 4.2 SimApiAuthClient
|
||||
|
||||
继承 `SimApiHttpClient`,自动配置 Server/AppId/AppKey,对 Auth Center 发起签名请求。
|
||||
|
||||
### 4.3 SimApiAuthCenter — Auth Center API
|
||||
|
||||
```csharp
|
||||
// === 签名验证 ===
|
||||
void VerifySign(string appId, string timestamp, string nonce, string sign);
|
||||
|
||||
// === 群组 ===
|
||||
GroupRelatedItem[]? GroupRelated(string profileId);
|
||||
AppAndProfileItem[]? GroupSearch(string keyword, int skip = 0, int take = 20);
|
||||
GroupDetailTreeNode? GroupDetail(string groupId, string profileId);
|
||||
string[]? GroupRelatedIndex(string groupId, string profileId);
|
||||
|
||||
// === Profile ===
|
||||
AppAndProfileItem[]? ProfileSearch(string keyword, int skip = 0, int take = 20);
|
||||
AppAndProfileItem[]? ProfileList(string[] ids);
|
||||
|
||||
// === 内部应用专用 ===
|
||||
bool CheckIsAppOwner(string profileId, string applicationId);
|
||||
AppAndProfileItem[]? GetAppList(string profileId, IEnumerable<string> appIds);
|
||||
|
||||
// === 登录 ===
|
||||
GetCodeResponse GetLoginCode(string? scene = null, Dictionary<string, object>? data = null, string? backUrl = null);
|
||||
LoginInfoResponse GetLoginInfo(string code, string? scene = null);
|
||||
|
||||
// === 安全验证(二次确认) ===
|
||||
GetCodeResponse GetConfirmCode(string scene, string userId, Dictionary<string, object>? data = null, string? backUrl = null);
|
||||
ConfirmResponse Confirm(string code, string scene, string? userId = null);
|
||||
```
|
||||
|
||||
**GetCodeResponse**: `{ Code, Server, FullUrl }`
|
||||
|
||||
### 4.4 SimApiAuthIam — IAM 权限管理
|
||||
|
||||
```csharp
|
||||
void RegisterPermissions(PermissionItem[] permissions);
|
||||
string[] GetPermissionOwned(string profileId);
|
||||
void CheckPermission(string profileId, string permission);
|
||||
```
|
||||
|
||||
**PermissionItem**: `{ Identifier, Name, Group, Description }`
|
||||
|
||||
### 4.5 SimApiAuthCenterMiddleware — 网关鉴权
|
||||
|
||||
内部应用专用。解析请求头 `X-SimApi-Gate-Auth` / `X-SimApi-Gate-Time` / `X-SimApi-Gate-Sign`,MD5 验签后将 Base64 解码的用户信息注入 `HttpContext.Items["LoginInfo"]`。
|
||||
|
||||
---
|
||||
|
||||
## 5. Attributes 完整参考
|
||||
|
||||
### [SimApiAuth] — 身份认证
|
||||
|
||||
```csharp
|
||||
[SimApiAuth] // 仅检查登录
|
||||
[SimApiAuth("admin")] // 单角色
|
||||
[SimApiAuth("admin,manager")] // 逗号分隔 OR 关系
|
||||
[SimApiAuth(new[]{"a","b"})] // 数组形式
|
||||
```
|
||||
- 加在 **Controller 类** 或 **方法** 上
|
||||
- **禁止** 代码中手动判断 `LoginInfo.Type.Contains(...)` 做权限控制
|
||||
|
||||
### [SimApiDoc] — Swagger 文档注解
|
||||
|
||||
```csharp
|
||||
[SimApiDoc("分组名", "接口名称")]
|
||||
[SimApiDoc("分组名", "接口名称", "详细描述")]
|
||||
[SimApiDoc(new[]{"tag1","tag2"}, "接口名称")]
|
||||
```
|
||||
|
||||
### [SimApiSign] — API 签名验证
|
||||
|
||||
```csharp
|
||||
[SimApiSign(KeyProvider = typeof(MySignProvider))]
|
||||
// 签名: MD5(field1=v1&...&appId=xxx×tamp=ts&nonce=nnn&密钥)
|
||||
```
|
||||
|
||||
实现 `SimApiSignProviderBase`:
|
||||
```csharp
|
||||
public class MySignProvider : SimApiSignProviderBase
|
||||
{
|
||||
// 可覆盖: AppIdName, TimestampName, NonceName, SignName, QueryExpires(秒), DuplicateRequestProtection, SignFields
|
||||
public override string? GetKey(string? appId) { ... }
|
||||
}
|
||||
```
|
||||
|
||||
### [AesBody] — AES 解密请求体
|
||||
|
||||
```csharp
|
||||
[AesBody(KeyProvider = typeof(MyAesKeyProvider))] MyRequest req
|
||||
// 客户端提交: {"data": "Base64(AES-256-CBC 密文)"}
|
||||
```
|
||||
|
||||
实现 `AesBodyProviderBase`,覆盖 `AppIdName` 和 `GetKey(appId)`。
|
||||
|
||||
### [SynapseEvent] — MQTT 事件处理
|
||||
|
||||
```csharp
|
||||
[SynapseEvent("order/created")] // 指定 eventName
|
||||
[SynapseEvent] // 不指定 = 方法名
|
||||
// 参数: 1个(string eventName) / 2个(string eventName, T data)
|
||||
// 注意: 至少需要1个参数
|
||||
```
|
||||
|
||||
### [SynapseRpc] — MQTT RPC 方法
|
||||
|
||||
```csharp
|
||||
[SynapseRpc] // 注册名 "ClassName.MethodName"
|
||||
[SynapseRpc("customName")] // 自定义名
|
||||
// 参数: 0~2个,第2个固定 Dictionary<string,string>(headers)
|
||||
```
|
||||
|
||||
### [OriginResponse] — 跳过响应封装
|
||||
|
||||
```csharp
|
||||
[HttpGet][OriginResponse]
|
||||
public string GetRaw() => "raw";
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Swagger 文档 — EnableSimApiDoc
|
||||
|
||||
```csharp
|
||||
options.ConfigureSimApiDoc(doc =>
|
||||
{
|
||||
doc.DocumentTitle = "接口文档";
|
||||
doc.ApiGroups = [new("api", "公共"), new("admin", "管理", "描述可选")];
|
||||
doc.SupportedMethod = [SubmitMethod.Post]; // 默认仅POST
|
||||
doc.ApiAuth = new SimApiAuthOption { Type = ["SimApiAuth"] }; // 认证方式
|
||||
});
|
||||
```
|
||||
|
||||
每组通过 `[ApiExplorerSettings(GroupName = "admin")]` 分类。
|
||||
|
||||
### 自动过滤器
|
||||
|
||||
| 过滤器 | 效果 |
|
||||
| --------------------------------- | ------------------------------------ |
|
||||
| `SimApiResponseOperationFilter` | 返回值包装为 `SimApiBaseResponse<T>` |
|
||||
| `SimApiAuthOperationFilter` | 鉴权接口 + Token Header |
|
||||
| `SimApiSignOperationFilter` | 签名接口注入签名参数 |
|
||||
| `AesBodyOperationFilter` | AES 接口展示原始结构 |
|
||||
| `GlobalDynamicObjectSchemaFilter` | object/Dictionary → Schema |
|
||||
| `RemoveEmptyTagsFilter` | 清除空分组 |
|
||||
|
||||
---
|
||||
|
||||
## 7. 对象存储 — EnableSimApiStorage
|
||||
|
||||
基于 MinIO SDK(S3 兼容)。
|
||||
|
||||
### 配置
|
||||
|
||||
```csharp
|
||||
options.EnableSimApiStorage = true;
|
||||
options.ConfigureSimApiStorage(s =>
|
||||
{
|
||||
s.Endpoint = "http://minio:9000"; // 不能以 / 结尾
|
||||
s.AccessKey = "admin";
|
||||
s.SecretKey = "pass";
|
||||
s.Bucket = "bucket";
|
||||
s.ServeUrl = "http://cdn.example.com/bucket"; // 不能以 / 结尾
|
||||
});
|
||||
```
|
||||
|
||||
### API
|
||||
|
||||
```csharp
|
||||
GetUploadUrlResponse GetUploadUrl(string path, int expire = 7200);
|
||||
// 返回: { UploadUrl, DownloadUrl, Path }
|
||||
|
||||
string GetDownloadUrl(string path, int expire = 600);
|
||||
void UploadFile(string path, Stream stream, string contentType = "image/png");
|
||||
string? FullUrl(string? path); // 路径→完整URL
|
||||
string? GetUrl(string? path); // 同上
|
||||
string? GetPath(string? url); // URL→相对路径
|
||||
IMinioClient Client { get; } // 底层 MinIO 客户端
|
||||
```
|
||||
|
||||
> **路径必须以 `/` 开头**
|
||||
|
||||
---
|
||||
|
||||
## 8. 缓存 — SimApiCache
|
||||
|
||||
通过 `EnableSimApiCache`(默认 `true`)控制。Key 自动加前缀 `SimApi:Cache:`。
|
||||
|
||||
存储后端与 `SimApiAuth` 一致:配了 `RedisConfiguration` 就用 Redis,否则用 InMemory。
|
||||
|
||||
```csharp
|
||||
void Set(string key, object value, DistributedCacheEntryOptions? options = null);
|
||||
T? Get<T>(string key);
|
||||
string? Get(string key);
|
||||
bool HasKey(string key);
|
||||
void Remove(string key);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. HTTP 客户端 — SimApiHttpClient
|
||||
|
||||
用于调用其他带签名/AES 的 SimApi 服务。
|
||||
|
||||
### 属性
|
||||
|
||||
```csharp
|
||||
virtual string Server { get; init; }
|
||||
virtual string AppId { get; init; }
|
||||
virtual string AppKey { get; init; }
|
||||
virtual string SignName { get; init; } = "sign";
|
||||
virtual string TimestampName { get; init; } = "timestamp";
|
||||
virtual string NonceName { get; init; } = "nonce";
|
||||
virtual string? AppIdName { get; init; } = "appId";
|
||||
virtual string[] SignFields { get; init; } = [];
|
||||
```
|
||||
|
||||
### 调用方法
|
||||
|
||||
```csharp
|
||||
T SignQuery<T>(string url, object? body = null, Dictionary<string, string>? queries = null);
|
||||
T AesQuery<T>(string url, object body);
|
||||
T AesSignQuery<T>(string url, object body, Dictionary<string, string>? queries = null);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 10. 任务调度 — EnableJob
|
||||
|
||||
Hangfire + Redis。
|
||||
|
||||
```csharp
|
||||
options.EnableJob = true;
|
||||
options.ConfigureSimApiJob(job =>
|
||||
{
|
||||
job.DashboardUrl = "/jobs"; // null = 不开启
|
||||
job.DashboardAuthUser = "admin";
|
||||
job.DashboardAuthPass = "pass";
|
||||
job.Database = 1; // Redis DB 编号
|
||||
job.Servers = [
|
||||
new() { Queues = ["default"], WorkerNum = 5 },
|
||||
new() { Queues = ["email"], WorkerNum = 2 }
|
||||
];
|
||||
});
|
||||
```
|
||||
|
||||
```csharp
|
||||
BackgroundJob.Enqueue(() => DoWork());
|
||||
BackgroundJob.Schedule(() => DoWork(), TimeSpan.FromMinutes(5));
|
||||
RecurringJob.AddOrUpdate("id", () => DoWork(), Cron.Daily);
|
||||
BackgroundJob.ContinueJobWith(id, () => Step2());
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. MQTT 通信 — EnableSynapse
|
||||
|
||||
基于 MQTTnet v5,WebSocket 连接。
|
||||
|
||||
### 配置
|
||||
|
||||
```csharp
|
||||
options.EnableSynapse = true;
|
||||
options.ConfigureSimApiSynapse(s =>
|
||||
{
|
||||
s.Websocket = "ws://mqtt:8083/mqtt";
|
||||
s.Username = "user";
|
||||
s.Password = "pass";
|
||||
s.SysName = "my-system";
|
||||
s.AppName = "order-service";
|
||||
s.AppId = "instance-001"; // 不填自动GUID
|
||||
s.RpcTimeout = 3; // 秒
|
||||
s.EventLoadBalancing = false; // $queue 负载均衡
|
||||
s.EnableConfigStore = true; // 分布式配置中心
|
||||
});
|
||||
```
|
||||
|
||||
### Topic 规则
|
||||
|
||||
| 用途 | Topic 格式 |
|
||||
| -------- | ------------------------------------------------------ |
|
||||
| 事件发布 | `{SysName}/event/{AppName}/{eventName}` |
|
||||
| 事件订阅 | `{SysName}/event/{eventName}` (或 `$queue/` 前缀) |
|
||||
| RPC 请求 | `{SysName}/{targetApp}/rpc/server/{method}` |
|
||||
| RPC 响应 | `{SysName}/{callerApp}/rpc/client/{AppId}/{messageId}` |
|
||||
| 配置 | `{SysName}/synapse-config-store/{key}` (Retain) |
|
||||
|
||||
### API
|
||||
|
||||
```csharp
|
||||
// 事件
|
||||
bool Event(string eventName, dynamic? param = null);
|
||||
|
||||
// RPC (同步)
|
||||
SimApiBaseResponse<T> Rpc<T>(string appName, string method, dynamic? param = null,
|
||||
Dictionary<string, string>? headers = null, int? timeout = null);
|
||||
|
||||
// RPC 内报错
|
||||
void RpcError(int code, string message = "");
|
||||
void RpcErrorWhen(bool condition, int code, string message = "");
|
||||
|
||||
// 分布式配置
|
||||
bool SetConfig(string key, string value);
|
||||
string? GetConfig(string key);
|
||||
```
|
||||
|
||||
### 处理器扫描(自动注册)
|
||||
|
||||
带 `[SynapseRpc]` / `[SynapseEvent]` 的类自动扫描注册为 Scoped 服务。
|
||||
|
||||
---
|
||||
|
||||
## 12. AES 加解密 — SimApiAesUtil
|
||||
|
||||
AES-256-CBC + PKCS7,密钥经 SHA256 处理。
|
||||
|
||||
```csharp
|
||||
string cipher = SimApiAesUtil.Encrypt("明文", "任意长度密钥");
|
||||
string plain = SimApiAesUtil.Decrypt(cipher, "任意长度密钥");
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 13. 工具集 — SimApiUtil
|
||||
|
||||
```csharp
|
||||
DateTime CstNow; // UTC+8
|
||||
double TimestampNow; // 秒级 Unix
|
||||
string SimApiVersion; // NuGet 包版本
|
||||
string AppVersion; // 宿主应用版本
|
||||
|
||||
string Md5(string src, string mode = "x2"); // x2=32位, x3=48位, x4=64位
|
||||
string Sha1(string src, string mode = "x2");
|
||||
string Base64Encode(string str);
|
||||
string Base64Decode(string base64Str);
|
||||
string Base64Encode(object obj);
|
||||
T? Base64Decode<T>(string base64Str);
|
||||
|
||||
string Json(object? obj); // camelCase,中文不转义
|
||||
T? FromJson<T>(string json);
|
||||
T XmlDeserialize<T>(string xml);
|
||||
JsonSerializerOptions JsonOption; // 可复用
|
||||
|
||||
bool CheckCell(string cell); // 手机号验证
|
||||
bool CheckEmail(string email);
|
||||
|
||||
IQueryable<T> Paginate<T>(this IQueryable<T> query, int page, int count);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 14. 数据模型 — SimApiBaseModel
|
||||
|
||||
```csharp
|
||||
public class UserEntity : SimApiBaseModel
|
||||
{
|
||||
// 自动: Id(GUID string), CreatedAt, UpdatedAt
|
||||
// 默认忽略映射: Id, CreatedAt, UpdatedAt
|
||||
}
|
||||
|
||||
void MapData<TS>(TS source, bool mapAll = false); // 同名同类型非null属性
|
||||
void MapData<TS>(TS source, string[] mapFields); // 指定字段
|
||||
void UpdateTime();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 15. DTO 规范
|
||||
|
||||
| 类型 | 命名 | 示例 |
|
||||
| ---- | ----------------- | ----------------- |
|
||||
| 请求 | `[动作]Request` | `UserEditRequest` |
|
||||
| 响应 | `[动作]Response` | `TokenResponse` |
|
||||
| 载体 | `[含义]Data/Item` | `GenerateData` |
|
||||
|
||||
### 框架内置 DTO
|
||||
|
||||
```csharp
|
||||
class SimApiStringIdOnlyRequest { required string Id; }
|
||||
class SimApiOneFieldRequest<T> { T? Data; }
|
||||
class SimApiBasePageRequest { int Page = 1; int Count = 20; }
|
||||
class SimApiBaseResponse { int Code; string Message; } // code=200 默认
|
||||
class SimApiBaseResponse<T> : SimApiBaseResponse { T? Data; }
|
||||
class PageResponse<T> { T? List; int Page; int Count; int Total; }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 16. SimApiOptions 完整配置
|
||||
|
||||
```csharp
|
||||
builder.Services.AddSimApi(options =>
|
||||
{
|
||||
options.RedisConfiguration = "localhost:6379";
|
||||
|
||||
// 功能开关
|
||||
options.EnableSimApiAuth = false; // Token 认证
|
||||
options.EnableSimApiCache = true; // 缓存(Redis 或 InMemory)
|
||||
options.EnableSimApiAuthGate = false; // Auth Center 网关鉴权
|
||||
options.EnableSimApiDoc = false; // Swagger 文档
|
||||
options.EnableSimApiStorage = false; // S3 存储
|
||||
options.EnableJob = false; // Hangfire
|
||||
options.EnableSynapse = false; // MQTT
|
||||
options.EnableSimApiHttpClient = false; // 外部 HTTP 调用
|
||||
options.EnableLogger = true; // 控制台日志
|
||||
options.EnableCors = true; // 全量 CORS
|
||||
options.EnableSimApiException = true; // 全局异常拦截
|
||||
options.EnableSimApiResponseFilter = true; // 响应统一封装
|
||||
options.EnableForwardHeaders = true; // 反向代理 Header
|
||||
options.EnableLowerUrl = true; // URL 小写
|
||||
|
||||
// 子模块配置
|
||||
options.ConfigureSimApiDoc(doc => { ... });
|
||||
options.ConfigureSimApiStorage(s => { ... });
|
||||
options.ConfigureSimApiJob(job => { ... });
|
||||
options.ConfigureSimApiSynapse(s => { ... });
|
||||
options.ConfigureSimApiAuthCenter(gate => { ... });
|
||||
options.ConfigureSimApiHttpClient(http => { ... });
|
||||
options.ConfigureSimApiRoute(route => { ... });
|
||||
options.ConfigureSimApiException(ex => { ... });
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 17. GOTCHAS — 常见错误
|
||||
|
||||
| ❌ 错误 | ✅ 正确 |
|
||||
| ------------------------------------------------------ | ------------------------------------------- |
|
||||
| 存储路径 `avatars/file.jpg`(无前导 `/`) | 必须以 **`/`** 开头 |
|
||||
| `s.Endpoint = "http://x:9000/"` | **不能以 `/` 结尾** |
|
||||
| `synapse.PublishEvent(...)` | 方法名是 **`synapse.Event(...)`** |
|
||||
| `synapse.CallRpcAsync(...)` | 方法名是 **`synapse.Rpc<T>(...)`** |
|
||||
| HTTP 4xx/5xx 状态码 | 永远 **HTTP 200**,错误在 JSON code |
|
||||
| `SupportedMethod` 写多种方法 | 默认仅 **POST** |
|
||||
| `SimApiStorageOptions = Configuration.GetSection(...)` | 用 **`ConfigureSimApiStorage(s => {...})`** |
|
||||
| 代码中 `LoginInfo.Type.Contains("admin")` | 用 `[SimApiAuth("admin")]` |
|
||||
| `return ActionResult<T>` | 直接返回 Entity / void |
|
||||
---
|
||||
|
||||
## 18. 禁止事项
|
||||
|
||||
| ❌ 禁止 | ✅ 正确 |
|
||||
| --------------------------------------- | ----------------------------------------------------- |
|
||||
| HTTP 4xx/5xx 表达业务错误 | HTTP 200 + JSON `code` |
|
||||
| `throw new Exception(msg)` | `ErrorWhen` 或 `throw new SimApiException(code, msg)` |
|
||||
| 鉴权 Attribute 只放方法 | 可以放 Controller **类**上 |
|
||||
| 手动判断 `LoginInfo.Type.Contains(...)` | `[SimApiAuth("role")]` |
|
||||
| Entity 配导航属性 / Fluent API | Convention 自动映射 |
|
||||
| 花括号块命名空间 | 文件范围 `namespace X;` |
|
||||
| 传统构造函数注入 | 主构造函数 |
|
||||
| `new List<T>()` / `new string[]{}` | `[]` 集合表达式 |
|
||||
| `Count() > 0` | `Any()` |
|
||||
| `ToList()` → 数组 | 直接 `ToArray()` |
|
||||
| 全局 catch 吞异常 | 让异常冒泡到 SimApiExceptionMiddleware |
|
||||
|
||||
+12
-30
@@ -1,42 +1,24 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
<Version>0.2.3</Version>
|
||||
<IsPackable>true</IsPackable>
|
||||
<Version>0.0.0</Version>
|
||||
<Authors>xRain@SimcuTeam</Authors>
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>Simcu.SimApi</PackageId>
|
||||
<IsPackable>true</IsPackable>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<IncludeSymbols>true</IncludeSymbols>
|
||||
<ReleaseVersion>5.0.0</ReleaseVersion>
|
||||
<SynchReleaseVersion>false</SynchReleaseVersion>
|
||||
<Nullable>enable</Nullable>
|
||||
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
<PackageVersion>5.0.2</PackageVersion>
|
||||
<TargetFramework>net8.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Folder Include="Helpers\"/>
|
||||
<Folder Include="Communications\"/>
|
||||
<Folder Include="Controllers\"/>
|
||||
<Folder Include="Middlewares\"/>
|
||||
<Folder Include="Exceptions\"/>
|
||||
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.23" />
|
||||
<PackageReference Include="Hangfire.Console" Version="1.4.3"/>
|
||||
<PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0"/>
|
||||
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="10.0.9" />
|
||||
<PackageReference Include="Minio" Version="7.0.0" />
|
||||
<PackageReference Include="MQTTnet" Version="5.1.0.1559" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="10.2.3" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.2.3" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Minio" Version="4.0.7"/>
|
||||
<PackageReference Include="RabbitMQ.Client" Version="6.6.0"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0"/>
|
||||
</ItemGroup>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical"/>
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
</Project>
|
||||
|
||||
+350
-68
@@ -1,13 +1,27 @@
|
||||
using System;
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Text.Json;
|
||||
using Hangfire;
|
||||
using Hangfire.Console;
|
||||
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;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.AuthSDK;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Interfaces;
|
||||
using SimApi.Logger;
|
||||
using SimApi.SwaggerFilters;
|
||||
using StackExchange.Redis;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
@@ -18,10 +32,29 @@ public static class SimApiExtensions
|
||||
{
|
||||
//**********快捷添加**************
|
||||
public static IServiceCollection AddSimApi(this IServiceCollection builder,
|
||||
Action<SimApiOptions> options = null)
|
||||
Action<SimApiOptions>? options = null)
|
||||
{
|
||||
var simApiOptions = new SimApiOptions();
|
||||
options?.Invoke(simApiOptions);
|
||||
simApiOptions.WebConfig ??= new();
|
||||
builder.AddSingleton(simApiOptions);
|
||||
|
||||
if (simApiOptions.RedisConfiguration != null)
|
||||
{
|
||||
builder.AddStackExchangeRedisCache(x => x.Configuration = simApiOptions.RedisConfiguration);
|
||||
builder.AddSingleton<IConnectionMultiplexer>(_ =>
|
||||
ConnectionMultiplexer.Connect(simApiOptions.RedisConfiguration));
|
||||
}
|
||||
else if (simApiOptions.EnableSimApiAuth || simApiOptions.EnableSimApiCache)
|
||||
{
|
||||
builder.AddDistributedMemoryCache();
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSimApiCache)
|
||||
{
|
||||
builder.AddSingleton<SimApiCache>();
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableLogger)
|
||||
{
|
||||
builder.AddLogging(logger =>
|
||||
@@ -37,15 +70,66 @@ public static class SimApiExtensions
|
||||
builder.AddSingleton<SimApiAuth>();
|
||||
}
|
||||
|
||||
var simApiAuthChecker = typeof(ISimApiAuthChecker);
|
||||
var stackTrace = new StackTrace();
|
||||
var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1)?.GetMethod();
|
||||
var callerAssembly = callingMethod?.DeclaringType?.Assembly;
|
||||
var callerTypes = callerAssembly?.GetTypes() ?? [];
|
||||
|
||||
foreach (var type in callerTypes)
|
||||
{
|
||||
if (type is { IsClass: true, IsAbstract: false } && simApiAuthChecker.IsAssignableFrom(type))
|
||||
{
|
||||
builder.AddScoped(simApiAuthChecker, type);
|
||||
}
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableJob)
|
||||
{
|
||||
builder.AddHangfire(x =>
|
||||
{
|
||||
var redisOption = new RedisStorageOptions();
|
||||
if (simApiOptions.SimApiJobOptions.Database.HasValue)
|
||||
{
|
||||
redisOption.Db = simApiOptions.SimApiJobOptions.Database.Value;
|
||||
}
|
||||
|
||||
x.UseRedisStorage(simApiOptions.SimApiJobOptions.RedisConfiguration ??
|
||||
simApiOptions.RedisConfiguration, redisOption);
|
||||
x.UseConsole();
|
||||
});
|
||||
foreach (var server in simApiOptions.SimApiJobOptions.Servers)
|
||||
{
|
||||
builder.AddHangfireServer(hfs =>
|
||||
{
|
||||
hfs.Queues = server.Queues;
|
||||
hfs.WorkerCount = server.WorkerNum;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableCors)
|
||||
{
|
||||
builder.AddCors(cors => cors.AddPolicy("any",
|
||||
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSimApiHttpClient)
|
||||
{
|
||||
builder.AddSingleton<SimApiHttpClient>();
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSynapse)
|
||||
{
|
||||
builder.AddSingleton<Synapse>();
|
||||
foreach (var type in callerTypes)
|
||||
{
|
||||
var methodsWithSynapse = type.GetMethods()
|
||||
.Where(m => m.GetCustomAttribute<SynapseRpcAttribute>() != null ||
|
||||
m.GetCustomAttribute<SynapseEventAttribute>() != null);
|
||||
if (!methodsWithSynapse.Any()) continue;
|
||||
builder.AddScoped(type);
|
||||
}
|
||||
}
|
||||
|
||||
// 使用SimApiDoc
|
||||
@@ -63,30 +147,117 @@ public static class SimApiExtensions
|
||||
});
|
||||
}
|
||||
|
||||
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.SchemaFilter<DictionarySchemaFilter>();
|
||||
x.DocumentFilter<RemoveEmptyTagsFilter>();
|
||||
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();
|
||||
var haveOauth = false;
|
||||
var haveSimApiAuth = false;
|
||||
var oauthFlows = new OpenApiOAuthFlows();
|
||||
foreach (var auth in docOptions.ApiAuth.Type)
|
||||
{
|
||||
switch (auth)
|
||||
{
|
||||
case "SimApiAuth":
|
||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
||||
{
|
||||
x.AddSecurityDefinition("SimApiAuth",
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Reference = new OpenApiReference
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "HeaderToken"
|
||||
}
|
||||
},
|
||||
new[] { "readAccess", "writeAccess" }
|
||||
}
|
||||
});
|
||||
haveSimApiAuth = true;
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header,
|
||||
Type = SecuritySchemeType.ApiKey
|
||||
});
|
||||
break;
|
||||
case "ClientCredentials":
|
||||
oauthFlows.ClientCredentials = new OpenApiOAuthFlow
|
||||
@@ -135,30 +306,6 @@ public static class SimApiExtensions
|
||||
Description = docOptions.ApiAuth.Description,
|
||||
In = ParameterLocation.Header
|
||||
});
|
||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
||||
{
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Reference = new OpenApiReference
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "oauth2"
|
||||
}
|
||||
},
|
||||
new[] { "SimApiAuth" }
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (haveSimApiAuth)
|
||||
{
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
@@ -185,7 +332,74 @@ public static class SimApiExtensions
|
||||
builder.AddSingleton<SimApiStorage>();
|
||||
}
|
||||
|
||||
builder.AddSingleton(simApiOptions);
|
||||
if (simApiOptions.EnableSimApiResponseFilter)
|
||||
{
|
||||
builder.AddControllers(opt => opt.Filters.Add<SimApiResponseFilter>())
|
||||
.AddJsonOptions(opt =>
|
||||
{
|
||||
opt.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
|
||||
});
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSimApiAuthGate)
|
||||
{
|
||||
builder.AddSingleton<SimApiAuthClient>();
|
||||
builder.AddSingleton<SimApiAuthCenter>();
|
||||
if (simApiOptions.SimApiAuthCenterOptions.UseIam)
|
||||
{
|
||||
builder.AddSingleton<SimApiAuthIam>();
|
||||
}
|
||||
}
|
||||
|
||||
builder.AddSingleton(simApiOptions.SimApiRequestLogOptions);
|
||||
return builder;
|
||||
}
|
||||
|
||||
public static IHost UseSimApi(this IHost builder)
|
||||
{
|
||||
var options = builder.Services.GetRequiredService<SimApiOptions>();
|
||||
|
||||
var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
|
||||
|
||||
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
|
||||
logger.LogInformation("主应用版本: {AppVersion}\nSimApi版本: {SimApiVersion}", SimApiUtil.AppVersion,
|
||||
SimApiUtil.SimApiVersion);
|
||||
|
||||
if (options.RedisConfiguration != null)
|
||||
{
|
||||
logger.LogInformation("开始配置 RedisCache ...");
|
||||
}
|
||||
|
||||
if (options.EnableSimApiCache)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiCache...");
|
||||
}
|
||||
|
||||
//请求一下检测存储错误
|
||||
if (options.EnableSimApiStorage)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiStorage...");
|
||||
builder.Services.GetService<SimApiStorage>();
|
||||
}
|
||||
|
||||
if (options.EnableSimApiHttpClient)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiHttpClient...\n服务器地址: {ApiUrl}\nAppId:{AuthUrl}n\nAppkey: {AppId}",
|
||||
options.SimApiHttpClientOptions.Server, options.SimApiHttpClientOptions.AppId,
|
||||
!string.IsNullOrEmpty(options.SimApiHttpClientOptions.AppKey));
|
||||
}
|
||||
|
||||
if (options.EnableSynapse)
|
||||
{
|
||||
var synapse = builder.Services.GetRequiredService<Synapse>();
|
||||
synapse.Init();
|
||||
}
|
||||
|
||||
if (options.EnableJob)
|
||||
{
|
||||
logger.LogInformation("开始配置 SimApiJob ...");
|
||||
}
|
||||
|
||||
return builder;
|
||||
}
|
||||
|
||||
@@ -194,13 +408,11 @@ public static class SimApiExtensions
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
|
||||
public static WebApplication UseSimApi(this WebApplication builder)
|
||||
{
|
||||
var options = builder.ApplicationServices.GetRequiredService<SimApiOptions>();
|
||||
|
||||
var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiOptions>>();
|
||||
|
||||
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
|
||||
var options = builder.Services.GetRequiredService<SimApiOptions>();
|
||||
var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
|
||||
UseSimApi((IHost)builder);
|
||||
if (options.EnableForwardHeaders)
|
||||
{
|
||||
logger.LogInformation("开始配置ForwardedHeaders...");
|
||||
@@ -213,28 +425,98 @@ public static class SimApiExtensions
|
||||
builder.UseCors("any");
|
||||
}
|
||||
|
||||
if (options.EnableSimApiResponseFilter)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiResponseFilter...");
|
||||
builder.MapControllers();
|
||||
}
|
||||
|
||||
var checkers = builder.Services.CreateScope().ServiceProvider.GetServices<ISimApiAuthChecker>().ToArray();
|
||||
if (checkers.Length != 0)
|
||||
{
|
||||
var msg = checkers.Aggregate("开始配置SimApiAuthChecker...",
|
||||
(current, checker) => current + $"\n|- {checker.GetType().FullName}");
|
||||
logger.LogInformation(msg);
|
||||
}
|
||||
|
||||
if (options.EnableSimApiAuthGate)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiAuthGate...");
|
||||
if (string.IsNullOrEmpty(options.SimApiAuthCenterOptions.AppId) ||
|
||||
string.IsNullOrEmpty(options.SimApiAuthCenterOptions.AppKey))
|
||||
{
|
||||
logger.LogCritical("必须配置AuthGate的AppId和AppKey才能启用SimApiAuthGate");
|
||||
}
|
||||
else
|
||||
{
|
||||
if (options.SimApiAuthCenterOptions.UseMiddleware)
|
||||
{
|
||||
builder.UseMiddleware<SimApiAuthCenterMiddleware>();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (options.EnableSimApiAuth)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiAuth...");
|
||||
builder.UseMiddleware<SimApiAuthMiddleware>();
|
||||
}
|
||||
|
||||
if (options.SimApiRouteOptions.UserInfoRoute != null)
|
||||
{
|
||||
logger.LogInformation("注册内置Route: UserInfo => {}", options.SimApiRouteOptions.UserInfoRoute);
|
||||
builder.MapControllerRoute(name: "UserInfo", pattern: options.SimApiRouteOptions.UserInfoRoute,
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiCommon",
|
||||
action = "UserInfo"
|
||||
});
|
||||
}
|
||||
|
||||
if (options.SimApiRouteOptions.LogoutRoute != null)
|
||||
{
|
||||
logger.LogInformation("注册内置Route: Logout => {}", options.SimApiRouteOptions.LogoutRoute);
|
||||
builder.MapControllerRoute(name: "Logout", pattern: options.SimApiRouteOptions.LogoutRoute,
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiAuth",
|
||||
action = "Logout"
|
||||
});
|
||||
}
|
||||
|
||||
if (options.SimApiRouteOptions.WebConfigRoute != null)
|
||||
{
|
||||
logger.LogInformation("注册内置Route: Logout => {}", options.SimApiRouteOptions.WebConfigRoute);
|
||||
builder.MapControllerRoute(name: "WebConfig", pattern: options.SimApiRouteOptions.WebConfigRoute,
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiCommon",
|
||||
action = "WebConfig"
|
||||
});
|
||||
}
|
||||
|
||||
if (options.EnableSimApiDoc)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiDoc...");
|
||||
var docOptions = options.SimApiDocOptions;
|
||||
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
|
||||
{
|
||||
x.DocumentTitle = docOptions.DocumentTitle;
|
||||
foreach (var group in docOptions.ApiGroups)
|
||||
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json")
|
||||
.UseSwaggerUI(x =>
|
||||
{
|
||||
x.SwaggerEndpoint($"/swagger/{group.Id}.json", name: group.Name);
|
||||
}
|
||||
x.DocumentTitle = docOptions.DocumentTitle;
|
||||
foreach (var group in docOptions.ApiGroups)
|
||||
{
|
||||
x.SwaggerEndpoint($"{group.Id}.json", name: group.Name);
|
||||
}
|
||||
|
||||
x.EnableValidator();
|
||||
x.SupportedSubmitMethods(docOptions.SupportedMethod);
|
||||
x.DisplayRequestDuration();
|
||||
});
|
||||
x.SupportedSubmitMethods(docOptions.SupportedMethod);
|
||||
x.DisplayRequestDuration();
|
||||
});
|
||||
}
|
||||
|
||||
if (options.EnableRequestLog)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiRequestLog...");
|
||||
builder.UseMiddleware<SimApiRequestLogMiddleware>();
|
||||
}
|
||||
|
||||
if (options.EnableSimApiException)
|
||||
@@ -243,22 +525,22 @@ public static class SimApiExtensions
|
||||
builder.UseMiddleware<SimApiExceptionMiddleware>();
|
||||
}
|
||||
|
||||
//请求一下检测存储错误
|
||||
if (options.EnableSimApiStorage)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiStorage...");
|
||||
builder.ApplicationServices.GetService<SimApiStorage>();
|
||||
}
|
||||
|
||||
if (options.EnableLowerUrl)
|
||||
{
|
||||
logger.LogInformation("开始配置使用URL小写...");
|
||||
}
|
||||
|
||||
if (options.EnableSynapse)
|
||||
if (options is { EnableJob: true, SimApiJobOptions.DashboardUrl: not null })
|
||||
{
|
||||
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
|
||||
synapse.Init();
|
||||
logger.LogInformation("开始配置 SimApiJob Web控制台...");
|
||||
builder.UseHangfireDashboard(options.SimApiJobOptions.DashboardUrl, new DashboardOptions
|
||||
{
|
||||
Authorization =
|
||||
[
|
||||
new SimApiJobWebAuth(options.SimApiJobOptions.DashboardAuthUser,
|
||||
options.SimApiJobOptions.DashboardAuthPass)
|
||||
]
|
||||
});
|
||||
}
|
||||
|
||||
return builder;
|
||||
|
||||
@@ -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,24 @@
|
||||
using System.Collections.Generic;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
public class DictionarySchemaFilter : ISchemaFilter
|
||||
{
|
||||
public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
|
||||
{
|
||||
if (!context.Type.IsGenericType || context.Type.GetGenericTypeDefinition() != typeof(Dictionary<,>))
|
||||
return;
|
||||
|
||||
if (schema is not OpenApiSchema concrete) return;
|
||||
|
||||
var valueType = context.Type.GetGenericArguments()[1];
|
||||
concrete.Type = JsonSchemaType.Object;
|
||||
concrete.AdditionalPropertiesAllowed = true;
|
||||
concrete.AdditionalProperties = context.SchemaGenerator.GenerateSchema(valueType, context.SchemaRepository);
|
||||
concrete.Properties?.Clear();
|
||||
concrete.Example = null;
|
||||
concrete.Examples?.Clear();
|
||||
}
|
||||
}
|
||||
@@ -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), [] }
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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 // 签名相关参数通常为字符串类型
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using MQTTnet;
|
||||
using MQTTnet.Protocol;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
public event EventHandler<ConfigStoreItem>? OnConfigChanged;
|
||||
private Dictionary<string, string> CurrentConfig { get; } = new();
|
||||
|
||||
private string ConfigStoreTopicPrefix => $"{Options.SysName}/synapse-config-store/";
|
||||
|
||||
private bool FireSetConfig(string key, string value)
|
||||
{
|
||||
if (key.Contains('#') || key.Contains('+')) return false;
|
||||
var topic = $"{Options.SysName}/synapse-config-store/{key}";
|
||||
var message = new MqttApplicationMessageBuilder()
|
||||
.WithTopic(topic)
|
||||
.WithPayload(value)
|
||||
.WithRetainFlag()
|
||||
.Build();
|
||||
if (!Client!.IsConnected) return false;
|
||||
Client!.PublishAsync(message, CancellationToken.None).Wait();
|
||||
logger.LogDebug("Synapse Config Set: {Config} => {Data}", key, value);
|
||||
return true;
|
||||
}
|
||||
|
||||
private string? FireGetConfig(string key)
|
||||
{
|
||||
return CurrentConfig.GetValueOrDefault(key);
|
||||
}
|
||||
|
||||
private void RunConfigStoreServer()
|
||||
{
|
||||
Client!.ApplicationMessageReceivedAsync += e =>
|
||||
{
|
||||
if (!e.ApplicationMessage.Topic.StartsWith(ConfigStoreTopicPrefix)) return Task.CompletedTask;
|
||||
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
|
||||
var eventName = e.ApplicationMessage.Topic.Replace(ConfigStoreTopicPrefix, string.Empty);
|
||||
CurrentConfig[eventName] = reqBody;
|
||||
OnConfigChanged?.Invoke(this, new ConfigStoreItem(eventName, reqBody));
|
||||
logger.LogDebug("Synapse Config Changed: {Config} => {Data}", eventName, reqBody);
|
||||
return Task.CompletedTask;
|
||||
};
|
||||
SubConfigStoreServerTopic();
|
||||
}
|
||||
|
||||
private void SubConfigStoreServerTopic()
|
||||
{
|
||||
var csSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
|
||||
.WithTopicFilter(o =>
|
||||
o.WithTopic($"{ConfigStoreTopicPrefix}#").WithRetainHandling(MqttRetainHandling.SendAtSubscribe))
|
||||
.Build();
|
||||
Client!.SubscribeAsync(csSubOpts).Wait();
|
||||
}
|
||||
|
||||
public record ConfigStoreItem(string Key, string Value);
|
||||
}
|
||||
+22
-19
@@ -1,31 +1,34 @@
|
||||
using System;
|
||||
using System.Text;
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Json;
|
||||
using System.Text.Unicode;
|
||||
using System.Threading;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using MQTTnet;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private void RunEventClient()
|
||||
private bool FireEvent(string eventName, object? param)
|
||||
{
|
||||
EventClientChannel = CreateChannel(0, "EventClient");
|
||||
}
|
||||
string paramJson;
|
||||
if (param is string strParam)
|
||||
{
|
||||
paramJson = strParam;
|
||||
}
|
||||
else
|
||||
{
|
||||
paramJson = SimApiUtil.Json(param);
|
||||
}
|
||||
|
||||
private void FireEvent(string eventName, object param)
|
||||
{
|
||||
var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
|
||||
var router = $"event.{Options.AppName}.{eventName}";
|
||||
var props = EventClientChannel.CreateBasicProperties();
|
||||
props.AppId = Options.AppId;
|
||||
props.MessageId = Guid.NewGuid().ToString();
|
||||
props.ReplyTo = Options.AppName;
|
||||
props.Type = eventName;
|
||||
EventClientChannel.BasicPublish(Options.SysName, router, false, props, Encoding.UTF8.GetBytes(paramJson));
|
||||
Logger.LogDebug("Event Publish: {OptionsAppName}.{EventName}\n{ParamJson}", Options.AppName, eventName,
|
||||
paramJson);
|
||||
var topic = $"{Options.SysName}/event/{Options.AppName}/{eventName}";
|
||||
var message = new MqttApplicationMessageBuilder()
|
||||
.WithTopic(topic)
|
||||
.WithPayload(paramJson)
|
||||
.WithRetainFlag(false)
|
||||
.Build();
|
||||
if (!Client!.IsConnected) return false;
|
||||
Client.PublishAsync(message, CancellationToken.None).Wait();
|
||||
logger.LogDebug("Synapse Event Publish: {Event}@{App} {Json}", eventName, Options.AppName, paramJson);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
+60
-32
@@ -1,50 +1,78 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using RabbitMQ.Client.Events;
|
||||
using MQTTnet;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private string EventServerTopicPrefix => $"{Options.SysName}/event/";
|
||||
|
||||
private void RunEventServer()
|
||||
{
|
||||
EventServerChannel = CreateChannel(Options.EventProcessorNum, "EventServer");
|
||||
var queue = $"{Options.SysName}_{Options.AppName}_event";
|
||||
EventServerChannel.QueueDeclare(queue, true, false, true, null);
|
||||
foreach (var ev in EventRegistry.Where(ev => !ev.Key.Contains('*') && !ev.Key.Contains('#')))
|
||||
Client!.ApplicationMessageReceivedAsync += async e =>
|
||||
{
|
||||
EventServerChannel.QueueBind(queue, Options.SysName, $"event.{ev.Key}", null);
|
||||
}
|
||||
var consumer = new EventingBasicConsumer(EventServerChannel);
|
||||
consumer.Received += (ch, ea) =>
|
||||
{
|
||||
var reqBody = Encoding.UTF8.GetString(ea.Body.ToArray());
|
||||
Logger.LogDebug("Event Receive: {BasicPropertiesReplyTo}.{BasicPropertiesType}\n{S}",
|
||||
ea.BasicProperties.ReplyTo, ea.BasicProperties.Type, reqBody);
|
||||
|
||||
var key = ea.RoutingKey.Replace("event.", string.Empty);
|
||||
var method = EventRegistry.FirstOrDefault(x => x.Key == key);
|
||||
var callClass = Sp.CreateScope().ServiceProvider.GetRequiredService(method.Class);
|
||||
var mt = callClass.GetType().GetMethod(method.Method);
|
||||
var pt = mt.GetParameters()[0].ParameterType;
|
||||
try
|
||||
await Task.Run(async () =>
|
||||
{
|
||||
mt.Invoke(callClass, pt == typeof(string)
|
||||
? new object[] { reqBody }
|
||||
: new[] { JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption) });
|
||||
EventServerChannel.BasicAck(ea.DeliveryTag, false);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Logger.LogError("Event Processor Error: {Err}", e.InnerException);
|
||||
EventServerChannel.BasicNack(ea.DeliveryTag, false, false);
|
||||
}
|
||||
if (!e.ApplicationMessage.Topic.StartsWith(EventServerTopicPrefix)) return;
|
||||
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
|
||||
var eventName = e.ApplicationMessage.Topic.Replace(EventServerTopicPrefix, string.Empty);
|
||||
logger.LogDebug("Synapse Event Receive: {EventName}\n{Body}", eventName, reqBody);
|
||||
var methods = EventRegistry
|
||||
.Where(x => Regex.IsMatch(eventName,
|
||||
"^" + Regex.Escape(x.Key!).Replace("\\+", "[^/]+").Replace("\\#", ".*") + "$"))
|
||||
.ToArray();
|
||||
var tasks = methods.Select(method => Task.Run(() =>
|
||||
{
|
||||
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(method.Class!);
|
||||
var mt = callClass.GetType().GetMethod(method.Method!);
|
||||
try
|
||||
{
|
||||
if (mt!.GetParameters().Length == 2)
|
||||
{
|
||||
var pt = mt.GetParameters()[1].ParameterType;
|
||||
mt.Invoke(callClass, pt == typeof(string)
|
||||
? [eventName, reqBody]
|
||||
: [eventName, JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption)]);
|
||||
}
|
||||
else
|
||||
{
|
||||
mt.Invoke(callClass, new object[] { eventName });
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
logger.LogError("Synapse Event Processor Error: {Err}\n{Stack}", ex.Message, ex.StackTrace);
|
||||
}
|
||||
}))
|
||||
.ToList();
|
||||
await Task.WhenAll(tasks);
|
||||
});
|
||||
};
|
||||
EventServerChannel.BasicConsume(queue, false, "", false, false, null, consumer);
|
||||
SubEventServerTopic();
|
||||
}
|
||||
|
||||
private void SubEventServerTopic()
|
||||
{
|
||||
foreach (var ev in EventRegistry)
|
||||
{
|
||||
var topic = $"{EventServerTopicPrefix}{ev.Key}";
|
||||
if (Options.EventLoadBalancing)
|
||||
{
|
||||
topic = "$queue/" + topic;
|
||||
}
|
||||
|
||||
var evSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
|
||||
.WithTopicFilter(o => o.WithTopic(topic)).Build();
|
||||
Client!.SubscribeAsync(evSubOpts).Wait();
|
||||
logger.LogDebug("Synapse Event Register Event Success: {EventName}\nFull Topic: {Topic}", ev.Key, topic);
|
||||
}
|
||||
}
|
||||
}
|
||||
+73
-42
@@ -1,70 +1,101 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Text;
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Json;
|
||||
using System.Text.Unicode;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Newtonsoft.Json.Serialization;
|
||||
using RabbitMQ.Client.Events;
|
||||
using MQTTnet;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
using System.Collections.Concurrent;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private Dictionary<string, byte[]> ResponseCache { get; } = new();
|
||||
private ConcurrentDictionary<string, TaskCompletionSource<string>> ResponseCompletionSources { get; } = new();
|
||||
|
||||
private string EventClientTopicPrefix => $"{Options.SysName}/{Options.AppName}/rpc/client/{Options.AppId}/";
|
||||
|
||||
private void RunRpcClient()
|
||||
{
|
||||
RpcClientChannel = CreateChannel(0, "RpcClient");
|
||||
var queue = $"{Options.SysName}_{Options.AppName}_client_{Options.AppId}";
|
||||
var router = $"client.{Options.AppName}.{Options.AppId}";
|
||||
RpcClientChannel.QueueDeclare(queue, true, false, true, null);
|
||||
RpcClientChannel.QueueBind(queue, Options.SysName, router, null);
|
||||
var consumer = new EventingBasicConsumer(RpcClientChannel);
|
||||
consumer.Received += (ch, ea) =>
|
||||
Client!.ApplicationMessageReceivedAsync += e =>
|
||||
{
|
||||
ResponseCache.Add(ea.BasicProperties.CorrelationId, ea.Body.ToArray());
|
||||
RpcClientChannel.BasicAck(ea.DeliveryTag, false);
|
||||
Logger.LogDebug(
|
||||
"RPC Response: ({BasicPropertiesCorrelationId}) {BasicPropertiesType}@{BasicPropertiesReplyTo} -> {OptionsAppName}\n{S}",
|
||||
ea.BasicProperties.CorrelationId, ea.BasicProperties.Type, ea.BasicProperties.ReplyTo, Options.AppName,
|
||||
Encoding.UTF8.GetString(ea.Body.ToArray()));
|
||||
if (!e.ApplicationMessage.Topic.StartsWith(EventClientTopicPrefix)) return Task.CompletedTask;
|
||||
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
|
||||
var messageId = e.ApplicationMessage.Topic.Replace(EventClientTopicPrefix, string.Empty);
|
||||
if (!ResponseCompletionSources.TryGetValue(messageId, out var tcs)) return Task.CompletedTask;
|
||||
tcs.SetResult(reqBody);
|
||||
ResponseCompletionSources.Remove(messageId, out _);
|
||||
return Task.CompletedTask;
|
||||
};
|
||||
RpcClientChannel.BasicConsume(queue, false, "", false, false, null, consumer);
|
||||
SubRpcClientTopic();
|
||||
}
|
||||
|
||||
private string FireRpc(string app, string action, object param)
|
||||
private void SubRpcClientTopic()
|
||||
{
|
||||
var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
|
||||
var router = $"server.{app}";
|
||||
string response;
|
||||
var props = RpcClientChannel.CreateBasicProperties();
|
||||
props.AppId = Options.AppId;
|
||||
props.MessageId = Guid.NewGuid().ToString();
|
||||
props.Type = action;
|
||||
props.ReplyTo = Options.AppName;
|
||||
RpcClientChannel.BasicPublish(Options.SysName, router, false, props, Encoding.UTF8.GetBytes(paramJson));
|
||||
Logger.LogDebug("RPC Request: ({PropsMessageId}) {OptionsAppName} -> {Action}@{App}\n{ParamJson}",
|
||||
props.MessageId,
|
||||
Options.AppName, action, app, paramJson);
|
||||
var ts = SimApiUtil.TimestampNow;
|
||||
while (true)
|
||||
var rcSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
|
||||
.WithTopicFilter(o => o.WithTopic($"{EventClientTopicPrefix}+")).Build();
|
||||
Client!.SubscribeAsync(rcSubOpts).Wait();
|
||||
}
|
||||
|
||||
private string? FireRpc(string app, string action, object? param, Dictionary<string, string>? headers = null,
|
||||
int? timeout = null)
|
||||
{
|
||||
// 移除锁语句
|
||||
string paramJson;
|
||||
if (param is string strParam)
|
||||
{
|
||||
if (SimApiUtil.TimestampNow - ts > Options.RpcTimeout)
|
||||
paramJson = strParam;
|
||||
}
|
||||
else
|
||||
{
|
||||
paramJson = SimApiUtil.Json(param);
|
||||
}
|
||||
|
||||
var topic = $"{Options.SysName}/{app}/rpc/server/{action}";
|
||||
var messageId = Guid.NewGuid().ToString();
|
||||
var tcs = new TaskCompletionSource<string>();
|
||||
ResponseCompletionSources.TryAdd(messageId, tcs);
|
||||
var messageBuilder = new MqttApplicationMessageBuilder()
|
||||
.WithTopic(topic)
|
||||
.WithPayload(paramJson)
|
||||
.WithResponseTopic($"{Options.AppName},{Options.AppId},{messageId}")
|
||||
.WithContentType("application/json")
|
||||
.WithRetainFlag(false);
|
||||
foreach (var h in headers ?? new Dictionary<string, string>())
|
||||
{
|
||||
messageBuilder.WithUserProperty(h.Key, h.Value);
|
||||
}
|
||||
|
||||
var message = messageBuilder.Build();
|
||||
if (!Client!.IsConnected) return null;
|
||||
Client.PublishAsync(message, CancellationToken.None).Wait();
|
||||
logger.LogDebug(
|
||||
"Synapse RPC Client Request: ({PropsMessageId}) {OptionsAppName} -> {Action}@{App}\n{ParamJson}\nHeaders: {Headers}",
|
||||
messageId, Options.AppName, action, app, paramJson, SimApiUtil.Json(headers));
|
||||
|
||||
string response;
|
||||
try
|
||||
{
|
||||
timeout ??= Options.RpcTimeout;
|
||||
if (tcs.Task.Wait(timeout.Value * 1000))
|
||||
{
|
||||
response = JsonSerializer.Serialize(new SimApiBaseResponse(502, "timeout"), SimApiUtil.JsonOption);
|
||||
break;
|
||||
response = tcs.Task.Result;
|
||||
logger.LogDebug(
|
||||
"Synapse RPC Client Response: ({BasicPropertiesCorrelationId}) {BasicPropertiesType}@{BasicPropertiesReplyTo} -> {OptionsAppName}\n{S}",
|
||||
messageId, action, app, Options.AppName, response);
|
||||
}
|
||||
if (ResponseCache.TryGetValue(props.MessageId, out var value))
|
||||
else
|
||||
{
|
||||
response = Encoding.UTF8.GetString(value);
|
||||
ResponseCache.Remove(props.MessageId);
|
||||
break;
|
||||
response = SimApiUtil.Json(new SimApiBaseResponse(502, "timeout"));
|
||||
}
|
||||
}
|
||||
catch
|
||||
{
|
||||
response = SimApiUtil.Json(new SimApiBaseResponse(500, "Synapse RPC Client Error"));
|
||||
}
|
||||
|
||||
return response;
|
||||
}
|
||||
}
|
||||
+96
-65
@@ -1,93 +1,124 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using RabbitMQ.Client.Events;
|
||||
using MQTTnet;
|
||||
using MQTTnet.Protocol;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Helpers;
|
||||
using JsonSerializer = System.Text.Json.JsonSerializer;
|
||||
using System.Text.Json;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private string RpcServerTopicPrefix => $"{Options.SysName}/{Options.AppName}/rpc/server/";
|
||||
|
||||
private void RunRpcServer()
|
||||
{
|
||||
RpcServerChannel = CreateChannel(Options.RpcProcessorNum, "RpcServer");
|
||||
var queue = $"{Options.SysName}_{Options.AppName}_server";
|
||||
var router = $"server.{Options.AppName}";
|
||||
RpcServerChannel.QueueDeclare(queue, true, false, true, null);
|
||||
RpcServerChannel.QueueBind(queue, Options.SysName, router, null);
|
||||
var consumer = new EventingBasicConsumer(RpcServerChannel);
|
||||
consumer.Received += (ch, ea) =>
|
||||
Client!.ApplicationMessageReceivedAsync += async e =>
|
||||
{
|
||||
var reqBody = Encoding.UTF8.GetString(ea.Body.ToArray());
|
||||
Logger.LogDebug(
|
||||
"RPC Receive: ({BasicPropertiesMessageId}) {BasicPropertiesReplyTo} -> {BasicPropertiesType}@{OptionsAppName}\n{S}",
|
||||
ea.BasicProperties.MessageId, ea.BasicProperties.ReplyTo, ea.BasicProperties.Type, Options.AppName,
|
||||
reqBody);
|
||||
var res = new SimApiBaseResponse(404, "method not found");
|
||||
var method = RpcRegistry.FirstOrDefault(x => x.Key == ea.BasicProperties.Type);
|
||||
if (method != null)
|
||||
await Task.Run(() =>
|
||||
{
|
||||
var callClass = Sp.CreateScope().ServiceProvider.GetRequiredService(method.Class);
|
||||
var mt = callClass.GetType().GetMethod(method.Method);
|
||||
var param = Array.Empty<object>();
|
||||
try
|
||||
if (!e.ApplicationMessage.Topic.StartsWith(RpcServerTopicPrefix)) return;
|
||||
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
|
||||
var action = e.ApplicationMessage.Topic.Replace(RpcServerTopicPrefix, string.Empty);
|
||||
var appInfo = e.ApplicationMessage.ResponseTopic.Split(",");
|
||||
logger.LogDebug(
|
||||
"Synapse RPC Server Receive: ({BasicPropertiesMessageId}) {BasicPropertiesReplyTo} -> {BasicPropertiesType}@{OptionsAppName}\n{S}",
|
||||
appInfo[2], appInfo[0], action, Options.AppName, reqBody);
|
||||
SimApiBaseResponse res;
|
||||
var method = RpcRegistry.FirstOrDefault(x => x.Key == action);
|
||||
if (method == null)
|
||||
{
|
||||
var pt = mt.GetParameters()[0].ParameterType;
|
||||
if (pt == typeof(string))
|
||||
res = new SimApiBaseResponse(404, "method not found");
|
||||
}
|
||||
else
|
||||
{
|
||||
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(method.Class!);
|
||||
var mt = callClass.GetType().GetMethod(method.Method!);
|
||||
try
|
||||
{
|
||||
param = new[] { reqBody };
|
||||
}
|
||||
else
|
||||
{
|
||||
var paramObj = JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption);
|
||||
param = new[] { paramObj };
|
||||
}
|
||||
var methodParams = mt!.GetParameters();
|
||||
object? ret;
|
||||
switch (methodParams.Length)
|
||||
{
|
||||
case 1:
|
||||
var pt = mt.GetParameters()[0].ParameterType;
|
||||
var param = pt == typeof(string)
|
||||
? [reqBody]
|
||||
: new[] { JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption) };
|
||||
ret = mt.Invoke(callClass, param);
|
||||
break;
|
||||
case 2:
|
||||
var headerData =
|
||||
e.ApplicationMessage.UserProperties.ToDictionary(x => x.Name, x => x.Value);
|
||||
var pt2 = mt.GetParameters()[0].ParameterType;
|
||||
var param2 = pt2 == typeof(string)
|
||||
? [reqBody]
|
||||
: new[]
|
||||
{
|
||||
JsonSerializer.Deserialize(reqBody, pt2, SimApiUtil.JsonOption), headerData
|
||||
};
|
||||
ret = mt.Invoke(callClass, param2);
|
||||
break;
|
||||
default:
|
||||
ret = mt.Invoke(callClass, []);
|
||||
break;
|
||||
}
|
||||
|
||||
var ret = mt.Invoke(callClass, param);
|
||||
res = new SimApiBaseResponse<object>
|
||||
{
|
||||
Data = ret
|
||||
};
|
||||
}
|
||||
catch (TargetInvocationException e)
|
||||
{
|
||||
if (e.InnerException is SimApiException ie)
|
||||
{
|
||||
Logger.LogDebug("RPC调用错误: {Err}", ie.Message);
|
||||
res = new SimApiBaseResponse(ie.Code, ie.Message);
|
||||
res = new SimApiBaseResponse<object?>
|
||||
{
|
||||
Data = ret
|
||||
};
|
||||
}
|
||||
else
|
||||
catch (TargetInvocationException ex)
|
||||
{
|
||||
res = new SimApiBaseResponse(500, e.Message);
|
||||
if (ex.InnerException is SimApiException ie)
|
||||
{
|
||||
logger.LogDebug("Synapse RPC调用错误: {Err}", ie.Message);
|
||||
res = new SimApiBaseResponse(ie.Code, ie.Message);
|
||||
}
|
||||
else
|
||||
{
|
||||
logger.LogError("Synapse RPC 方法异常: {Err}\n{Stack}", ex.Message, ex.StackTrace);
|
||||
res = new SimApiBaseResponse(500, ex.Message);
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
logger.LogDebug("Synapse RPC调用失败: {Err}", ex.Message);
|
||||
res = new SimApiBaseResponse(500, ex.Message);
|
||||
}
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Logger.LogDebug("RPC调用失败: {Err}", e.Message);
|
||||
res = new SimApiBaseResponse(500, e.Message);
|
||||
}
|
||||
}
|
||||
|
||||
var returnJson = JsonSerializer.Serialize((object)res, SimApiUtil.JsonOption);
|
||||
var reply = $"client.{ea.BasicProperties.ReplyTo}.{ea.BasicProperties.AppId}";
|
||||
var props = RpcServerChannel.CreateBasicProperties();
|
||||
props.AppId = Options.AppId;
|
||||
props.CorrelationId = ea.BasicProperties.MessageId;
|
||||
props.MessageId = Guid.NewGuid().ToString();
|
||||
props.ReplyTo = Options.AppName;
|
||||
props.Type = ea.BasicProperties.Type;
|
||||
RpcServerChannel.BasicPublish(Options.SysName, reply, false, props, Encoding.UTF8.GetBytes(returnJson));
|
||||
Logger.LogDebug(
|
||||
"Rpc Return: ({BasicPropertiesMessageId}) {BasicPropertiesType}@{OptionsAppName} -> {BasicPropertiesReplyTo}\n{ReturnJson}",
|
||||
ea.BasicProperties.MessageId, ea.BasicProperties.Type, Options.AppName, ea.BasicProperties.ReplyTo,
|
||||
returnJson);
|
||||
var returnJson = SimApiUtil.Json(res);
|
||||
var reply = $"{Options.SysName}/{appInfo[0]}/rpc/client/{appInfo[1]}/{appInfo[2]}";
|
||||
var message = new MqttApplicationMessageBuilder()
|
||||
.WithTopic(reply)
|
||||
.WithPayload(returnJson)
|
||||
.WithRetainFlag(false)
|
||||
.Build();
|
||||
if (!Client.IsConnected) return;
|
||||
Client.PublishAsync(message, CancellationToken.None).Wait();
|
||||
logger.LogDebug(
|
||||
"Synapse Rpc Server Return: ({BasicPropertiesMessageId}) {BasicPropertiesType}@{OptionsAppName} -> {BasicPropertiesReplyTo}\n{ReturnJson}",
|
||||
appInfo[2], action, Options.AppName, appInfo[0], returnJson);
|
||||
});
|
||||
};
|
||||
RpcServerChannel.BasicConsume(queue, true, "", false, false, null, consumer);
|
||||
SubRpcServerTopic();
|
||||
}
|
||||
|
||||
private void SubRpcServerTopic()
|
||||
{
|
||||
var rsSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
|
||||
.WithTopicFilter(o =>
|
||||
o.WithTopic($"$queue/{RpcServerTopicPrefix}+").WithRetainHandling(MqttRetainHandling.SendAtSubscribe))
|
||||
.Build();
|
||||
Client!.SubscribeAsync(rsSubOpts).Wait();
|
||||
}
|
||||
}
|
||||
+210
-133
@@ -3,79 +3,63 @@ using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using RabbitMQ.Client;
|
||||
using RabbitMQ.Client.Exceptions;
|
||||
using MQTTnet;
|
||||
using MQTTnet.Formatter;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
public partial class Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logger, IServiceProvider sp)
|
||||
{
|
||||
private IServiceProvider Sp { get; }
|
||||
private SimApiSynapseOptions Options { get; } = simApiOptions.SimApiSynapseOptions;
|
||||
|
||||
private SimApiSynapseOptions Options { get; }
|
||||
private MqttClientFactory MqttFactory { get; } = new();
|
||||
public IMqttClient? Client { get; set; }
|
||||
|
||||
private ILogger<Synapse> Logger { get; }
|
||||
private List<RegisterItem> EventRegistry { get; set; } = new();
|
||||
|
||||
private IConnection Connection { get; set; }
|
||||
|
||||
private IModel EventClientChannel { get; set; }
|
||||
|
||||
private IModel EventServerChannel { get; set; }
|
||||
|
||||
private IModel RpcClientChannel { get; set; }
|
||||
|
||||
private IModel RpcServerChannel { get; set; }
|
||||
|
||||
private List<RegisterItem> EventRegistry { get; set; }
|
||||
|
||||
private List<RegisterItem> RpcRegistry { get; set; }
|
||||
|
||||
public Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logger, IServiceProvider sp)
|
||||
{
|
||||
Logger = logger;
|
||||
Sp = sp;
|
||||
Options = simApiOptions.SimApiSynapseOptions;
|
||||
}
|
||||
private List<RegisterItem> RpcRegistry { get; set; } = new();
|
||||
|
||||
public void Init()
|
||||
{
|
||||
ProcessAttribute();
|
||||
Logger.LogDebug("Synapse初始化配置信息: {Json}", SimApiUtil.Json(Options));
|
||||
logger.LogDebug("Synapse初始化配置信息: {Json}", SimApiUtil.Json(Options));
|
||||
if (string.IsNullOrEmpty(Options.AppName) || string.IsNullOrEmpty(Options.SysName))
|
||||
{
|
||||
Logger.LogCritical("Synapse初始化失败: AppName or SysName 错误");
|
||||
logger.LogCritical("Synapse初始化失败: AppName 和 SysName 不能为空");
|
||||
}
|
||||
|
||||
Options.AppId ??= Guid.NewGuid().ToString();
|
||||
Logger.LogInformation("System Name: {SysName}\nApp Name: {AppName}\nAppId: {AppId}", Options.SysName,
|
||||
Options.AppName, Options.AppId);
|
||||
logger.LogInformation("Synapse Sys Name: {SysName}\nSynapse App Name: {AppName}\nSynapse App Id: {AppId}",
|
||||
Options.SysName, Options.AppName, Options.AppId);
|
||||
CreateConnection();
|
||||
CheckAndCreateExchange();
|
||||
ProcessAttribute();
|
||||
//事件客户端
|
||||
if (Options.DisableEventClient)
|
||||
{
|
||||
Logger.LogWarning("Event Client Disabled: DisableEventClient set true");
|
||||
logger.LogWarning("Synapse Event Client Disabled: DisableEventClient set true");
|
||||
}
|
||||
else
|
||||
{
|
||||
RunEventClient();
|
||||
Logger.LogInformation("Event Client Ready");
|
||||
logger.LogInformation("Synapse Event Client Ready");
|
||||
}
|
||||
|
||||
//RPC客户端
|
||||
if (Options.DisableRpcClient)
|
||||
{
|
||||
Logger.LogWarning("Rpc Client Disabled: DisableEventClient set true");
|
||||
logger.LogWarning("Synapse Rpc Client Disabled: DisableEventClient set true");
|
||||
}
|
||||
else
|
||||
{
|
||||
RunRpcClient();
|
||||
Logger.LogInformation("Rpc Client Ready, Client Timeout: {OptionsRpcTimeout}s", Options.RpcTimeout);
|
||||
logger.LogInformation("Synapse Rpc Client Ready, Client Timeout: {OptionsRpcTimeout}s", Options.RpcTimeout);
|
||||
}
|
||||
|
||||
if (RpcRegistry.Count > 0)
|
||||
@@ -87,111 +71,159 @@ public partial class Synapse
|
||||
{
|
||||
RunEventServer();
|
||||
}
|
||||
|
||||
if (Options.EnableConfigStore)
|
||||
{
|
||||
RunConfigStoreServer();
|
||||
logger.LogInformation("Synapse Config Store Ready [{SysName}] ...", Options.SysName);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public SimApiBaseResponse<T> Rpc<T>(string appName, string method, dynamic param)
|
||||
/// <summary>
|
||||
/// 调用RPC使用明确的返回值类型
|
||||
/// </summary>
|
||||
/// <param name="appName"></param>
|
||||
/// <param name="method"></param>
|
||||
/// <param name="param"></param>
|
||||
/// <param name="headers"></param>
|
||||
/// <param name="timeout"></param>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <returns></returns>
|
||||
public SimApiBaseResponse<T> Rpc<T>(string appName, string method, dynamic? param = null,
|
||||
Dictionary<string, string>? headers = null, int? timeout = null)
|
||||
{
|
||||
var res = new SimApiBaseResponse(500, "Rpc Client Disabled!");
|
||||
var res = new SimApiBaseResponse(500, "Synapse Rpc Client Disabled!");
|
||||
if (Options.DisableRpcClient)
|
||||
{
|
||||
Logger.LogError("Rpc Client Disabled!");
|
||||
logger.LogError("Synapse Rpc Client Disabled!");
|
||||
}
|
||||
else
|
||||
{
|
||||
var data = FireRpc(appName, method, param);
|
||||
res = JsonSerializer.Deserialize<SimApiBaseResponse<T>>(data, SimApiUtil.JsonOption);
|
||||
var data = FireRpc(appName, method, param, headers, timeout);
|
||||
res = SimApiUtil.FromJson<SimApiBaseResponse<T>>(data);
|
||||
}
|
||||
|
||||
return res as SimApiBaseResponse<T>;
|
||||
return (res as SimApiBaseResponse<T>)!;
|
||||
}
|
||||
|
||||
public SimApiBaseResponse<object> Rpc(string appName, string method, dynamic param)
|
||||
/// <summary>
|
||||
/// 调用RPC使用object作为返回值类型
|
||||
/// </summary>
|
||||
/// <param name="appName"></param>
|
||||
/// <param name="method"></param>
|
||||
/// <param name="param"></param>
|
||||
/// <param name="headers"></param>
|
||||
/// <param name="timeout"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiBaseResponse<object> Rpc(string appName, string method, dynamic? param = null,
|
||||
Dictionary<string, string>? headers = null, int? timeout = null)
|
||||
{
|
||||
return Rpc<object>(appName, method, param);
|
||||
return Rpc<object>(appName, method, param, headers, timeout);
|
||||
}
|
||||
|
||||
public void Event(string eventName, dynamic param)
|
||||
|
||||
/// <summary>
|
||||
/// 只能在Rpc方法中使用,快捷抛出异常返回
|
||||
/// </summary>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
/// <exception cref="SimApiException"></exception>
|
||||
public void RpcError(int code, string message = "")
|
||||
{
|
||||
if (Options.DisableEventClient)
|
||||
{
|
||||
Logger.LogError("Event Client Disabled!");
|
||||
}
|
||||
else
|
||||
{
|
||||
FireEvent(eventName, param);
|
||||
}
|
||||
throw new SimApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 如果条件成立,则爆出错误
|
||||
/// </summary>
|
||||
/// <param name="condition"></param>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
public void RpcErrorWhen(bool condition, int code, string message = "")
|
||||
{
|
||||
if (condition) RpcError(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 发送一个事件x
|
||||
/// </summary>
|
||||
/// <param name="eventName"></param>
|
||||
/// <param name="param"></param>
|
||||
public bool Event(string eventName, dynamic? param = null)
|
||||
{
|
||||
if (!Options.DisableEventClient) return FireEvent(eventName, param);
|
||||
logger.LogError("Synapse Event Client Disabled!");
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 设置一个系统配置项
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <param name="value"></param>
|
||||
/// <returns></returns>
|
||||
public bool SetConfig(string key, string value)
|
||||
{
|
||||
if (Options.EnableConfigStore) return FireSetConfig(key, value);
|
||||
logger.LogError("Synapse Config Store Disabled!");
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 读取一个配置项,如果没有则为空
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
/// <returns></returns>
|
||||
public string? GetConfig(string key)
|
||||
{
|
||||
if (Options.EnableConfigStore) return FireGetConfig(key);
|
||||
logger.LogError("Synapse Config Store Disabled!");
|
||||
return null;
|
||||
}
|
||||
|
||||
private void CreateConnection()
|
||||
{
|
||||
var factory = new ConnectionFactory
|
||||
Client = MqttFactory.CreateMqttClient();
|
||||
var clientOpts = new MqttClientOptionsBuilder().WithProtocolVersion(MqttProtocolVersion.V500)
|
||||
.WithWebSocketServer(o => o.WithUri(Options.Websocket))
|
||||
.WithCredentials(Options.Username, Options.Password)
|
||||
.WithClientId($"{Options.AppName}:{Options.AppId}")
|
||||
.Build();
|
||||
Client!.ConnectAsync(clientOpts, CancellationToken.None).Wait();
|
||||
Client.ConnectedAsync += _ =>
|
||||
{
|
||||
HostName = Options.MqHost,
|
||||
Port = Options.MqPort,
|
||||
VirtualHost = Options.MqVHost,
|
||||
UserName = Options.MqUser,
|
||||
Password = Options.MqPass
|
||||
logger.LogInformation("Synapse MQTT[{AppName}:{AppId}] 连接成功...", Options.AppName, Options.AppId);
|
||||
//RPC客户端
|
||||
if (!Options.DisableRpcClient) SubRpcClientTopic();
|
||||
if (RpcRegistry.Count > 0) SubRpcServerTopic();
|
||||
if (EventRegistry.Count > 0) SubEventServerTopic();
|
||||
if (Options.EnableConfigStore) SubConfigStoreServerTopic();
|
||||
return Task.CompletedTask;
|
||||
};
|
||||
try
|
||||
//重连
|
||||
Client.DisconnectedAsync += async _ =>
|
||||
{
|
||||
Connection = factory.CreateConnection();
|
||||
Logger.LogInformation("连接RabbitMQ服务器成功");
|
||||
}
|
||||
catch (BrokerUnreachableException e)
|
||||
{
|
||||
Logger.LogError("连接RabbitMQ失败: \n{Err}", e);
|
||||
}
|
||||
}
|
||||
|
||||
private IModel CreateChannel(ushort processNum = 0, string desc = "unknow")
|
||||
{
|
||||
IModel channel = null;
|
||||
try
|
||||
{
|
||||
var log = $"Channel [{desc}] 创建成功...";
|
||||
channel = Connection.CreateModel();
|
||||
if (processNum != 0)
|
||||
logger.LogError("Synapse MQTT[{AppName}:{AppId}] 断开连接,开始重连...", Options.AppName, Options.AppId);
|
||||
await Task.Delay(TimeSpan.FromSeconds(5));
|
||||
try
|
||||
{
|
||||
channel.BasicQos(0, processNum, false);
|
||||
log += $"最大处理器数量: {processNum}";
|
||||
logger.LogInformation("Synapse MQTT[{AppName}:{AppId}] 开始连接MQTT服务器...", Options.AppName, Options.AppId);
|
||||
Client.ConnectAsync(clientOpts).Wait();
|
||||
}
|
||||
|
||||
Logger.LogInformation(log);
|
||||
}
|
||||
catch (ConnectFailureException e)
|
||||
{
|
||||
Logger.LogError("Channel [{{Desc}}] 创建失败...\n {0}", e);
|
||||
}
|
||||
|
||||
return channel;
|
||||
}
|
||||
|
||||
private void CheckAndCreateExchange()
|
||||
{
|
||||
var channel = CreateChannel(0, "Exchange");
|
||||
try
|
||||
{
|
||||
channel.ExchangeDeclare(Options.SysName, ExchangeType.Topic, true, true, null);
|
||||
Logger.LogDebug("Register Exchange Success");
|
||||
}
|
||||
catch (ConnectFailureException e)
|
||||
{
|
||||
Logger.LogError("Failed to declare Exchange.\n {Err}", e);
|
||||
}
|
||||
|
||||
channel.Close();
|
||||
Logger.LogDebug("Exchange Channel Closed");
|
||||
catch
|
||||
{
|
||||
logger.LogError("Synapse MQTT[{AppName}:{AppId}] 重连失败...", Options.AppName, Options.AppId);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private void ProcessAttribute()
|
||||
{
|
||||
EventRegistry = new List<RegisterItem>();
|
||||
RpcRegistry = new List<RegisterItem>();
|
||||
var stackTrace = new StackTrace();
|
||||
var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1).GetMethod();
|
||||
var assembly = callingMethod.DeclaringType.Assembly;
|
||||
var types = assembly.GetTypes(); // 获取程序集中的所有类型
|
||||
var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1)?.GetMethod();
|
||||
var assembly = callingMethod?.DeclaringType?.Assembly;
|
||||
var types = assembly!.GetTypes(); // 获取程序集中的所有类型
|
||||
foreach (var type in types)
|
||||
{
|
||||
var methods = type.GetMethods(); // 获取类型中的所有方法
|
||||
@@ -200,48 +232,93 @@ public partial class Synapse
|
||||
if (method.IsDefined(typeof(SynapseEventAttribute), false))
|
||||
{
|
||||
var attribute =
|
||||
(SynapseEventAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseEventAttribute));
|
||||
if (attribute != null)
|
||||
(SynapseEventAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseEventAttribute))!;
|
||||
var tmp = new RegisterItem
|
||||
{
|
||||
EventRegistry.Add(new RegisterItem
|
||||
{
|
||||
Key = attribute.Name ?? method.Name,
|
||||
Class = type,
|
||||
Method = method.Name
|
||||
});
|
||||
Key = attribute.Name ?? method.Name,
|
||||
Class = type,
|
||||
Method = method.Name
|
||||
};
|
||||
if (tmp.Key.StartsWith('/') || tmp.Key.EndsWith('/'))
|
||||
{
|
||||
logger.LogError("Synapse Event Register Error: {Key} Can't start or end of '/'", tmp.Key);
|
||||
continue;
|
||||
}
|
||||
|
||||
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(tmp.Class!);
|
||||
var mt = callClass.GetType().GetMethod(tmp.Method);
|
||||
if (mt!.GetParameters().Length > 2 || mt.GetParameters().Length < 1)
|
||||
{
|
||||
logger.LogError(
|
||||
"Synapse Event Register Error: Only one or two parameter supported. {Key} -> {Method}@{Class}",
|
||||
tmp.Key, tmp.Method, tmp.Class.Name);
|
||||
continue;
|
||||
}
|
||||
|
||||
EventRegistry.Add(tmp);
|
||||
}
|
||||
|
||||
if (method.IsDefined(typeof(SynapseRpcAttribute), false))
|
||||
{
|
||||
var attribute =
|
||||
(SynapseRpcAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseRpcAttribute));
|
||||
if (attribute != null)
|
||||
(SynapseRpcAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseRpcAttribute))!;
|
||||
var tmp = new RegisterItem
|
||||
{
|
||||
RpcRegistry.Add(new RegisterItem
|
||||
{
|
||||
Key = attribute.Name ?? $"{type.Name}.{method.Name}",
|
||||
Class = type,
|
||||
Method = method.Name
|
||||
});
|
||||
Key = attribute.Name ?? $"{type.Name}.{method.Name}",
|
||||
Class = type,
|
||||
Method = method.Name
|
||||
};
|
||||
if (tmp.Key.Contains('/') || tmp.Key.Contains('#') || tmp.Key.Contains('+'))
|
||||
{
|
||||
logger.LogError("Synapse Rpc Register Error: {Key} contains '/' , '#' , '+'", tmp.Key);
|
||||
continue;
|
||||
}
|
||||
|
||||
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(tmp.Class!);
|
||||
var mt = callClass.GetType().GetMethod(tmp.Method);
|
||||
if (mt!.GetParameters().Length > 2)
|
||||
{
|
||||
logger.LogError(
|
||||
"Synapse Rpc Register Error: Only 1,2 or none parameter supported. {Key} -> {Method}@{Class}",
|
||||
tmp.Key, tmp.Method, tmp.Class.Name);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (mt.GetParameters().Length == 2 &&
|
||||
mt.GetParameters()[1].ParameterType != typeof(Dictionary<string, string>))
|
||||
{
|
||||
logger.LogError(
|
||||
"Synapse Rpc Register Error: RpcMethod Parameter 2 must be Dictionary<string, string>. {Key} -> {Method}@{Class}",
|
||||
tmp.Key, tmp.Method, tmp.Class.Name);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (RpcRegistry.Any(x => x.Key == tmp.Key))
|
||||
{
|
||||
logger.LogError("Synapse Rpc Register Error: {Key} Already Exists -> {Method}@{Class}", tmp.Key,
|
||||
tmp.Method, tmp.Class.Name);
|
||||
continue;
|
||||
}
|
||||
|
||||
RpcRegistry.Add(tmp);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var events = EventRegistry.Aggregate(string.Empty,
|
||||
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class.Name}");
|
||||
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class!.Name}");
|
||||
var rpcList = RpcRegistry.Aggregate(string.Empty,
|
||||
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class.Name}");
|
||||
Logger.LogInformation(">>> Synapse System 读取Event方法:{Event}\n>>>Synapse System 读取RPC方法:{Rpc}", events, rpcList);
|
||||
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class!.Name}");
|
||||
if (EventRegistry.Count > 0) logger.LogInformation(" >> Synapse System 读取Event方法:{Event}", events);
|
||||
if (RpcRegistry.Count > 0) logger.LogInformation(" >> Synapse System 读取RPC方法:{Rpc}", rpcList);
|
||||
}
|
||||
}
|
||||
|
||||
public class RegisterItem
|
||||
{
|
||||
public string Key { get; set; }
|
||||
public string? Key { get; init; }
|
||||
|
||||
public Type Class { get; set; }
|
||||
public Type? Class { get; init; }
|
||||
|
||||
public string Method { get; set; }
|
||||
public string? Method { get; init; }
|
||||
}
|
||||
Reference in New Issue
Block a user