Compare commits

...
16 Commits
Author SHA1 Message Date
xrain e17b9d9eed request log add stringfield length 2026-08-11 04:22:36 +08:00
xrain 80a05ea20b 移除了version路由, 融合进config 2026-08-10 22:07:38 +08:00
xrain 33f7cff11c 修复了版本节点错误 2026-08-07 21:45:13 +08:00
xrain c7a4395000 cache/auth 不强依赖Redis 2026-08-07 03:45:19 +08:00
xrain bf98792f96 字典请求返回格式化 2026-07-14 18:59:13 +08:00
xrain 8c5081d442 新增 SimApiRequestLogMiddleware 请求日志中间件,支持配置 ShowFullHeader / ShowFullResponse 2026-07-11 16:15:03 +08:00
xrain 2ed4605a2c PageResponse修正 2026-06-23 17:47:42 +08:00
xrain ceeea2c451 http客户端加密debug输出,版本升级 2026-06-23 16:13:04 +08:00
xrain 464878edce http客户端返回修改,版本升级 2026-06-23 15:25:35 +08:00
xrain aaba8b8b73 fix 2026-05-22 12:37:00 +08:00
xrain 6e2ae11c54 修正了方法名称,修正了说明文档 2026-05-20 10:53:41 +08:00
xrain d0a5e996c9 fix sdk 2026-05-20 09:45:35 +08:00
xrain 3b405079c1 修改命名空间 2026-05-20 09:38:40 +08:00
xrain 611808787e 修正了错误 2026-05-12 12:09:36 +08:00
xrain 8ee297e819 修正了错误 2026-05-12 12:05:03 +08:00
xrain bc4195e984 现在内置路由单独控制了 2026-05-12 11:48:37 +08:00
23 changed files with 1015 additions and 1192 deletions
+4
View File
@@ -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,15 +1,16 @@
using System;
using System.Collections.Generic;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using SimApi.Communications;
using static SimApi.Helpers.SimApiError;
namespace SimApi.AuthGate;
namespace SimApi.AuthSDK;
public class SimApiAuthGate(SimApiAuthGateClient simapi)
public class SimApiAuthCenter(SimApiAuthClient simapi)
{
#region AuthGate公开接口
public SimApiAuthClient Client { get; } = simapi;
#region
/// <summary>
/// 委托AuthCenter进行应用签名验证
@@ -21,13 +22,68 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
public void VerifySign(string appId, string timestamp, string nonce, string sign)
{
var http = new HttpClient();
var url = $"{simapi.Server}/api/auth/sign/verify?appId={appId}&timestamp={timestamp}&nonce={nonce}&sign={sign}";
var url = $"{Client.Server}/api/auth/sign/verify?appId={appId}&timestamp={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>
@@ -35,9 +91,9 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <param name="skip"></param>
/// <param name="take"></param>
/// <returns></returns>
public SimApiAuthGateDto.AppAndProfileItem[]? ProfileSearch(string keyword, int skip = 0, int take = 20)
public SimApiAuthCenterDto.AppAndProfileItem[]? ProfileSearch(string keyword, int skip = 0, int take = 20)
{
return simapi.SignQuery<SimApiAuthGateDto.AppAndProfileItem[]>("/api/auth/profile/search",
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/profile/search",
new { keyword, skip, take });
}
@@ -46,9 +102,9 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// </summary>
/// <param name="ids"></param>
/// <returns></returns>
public SimApiAuthGateDto.AppAndProfileItem[]? ProfileList(string[] ids)
public SimApiAuthCenterDto.AppAndProfileItem[]? ProfileList(string[] ids)
{
return simapi.SignQuery<SimApiAuthGateDto.AppAndProfileItem[]>("/api/auth/profile/list", new { ids });
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/profile/list", new { ids });
}
#endregion
@@ -63,7 +119,7 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <returns></returns>
public bool CheckIsAppOwner(string profileId, string applicationId)
{
return simapi.SignQuery<bool>("/api/auth/internal/apps/check-owner", new
return Client.SignQuery<bool>("/api/auth/internal/app/check-owner", new
{
ProfileId = profileId,
AppId = applicationId,
@@ -76,9 +132,9 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <param name="profileId"></param>
/// <param name="appIds"></param>
/// <returns></returns>
public SimApiAuthGateDto.AppAndProfileItem[]? GetAppList(string profileId, IEnumerable<string> appIds)
public SimApiAuthCenterDto.AppAndProfileItem[]? GetAppList(string profileId, IEnumerable<string> appIds)
{
return simapi.SignQuery<SimApiAuthGateDto.AppAndProfileItem[]>("/api/auth/internal/apps/related", new
return Client.SignQuery<SimApiAuthCenterDto.AppAndProfileItem[]>("/api/auth/internal/app/related", new
{
ProfileId = profileId,
AllowedAppIds = appIds,
@@ -96,16 +152,17 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <param name="data"></param>
/// <param name="backUrl"></param>
/// <returns></returns>
public SimApiAuthGateDto.GetCodeResponse GetAuthCode(string? scene = null, Dictionary<string, object>? data = null,
public SimApiAuthCenterDto.GetCodeResponse GetLoginCode(string? scene = null,
Dictionary<string, object>? data = null,
string? backUrl = null)
{
var code = simapi.SignQuery<string>("/api/auth/confirm/code",
var code = Client.SignQuery<string>("/api/auth/login/code",
new { scene, data, backUrl });
return new SimApiAuthGateDto.GetCodeResponse()
return new SimApiAuthCenterDto.GetCodeResponse()
{
Code = code!,
Server = simapi.Server,
FullUrl = $"{simapi.Server}/auth?code={code}"
Server = Client.Server,
FullUrl = $"{Client.Server}/auth?code={code}"
};
}
@@ -115,9 +172,9 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <param name="code"></param>
/// <param name="scene"></param>
/// <returns></returns>
public SimApiAuthGateDto.AuthInfoResponse GetAuthInfo(string code, string? scene = null)
public SimApiAuthCenterDto.LoginInfoResponse GetLoginInfo(string code, string? scene = null)
{
var resp = simapi.SignQuery<SimApiAuthGateDto.AuthInfoResponse>("/api/auth/confirm/get", new { code });
var resp = Client.SignQuery<SimApiAuthCenterDto.LoginInfoResponse>("/api/auth/login/get", new { code });
ErrorWhenNull(resp, 400232, "登录信息获取失败");
ErrorWhen(resp.Scene != scene, 403003, "登录场景不匹配");
return resp;
@@ -135,17 +192,17 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <param name="data"></param>
/// <param name="backUrl"></param>
/// <returns></returns>
public SimApiAuthGateDto.GetCodeResponse GetConfirmCode(string scene, string userId,
public SimApiAuthCenterDto.GetCodeResponse GetConfirmCode(string scene, string userId,
Dictionary<string, object>? data = null,
string? backUrl = null)
{
var code = simapi.SignQuery<string>("/api/auth/confirm/code",
var code = Client.SignQuery<string>("/api/auth/confirm/code",
new { scene, data, backUrl, profileId = userId });
return new SimApiAuthGateDto.GetCodeResponse()
return new SimApiAuthCenterDto.GetCodeResponse()
{
Code = code!,
Server = simapi.Server,
FullUrl = $"{simapi.Server}/confirm?code={code}"
Server = Client.Server,
FullUrl = $"{Client.Server}/confirm?code={code}"
};
}
@@ -156,9 +213,9 @@ public class SimApiAuthGate(SimApiAuthGateClient simapi)
/// <param name="scene"></param>
/// <param name="userId"></param>
/// <returns></returns>
public SimApiAuthGateDto.ConfirmResponse Confirm(string code, string scene, string? userId = null)
public SimApiAuthCenterDto.ConfirmResponse Confirm(string code, string scene, string? userId = null)
{
var resp = simapi.SignQuery<SimApiAuthGateDto.ConfirmResponse>("/api/auth/confirm/get", new { code });
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, "安全确认场景不匹配");
@@ -1,14 +1,14 @@
using System;
using System.Collections.Generic;
namespace SimApi.AuthGate;
namespace SimApi.AuthSDK;
public class SimApiAuthGateDto
public class SimApiAuthCenterDto
{
public class AppAndProfileItem
{
public string Id { get; set; } = "";
public string Name { get; set; } = "";
public required string Id { get; set; }
public required string Name { get; set; }
public string? Image { get; set; }
public string? Description { get; set; }
}
@@ -21,7 +21,7 @@ public class SimApiAuthGateDto
public Dictionary<string, object>? Data { get; set; }
}
public class AuthInfoResponse
public class LoginInfoResponse
{
public string? Scene { get; set; }
public Dictionary<string, object>? Data { get; set; }
@@ -37,4 +37,25 @@ public class SimApiAuthGateDto
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; } = [];
}
}
@@ -5,9 +5,9 @@ using SimApi.Communications;
using SimApi.Configurations;
using SimApi.Helpers;
namespace SimApi.AuthGate;
namespace SimApi.AuthSDK;
public class SimApiAuthGateMiddleware(RequestDelegate next, ILogger<SimApiAuthGateMiddleware> logger)
public class SimApiAuthCenterMiddleware(RequestDelegate next, ILogger<SimApiAuthCenterMiddleware> logger)
{
public Task Invoke(HttpContext httpContext, SimApiOptions simApiOptions)
{
@@ -16,7 +16,7 @@ public class SimApiAuthGateMiddleware(RequestDelegate next, ILogger<SimApiAuthGa
httpContext.Request.Headers.TryGetValue("X-SimApi-Gate-Sign", out var sign))
{
var signStr =
$"appId={simApiOptions.SimApiAuthGateOptions.AppId}&auth={auth}&time={time}&appKey={simApiOptions.SimApiAuthGateOptions.AppKey}";
$"appId={simApiOptions.SimApiAuthCenterOptions.AppId}&auth={auth}&time={time}&appKey={simApiOptions.SimApiAuthCenterOptions.AppKey}";
logger.LogDebug($"签名字符串 => {signStr}");
if (SimApiUtil.Md5(signStr) == sign && !string.IsNullOrEmpty(auth))
{
@@ -2,12 +2,12 @@
using SimApi.Configurations;
using SimApi.Helpers;
namespace SimApi.AuthGate;
namespace SimApi.AuthSDK;
public class SimApiAuthGateClient(SimApiOptions apiOptions, ILogger<SimApiAuthGateClient> logger)
public class SimApiAuthClient(SimApiOptions apiOptions, ILogger<SimApiAuthClient> logger)
: SimApiHttpClient(apiOptions, logger)
{
public override string Server { get; init; } = apiOptions.SimApiAuthGateOptions.Server ?? string.Empty;
public override string AppId { get; init; } = apiOptions.SimApiAuthGateOptions.AppId ?? string.Empty;
public override string AppKey { get; init; } = apiOptions.SimApiAuthGateOptions.AppKey ?? string.Empty;
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;
}
@@ -1,15 +1,15 @@
using Microsoft.Extensions.Logging;
using static SimApi.Helpers.SimApiError;
namespace SimApi.AuthGate;
namespace SimApi.AuthSDK;
public class SimApiIam(SimApiAuthGateClient simapi, ILogger<SimApiIam> logger)
public class SimApiAuthIam(SimApiAuthClient simapi, ILogger<SimApiAuthIam> logger)
{
/// <summary>
/// 向Iam注册权限
/// </summary>
/// <param name="permissions"></param>
public void RegisterPermissions(SimApiIamDto.PermissionItem[] permissions)
public void RegisterPermissions(SimApiAuthIamDto.PermissionItem[] permissions)
{
var log = $"检测到 {permissions.Length} 个权限接口,正在注册..: ";
foreach (var permission in permissions)
@@ -26,10 +26,11 @@ public class SimApiIam(SimApiAuthGateClient simapi, ILogger<SimApiIam> logger)
/// 获取拥有的权限标识数组
/// </summary>
/// <param name="profileId"></param>
/// <param name="groupId"></param>
/// <returns></returns>
public string[] GetPermissionOwned(string profileId)
public string[] GetPermissionOwned(string profileId, string? groupId = null)
{
return simapi.SignQuery<string[]>("/api/iam/permission/owned", new { profileId }) ?? [];
return simapi.SignQuery<string[]>("/api/iam/permission/owned", new { profileId, groupId }) ?? [];
}
/// <summary>
@@ -37,9 +38,10 @@ public class SimApiIam(SimApiAuthGateClient simapi, ILogger<SimApiIam> logger)
/// </summary>
/// <param name="profileId"></param>
/// <param name="permission"></param>
public void CheckPermission(string profileId, string permission)
/// <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 });
var ok = simapi.SignQuery<bool>("/api/iam/permission/check", new { profileId, permission, groupId });
ErrorWhen(!ok, 403, "没有该权限");
}
}
@@ -1,6 +1,6 @@
namespace SimApi.AuthGate;
namespace SimApi.AuthSDK;
public class SimApiIamDto
public class SimApiAuthIamDto
{
public class PermissionItem
{
+1 -1
View File
@@ -51,7 +51,7 @@ public class SimApiBaseResponse(int code = 200, string message = "成功")
/// <typeparam name="T"></typeparam>
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; }
@@ -1,6 +1,6 @@
namespace SimApi.Configurations;
public class SimApiAuthGateOptions
public class SimApiAuthCenterOptions
{
public string? Server { get; set; }
public string? AppId { get; set; }
+45 -13
View File
@@ -1,11 +1,25 @@
using System;
using System.Collections.Generic;
namespace SimApi.Configurations;
public class SimApiOptions
{
/// <summary>
/// Redis配置
/// </summary>
public string? RedisConfiguration { get; set; }
/// <summary>
/// 原样返回给前端的配置信息
/// </summary>
public Dictionary<string, object>? WebConfig { get; set; }
/// <summary>
/// WebConfig返回是否包含版本信息
/// </summary>
public bool WebConfigIncludeVersion { get; set; } = true;
/// <summary>
/// 是否启用后台任务系统 *基于Hangfire
/// </summary>
@@ -17,6 +31,12 @@ public class SimApiOptions
/// </summary>
public bool EnableSimApiAuth { get; set; }
/// <summary>
/// 启用Cache功能
/// </summary>
public bool EnableSimApiCache { get; set; } = true;
/// <summary>
/// 启用SimApi网关授权, 基于上层网关透传的身份令牌验证
/// </summary>
@@ -56,6 +76,11 @@ public class SimApiOptions
/// </summary>
public bool EnableSimApiResponseFilter { get; set; } = true;
/// <summary>
/// 启用请求日志中间件
/// default: false
/// </summary>
public bool EnableRequestLog { get; set; }
/// <summary>
/// 开启ForwardHeaders,开启后可以透传负载均衡的Headers
@@ -69,24 +94,17 @@ 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
/// </summary>
@@ -104,12 +122,21 @@ public class SimApiOptions
public SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new();
public SimApiAuthGateOptions SimApiAuthGateOptions { 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);
@@ -140,8 +167,13 @@ public class SimApiOptions
options?.Invoke(SimApiJobOptions);
}
public void ConfigureSimApiAuthGate(Action<SimApiAuthGateOptions>? options = null)
public void ConfigureSimApiAuthCenter(Action<SimApiAuthCenterOptions>? options = null)
{
options?.Invoke(SimApiAuthGateOptions);
options?.Invoke(SimApiAuthCenterOptions);
}
public void ConfigureSimApiRequestLog(Action<SimApiRequestLogOptions>? options = null)
{
options?.Invoke(SimApiRequestLogOptions);
}
}
+19
View File
@@ -0,0 +1,19 @@
namespace SimApi.Configurations;
public class SimApiRequestLogOptions
{
/// <summary>
/// 是否打印完整的请求Header
/// </summary>
public bool ShowFullHeader { get; set; }
/// <summary>
/// 是否打印完整的响应体
/// </summary>
public bool ShowFullResponse { get; set; }
/// <summary>
/// 请求字段显示最长长度
/// </summary>
public int RequestStringLogLength { get; set; } = 0;
}
+8
View File
@@ -0,0 +1,8 @@
namespace SimApi.Configurations;
public class SimApiRouteOptions
{
public string? LogoutRoute = "/auth/logout";
public string? UserInfoRoute = "/user/info";
public string? WebConfigRoute = "/config";
}
-3
View File
@@ -5,8 +5,6 @@ using SimApi.Helpers;
namespace SimApi.Controllers;
using static SimApiError;
public class SimApiAuthController(SimApiAuth auth) : SimApiBaseController
{
/// <summary>
@@ -21,5 +19,4 @@ public class SimApiAuthController(SimApiAuth auth) : SimApiBaseController
auth.Logout(value!);
}
}
}
+21 -8
View File
@@ -1,13 +1,16 @@
using System.Collections.Generic;
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using SimApi.Attributes;
using SimApi.Communications;
using SimApi.Configurations;
using SimApi.Helpers;
using static SimApi.Helpers.SimApiError;
namespace SimApi.Controllers;
public class SimApiCommonController : SimApiBaseController
public class SimApiCommonController(SimApiOptions simApiOptions) : SimApiBaseController
{
/// <summary>
/// 错误回馈页面
@@ -21,21 +24,31 @@ public class SimApiCommonController : SimApiBaseController
Error(code);
}
/// <summary>
/// 给前端的自定义信息
/// </summary>
/// <returns></returns>
[HttpPost, HttpGet]
public Dictionary<string, string> Versions()
public Dictionary<string, object> WebConfig()
{
return new Dictionary<string, string>
var resp = simApiOptions.WebConfig!.ToDictionary();
if (simApiOptions.WebConfigIncludeVersion)
{
{ "SimApi", SimApiUtil.SimApiVersion },
{ "App", SimApiUtil.AppVersion }
};
resp.Add("Versions", new Dictionary<string, string>
{
{ "SimApi", SimApiUtil.SimApiVersion },
{ "App", SimApiUtil.AppVersion }
});
}
return resp;
}
/// <summary>
/// 获取已登录用户信息
/// </summary>
/// <returns></returns>
[HttpPost("/user/info"), SimApiAuth, SimApiDoc("认证", "获取已登录用户信息")]
[HttpPost, SimApiAuth, SimApiDoc("认证", "获取已登录用户信息")]
public SimApiLoginItem UserInfo() => LoginInfo;
}
+108 -43
View File
@@ -1,19 +1,32 @@
using System;
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, IConnectionMultiplexer redis)
public class SimApiAuth
{
private const string TokenCacheKey = "SimApi:Auth:Token:{token}";
private const string TokenSetCacheKey = "SimApi:Auth:User:{userId}";
private readonly IDatabase _redisDb = redis.GetDatabase();
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>
/// 登录信息
@@ -28,13 +41,20 @@ public class SimApiAuth(IDistributedCache cache, IConnectionMultiplexer redis)
token ??= Guid.NewGuid().ToString();
var cacheKey = TokenCacheKey.Replace("{token}", token);
var setCacheKey = TokenSetCacheKey.Replace("{userId}", loginItem.Id);
_redisDb.SetAdd(setCacheKey, token);
cache.SetString(cacheKey, SimApiUtil.Json(loginItem),
new DistributedCacheEntryOptions
{
SlidingExpiration = expireTime
});
_redisDb.KeyExpire(setCacheKey, expireTime.Value);
_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;
}
@@ -48,10 +68,15 @@ public class SimApiAuth(IDistributedCache cache, IConnectionMultiplexer redis)
public string Update(SimApiLoginItem loginItem, string token)
{
var cacheKey = TokenCacheKey.Replace("{token}", token);
cache.SetString(cacheKey, SimApiUtil.Json(loginItem));
var ttl = _redisDb.KeyTimeToLive(cacheKey);
var setCacheKey = TokenSetCacheKey.Replace("{userId}", loginItem.Id);
_redisDb.KeyExpire(setCacheKey, ttl);
_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;
}
@@ -64,9 +89,10 @@ public class SimApiAuth(IDistributedCache cache, IConnectionMultiplexer redis)
public SimApiLoginItem? GetLogin(string token)
{
var cacheKey = TokenCacheKey.Replace("{token}", token);
var login = cache.GetString(cacheKey);
var login = _cache.GetString(cacheKey);
var resp = login != null ? SimApiUtil.FromJson<SimApiLoginItem>(login) : null;
if (resp != null)
if (resp != null && _redisDb != null)
{
var ttl = _redisDb.KeyTimeToLive(cacheKey);
var setCacheKey = TokenSetCacheKey.Replace("{userId}", resp.Id);
@@ -83,26 +109,42 @@ public class SimApiAuth(IDistributedCache cache, IConnectionMultiplexer redis)
/// <returns></returns>
public SimApiLoginItem[] GetAllLogins(string userId)
{
var setCacheKey = TokenSetCacheKey.Replace("{userId}", userId);
var allLogins = _redisDb.SetMembers(setCacheKey).ToStringArray();
var resp = new List<SimApiLoginItem>();
foreach (var login in allLogins)
if (_redisDb != null)
{
if (login != null)
var setCacheKey = TokenSetCacheKey.Replace("{userId}", userId);
var allLogins = _redisDb.SetMembers(setCacheKey).ToStringArray();
var resp = new List<SimApiLoginItem>();
foreach (var login in allLogins)
{
var item = GetLogin(login);
if (item != null)
if (login != null)
{
resp.Add(item);
}
else
{
_redisDb.SetRemove(setCacheKey, login);
var item = GetLogin(login);
if (item != null)
resp.Add(item);
else
_redisDb.SetRemove(setCacheKey, login);
}
}
}
return resp.ToArray();
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>
@@ -111,18 +153,32 @@ public class SimApiAuth(IDistributedCache cache, IConnectionMultiplexer redis)
/// <param name="userId"></param>
public void LogoutAll(string userId)
{
var setCacheKey = TokenSetCacheKey.Replace("{userId}", userId);
var allLogins = _redisDb.SetMembers(setCacheKey).ToStringArray();
foreach (var login in allLogins)
if (_redisDb != null)
{
if (login != null)
var setCacheKey = TokenSetCacheKey.Replace("{userId}", userId);
var allLogins = _redisDb.SetMembers(setCacheKey).ToStringArray();
foreach (var login in allLogins)
{
var cacheKey = TokenCacheKey.Replace("{token}", login);
cache.Remove(cacheKey);
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);
}
}
}
_redisDb.KeyDelete(setCacheKey);
}
/// <summary>
@@ -132,13 +188,22 @@ public class SimApiAuth(IDistributedCache cache, IConnectionMultiplexer redis)
public void Logout(string token)
{
var item = GetLogin(token);
if (item != null)
if (_redisDb != null)
{
var setCacheKey = TokenSetCacheKey.Replace("{userId}", item.Id);
_redisDb.SetRemove(setCacheKey, token);
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);
_cache.Remove(cacheKey);
}
}
}
+1 -1
View File
@@ -65,7 +65,7 @@ public static class SimApiError
/// <param name="code">错误代码</param>
/// <param name="message">错误描述</param>
public static void ErrorWhenNull([NotNull] object? condition, int code = 404,
string message = "请求的资源不存在")
string message = "")
{
ErrorWhen(condition == null, code, message);
}
+16 -14
View File
@@ -12,15 +12,15 @@ namespace SimApi.Helpers;
public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHttpClient>? logger = null)
{
public virtual string Server { get; init; } = apiOptions?.SimApiHttpClientOptions.Server ?? string.Empty;
public virtual string AppId { get; init; } = apiOptions?.SimApiHttpClientOptions.AppId ?? string.Empty;
public virtual string AppKey { get; init; } = apiOptions?.SimApiHttpClientOptions.AppKey ?? string.Empty;
public virtual string 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 virtual string SignName { get; init; } = "sign";
public virtual string TimestampName { get; init; } = "timestamp";
public virtual string NonceName { get; init; } = "nonce";
public virtual string? AppIdName { get; init; } = "appId";
public virtual string[] SignFields { get; init; } = [];
/// <summary>
/// 发起签名请求
@@ -30,7 +30,7 @@ public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHt
/// <param name="queries"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public T? SignQuery<T>(string url, object? body = null, Dictionary<string, string>? queries = null)
public T SignQuery<T>(string url, object? body = null, Dictionary<string, string>? queries = null)
{
url = Server + url;
var queryUrl = SignFields.Aggregate(string.Empty,
@@ -60,14 +60,14 @@ public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHt
/// <param name="body"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public T? AesQuery<T>(string url, object body)
public T AesQuery<T>(string url, object body)
{
url = Server + url;
if (!string.IsNullOrEmpty(AppIdName))
{
url += $"?{AppIdName}={AppId}";
}
logger?.LogDebug($"[HTTPCLIENT请求][加密前BODY] {url}\n{SimApiUtil.Json(body)}\n");
var req = new SimApiOneFieldRequest<string>
{
Data = SimApiAesUtil.Encrypt(SimApiUtil.Json(body), AppKey)
@@ -83,8 +83,9 @@ public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHt
/// <param name="queries"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public T? AesSignQuery<T>(string url, object body, Dictionary<string, string>? queries = null)
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)
@@ -100,15 +101,16 @@ public class SimApiHttpClient(SimApiOptions? apiOptions = null, ILogger<SimApiHt
/// <typeparam name="T"></typeparam>
/// <returns></returns>
/// <exception cref="SimApiException"></exception>
private T? Query<T>(string url, object? req)
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;
return res.Data!;
}
}
+6 -2
View File
@@ -45,11 +45,15 @@ public class SimApiExceptionMiddleware(
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, "服务器异常");
response = new SimApiBaseResponse(500, "服务器错误");
log.LogError(ex, ex.Message);
response = new SimApiBaseResponse(500);
}
await ErrorResponseAsync(context, response);
+124
View File
@@ -0,0 +1,124 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.ExceptionServices;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using SimApi.Configurations;
using SimApi.Helpers;
namespace SimApi.Middlewares;
/// <summary>
/// 请求日志中间件
/// </summary>
public class SimApiRequestLogMiddleware(
RequestDelegate next,
ILogger<SimApiRequestLogMiddleware> log,
SimApiRequestLogOptions options)
{
public async Task InvokeAsync(HttpContext context)
{
var sw = Stopwatch.StartNew();
var fullUrl =
$"{context.Request.Scheme}://{context.Request.Host}{context.Request.Path}{context.Request.QueryString}";
var logMessage = new StringBuilder();
logMessage.AppendLine($"[{context.Request.Method}] {fullUrl}");
if (options.ShowFullHeader)
{
logMessage.AppendLine("*( RequestHeaders [Full] ) =>");
var headersDict = new Dictionary<string, string>();
foreach (var header in context.Request.Headers)
{
headersDict[header.Key] = header.Value.ToString();
}
logMessage.AppendLine(JsonSerializer.Serialize(headersDict));
}
else
{
logMessage.AppendLine("*( RequestHeaders ) =>");
var token = context.Request.Headers["Token"].FirstOrDefault() ?? "";
var queryId = context.Request.Headers["Query-Id"].FirstOrDefault() ?? "";
logMessage.AppendLine($"Token: {token} QueryId: {queryId}");
}
context.Request.EnableBuffering();
var requestBodyText = await new StreamReader(context.Request.Body).ReadToEndAsync();
context.Request.Body.Seek(0, SeekOrigin.Begin);
logMessage.AppendLine("*( RequestBody ) =>");
if (options.RequestStringLogLength == 0)
{
logMessage.AppendLine(requestBodyText);
}
else
{
var reqLogs = SimApiUtil.FromJson<Dictionary<string, object>>(requestBodyText);
foreach (var reqLog in reqLogs)
{
if (reqLog.Value is not JsonElement { ValueKind: JsonValueKind.String } je) continue;
var str = je.GetString();
if (str?.Length > options.RequestStringLogLength)
{
reqLogs[reqLog.Key] = str[..options.RequestStringLogLength] + $"...({str.Length})";
}
}
logMessage.AppendLine(SimApiUtil.Json(reqLogs));
}
var originalBodyStream = context.Response.Body;
using var responseBody = new MemoryStream();
context.Response.Body = responseBody;
ExceptionDispatchInfo? edi = null;
try
{
await next(context);
}
catch (Exception ex)
{
edi = ExceptionDispatchInfo.Capture(ex);
}
finally
{
sw.Stop();
responseBody.Seek(0, SeekOrigin.Begin);
var responseText = await new StreamReader(responseBody).ReadToEndAsync();
logMessage.AppendLine($"*( Response [{context.Response.StatusCode}] ) =>");
if (options.ShowFullResponse)
{
logMessage.Append(responseText);
}
else
{
var truncated = responseText.Length > 200 ? responseText[..200] : responseText;
logMessage.Append(truncated);
}
if (edi != null)
{
logMessage.Append(Environment.NewLine);
logMessage.Append($"Exception: {edi.SourceException}");
}
responseBody.Seek(0, SeekOrigin.Begin);
await responseBody.CopyToAsync(originalBodyStream);
context.Response.Body = originalBodyStream;
log.LogInformation(logMessage.ToString());
}
edi?.Throw();
}
}
+449 -1038
View File
File diff suppressed because it is too large Load Diff
+5 -5
View File
@@ -12,13 +12,13 @@
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.22" />
<PackageReference Include="Hangfire.AspNetCore" Version="1.8.23" />
<PackageReference Include="Hangfire.Console" Version="1.4.3"/>
<PackageReference Include="Hangfire.Redis.StackExchange" Version="1.12.0"/>
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="10.0.1" />
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="10.0.9" />
<PackageReference Include="Minio" Version="7.0.0" />
<PackageReference Include="MQTTnet" Version="5.0.1.1416"/>
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="10.1.0" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.1.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>
</Project>
+54 -14
View File
@@ -16,7 +16,7 @@ using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using SimApi.Attributes;
using SimApi.AuthGate;
using SimApi.AuthSDK;
using SimApi.Configurations;
using SimApi.Interfaces;
using SimApi.Logger;
@@ -36,11 +36,22 @@ public static class SimApiExtensions
{
var simApiOptions = new SimApiOptions();
options?.Invoke(simApiOptions);
simApiOptions.WebConfig ??= new();
builder.AddSingleton(simApiOptions);
if (simApiOptions.RedisConfiguration != null)
{
builder.AddStackExchangeRedisCache(x => x.Configuration = simApiOptions.RedisConfiguration);
builder.AddSingleton<IConnectionMultiplexer>(_ =>
ConnectionMultiplexer.Connect(simApiOptions.RedisConfiguration));
}
else if (simApiOptions.EnableSimApiAuth || simApiOptions.EnableSimApiCache)
{
builder.AddDistributedMemoryCache();
}
if (simApiOptions.EnableSimApiCache)
{
builder.AddSingleton<SimApiCache>();
}
@@ -209,6 +220,7 @@ public static class SimApiExtensions
x.OperationFilter<SimApiSignOperationFilter>();
x.OperationFilter<AesBodyOperationFilter>();
x.SchemaFilter<GlobalDynamicObjectSchemaFilter>();
x.SchemaFilter<DictionarySchemaFilter>();
x.DocumentFilter<RemoveEmptyTagsFilter>();
if (simApiOptions.EnableSimApiAuth)
{
@@ -331,15 +343,15 @@ public static class SimApiExtensions
if (simApiOptions.EnableSimApiAuthGate)
{
builder.AddSingleton<SimApiAuthGateClient>();
builder.AddSingleton<SimApiAuthGate>();
if (simApiOptions.SimApiAuthGateOptions.UseIam)
builder.AddSingleton<SimApiAuthClient>();
builder.AddSingleton<SimApiAuthCenter>();
if (simApiOptions.SimApiAuthCenterOptions.UseIam)
{
builder.AddSingleton<SimApiIam>();
builder.AddSingleton<SimApiAuthIam>();
}
}
builder.AddSingleton(simApiOptions);
builder.AddSingleton(simApiOptions.SimApiRequestLogOptions);
return builder;
}
@@ -358,6 +370,11 @@ public static class SimApiExtensions
logger.LogInformation("开始配置 RedisCache ...");
}
if (options.EnableSimApiCache)
{
logger.LogInformation("开始配置SimApiCache...");
}
//请求一下检测存储错误
if (options.EnableSimApiStorage)
{
@@ -425,16 +442,16 @@ public static class SimApiExtensions
if (options.EnableSimApiAuthGate)
{
logger.LogInformation("开始配置SimApiAuthGate...");
if (string.IsNullOrEmpty(options.SimApiAuthGateOptions.AppId) ||
string.IsNullOrEmpty(options.SimApiAuthGateOptions.AppKey))
if (string.IsNullOrEmpty(options.SimApiAuthCenterOptions.AppId) ||
string.IsNullOrEmpty(options.SimApiAuthCenterOptions.AppKey))
{
logger.LogCritical("必须配置AuthGate的AppId和AppKey才能启用SimApiAuthGate");
}
else
{
if (options.SimApiAuthGateOptions.UseMiddleware)
if (options.SimApiAuthCenterOptions.UseMiddleware)
{
builder.UseMiddleware<SimApiAuthGateMiddleware>();
builder.UseMiddleware<SimApiAuthCenterMiddleware>();
}
}
}
@@ -443,7 +460,23 @@ public static class SimApiExtensions
{
logger.LogInformation("开始配置SimApiAuth...");
builder.UseMiddleware<SimApiAuthMiddleware>();
builder.MapControllerRoute(name: "Logout", pattern: "/auth/logout",
}
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",
@@ -451,13 +484,14 @@ public static class SimApiExtensions
});
}
if (options.EnableVersionUrl)
if (options.SimApiRouteOptions.WebConfigRoute != null)
{
builder.MapControllerRoute(name: "Versions", pattern: "/versions",
logger.LogInformation("注册内置Route: Logout => {}", options.SimApiRouteOptions.WebConfigRoute);
builder.MapControllerRoute(name: "WebConfig", pattern: options.SimApiRouteOptions.WebConfigRoute,
defaults: new
{
controller = "SimApiCommon",
action = "Versions"
action = "WebConfig"
});
}
@@ -479,6 +513,12 @@ public static class SimApiExtensions
});
}
if (options.EnableRequestLog)
{
logger.LogInformation("开始配置SimApiRequestLog...");
builder.UseMiddleware<SimApiRequestLogMiddleware>();
}
if (options.EnableSimApiException)
{
logger.LogInformation("开始配置SimApiException...");
+24
View File
@@ -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();
}
}