Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 |
@@ -9,16 +9,21 @@ jobs:
|
||||
publish:
|
||||
name: Publish Project to Nuget
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/checkout@v4
|
||||
- name: Setup .NET Core
|
||||
uses: actions/setup-dotnet@v1
|
||||
uses: actions/setup-dotnet@v5
|
||||
with:
|
||||
dotnet-version: "9.0.305"
|
||||
dotnet-version: "10.x.x"
|
||||
- name: NuGet login (OIDC → temp API key)
|
||||
uses: NuGet/login@v1
|
||||
id: login
|
||||
with:
|
||||
user: ${{ secrets.NUGET_USER }}
|
||||
- name: Publish
|
||||
run: |
|
||||
version=`git describe --tags`
|
||||
dotnet build --configuration release -p:Version=$version
|
||||
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
|
||||
env:
|
||||
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
|
||||
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${{steps.login.outputs.NUGET_API_KEY}} -s https://api.nuget.org/v3/index.json
|
||||
@@ -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/
|
||||
|
||||
@@ -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 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 = [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,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,235 +0,0 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Net.Http;
|
||||
using System.Net.Http.Json;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.CoceSdk;
|
||||
|
||||
public class CoceApp(SimApiOptions simApiOptions, ILogger<CoceApp> logger, IDistributedCache cache)
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// 获取Level Token
|
||||
/// </summary>
|
||||
/// <param name="lv1Token"></param>
|
||||
/// <param name="level"></param>
|
||||
/// <returns></returns>
|
||||
public LevelTokenResponse? GetLevelToken(string lv1Token, int level = 5)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "lv1Token", lv1Token },
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
{ "level", level }
|
||||
};
|
||||
return QueryAppApi<LevelTokenResponse>("/api/app/token", dict);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 通过用户手机号搜索用户
|
||||
/// </summary>
|
||||
/// <param name="phone"></param>
|
||||
/// <returns></returns>
|
||||
public UserInfo? SearchUserByPhone(string phone)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "cell", phone },
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
};
|
||||
return QueryAppApi<UserInfo>("/api/app/user/search-by-phone", dict);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 通过给出的UserId列表获取用户信息
|
||||
/// </summary>
|
||||
/// <param name="userIds"></param>
|
||||
/// <returns></returns>
|
||||
public UserInfo[]? SearchUserByIds(IEnumerable<string> userIds)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "ids", string.Join(",", userIds) },
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
};
|
||||
return QueryAppApi<UserInfo[]>("/api/app/user/search-by-ids", dict);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 向用户发送消息
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="title"></param>
|
||||
/// <param name="content"></param>
|
||||
/// <returns></returns>
|
||||
public bool SendUserMessage(string userId, string title, string content)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
{ "userId", userId },
|
||||
{ "type", "text" },
|
||||
{ "title", title },
|
||||
{ "text", content }
|
||||
};
|
||||
return QueryAppApiNoResp("/api/app/message", dict);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 创建交易订单号
|
||||
/// </summary>
|
||||
/// <param name="name"></param>
|
||||
/// <param name="amount"></param>
|
||||
/// <param name="ext"></param>
|
||||
/// <returns></returns>
|
||||
public string? TradeCreate(string name, int amount, string ext)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
{ "amount", amount },
|
||||
{ "ext", ext },
|
||||
{ "name", name }
|
||||
};
|
||||
return QueryAppApi<string>("/api/app/trade/create", dict);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 查询订单状态
|
||||
/// </summary>
|
||||
/// <param name="tradeNo"></param>
|
||||
/// <returns></returns>
|
||||
public CheckTradeResponse? TradeCheck(string tradeNo)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
{ "tradeNo", tradeNo }
|
||||
};
|
||||
return QueryAppApi<CheckTradeResponse>("/api/app/trade/result", dict);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 对订单进行退款
|
||||
/// </summary>
|
||||
/// <param name="tradeNo"></param>
|
||||
/// <returns></returns>
|
||||
public bool TradeRefund(string tradeNo)
|
||||
{
|
||||
var dict = new Dictionary<string, object>
|
||||
{
|
||||
{ "time", (int)SimApiUtil.TimestampNow },
|
||||
{ "appId", simApiOptions.CoceSdkOptions.AppId! },
|
||||
{ "tradeNo", tradeNo }
|
||||
};
|
||||
return QueryAppApiNoResp("/api/app/trade/refund", dict);
|
||||
}
|
||||
|
||||
|
||||
private T? QueryAppApi<T>(string endpoint, Dictionary<string, object> request)
|
||||
{
|
||||
var response = QueryAppApi(endpoint, request);
|
||||
var result = response.Content.ReadFromJsonAsync<SimApiBaseResponse<T>>().Result!;
|
||||
if (result.Code == 200) return result.Data;
|
||||
logger.LogDebug("发生错误: {Code} => {Message}", result.Code, result.Message);
|
||||
return default;
|
||||
}
|
||||
|
||||
private bool QueryAppApiNoResp(string endpoint, Dictionary<string, object> request)
|
||||
{
|
||||
var response = QueryAppApi(endpoint, request);
|
||||
var result = response.Content.ReadFromJsonAsync<SimApiBaseResponse>().Result!;
|
||||
return result.Code == 200;
|
||||
}
|
||||
|
||||
private HttpResponseMessage QueryAppApi(string endpoint, Dictionary<string, object> request)
|
||||
{
|
||||
var platUrl = simApiOptions.CoceSdkOptions.ApiEndpoint + endpoint;
|
||||
var sorted = request.OrderBy(x => x.Key);
|
||||
var signStr = sorted.Aggregate("", (current, item) => current + $"{item.Key}={item.Value}&").TrimEnd('&');
|
||||
logger.LogDebug("签名的字符串: {SignStr}", signStr);
|
||||
var sign = SimApiUtil.Md5(signStr + simApiOptions.CoceSdkOptions.AppKey);
|
||||
logger.LogDebug("签名: {Sign}", sign);
|
||||
request.Add("sign", sign);
|
||||
logger.LogDebug("请求地址: {PlatUrl} => {Data}", platUrl, JsonSerializer.Serialize(request));
|
||||
var http = new HttpClient();
|
||||
return http.PostAsJsonAsync(platUrl, request).Result;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 获取用户的群组信息
|
||||
/// </summary>
|
||||
/// <param name="token">Level >=2 的Token</param>
|
||||
/// <returns></returns>
|
||||
public IEnumerable<GroupInfo>? GetUserGroups(string token)
|
||||
{
|
||||
const string uri = "/api/lv2/user/groups";
|
||||
var resp = ProxyQuery<GroupInfo[]>(uri, token,"{}");
|
||||
return resp;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取用户信息
|
||||
/// </summary>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public UserInfo? GetUserInfo(string token)
|
||||
{
|
||||
const string uri = "/api/lv1/user/info";
|
||||
return ProxyQuery<UserInfo>(uri, token);
|
||||
}
|
||||
|
||||
public void SaveToken(string userId, string levelToken)
|
||||
{
|
||||
cache.SetString($"LEVEL:TOKEN:{userId}", levelToken);
|
||||
}
|
||||
|
||||
public string? GetToken(string userId)
|
||||
{
|
||||
return cache.GetString($"LEVEL:TOKEN:{userId}");
|
||||
}
|
||||
|
||||
|
||||
public dynamic? ProxyQuery(string uri, string token, string json) => ProxyQuery<dynamic>(uri, token, json);
|
||||
|
||||
public dynamic? ProxyQueue(string uri, string token, object data) =>
|
||||
ProxyQuery<dynamic>(uri, token, JsonSerializer.Serialize(data));
|
||||
|
||||
public T? ProxyQueue<T>(string uri, string token, object data) =>
|
||||
ProxyQuery<T>(uri, token, JsonSerializer.Serialize(data));
|
||||
|
||||
public T? ProxyQuery<T>(string uri, string token, string json = "{}")
|
||||
{
|
||||
var http = new HttpClient();
|
||||
http.DefaultRequestHeaders.Add("Token", token);
|
||||
var realUrl = simApiOptions.CoceSdkOptions.ApiEndpoint + uri;
|
||||
var response = http.PostAsync(realUrl, new StringContent(json, Encoding.UTF8, "application/json"))
|
||||
.Result;
|
||||
var resp = response.Content.ReadFromJsonAsync<SimApiBaseResponse<T>>().Result!;
|
||||
if (resp.Code != 200)
|
||||
{
|
||||
logger.LogDebug("请求发生错误: {RespCode} => {RespMessage}", resp.Code, resp.Message);
|
||||
}
|
||||
|
||||
return resp.Code == 200 ? resp.Data : default;
|
||||
}
|
||||
|
||||
public ConfigResponse GetConfig()
|
||||
{
|
||||
return new ConfigResponse(simApiOptions.CoceSdkOptions.AppId!, simApiOptions.CoceSdkOptions.AuthEndpoint);
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
namespace SimApi.CoceSdk;
|
||||
|
||||
public class CoceAppSdkOption
|
||||
{
|
||||
/**
|
||||
* 中心API服务器地址
|
||||
*/
|
||||
public string ApiEndpoint { get; set; } = "https://api.coce.cc";
|
||||
|
||||
public string AuthEndpoint { get; set; } = "https://home.coce.cc";
|
||||
|
||||
public string? AppId { get; set; }
|
||||
|
||||
public string? AppKey { get; set; }
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Controllers;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.CoceSdk;
|
||||
|
||||
public class CoceController(CoceApp coce, SimApiAuth auth, IServiceProvider sp) : SimApiBaseController
|
||||
{
|
||||
[HttpPost]
|
||||
public SimApiBaseResponse<ConfigResponse> GetConfig()
|
||||
{
|
||||
return new SimApiBaseResponse<ConfigResponse>(coce.GetConfig());
|
||||
}
|
||||
|
||||
[HttpPost]
|
||||
public SimApiBaseResponse<string> Login([FromBody] SimApiOneFieldRequest<string> request)
|
||||
{
|
||||
var data = coce.GetLevelToken(request.Data!);
|
||||
ErrorWhenNull(data, 400);
|
||||
coce.SaveToken(data!.UserId, data.Token);
|
||||
var userinfo = coce.GetUserInfo(data!.Token);
|
||||
var meta = new Dictionary<string, string>
|
||||
{
|
||||
{ "name", userinfo!.Name },
|
||||
{ "image", userinfo.Image }
|
||||
};
|
||||
var groups = coce.GetUserGroups(data.Token!)!;
|
||||
var loginItem = new SimApiLoginItem
|
||||
{
|
||||
Id = data.UserId,
|
||||
Meta = meta,
|
||||
};
|
||||
var processor = sp.GetService<ICoceLoginProcessor>();
|
||||
processor?.Process(loginItem, groups.ToArray());
|
||||
return new SimApiBaseResponse<string>(auth.Login(loginItem));
|
||||
}
|
||||
|
||||
[HttpPost, SimApiAuth]
|
||||
public SimApiBaseResponse<GroupInfo[]> ListGroups()
|
||||
{
|
||||
var levelToken = coce.GetToken(LoginInfo.Id!);
|
||||
var groups = coce.GetUserGroups(levelToken!)!;
|
||||
return new SimApiBaseResponse<GroupInfo[]>(groups.ToArray());
|
||||
}
|
||||
}
|
||||
@@ -1,43 +0,0 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.CoceSdk;
|
||||
|
||||
public record ConfigResponse(string AppId, string AuthUrl);
|
||||
|
||||
public record LevelTokenResponse(string Token, string UserId, int TokenLevel);
|
||||
|
||||
public record GroupInfo(string Id, string Name, string Image, string Description, string Role);
|
||||
|
||||
public record UserInfo(string UserId, string Name, string Image);
|
||||
|
||||
public record CheckTradeResponse(
|
||||
string TradeNo,
|
||||
int Amount,
|
||||
int Fee,
|
||||
string Name,
|
||||
string? Ext,
|
||||
string Status,
|
||||
DateTime CreatedAt,
|
||||
DateTime? FinishedAt,
|
||||
DateTime? RefundAt,
|
||||
DateTime? CloseAt);
|
||||
|
||||
public class UserInfoWithGroup
|
||||
{
|
||||
public string? UserId { get; set; }
|
||||
|
||||
public string? Name { get; set; }
|
||||
|
||||
public string? LevelToken { get; set; }
|
||||
|
||||
public UserGroupItem[]? UserGroupItems { get; set; }
|
||||
}
|
||||
|
||||
public class UserGroupItem
|
||||
{
|
||||
public string? GroupId { get; set; }
|
||||
|
||||
public string? GroupName { get; set; }
|
||||
|
||||
public string? GroupRole { get; set; }
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
using System.Collections.Generic;
|
||||
using SimApi.Communications;
|
||||
|
||||
namespace SimApi.CoceSdk;
|
||||
|
||||
public interface ICoceLoginProcessor
|
||||
{
|
||||
SimApiLoginItem Process(SimApiLoginItem loginItem, GroupInfo[] groups);
|
||||
}
|
||||
@@ -27,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, "未知错误代码"))
|
||||
{
|
||||
}
|
||||
|
||||
@@ -46,23 +46,15 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态内容分页
|
||||
/// 分页内容返回
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiBasePageResponse<T>() : SimApiBaseResponse
|
||||
public class PageResponse<T>
|
||||
{
|
||||
public T? List { get; set; }
|
||||
public 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>
|
||||
|
||||
@@ -10,5 +10,5 @@ public class SimApiLoginItem
|
||||
public required string Id { get; set; }
|
||||
public string[] Type { get; set; } = ["user"];
|
||||
public Dictionary<string, string> Meta { get; set; } = [];
|
||||
public object? Extra { 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; }
|
||||
}
|
||||
@@ -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;
|
||||
}
|
||||
@@ -29,11 +29,12 @@ public class SimApiJobOptions
|
||||
/// 设置为null 使用默认redis配置
|
||||
/// </summary>
|
||||
public int? Database { get; set; } = null;
|
||||
|
||||
public SimApiJobServerConfig[] Servers { get; set; } = [new()];
|
||||
}
|
||||
|
||||
public class SimApiJobServerConfig()
|
||||
{
|
||||
public string[] Queues { get; set; } = ["default"];
|
||||
public int WorkerNum { get; set; } = 50;
|
||||
public int WorkerNum { get; set; } = 5;
|
||||
}
|
||||
@@ -1,5 +1,4 @@
|
||||
using System;
|
||||
using SimApi.CoceSdk;
|
||||
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
@@ -19,9 +18,15 @@ public class SimApiOptions
|
||||
public bool EnableSimApiAuth { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 是否使用CoceSdk
|
||||
/// 启用Cache功能
|
||||
/// </summary>
|
||||
public bool EnableCoceSdk { get; set; }
|
||||
public bool EnableSimApiCache { get; set; } = true;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 启用SimApi网关授权, 基于上层网关透传的身份令牌验证
|
||||
/// </summary>
|
||||
public bool EnableSimApiAuthGate { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 开启S3兼容的存储系统。
|
||||
@@ -46,9 +51,6 @@ public class SimApiOptions
|
||||
/// </summary>
|
||||
public bool EnableCors { get; set; } = true;
|
||||
|
||||
|
||||
public CoceAppSdkOption CoceSdkOptions { get; set; } = new();
|
||||
|
||||
/// <summary>
|
||||
/// 启用异常拦截,启用后,所有的异常将被通过json反馈。
|
||||
/// default: true
|
||||
@@ -60,6 +62,11 @@ public class SimApiOptions
|
||||
/// </summary>
|
||||
public bool EnableSimApiResponseFilter { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 启用请求日志中间件
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableRequestLog { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 开启ForwardHeaders,开启后可以透传负载均衡的Headers
|
||||
@@ -73,21 +80,16 @@ public class SimApiOptions
|
||||
/// </summary>
|
||||
public bool EnableLowerUrl { get; set; } = true;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 应用可以通过 /versions 显示出应用版本和SimApi包版本
|
||||
/// default: true
|
||||
/// </summary>
|
||||
public bool EnableVersionUrl { get; set; } = true;
|
||||
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 启用格式化的 Console Logger
|
||||
/// default: false
|
||||
/// </summary>
|
||||
public bool EnableLogger { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// 是否启用SimApiHttpClient
|
||||
/// </summary>
|
||||
public bool EnableSimApiHttpClient { get; set; } = false;
|
||||
|
||||
/// <summary>
|
||||
/// 配置Job
|
||||
@@ -106,16 +108,36 @@ public class SimApiOptions
|
||||
|
||||
public SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new();
|
||||
|
||||
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 ConfigureCoceSdk(Action<CoceAppSdkOption>? options = null)
|
||||
{
|
||||
options?.Invoke(CoceSdkOptions);
|
||||
}
|
||||
|
||||
public void ConfigureSimApiDoc(Action<SimApiDocOptions>? options = null)
|
||||
{
|
||||
options?.Invoke(SimApiDocOptions);
|
||||
@@ -130,4 +152,14 @@ public class SimApiOptions
|
||||
{
|
||||
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,14 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiRequestLogOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// 是否打印完整的请求Header
|
||||
/// </summary>
|
||||
public bool ShowFullHeader { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 是否打印完整的响应体
|
||||
/// </summary>
|
||||
public bool ShowFullResponse { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiRouteOptions
|
||||
{
|
||||
public string? VersionRoute = "/versions";
|
||||
public string? LogoutRoute = "/auth/logout";
|
||||
public string? UserInfoRoute = "/user/info";
|
||||
}
|
||||
@@ -1,5 +1,4 @@
|
||||
using System.Collections.Generic;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
@@ -8,42 +7,16 @@ namespace SimApi.Controllers;
|
||||
|
||||
public class SimApiAuthController(SimApiAuth auth) : SimApiBaseController
|
||||
{
|
||||
/// <summary>
|
||||
/// 检测用户登陆的控制器
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost, SimApiDoc("认证", "检测登陆")]
|
||||
public SimApiBaseResponse<string> CheckLogin()
|
||||
{
|
||||
ErrorWhenNull(LoginInfo, 401, "未登录");
|
||||
return new SimApiBaseResponse<string>
|
||||
{
|
||||
Data = LoginInfo.Id
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost, SimApiDoc("认证", "退出登陆")]
|
||||
public SimApiBaseResponse Logout()
|
||||
public void Logout()
|
||||
{
|
||||
string? token = null;
|
||||
|
||||
if (Request.Headers.TryGetValue("Token", out var value))
|
||||
{
|
||||
token = value;
|
||||
auth.Logout(value!);
|
||||
}
|
||||
|
||||
auth.Logout(token!);
|
||||
return new SimApiBaseResponse();
|
||||
}
|
||||
|
||||
|
||||
[HttpPost, SimApiAuth]
|
||||
public SimApiBaseResponse<SimApiLoginItem> UserInfo()
|
||||
{
|
||||
return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);
|
||||
}
|
||||
}
|
||||
@@ -1,10 +1,9 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Communications;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using System.Linq;
|
||||
using SimApi.Exceptions;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
@@ -24,6 +23,8 @@ public class SimApiBaseController : Controller
|
||||
/// </summary>
|
||||
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"]!;
|
||||
|
||||
protected string LoginToken => (string)HttpContext.Items["LoginToken"]!;
|
||||
|
||||
/// <summary>
|
||||
/// 验证请求参数
|
||||
/// </summary>
|
||||
@@ -38,74 +39,4 @@ public class SimApiBaseController : Controller
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
protected static void Error(int code = 500, string message = "")
|
||||
{
|
||||
throw new SimApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhen([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenTrue([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
|
||||
{
|
||||
ErrorWhen(condition, code, message);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 如果condition是false 报错
|
||||
/// </summary>
|
||||
/// <param name="condition"></param>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
protected static void ErrorWhenFalse([DoesNotReturnIf(false)] bool condition, int code = 400, string message = "")
|
||||
{
|
||||
ErrorWhen(!condition, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测给定的变量是否为NUll
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenNull([NotNull] object? condition, int code = 404, string message = "请求的资源不存在")
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 上传文件
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
protected SimApiBaseResponse<string> UploadFile()
|
||||
{
|
||||
return new SimApiBaseResponse<string>();
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,9 @@
|
||||
using System.Collections.Generic;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
using static SimApi.Helpers.SimApiError;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
@@ -14,22 +16,27 @@ public class SimApiCommonController : 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);
|
||||
}
|
||||
|
||||
|
||||
[HttpPost, HttpGet]
|
||||
public SimApiBaseResponse<Dictionary<string, string>> Versions()
|
||||
public Dictionary<string, string> Versions()
|
||||
{
|
||||
return new SimApiBaseResponse<Dictionary<string, string>>()
|
||||
return new Dictionary<string, string>
|
||||
{
|
||||
Data = new Dictionary<string, string>
|
||||
{
|
||||
{ "SimApi", SimApiUtil.SimApiVersion },
|
||||
{ "App", SimApiUtil.AppVersion }
|
||||
}
|
||||
{ "SimApi", SimApiUtil.SimApiVersion },
|
||||
{ "App", SimApiUtil.AppVersion }
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 获取已登录用户信息
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost, SimApiAuth, SimApiDoc("认证", "获取已登录用户信息")]
|
||||
public SimApiLoginItem UserInfo() => LoginInfo;
|
||||
}
|
||||
+162
-13
@@ -1,25 +1,61 @@
|
||||
using System;
|
||||
using System.Text.Json;
|
||||
using System.Collections.Concurrent;
|
||||
using System.Collections.Generic;
|
||||
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
|
||||
{
|
||||
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)
|
||||
{
|
||||
_cache = cache;
|
||||
_redisDb = sp.GetService<IConnectionMultiplexer>()?.GetDatabase();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 登录信息
|
||||
/// </summary>
|
||||
/// <param name="loginItem"></param>
|
||||
/// <param name="expireTime"></param>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(SimApiLoginItem loginItem, string? token = null)
|
||||
public string Login(SimApiLoginItem loginItem, TimeSpan? expireTime = null, string? token = null)
|
||||
{
|
||||
expireTime ??= TimeSpan.FromDays(7);
|
||||
token ??= Guid.NewGuid().ToString();
|
||||
cache.SetString(token, JsonSerializer.Serialize(loginItem));
|
||||
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;
|
||||
}
|
||||
|
||||
@@ -31,10 +67,20 @@ public class SimApiAuth(IDistributedCache cache)
|
||||
/// <returns></returns>
|
||||
public string Update(SimApiLoginItem loginItem, string token)
|
||||
{
|
||||
cache.SetString(token, JsonSerializer.Serialize(loginItem));
|
||||
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>
|
||||
@@ -42,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) : null;
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+40
-3
@@ -7,8 +7,15 @@ 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);
|
||||
@@ -19,14 +26,44 @@ public class SimApiCache(IDistributedCache cache)
|
||||
}
|
||||
}
|
||||
|
||||
public string? Get(string key)
|
||||
/// <summary>
|
||||
/// 移除缓存
|
||||
/// </summary>
|
||||
/// <param name="key"></param>
|
||||
public void Remove(string key)
|
||||
{
|
||||
return cache.GetString(Prefix + 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 : JsonSerializer.Deserialize<T>(data);
|
||||
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);
|
||||
}
|
||||
}
|
||||
+70
-21
@@ -3,30 +3,45 @@ 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(string? appId, string appKey)
|
||||
public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHttpClient>? logger = null)
|
||||
{
|
||||
public string SignName { get; init; } = "sign";
|
||||
public string TimestampName { get; init; } = "timestamp";
|
||||
public string NonceName { get; init; } = "nonce";
|
||||
public string? AppIdName { get; init; } = "appId";
|
||||
public string[] SignFields { get; init; } = [];
|
||||
public 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; } = [];
|
||||
|
||||
public T? SignQuery<T>(string url, object body, Dictionary<string, string>? queries = null)
|
||||
/// <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 += $"{AppIdName}={AppId}&";
|
||||
}
|
||||
|
||||
queryUrl += $"{TimestampName}={(int)SimApiUtil.TimestampNow}&{NonceName}={Guid.NewGuid()}";
|
||||
var signStr = $"{queryUrl}&{appKey}";
|
||||
var signStr = $"{queryUrl}&{AppKey}";
|
||||
var path = $"{url}?{queryUrl}&{SignName}={SimApiUtil.Md5(signStr)}";
|
||||
|
||||
if (queries != null)
|
||||
@@ -35,33 +50,67 @@ public class SimApiHttpClient(string? appId, string appKey)
|
||||
.Aggregate(path, (current, q) => current + $"&{q.Key}={q.Value}");
|
||||
}
|
||||
|
||||
var http = new HttpClient();
|
||||
var resp = http.PostAsJsonAsync(path, body).Result;
|
||||
return resp.Content.ReadFromJsonAsync<T>().Result;
|
||||
return Query<T>(path, body);
|
||||
}
|
||||
|
||||
public T? AesQuery<T>(string url, object 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}";
|
||||
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)
|
||||
Data = SimApiAesUtil.Encrypt(SimApiUtil.Json(body), AppKey)
|
||||
};
|
||||
var http = new HttpClient();
|
||||
var resp = http.PostAsJsonAsync(url, req).Result;
|
||||
return resp.Content.ReadFromJsonAsync<T>().Result;
|
||||
return Query<T>(url, req);
|
||||
}
|
||||
|
||||
public T? AesSignQuery<T>(string url, object body, Dictionary<string, string>? queries = null)
|
||||
/// <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)
|
||||
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!;
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Net.Mail;
|
||||
using System.Reflection;
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
@@ -94,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>
|
||||
@@ -131,6 +151,51 @@ public static class SimApiUtil
|
||||
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>
|
||||
@@ -154,6 +219,17 @@ public static class SimApiUtil
|
||||
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);
|
||||
}
|
||||
@@ -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,20 +10,20 @@ 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)) return next(httpContext);
|
||||
var login = auth.GetLogin(token);
|
||||
if (login != null)
|
||||
{
|
||||
httpContext.Items.Add("LoginToken", token);
|
||||
httpContext.Items.Add("LoginInfo", login);
|
||||
}
|
||||
|
||||
return next(httpContext);
|
||||
}
|
||||
}
|
||||
@@ -1,17 +1,22 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
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);
|
||||
if (!context.Response.HasStarted)
|
||||
{
|
||||
switch (context.Response.StatusCode)
|
||||
{
|
||||
case 200:
|
||||
case 301:
|
||||
case 302:
|
||||
break;
|
||||
case 404:
|
||||
throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
|
||||
default:
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
}
|
||||
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)
|
||||
{
|
||||
while (ex is AggregateException aggEx && aggEx.InnerException != null)
|
||||
{
|
||||
ex = aggEx.InnerException;
|
||||
}
|
||||
|
||||
return ex;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异步输出错误响应(修复异步异常捕获核心)
|
||||
/// </summary>
|
||||
private static async Task ErrorResponseAsync(HttpContext context, SimApiBaseResponse response)
|
||||
{
|
||||
// 响应已开始则直接返回,不修改
|
||||
if (context.Response.HasStarted)
|
||||
return;
|
||||
|
||||
context.Response.StatusCode = 200;
|
||||
context.Response.Headers.Append("Content-Type", "application/json");
|
||||
context.Response.WriteAsync(response.ToString()).Wait();
|
||||
context.Response.ContentType = "application/json";
|
||||
context.Response.ContentLength = null; // 清除可能已设置的 Content-Length
|
||||
await context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,105 @@
|
||||
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;
|
||||
|
||||
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 ) =>");
|
||||
logMessage.AppendLine(requestBodyText);
|
||||
|
||||
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();
|
||||
}
|
||||
}
|
||||
@@ -30,7 +30,7 @@ public class AesBodyModelBinder : IModelBinder
|
||||
SimApiOneFieldRequest<string>? aesRequest;
|
||||
try
|
||||
{
|
||||
aesRequest = JsonSerializer.Deserialize<SimApiOneFieldRequest<string>>(requestBody, SimApiUtil.JsonOption);
|
||||
aesRequest = SimApiUtil.FromJson<SimApiOneFieldRequest<string>>(requestBody);
|
||||
}
|
||||
catch (JsonException ex)
|
||||
{
|
||||
|
||||
@@ -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 |
|
||||
|
||||
+7
-21
@@ -1,5 +1,4 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
@@ -9,30 +8,17 @@
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>Simcu.SimApi</PackageId>
|
||||
<Nullable>enable</Nullable>
|
||||
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
|
||||
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Folder Include="Communications\"/>
|
||||
<Folder Include="Exceptions\"/>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.21" />
|
||||
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.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="9.0.10" />
|
||||
<PackageReference Include="Minio" Version="6.0.5" />
|
||||
<PackageReference Include="MQTTnet" Version="5.0.1.1416"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.6" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
|
||||
<PackageReference Include="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>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical"/>
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
</Project>
|
||||
|
||||
+184
-63
@@ -9,17 +9,19 @@ 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.CoceSdk;
|
||||
using SimApi.AuthSDK;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Interfaces;
|
||||
using SimApi.Logger;
|
||||
using SimApi.SwaggerFilters;
|
||||
using StackExchange.Redis;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
@@ -34,9 +36,20 @@ public static class SimApiExtensions
|
||||
{
|
||||
var simApiOptions = new SimApiOptions();
|
||||
options?.Invoke(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>();
|
||||
}
|
||||
|
||||
@@ -55,9 +68,18 @@ public static class SimApiExtensions
|
||||
builder.AddSingleton<SimApiAuth>();
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableCoceSdk)
|
||||
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)
|
||||
{
|
||||
builder.AddSingleton<CoceApp>();
|
||||
if (type is { IsClass: true, IsAbstract: false } && simApiAuthChecker.IsAssignableFrom(type))
|
||||
{
|
||||
builder.AddScoped(simApiAuthChecker, type);
|
||||
}
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableJob)
|
||||
@@ -90,15 +112,15 @@ public static class SimApiExtensions
|
||||
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSimApiHttpClient)
|
||||
{
|
||||
builder.AddSingleton<SimApiHttpClient>();
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSynapse)
|
||||
{
|
||||
builder.AddSingleton<Synapse>();
|
||||
//自动依赖注入
|
||||
var stackTrace = new StackTrace();
|
||||
var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1)?.GetMethod();
|
||||
var assembly = callingMethod?.DeclaringType?.Assembly;
|
||||
var types = assembly?.GetTypes() ?? [];
|
||||
foreach (var type in types)
|
||||
foreach (var type in callerTypes)
|
||||
{
|
||||
var methodsWithSynapse = type.GetMethods()
|
||||
.Where(m => m.GetCustomAttribute<SynapseRpcAttribute>() != null ||
|
||||
@@ -123,11 +145,81 @@ public static class SimApiExtensions
|
||||
});
|
||||
}
|
||||
|
||||
x.CustomSchemaIds(type => type.FullName?.Replace("+", "."));
|
||||
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>();
|
||||
@@ -157,11 +249,12 @@ public static class SimApiExtensions
|
||||
switch (auth)
|
||||
{
|
||||
case "SimApiAuth":
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
x.AddSecurityDefinition("SimApiAuth",
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header
|
||||
In = ParameterLocation.Header,
|
||||
Type = SecuritySchemeType.ApiKey
|
||||
});
|
||||
break;
|
||||
case "ClientCredentials":
|
||||
@@ -246,6 +339,17 @@ public static class SimApiExtensions
|
||||
});
|
||||
}
|
||||
|
||||
if (simApiOptions.EnableSimApiAuthGate)
|
||||
{
|
||||
builder.AddSingleton<SimApiAuthClient>();
|
||||
builder.AddSingleton<SimApiAuthCenter>();
|
||||
if (simApiOptions.SimApiAuthCenterOptions.UseIam)
|
||||
{
|
||||
builder.AddSingleton<SimApiAuthIam>();
|
||||
}
|
||||
}
|
||||
|
||||
builder.AddSingleton(simApiOptions.SimApiRequestLogOptions);
|
||||
builder.AddSingleton(simApiOptions);
|
||||
return builder;
|
||||
}
|
||||
@@ -265,6 +369,11 @@ public static class SimApiExtensions
|
||||
logger.LogInformation("开始配置 RedisCache ...");
|
||||
}
|
||||
|
||||
if (options.EnableSimApiCache)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiCache...");
|
||||
}
|
||||
|
||||
//请求一下检测存储错误
|
||||
if (options.EnableSimApiStorage)
|
||||
{
|
||||
@@ -272,11 +381,11 @@ public static class SimApiExtensions
|
||||
builder.Services.GetService<SimApiStorage>();
|
||||
}
|
||||
|
||||
if (options.EnableCoceSdk)
|
||||
if (options.EnableSimApiHttpClient)
|
||||
{
|
||||
logger.LogInformation("开始配置CoceAppSdk...\nApi入口: {ApiUrl}\nAuth入口:{AuthUrl}n\nAppId: {AppId}",
|
||||
options.CoceSdkOptions.ApiEndpoint, options.CoceSdkOptions.AuthEndpoint,
|
||||
options.CoceSdkOptions.AppId);
|
||||
logger.LogInformation("开始配置SimApiHttpClient...\n服务器地址: {ApiUrl}\nAppId:{AuthUrl}n\nAppkey: {AppId}",
|
||||
options.SimApiHttpClientOptions.Server, options.SimApiHttpClientOptions.AppId,
|
||||
!string.IsNullOrEmpty(options.SimApiHttpClientOptions.AppKey));
|
||||
}
|
||||
|
||||
if (options.EnableSynapse)
|
||||
@@ -321,57 +430,42 @@ public static class SimApiExtensions
|
||||
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>();
|
||||
builder.MapControllerRoute(name: "GetUserInfo", pattern: "/user/info",
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiAuth",
|
||||
action = "UserInfo"
|
||||
});
|
||||
builder.MapControllerRoute(name: "CheckLogin", pattern: "/auth/check",
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiAuth",
|
||||
action = "CheckLogin"
|
||||
});
|
||||
builder.MapControllerRoute(name: "Logout", pattern: "/auth/logout",
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiAuth",
|
||||
action = "Logout"
|
||||
});
|
||||
if (options.EnableCoceSdk)
|
||||
{
|
||||
logger.LogInformation("开始配置CoceAppSdk...\nApi入口: {ApiUrl}\nAuth入口:{AuthUrl}n\nAppId: {AppId}",
|
||||
options.CoceSdkOptions.ApiEndpoint, options.CoceSdkOptions.AuthEndpoint,
|
||||
options.CoceSdkOptions.AppId);
|
||||
builder.MapControllerRoute(name: "LoginUseCoce", pattern: "/auth/login",
|
||||
defaults: new
|
||||
{
|
||||
controller = "Coce",
|
||||
action = "Login"
|
||||
});
|
||||
builder.MapControllerRoute(name: "LoginUseCoce", pattern: "/user/groups",
|
||||
defaults: new
|
||||
{
|
||||
controller = "Coce",
|
||||
action = "ListGroups"
|
||||
});
|
||||
builder.MapControllerRoute(name: "LoginUseCoce", pattern: "/auth/config",
|
||||
defaults: new
|
||||
{
|
||||
controller = "Coce",
|
||||
action = "GetConfig"
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (options.EnableVersionUrl)
|
||||
|
||||
if (options.SimApiRouteOptions.VersionRoute != null)
|
||||
{
|
||||
builder.MapControllerRoute(name: "Versions", pattern: "/versions",
|
||||
logger.LogInformation("注册内置Route: Versions => {}", options.SimApiRouteOptions.LogoutRoute);
|
||||
builder.MapControllerRoute(name: "Versions", pattern: options.SimApiRouteOptions.VersionRoute,
|
||||
defaults: new
|
||||
{
|
||||
controller = "SimApiCommon",
|
||||
@@ -379,6 +473,28 @@ public static class SimApiExtensions
|
||||
});
|
||||
}
|
||||
|
||||
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.EnableSimApiDoc)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiDoc...");
|
||||
@@ -389,15 +505,20 @@ public static class SimApiExtensions
|
||||
x.DocumentTitle = docOptions.DocumentTitle;
|
||||
foreach (var group in docOptions.ApiGroups)
|
||||
{
|
||||
x.SwaggerEndpoint($"/swagger/{group.Id}.json", name: group.Name);
|
||||
x.SwaggerEndpoint($"{group.Id}.json", name: group.Name);
|
||||
}
|
||||
|
||||
x.EnableValidator();
|
||||
x.SupportedSubmitMethods(docOptions.SupportedMethod);
|
||||
x.DisplayRequestDuration();
|
||||
});
|
||||
}
|
||||
|
||||
if (options.EnableRequestLog)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiRequestLog...");
|
||||
builder.UseMiddleware<SimApiRequestLogMiddleware>();
|
||||
}
|
||||
|
||||
if (options.EnableSimApiException)
|
||||
{
|
||||
logger.LogInformation("开始配置SimApiException...");
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.OpenApi;
|
||||
using SimApi.Attributes;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Reflection;
|
||||
|
||||
@@ -21,11 +22,11 @@ public class AesBodyOperationFilter : IOperationFilter
|
||||
.GetCustomAttribute<AesBodyAttribute>() != null;
|
||||
if (!hasAesBodyAttr) continue;
|
||||
// 1. 移除默认的 Query 参数描述(如果存在)
|
||||
var queryParam = operation.Parameters
|
||||
var queryParam = operation.Parameters!
|
||||
.FirstOrDefault(p => p.Name == parameter.Name);
|
||||
if (queryParam != null)
|
||||
{
|
||||
operation.Parameters.Remove(queryParam);
|
||||
operation.Parameters!.Remove(queryParam);
|
||||
}
|
||||
|
||||
// 2. 添加 Body 参数描述
|
||||
|
||||
@@ -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();
|
||||
}
|
||||
}
|
||||
@@ -1,27 +1,26 @@
|
||||
using System;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using System.Reflection;
|
||||
using Microsoft.OpenApi.Any;
|
||||
using System.Text.Json.Nodes;
|
||||
|
||||
namespace SimApi.SwaggerFilters;
|
||||
|
||||
public class GlobalDynamicObjectSchemaFilter : ISchemaFilter
|
||||
{
|
||||
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
|
||||
public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
|
||||
{
|
||||
if (!IsDynamicObjectType(context.Type)) return;
|
||||
schema.AdditionalPropertiesAllowed = true;
|
||||
schema.AdditionalProperties = new OpenApiSchema
|
||||
var oaSchema = schema as OpenApiSchema;
|
||||
oaSchema!.AdditionalPropertiesAllowed = true;
|
||||
oaSchema.AdditionalProperties = new OpenApiSchema
|
||||
{
|
||||
Type = "object", // 表示 value 可以是任意类型(兼容所有类型)
|
||||
Nullable = true
|
||||
Type = JsonSchemaType.Object, // 表示 value 可以是任意类型(兼容所有类型)
|
||||
};
|
||||
|
||||
// 2. 覆盖默认示例,使用包含多种类型的示例
|
||||
schema.Example = CreateMultiTypeExample();
|
||||
oaSchema.Example = CreateMultiTypeExample();
|
||||
}
|
||||
|
||||
// 判断是否为需要处理的“动态对象”类型
|
||||
@@ -33,30 +32,39 @@ public class GlobalDynamicObjectSchemaFilter : ISchemaFilter
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (type == typeof(object))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return type.Name.Contains("AnonymousType") && type.Namespace == null;
|
||||
}
|
||||
|
||||
// 创建包含多种类型的示例(覆盖默认的 string 示例)
|
||||
private OpenApiObject CreateMultiTypeExample()
|
||||
private JsonNode CreateMultiTypeExample()
|
||||
{
|
||||
return new OpenApiObject
|
||||
return new JsonObject
|
||||
{
|
||||
["stringProp"] = new OpenApiString("example string"), // 字符串
|
||||
["numberProp"] = new OpenApiInteger(123), // 数字
|
||||
["boolProp"] = new OpenApiBoolean(true), // 布尔值
|
||||
["objectProp"] = new OpenApiObject // 嵌套对象
|
||||
// 字符串类型: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"] = new OpenApiString("nested value")
|
||||
["nestedKey"] = JsonValue.Create("nested value")
|
||||
},
|
||||
["arrayProp"] = new OpenApiArray // 数组
|
||||
// 数组类型:JsonArray 对应 OpenApiArray
|
||||
["arrayProp"] = new JsonArray
|
||||
{
|
||||
new OpenApiInteger(1),
|
||||
new OpenApiString("two")
|
||||
}
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using SimApi.Attributes;
|
||||
|
||||
@@ -18,28 +18,12 @@ namespace SimApi.SwaggerFilters
|
||||
||
|
||||
// 控制器上有 [SimApiAuth](继承到所有方法)
|
||||
context.MethodInfo.DeclaringType?.GetCustomAttributes<SimApiAuthAttribute>(true).Any() == true;
|
||||
if (requiresAuth)
|
||||
if (!requiresAuth) return;
|
||||
operation.Security ??= new List<OpenApiSecurityRequirement>();
|
||||
operation.Security.Add(new OpenApiSecurityRequirement()
|
||||
{
|
||||
// 添加授权要求:关联步骤 2 中定义的 "SimApiAuth" 安全方案
|
||||
operation.Security = new List<OpenApiSecurityRequirement>
|
||||
{
|
||||
new OpenApiSecurityRequirement
|
||||
{
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Reference = new OpenApiReference
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "SimApiAuth" // 必须与 AddSecurityDefinition 的第一个参数一致
|
||||
}
|
||||
},
|
||||
[] // 无需指定作用域(scope)时留空
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
// 未标记 [SimApiAuth] 的接口:不添加安全要求,Swagger 不显示锁图标
|
||||
{ new OpenApiSecuritySchemeReference("SimApiAuth", context.Document), [] }
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
using System.Reflection;
|
||||
using System.Threading.Tasks;
|
||||
@@ -46,7 +46,7 @@ public class SimApiResponseOperationFilter : IOperationFilter
|
||||
var schema = context.SchemaGenerator.GenerateSchema(wrappedType, context.SchemaRepository);
|
||||
|
||||
// 5. 替换 Swagger 文档中的响应类型(只保留 200 OK 的响应,匹配过滤器逻辑)
|
||||
operation.Responses.Clear(); // 清除默认响应(如 200 返回原始类型)
|
||||
operation.Responses!.Clear(); // 清除默认响应(如 200 返回原始类型)
|
||||
operation.Responses.Add("200", new OpenApiResponse
|
||||
{
|
||||
Description = "请求成功",
|
||||
|
||||
@@ -3,7 +3,7 @@ using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Microsoft.OpenApi;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.ModelBinders;
|
||||
using Swashbuckle.AspNetCore.SwaggerGen;
|
||||
@@ -67,20 +67,24 @@ public class SimApiSignOperationFilter(IServiceProvider serviceProvider) : IOper
|
||||
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 != null)
|
||||
if (tmp is OpenApiParameter concreteParam)
|
||||
{
|
||||
tmp.Required = required;
|
||||
tmp.Description = description;
|
||||
// 重新赋值只读属性(通过实例化新对象覆盖,或直接修改具体类的可写属性)
|
||||
concreteParam.Required = required; // OpenApiParameter 的 Required 有 setter
|
||||
concreteParam.Description = description;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
operation.Parameters ??= new List<OpenApiParameter>();
|
||||
operation.Parameters ??= new List<IOpenApiParameter>();
|
||||
operation.Parameters.Add(new OpenApiParameter
|
||||
{
|
||||
Name = name,
|
||||
@@ -89,7 +93,7 @@ public class SimApiSignOperationFilter(IServiceProvider serviceProvider) : IOper
|
||||
Required = required,
|
||||
Schema = new OpenApiSchema
|
||||
{
|
||||
Type = "string" // 签名相关参数通常为字符串类型
|
||||
Type = JsonSchemaType.String // 签名相关参数通常为字符串类型
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@@ -17,8 +17,9 @@ public partial class Synapse
|
||||
}
|
||||
else
|
||||
{
|
||||
paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
|
||||
paramJson = SimApiUtil.Json(param);
|
||||
}
|
||||
|
||||
var topic = $"{Options.SysName}/event/{Options.AppName}/{eventName}";
|
||||
var message = new MqttApplicationMessageBuilder()
|
||||
.WithTopic(topic)
|
||||
|
||||
@@ -50,7 +50,7 @@ public partial class Synapse
|
||||
}
|
||||
else
|
||||
{
|
||||
paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
|
||||
paramJson = SimApiUtil.Json(param);
|
||||
}
|
||||
|
||||
var topic = $"{Options.SysName}/{app}/rpc/server/{action}";
|
||||
@@ -73,7 +73,7 @@ public partial class Synapse
|
||||
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, JsonSerializer.Serialize(headers));
|
||||
messageId, Options.AppName, action, app, paramJson, SimApiUtil.Json(headers));
|
||||
|
||||
string response;
|
||||
try
|
||||
@@ -88,13 +88,12 @@ public partial class Synapse
|
||||
}
|
||||
else
|
||||
{
|
||||
response = JsonSerializer.Serialize(new SimApiBaseResponse(502, "timeout"), SimApiUtil.JsonOption);
|
||||
response = SimApiUtil.Json(new SimApiBaseResponse(502, "timeout"));
|
||||
}
|
||||
}
|
||||
catch
|
||||
{
|
||||
response = JsonSerializer.Serialize(new SimApiBaseResponse(500, "Synapse RPC Client Error"),
|
||||
SimApiUtil.JsonOption);
|
||||
response = SimApiUtil.Json(new SimApiBaseResponse(500, "Synapse RPC Client Error"));
|
||||
}
|
||||
|
||||
return response;
|
||||
|
||||
@@ -10,7 +10,7 @@ using MQTTnet.Protocol;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Helpers;
|
||||
using JsonSerializer = System.Text.Json.JsonSerializer;
|
||||
using System.Text.Json;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
@@ -96,7 +96,7 @@ public partial class Synapse
|
||||
}
|
||||
}
|
||||
|
||||
var returnJson = JsonSerializer.Serialize((object)res, SimApiUtil.JsonOption);
|
||||
var returnJson = SimApiUtil.Json(res);
|
||||
var reply = $"{Options.SysName}/{appInfo[0]}/rpc/client/{appInfo[1]}/{appInfo[2]}";
|
||||
var message = new MqttApplicationMessageBuilder()
|
||||
.WithTopic(reply)
|
||||
|
||||
+1
-1
@@ -101,7 +101,7 @@ public partial class Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logge
|
||||
else
|
||||
{
|
||||
var data = FireRpc(appName, method, param, headers, timeout);
|
||||
res = JsonSerializer.Deserialize<SimApiBaseResponse<T>>(data, SimApiUtil.JsonOption);
|
||||
res = SimApiUtil.FromJson<SimApiBaseResponse<T>>(data);
|
||||
}
|
||||
|
||||
return (res as SimApiBaseResponse<T>)!;
|
||||
|
||||
Reference in New Issue
Block a user