Compare commits

...
10 Commits
Author SHA1 Message Date
xrain cb291691d5 upgrade to c#12 2024-03-23 07:29:43 +08:00
xrain 47a48d0103 增加了model默认字段 2024-03-23 07:12:25 +08:00
xrain 4c50acc309 增加了model默认字段 2024-03-23 07:10:17 +08:00
xrain be9092bf3c fix rpc client error 2023-10-30 03:45:15 +08:00
xrain 345aaa261e fix readme 2023-10-23 17:42:37 +08:00
xrain f98cc6ff5a add common json options 2023-10-23 17:39:27 +08:00
xrain a3fff03ff6 优化了Exception报错 2023-10-20 15:29:32 +08:00
xrain caeb697421 fix some bug 2023-10-20 14:13:53 +08:00
xrain ef721b227b add Synapse System 2023-10-20 12:33:18 +08:00
xrain 56b5421290 change log for once output 2023-09-26 20:47:41 +08:00
31 changed files with 1563 additions and 1078 deletions
+1 -1
View File
@@ -14,7 +14,7 @@ jobs:
- name: Setup .NET Core - name: Setup .NET Core
uses: actions/setup-dotnet@v1 uses: actions/setup-dotnet@v1
with: with:
dotnet-version: "7.0.100" dotnet-version: "8.0.200"
- name: Publish - name: Publish
run: | run: |
version=`git describe --tags` version=`git describe --tags`
+4 -11
View File
@@ -5,8 +5,8 @@ using Microsoft.AspNetCore.Mvc.Filters;
using SimApi.Communications; using SimApi.Communications;
using SimApi.Exceptions; using SimApi.Exceptions;
namespace SimApi.Attributes namespace SimApi.Attributes;
{
/// <summary> /// <summary>
/// 检测登录中间件 /// 检测登录中间件
/// </summary> /// </summary>
@@ -19,10 +19,7 @@ namespace SimApi.Attributes
//默认是user登录类型 //默认是user登录类型
public SimApiAuthAttribute() public SimApiAuthAttribute()
{ {
Types = new[] Types = new[] { "user" };
{
"user"
};
} }
//只检测一种用户类型的快捷方式 //只检测一种用户类型的快捷方式
@@ -40,10 +37,7 @@ namespace SimApi.Attributes
//只检测一种用户类型的快捷方式 //只检测一种用户类型的快捷方式
public SimApiAuthAttribute(string type, string url) public SimApiAuthAttribute(string type, string url)
{ {
Types = new[] Types = new[] { type };
{
type
};
new HttpPostAttribute(url); new HttpPostAttribute(url);
} }
@@ -62,4 +56,3 @@ namespace SimApi.Attributes
} }
} }
} }
}
+2 -3
View File
@@ -1,8 +1,8 @@
using System; using System;
using Swashbuckle.AspNetCore.Annotations; using Swashbuckle.AspNetCore.Annotations;
namespace SimApi.Attributes namespace SimApi.Attributes;
{
/// <summary> /// <summary>
/// 快捷自定义接口文档类 /// 快捷自定义接口文档类
/// </summary> /// </summary>
@@ -22,4 +22,3 @@ namespace SimApi.Attributes
// Produces = new[] {"application/json"}; // Produces = new[] {"application/json"};
} }
} }
}
+14
View File
@@ -0,0 +1,14 @@
using System;
namespace SimApi.Attributes;
[AttributeUsage(AttributeTargets.Method)]
public class SynapseEventAttribute : Attribute
{
public string Name { get; }
public SynapseEventAttribute(string name)
{
Name = name;
}
}
+19
View File
@@ -0,0 +1,19 @@
using System;
namespace SimApi.Attributes;
[AttributeUsage(AttributeTargets.Method)]
public class SynapseRpcAttribute : Attribute
{
public string Name { get; }
public SynapseRpcAttribute()
{
Name = null;
}
public SynapseRpcAttribute(string name)
{
Name = name;
}
}
+2 -3
View File
@@ -1,5 +1,5 @@
namespace SimApi.Communications namespace SimApi.Communications;
{
/// <summary> /// <summary>
/// 只有ID的请求 /// 只有ID的请求
/// </summary> /// </summary>
@@ -20,4 +20,3 @@
/// 基础分页请求 /// 基础分页请求
/// </summary> /// </summary>
public record SimApiBasePageRequest(int Page, int Count); public record SimApiBasePageRequest(int Page, int Count);
}
+15 -26
View File
@@ -2,8 +2,8 @@
using System.Text.Json; using System.Text.Json;
using System.Text.Json.Serialization; using System.Text.Json.Serialization;
namespace SimApi.Communications namespace SimApi.Communications;
{
/// <summary> /// <summary>
/// 基础相应 /// 基础相应
/// </summary> /// </summary>
@@ -14,27 +14,13 @@ namespace SimApi.Communications
/// </summary> /// </summary>
private static readonly Dictionary<int, string> MsgBox = new() private static readonly Dictionary<int, string> MsgBox = new()
{ {
{ { 200, "成功" },
200, "成功" { 204, "没有数据" },
}, { 400, "参数错误" },
{ { 401, "需要登录" },
204, "没有数据" { 403, "无权访问" },
}, { 404, "接口不存在" },
{ { 500, "服务器错误" }
400, "参数错误"
},
{
401, "需要登录"
},
{
403, "无权访问"
},
{
404, "接口不存在"
},
{
500, "服务器错误"
}
}; };
public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误") public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误")
@@ -63,8 +49,12 @@ namespace SimApi.Communications
/// 动态内容分页 /// 动态内容分页
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public record SimApiBasePageResponse<T> public record SimApiBasePageResponse<T>(
(T List, int Page = 1, int Count = 1, int Total = 1, int Code = 200, T List,
int Page = 1,
int Count = 1,
int Total = 1,
int Code = 200,
string Message = "成功") : SimApiBaseResponse(Code, Message); string Message = "成功") : SimApiBaseResponse(Code, Message);
/// <summary> /// <summary>
@@ -73,4 +63,3 @@ namespace SimApi.Communications
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code, public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code,
Message); Message);
}
+2 -3
View File
@@ -1,7 +1,6 @@
namespace SimApi.Communications namespace SimApi.Communications;
{
/// <summary> /// <summary>
/// 登录信息中间件 /// 登录信息中间件
/// </summary> /// </summary>
public record SimApiLoginItem(string Id, string[] Type); public record SimApiLoginItem(string Id, string[] Type);
}
+7 -5
View File
@@ -1,9 +1,8 @@
using System; using System.Collections.Generic;
using System.Collections.Generic;
using Swashbuckle.AspNetCore.SwaggerUI; using Swashbuckle.AspNetCore.SwaggerUI;
namespace SimApi.Configs namespace SimApi.Configs;
{
/// <summary> /// <summary>
/// 文档组配置 /// 文档组配置
/// </summary> /// </summary>
@@ -31,9 +30,13 @@ namespace SimApi.Configs
public class SimApiAuthOption public class SimApiAuthOption
{ {
public string[] Type { get; set; } = new[] { "SimApiAuth" }; public string[] Type { get; set; } = new[] { "SimApiAuth" };
public string Description { get; set; } = "认证服务器颁发的AccessToken"; public string Description { get; set; } = "认证服务器颁发的AccessToken";
public string AuthorizationUrl { get; set; } public string AuthorizationUrl { get; set; }
public string TokenUrl { get; set; } public string TokenUrl { get; set; }
public Dictionary<string, string> Scopes { get; set; } public Dictionary<string, string> Scopes { get; set; }
} }
@@ -70,4 +73,3 @@ namespace SimApi.Configs
/// </summary> /// </summary>
public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post }; public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
} }
}
+21 -5
View File
@@ -1,7 +1,7 @@
using System; using System;
namespace SimApi.Configs namespace SimApi.Configs;
{
public class SimApiOptions public class SimApiOptions
{ {
/// <summary> /// <summary>
@@ -52,16 +52,33 @@ namespace SimApi.Configs
/// </summary> /// </summary>
public bool EnableLogger { get; set; } = false; public bool EnableLogger { get; set; } = false;
/// <summary>
/// 是否启用Synapse
/// </summary>
public bool EnableSynapse { get; set; } = false;
/// <summary> /// <summary>
/// Swagger文档相关配置,需要启用 EnableSimApiDoc /// Swagger文档相关配置,需要启用 EnableSimApiDoc
/// </summary> /// </summary>
public SimApiDocOptions SimApiDocOptions { get; set; } = new SimApiDocOptions(); public SimApiDocOptions SimApiDocOptions { get; set; } = new();
/// <summary> /// <summary>
/// S3兼容的存储系统配置,需要启用 EnableSimApiStorage /// S3兼容的存储系统配置,需要启用 EnableSimApiStorage
/// </summary> /// </summary>
public SimApiStorageOptions SimApiStorageOptions { get; set; } = new SimApiStorageOptions(); public SimApiStorageOptions SimApiStorageOptions { get; set; } = new();
public SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new();
public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions> options = null)
{
options?.Invoke(SimApiSynapseOptions);
}
public void ConfigureSimApiSynapse(SimApiSynapseOptions options)
{
SimApiSynapseOptions = options;
}
public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null) public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null)
{ {
@@ -73,4 +90,3 @@ namespace SimApi.Configs
options?.Invoke(SimApiStorageOptions); options?.Invoke(SimApiStorageOptions);
} }
} }
}
+2 -3
View File
@@ -1,5 +1,5 @@
namespace SimApi.Configs namespace SimApi.Configs;
{
public class SimApiStorageOptions public class SimApiStorageOptions
{ {
/// <summary> /// <summary>
@@ -21,4 +21,3 @@ namespace SimApi.Configs
public string SecretKey { get; set; } public string SecretKey { get; set; }
} }
}
+30
View File
@@ -0,0 +1,30 @@
namespace SimApi.Configs;
public class SimApiSynapseOptions
{
public string MqHost { get; set; }
public int MqPort { get; set; }
public string MqUser { get; set; }
public string MqPass { get; set; }
public string MqVHost { get; set; } = "/";
public string SysName { get; set; }
public string AppName { get; set; }
public string AppId { get; set; }
public int RpcTimeout { get; set; } = 3;
public ushort EventProcessorNum { get; set; } = 20;
public ushort RpcProcessorNum { get; set; } = 20;
public bool DisableEventClient { get; set; } = false;
public bool DisableRpcClient { get; set; } = false;
}
+2 -4
View File
@@ -4,10 +4,9 @@ using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding; using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Linq; using System.Linq;
using SimApi.Exceptions; using SimApi.Exceptions;
using SimApi.Attributes;
namespace SimApi.Controllers namespace SimApi.Controllers;
{
/// <summary> /// <summary>
/// 基础控制器,所有控制器均继承本控制器 /// 基础控制器,所有控制器均继承本控制器
/// 1. 自动验证请求参数 /// 1. 自动验证请求参数
@@ -84,4 +83,3 @@ namespace SimApi.Controllers
return new SimApiBaseResponse<string>(null); return new SimApiBaseResponse<string>(null);
} }
} }
}
+5 -14
View File
@@ -1,21 +1,13 @@
using System; using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc;
using SimApi.Attributes; using SimApi.Attributes;
using SimApi.Communications; using SimApi.Communications;
using SimApi.Helpers; using SimApi.Helpers;
namespace SimApi.Controllers namespace SimApi.Controllers;
{
[ApiExplorerSettings(GroupName = "api")] [ApiExplorerSettings(GroupName = "api")]
public class YYCommonController : SimApiBaseController public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
{ {
private SimApiAuth Auth { get; }
public YYCommonController(SimApiAuth auth)
{
Auth = auth;
}
/// <summary> /// <summary>
/// 错误回馈页面 /// 错误回馈页面
/// </summary> /// </summary>
@@ -53,8 +45,7 @@ namespace SimApi.Controllers
token = Request.Headers["Token"]; token = Request.Headers["Token"];
} }
Auth.Logout(token); auth.Logout(token);
return new SimApiBaseResponse(); return new SimApiBaseResponse();
} }
} }
}
+5 -10
View File
@@ -1,16 +1,11 @@
using System; using System;
namespace SimApi.Exceptions
{ namespace SimApi.Exceptions;
/// <summary> /// <summary>
/// Api错误捕获异常 /// Api错误捕获异常
/// </summary> /// </summary>
public class SimApiException : Exception public class SimApiException(int code, string message = "") : Exception(message)
{ {
public int Code { get; } public int Code { get; } = code;
public SimApiException(int code, string message = "") : base(message)
{
Code = code;
}
}
} }
+6 -18
View File
@@ -1,23 +1,15 @@
using System; using System;
using System.Text.Json; using System.Text.Json;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using SimApi.Communications; using SimApi.Communications;
namespace SimApi.Helpers namespace SimApi.Helpers;
{
/// <summary> /// <summary>
/// 认证助手 /// 认证助手
/// </summary> /// </summary>
public class SimApiAuth public class SimApiAuth(IDistributedCache cache)
{ {
private IDistributedCache Cache { get; }
public SimApiAuth(IDistributedCache cache)
{
Cache = cache;
}
/// <summary> /// <summary>
/// 产生一个Token记录并返回Token /// 产生一个Token记录并返回Token
/// </summary> /// </summary>
@@ -25,10 +17,7 @@ namespace SimApi.Helpers
/// <returns></returns> /// <returns></returns>
public string Login(string id, string type = "user", string token = null) public string Login(string id, string type = "user", string token = null)
{ {
return Login(id, new[] return Login(id, new[] { type }, token);
{
type
}, token);
} }
/// <summary> /// <summary>
@@ -41,7 +30,7 @@ namespace SimApi.Helpers
{ {
uuid ??= Guid.NewGuid().ToString(); uuid ??= Guid.NewGuid().ToString();
var loginItem = new SimApiLoginItem(id, type); var loginItem = new SimApiLoginItem(id, type);
Cache.SetString(uuid, JsonSerializer.Serialize(loginItem)); cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
return uuid; return uuid;
} }
@@ -53,8 +42,7 @@ namespace SimApi.Helpers
{ {
if (!string.IsNullOrEmpty(uuid)) if (!string.IsNullOrEmpty(uuid))
{ {
Cache.Remove(uuid); cache.Remove(uuid);
}
} }
} }
} }
+3 -5
View File
@@ -2,11 +2,10 @@
using System.IO; using System.IO;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using Minio; using Minio;
using Minio.Exceptions;
using SimApi.Configs; using SimApi.Configs;
namespace SimApi.Helpers namespace SimApi.Helpers;
{
public class SimApiStorage public class SimApiStorage
{ {
private MinioClient Mc { get; } private MinioClient Mc { get; }
@@ -97,7 +96,6 @@ namespace SimApi.Helpers
return path; return path;
} }
return path.StartsWith("~") ? url + path.Substring(1, path.Length - 1) : $"{ServeUrl}{path}"; return path.StartsWith('~') ? string.Concat(url, path.AsSpan(1, path.Length - 1)) : $"{ServeUrl}{path}";
}
} }
} }
+21 -20
View File
@@ -3,28 +3,33 @@ using System.Security.Cryptography;
using System.Text; using System.Text;
using System.Text.Encodings.Web; using System.Text.Encodings.Web;
using System.Text.Json; using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
using System.Text.Unicode; using System.Text.Unicode;
namespace SimApi.Helpers namespace SimApi.Helpers;
{
public static class SimApiUtil public static class SimApiUtil
{ {
/// <summary> /// <summary>
/// 当前CST时间 /// 当前CST时间
/// </summary> /// </summary>
public static DateTime CstNow public static DateTime CstNow => DateTime.UtcNow.AddHours(8);
/// <summary>
/// JSON序列化常规选项
/// </summary>
public static JsonSerializerOptions JsonOption => new()
{ {
get => DateTime.UtcNow.AddHours(8); Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
} PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};
/// <summary> /// <summary>
/// 当前秒级时间戳 /// 当前秒级时间戳
/// </summary> /// </summary>
public static double TimestampNow public static double TimestampNow => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
{
get => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
}
/// <summary> /// <summary>
/// 检测手机号是否正确 /// 检测手机号是否正确
@@ -45,13 +50,13 @@ namespace SimApi.Helpers
/// <returns></returns> /// <returns></returns>
public static string Md5(string source, string mode = "x2") public static string Md5(string source, string mode = "x2")
{ {
byte[] sor = Encoding.UTF8.GetBytes(source); var sor = Encoding.UTF8.GetBytes(source);
MD5 md5 = MD5.Create(); var md5 = MD5.Create();
byte[] result = md5.ComputeHash(sor); var result = md5.ComputeHash(sor);
StringBuilder strbul = new StringBuilder(40); var strbul = new StringBuilder(40);
for (int i = 0; i < result.Length; i++) foreach (var t in result)
{ {
strbul.Append(result[i].ToString(mode)); strbul.Append(t.ToString(mode));
} }
return strbul.ToString(); return strbul.ToString();
@@ -64,10 +69,6 @@ namespace SimApi.Helpers
/// <returns></returns> /// <returns></returns>
public static string Json(object obj) public static string Json(object obj)
{ {
return JsonSerializer.Serialize(obj, new JsonSerializerOptions return JsonSerializer.Serialize(obj, JsonOption);
{
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All)
});
}
} }
} }
+7 -19
View File
@@ -2,17 +2,10 @@ using System;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using SimApi.Helpers; using SimApi.Helpers;
namespace SimApi.Logger namespace SimApi.Logger;
{
public class SimApiLogger : ILogger
{
private string Name { get; }
public SimApiLogger(string name) public class SimApiLogger(string name) : ILogger
{ {
Name = name;
}
public IDisposable BeginScope<TState>(TState state) => default!; public IDisposable BeginScope<TState>(TState state) => default!;
public bool IsEnabled(LogLevel logLevel) => true; public bool IsEnabled(LogLevel logLevel) => true;
@@ -20,7 +13,6 @@ namespace SimApi.Logger
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception,
Func<TState, Exception, string> formatter) Func<TState, Exception, string> formatter)
{ {
var defautColor = Console.ForegroundColor;
Console.ForegroundColor = logLevel switch Console.ForegroundColor = logLevel switch
{ {
LogLevel.Debug => ConsoleColor.DarkMagenta, LogLevel.Debug => ConsoleColor.DarkMagenta,
@@ -28,18 +20,14 @@ namespace SimApi.Logger
LogLevel.Warning => ConsoleColor.Yellow, LogLevel.Warning => ConsoleColor.Yellow,
LogLevel.Error => ConsoleColor.Red, LogLevel.Error => ConsoleColor.Red,
LogLevel.Critical => ConsoleColor.DarkRed, LogLevel.Critical => ConsoleColor.DarkRed,
_ => defautColor _ => ConsoleColor.White
}; };
Console.WriteLine( var message =
$"[ {Name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]"); $"[ {name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
Console.ForegroundColor = defautColor;
Console.WriteLine($"{state}");
if (exception != null) if (exception != null)
{ {
Console.WriteLine($"{exception}"); message += $"{exception}\n";
}
Console.WriteLine();
} }
Console.WriteLine(message);
} }
} }
+3 -5
View File
@@ -1,12 +1,11 @@
using System.Collections.Concurrent; using System.Collections.Concurrent;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
namespace SimApi.Logger namespace SimApi.Logger;
{
public class SimApiLoggerProvider : ILoggerProvider public class SimApiLoggerProvider : ILoggerProvider
{ {
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers = private readonly ConcurrentDictionary<string, SimApiLogger> _loggers = new();
new ConcurrentDictionary<string, SimApiLogger>();
public ILogger CreateLogger(string categoryName) public ILogger CreateLogger(string categoryName)
@@ -19,4 +18,3 @@ namespace SimApi.Logger
_loggers.Clear(); _loggers.Clear();
} }
} }
}
+6 -14
View File
@@ -4,26 +4,19 @@ using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using SimApi.Communications; using SimApi.Communications;
namespace SimApi.Middlewares namespace SimApi.Middlewares;
{
/// <summary> /// <summary>
/// 认证信息获取中间件 /// 认证信息获取中间件
/// </summary> /// </summary>
public class SimApiAuthMiddleware public class SimApiAuthMiddleware(RequestDelegate next)
{ {
private RequestDelegate Next { get; }
public SimApiAuthMiddleware(RequestDelegate next)
{
Next = next;
}
public Task Invoke(HttpContext httpContext, IDistributedCache cache) public Task Invoke(HttpContext httpContext, IDistributedCache cache)
{ {
string token = null; string token = null;
if (httpContext.Request.Headers.ContainsKey("Token")) if (httpContext.Request.Headers.TryGetValue("Token", out var header))
{ {
token = httpContext.Request.Headers["Token"]; token = header;
} }
if (!string.IsNullOrEmpty(token)) if (!string.IsNullOrEmpty(token))
@@ -35,7 +28,6 @@ namespace SimApi.Middlewares
} }
} }
return Next(httpContext); return next(httpContext);
}
} }
} }
+11 -25
View File
@@ -6,40 +6,27 @@ using SimApi.Communications;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using SimApi.Exceptions; using SimApi.Exceptions;
namespace SimApi.Middlewares namespace SimApi.Middlewares;
{
/// <summary> /// <summary>
/// 异常处理中间件 /// 异常处理中间件
/// </summary> /// </summary>
public class SimApiExceptionMiddleware public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
{ {
private RequestDelegate Next { get; }
private ILogger<SimApiExceptionMiddleware> Log { get; }
public SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
{
Log = log;
Next = next;
}
public async Task InvokeAsync(HttpContext context) public async Task InvokeAsync(HttpContext context)
{ {
if (context.Request.Headers.ContainsKey("Query-Id")) if (context.Request.Headers.TryGetValue("Query-Id", out var header))
{ {
context.Response.Headers["Query-Id"] = context.Request.Headers["Query-Id"]; context.Response.Headers["Query-Id"] = header;
} }
var response = new SimApiBaseResponse(); SimApiBaseResponse response;
try try
{ {
await Next(context); await next(context);
if (context.Response.StatusCode != 200) if (context.Response.StatusCode != 200)
{ {
if (!new[] if (!new[] { 301, 302 }.Contains(context.Response.StatusCode))
{
301, 302
}.Contains(context.Response.StatusCode))
{ {
throw new SimApiException(context.Response.StatusCode); throw new SimApiException(context.Response.StatusCode);
} }
@@ -55,8 +42,8 @@ namespace SimApi.Middlewares
} }
catch (Exception ex) catch (Exception ex)
{ {
Log.LogError(ex.Message); log.LogError(ex.Message);
Log.LogError(ex.StackTrace); log.LogError(ex.StackTrace);
response = new SimApiBaseResponse(500, ex.Message); response = new SimApiBaseResponse(500, ex.Message);
ErrorResponse(context, response); ErrorResponse(context, response);
} }
@@ -72,9 +59,8 @@ namespace SimApi.Middlewares
if (!context.Response.HasStarted) if (!context.Response.HasStarted)
{ {
context.Response.StatusCode = 200; context.Response.StatusCode = 200;
context.Response.Headers.Add("Content-Type", "application/json"); context.Response.Headers.Append("Content-Type", "application/json");
context.Response.WriteAsync(response.ToString()); context.Response.WriteAsync(response.ToString());
} }
} }
} }
}
+13 -8
View File
@@ -1,16 +1,22 @@
using System; using System;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq; using System.Linq;
using System.Text.Json;
using SimApi.Helpers; using SimApi.Helpers;
namespace SimApi.Models namespace SimApi.Models;
{
public class SimApiBaseModel public class SimApiBaseModel
{ {
protected virtual string[] MapperIgnoreField { get; set; } = [Column(Order = 1)]
{ public string Id { get; set; } = Guid.NewGuid().ToString();
"Id", "CreatedAt", "UpdatedAt"
}; [Column(Order = 9998)]
public DateTime UpdatedAt { get; set; } = SimApiUtil.CstNow;
[Column(Order = 9999)]
public DateTime CreatedAt { get; set; } = SimApiUtil.CstNow;
protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" };
protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt"; protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt";
@@ -81,4 +87,3 @@ namespace SimApi.Models
GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow); GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow);
} }
} }
}
+2 -1
View File
@@ -1,4 +1,4 @@
# YYApi 基于Asp.net Core 3/5的一个基础辅助包 # SimApi 基于.Net的一个基础辅助包
[![PublishNugetPackage](https://github.com/simcu/simapi-net/actions/workflows/nuget-publish.yml/badge.svg)](https://github.com/simcu/simapi-net/actions/workflows/nuget-publish.yml) [![PublishNugetPackage](https://github.com/simcu/simapi-net/actions/workflows/nuget-publish.yml/badge.svg)](https://github.com/simcu/simapi-net/actions/workflows/nuget-publish.yml)
### 包含了以下组件: ### 包含了以下组件:
@@ -52,3 +52,4 @@ services.AddSimApi(options =>
options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>(); options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>();
}); });
``` ```
基于S3的存储,基于RabbitMq的事件RPC调用,自定义Logger格式,自定义响应格式
+2 -3
View File
@@ -14,7 +14,7 @@
<SynchReleaseVersion>false</SynchReleaseVersion> <SynchReleaseVersion>false</SynchReleaseVersion>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageVersion>5.0.2</PackageVersion> <PackageVersion>5.0.2</PackageVersion>
<TargetFrameworks>net6.0;net7.0</TargetFrameworks> <TargetFramework>net8.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
@@ -22,12 +22,11 @@
<Folder Include="Communications\"/> <Folder Include="Communications\"/>
<Folder Include="Controllers\"/> <Folder Include="Controllers\"/>
<Folder Include="Middlewares\"/> <Folder Include="Middlewares\"/>
<Folder Include="Attributes\" />
<Folder Include="Exceptions\"/> <Folder Include="Exceptions\"/>
<Folder Include="Configurations\" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Minio" Version="4.0.7"/> <PackageReference Include="Minio" Version="4.0.7"/>
<PackageReference Include="RabbitMQ.Client" Version="6.6.0"/>
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0"/> <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0"/>
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0"/> <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0"/>
</ItemGroup> </ItemGroup>
+15 -11
View File
@@ -9,8 +9,8 @@ using Microsoft.Extensions.Logging;
using SimApi.Configs; using SimApi.Configs;
using SimApi.Logger; using SimApi.Logger;
namespace SimApi namespace SimApi;
{
/// <summary> /// <summary>
/// 加入系统的扩展信息 /// 加入系统的扩展信息
/// </summary> /// </summary>
@@ -42,6 +42,11 @@ namespace SimApi
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); })); policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
} }
if (simApiOptions.EnableSynapse)
{
builder.AddSingleton<Synapse>();
}
// 使用SimApiDoc // 使用SimApiDoc
if (simApiOptions.EnableSimApiDoc) if (simApiOptions.EnableSimApiDoc)
{ {
@@ -77,10 +82,7 @@ namespace SimApi
Id = "HeaderToken" Id = "HeaderToken"
} }
}, },
new[] new[] { "readAccess", "writeAccess" }
{
"readAccess", "writeAccess"
}
} }
}); });
haveSimApiAuth = true; haveSimApiAuth = true;
@@ -143,10 +145,7 @@ namespace SimApi
Id = "oauth2" Id = "oauth2"
} }
}, },
new[] new[] { "SimApiAuth" }
{
"SimApiAuth"
}
} }
}); });
} }
@@ -254,7 +253,12 @@ namespace SimApi
logger.LogInformation("开始配置使用URL小写..."); logger.LogInformation("开始配置使用URL小写...");
} }
if (options.EnableSynapse)
{
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
synapse.Init();
}
return builder; return builder;
} }
} }
}
+31
View File
@@ -0,0 +1,31 @@
using System;
using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Unicode;
using Microsoft.Extensions.Logging;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private void RunEventClient()
{
EventClientChannel = CreateChannel(0, "EventClient");
}
private void FireEvent(string eventName, object param)
{
var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
var router = $"event.{Options.AppName}.{eventName}";
var props = EventClientChannel.CreateBasicProperties();
props.AppId = Options.AppId;
props.MessageId = Guid.NewGuid().ToString();
props.ReplyTo = Options.AppName;
props.Type = eventName;
EventClientChannel.BasicPublish(Options.SysName, router, false, props, Encoding.UTF8.GetBytes(paramJson));
Logger.LogDebug("Event Publish: {OptionsAppName}.{EventName}\n{ParamJson}", Options.AppName, eventName,
paramJson);
}
}
+50
View File
@@ -0,0 +1,50 @@
using System;
using System.Linq;
using System.Text;
using System.Text.Json;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using RabbitMQ.Client.Events;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private void RunEventServer()
{
EventServerChannel = CreateChannel(Options.EventProcessorNum, "EventServer");
var queue = $"{Options.SysName}_{Options.AppName}_event";
EventServerChannel.QueueDeclare(queue, true, false, true, null);
foreach (var ev in EventRegistry.Where(ev => !ev.Key.Contains('*') && !ev.Key.Contains('#')))
{
EventServerChannel.QueueBind(queue, Options.SysName, $"event.{ev.Key}", null);
}
var consumer = new EventingBasicConsumer(EventServerChannel);
consumer.Received += (ch, ea) =>
{
var reqBody = Encoding.UTF8.GetString(ea.Body.ToArray());
Logger.LogDebug("Event Receive: {BasicPropertiesReplyTo}.{BasicPropertiesType}\n{S}",
ea.BasicProperties.ReplyTo, ea.BasicProperties.Type, reqBody);
var key = ea.RoutingKey.Replace("event.", string.Empty);
var method = EventRegistry.FirstOrDefault(x => x.Key == key);
var callClass = Sp.CreateScope().ServiceProvider.GetRequiredService(method.Class);
var mt = callClass.GetType().GetMethod(method.Method);
var pt = mt.GetParameters()[0].ParameterType;
try
{
mt.Invoke(callClass, pt == typeof(string)
? new object[] { reqBody }
: new[] { JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption) });
EventServerChannel.BasicAck(ea.DeliveryTag, false);
}
catch (Exception e)
{
Logger.LogError("Event Processor Error: {Err}", e.InnerException);
EventServerChannel.BasicNack(ea.DeliveryTag, false, false);
}
};
EventServerChannel.BasicConsume(queue, false, "", false, false, null, consumer);
}
}
+70
View File
@@ -0,0 +1,70 @@
using System;
using System.Collections.Generic;
using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Unicode;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json.Serialization;
using RabbitMQ.Client.Events;
using SimApi.Communications;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private Dictionary<string, byte[]> ResponseCache { get; } = new();
private void RunRpcClient()
{
RpcClientChannel = CreateChannel(0, "RpcClient");
var queue = $"{Options.SysName}_{Options.AppName}_client_{Options.AppId}";
var router = $"client.{Options.AppName}.{Options.AppId}";
RpcClientChannel.QueueDeclare(queue, true, false, true, null);
RpcClientChannel.QueueBind(queue, Options.SysName, router, null);
var consumer = new EventingBasicConsumer(RpcClientChannel);
consumer.Received += (ch, ea) =>
{
ResponseCache.Add(ea.BasicProperties.CorrelationId, ea.Body.ToArray());
RpcClientChannel.BasicAck(ea.DeliveryTag, false);
Logger.LogDebug(
"RPC Response: ({BasicPropertiesCorrelationId}) {BasicPropertiesType}@{BasicPropertiesReplyTo} -> {OptionsAppName}\n{S}",
ea.BasicProperties.CorrelationId, ea.BasicProperties.Type, ea.BasicProperties.ReplyTo, Options.AppName,
Encoding.UTF8.GetString(ea.Body.ToArray()));
};
RpcClientChannel.BasicConsume(queue, false, "", false, false, null, consumer);
}
private string FireRpc(string app, string action, object param)
{
var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
var router = $"server.{app}";
string response;
var props = RpcClientChannel.CreateBasicProperties();
props.AppId = Options.AppId;
props.MessageId = Guid.NewGuid().ToString();
props.Type = action;
props.ReplyTo = Options.AppName;
RpcClientChannel.BasicPublish(Options.SysName, router, false, props, Encoding.UTF8.GetBytes(paramJson));
Logger.LogDebug("RPC Request: ({PropsMessageId}) {OptionsAppName} -> {Action}@{App}\n{ParamJson}",
props.MessageId,
Options.AppName, action, app, paramJson);
var ts = SimApiUtil.TimestampNow;
while (true)
{
if (SimApiUtil.TimestampNow - ts > Options.RpcTimeout)
{
response = JsonSerializer.Serialize(new SimApiBaseResponse(502, "timeout"), SimApiUtil.JsonOption);
break;
}
if (ResponseCache.TryGetValue(props.MessageId, out var value))
{
response = Encoding.UTF8.GetString(value);
ResponseCache.Remove(props.MessageId);
break;
}
}
return response;
}
}
+93
View File
@@ -0,0 +1,93 @@
using System;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.Unicode;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using RabbitMQ.Client.Events;
using SimApi.Communications;
using SimApi.Exceptions;
using SimApi.Helpers;
using JsonSerializer = System.Text.Json.JsonSerializer;
namespace SimApi;
public partial class Synapse
{
private void RunRpcServer()
{
RpcServerChannel = CreateChannel(Options.RpcProcessorNum, "RpcServer");
var queue = $"{Options.SysName}_{Options.AppName}_server";
var router = $"server.{Options.AppName}";
RpcServerChannel.QueueDeclare(queue, true, false, true, null);
RpcServerChannel.QueueBind(queue, Options.SysName, router, null);
var consumer = new EventingBasicConsumer(RpcServerChannel);
consumer.Received += (ch, ea) =>
{
var reqBody = Encoding.UTF8.GetString(ea.Body.ToArray());
Logger.LogDebug(
"RPC Receive: ({BasicPropertiesMessageId}) {BasicPropertiesReplyTo} -> {BasicPropertiesType}@{OptionsAppName}\n{S}",
ea.BasicProperties.MessageId, ea.BasicProperties.ReplyTo, ea.BasicProperties.Type, Options.AppName,
reqBody);
var res = new SimApiBaseResponse(404, "method not found");
var method = RpcRegistry.FirstOrDefault(x => x.Key == ea.BasicProperties.Type);
if (method != null)
{
var callClass = Sp.CreateScope().ServiceProvider.GetRequiredService(method.Class);
var mt = callClass.GetType().GetMethod(method.Method);
var param = Array.Empty<object>();
try
{
var pt = mt.GetParameters()[0].ParameterType;
if (pt == typeof(string))
{
param = new[] { reqBody };
}
else
{
var paramObj = JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption);
param = new[] { paramObj };
}
var ret = mt.Invoke(callClass, param);
res = new SimApiBaseResponse<object>(ret);
}
catch (TargetInvocationException e)
{
if (e.InnerException is SimApiException ie)
{
Logger.LogDebug("RPC调用错误: {Err}", ie.Message);
res = new SimApiBaseResponse(ie.Code, ie.Message);
}
else
{
res = new SimApiBaseResponse(500, e.Message);
}
}
catch (Exception e)
{
Logger.LogDebug("RPC调用失败: {Err}", e.Message);
res = new SimApiBaseResponse(500, e.Message);
}
}
var returnJson = JsonSerializer.Serialize((object)res, SimApiUtil.JsonOption);
var reply = $"client.{ea.BasicProperties.ReplyTo}.{ea.BasicProperties.AppId}";
var props = RpcServerChannel.CreateBasicProperties();
props.AppId = Options.AppId;
props.CorrelationId = ea.BasicProperties.MessageId;
props.MessageId = Guid.NewGuid().ToString();
props.ReplyTo = Options.AppName;
props.Type = ea.BasicProperties.Type;
RpcServerChannel.BasicPublish(Options.SysName, reply, false, props, Encoding.UTF8.GetBytes(returnJson));
Logger.LogDebug(
"Rpc Return: ({BasicPropertiesMessageId}) {BasicPropertiesType}@{OptionsAppName} -> {BasicPropertiesReplyTo}\n{ReturnJson}",
ea.BasicProperties.MessageId, ea.BasicProperties.Type, Options.AppName, ea.BasicProperties.ReplyTo,
returnJson);
};
RpcServerChannel.BasicConsume(queue, true, "", false, false, null, consumer);
}
}
+238
View File
@@ -0,0 +1,238 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text.Json;
using Microsoft.Extensions.Logging;
using RabbitMQ.Client;
using RabbitMQ.Client.Exceptions;
using SimApi.Attributes;
using SimApi.Communications;
using SimApi.Configs;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private IServiceProvider Sp { get; }
private SimApiSynapseOptions Options { get; }
private ILogger<Synapse> Logger { get; }
private IConnection Connection { get; set; }
private IModel EventClientChannel { get; set; }
private IModel EventServerChannel { get; set; }
private IModel RpcClientChannel { get; set; }
private IModel RpcServerChannel { get; set; }
private List<RegisterItem> EventRegistry { get; set; }
private List<RegisterItem> RpcRegistry { get; set; }
public Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logger, IServiceProvider sp)
{
Logger = logger;
Sp = sp;
Options = simApiOptions.SimApiSynapseOptions;
}
public void Init()
{
ProcessAttribute();
Logger.LogDebug("Synapse初始化配置信息: {Json}", SimApiUtil.Json(Options));
if (string.IsNullOrEmpty(Options.AppName) || string.IsNullOrEmpty(Options.SysName))
{
Logger.LogCritical("Synapse初始化失败: AppName or SysName 错误");
}
Options.AppId ??= Guid.NewGuid().ToString();
Logger.LogInformation("System Name: {SysName}\nApp Name: {AppName}\nAppId: {AppId}", Options.SysName,
Options.AppName, Options.AppId);
CreateConnection();
CheckAndCreateExchange();
//事件客户端
if (Options.DisableEventClient)
{
Logger.LogWarning("Event Client Disabled: DisableEventClient set true");
}
else
{
RunEventClient();
Logger.LogInformation("Event Client Ready");
}
//RPC客户端
if (Options.DisableRpcClient)
{
Logger.LogWarning("Rpc Client Disabled: DisableEventClient set true");
}
else
{
RunRpcClient();
Logger.LogInformation("Rpc Client Ready, Client Timeout: {OptionsRpcTimeout}s", Options.RpcTimeout);
}
if (RpcRegistry.Count > 0)
{
RunRpcServer();
}
if (EventRegistry.Count > 0)
{
RunEventServer();
}
}
public SimApiBaseResponse<T> Rpc<T>(string appName, string method, dynamic param)
{
var res = new SimApiBaseResponse(500, "Rpc Client Disabled!");
if (Options.DisableRpcClient)
{
Logger.LogError("Rpc Client Disabled!");
}
else
{
var data = FireRpc(appName, method, param);
res = JsonSerializer.Deserialize<SimApiBaseResponse<T>>(data, SimApiUtil.JsonOption);
}
return res as SimApiBaseResponse<T>;
}
public SimApiBaseResponse<object> Rpc(string appName, string method, dynamic param)
{
return Rpc<object>(appName, method, param);
}
public void Event(string eventName, dynamic param)
{
if (Options.DisableEventClient)
{
Logger.LogError("Event Client Disabled!");
}
else
{
FireEvent(eventName, param);
}
}
private void CreateConnection()
{
var factory = new ConnectionFactory
{
HostName = Options.MqHost,
Port = Options.MqPort,
VirtualHost = Options.MqVHost,
UserName = Options.MqUser,
Password = Options.MqPass
};
try
{
Connection = factory.CreateConnection();
Logger.LogInformation("连接RabbitMQ服务器成功");
}
catch (BrokerUnreachableException e)
{
Logger.LogError("连接RabbitMQ失败: \n{Err}", e);
}
}
private IModel CreateChannel(ushort processNum = 0, string desc = "unknow")
{
IModel channel = null;
try
{
var log = $"Channel [{desc}] 创建成功...";
channel = Connection.CreateModel();
if (processNum != 0)
{
channel.BasicQos(0, processNum, false);
log += $"最大处理器数量: {processNum}";
}
Logger.LogInformation(log);
}
catch (ConnectFailureException e)
{
Logger.LogError("Channel [{{Desc}}] 创建失败...\n {0}", e);
}
return channel;
}
private void CheckAndCreateExchange()
{
var channel = CreateChannel(0, "Exchange");
try
{
channel.ExchangeDeclare(Options.SysName, ExchangeType.Topic, true, true, null);
Logger.LogDebug("Register Exchange Success");
}
catch (ConnectFailureException e)
{
Logger.LogError("Failed to declare Exchange.\n {Err}", e);
}
channel.Close();
Logger.LogDebug("Exchange Channel Closed");
}
private void ProcessAttribute()
{
EventRegistry = new List<RegisterItem>();
RpcRegistry = new List<RegisterItem>();
var stackTrace = new StackTrace();
var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1).GetMethod();
var assembly = callingMethod.DeclaringType.Assembly;
var types = assembly.GetTypes(); // 获取程序集中的所有类型
foreach (var type in types)
{
var methods = type.GetMethods(); // 获取类型中的所有方法
foreach (var method in methods)
{
if (method.IsDefined(typeof(SynapseEventAttribute), false))
{
var attribute =
(SynapseEventAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseEventAttribute));
if (attribute != null)
{
EventRegistry.Add(new RegisterItem
{
Key = attribute.Name ?? method.Name,
Class = type,
Method = method.Name
});
}
}
if (method.IsDefined(typeof(SynapseRpcAttribute), false))
{
var attribute =
(SynapseRpcAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseRpcAttribute));
if (attribute != null)
{
RpcRegistry.Add(new RegisterItem
{
Key = attribute.Name ?? $"{type.Name}.{method.Name}",
Class = type,
Method = method.Name
});
}
}
}
}
var events = EventRegistry.Aggregate(string.Empty,
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class.Name}");
var rpcList = RpcRegistry.Aggregate(string.Empty,
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class.Name}");
Logger.LogInformation(">>> Synapse System 读取Event方法:{Event}\n>>>Synapse System 读取RPC方法:{Rpc}", events, rpcList);
}
}
public class RegisterItem
{
public string Key { get; set; }
public Type Class { get; set; }
public string Method { get; set; }
}