Compare commits

...
56 Commits
Author SHA1 Message Date
xrain 929ddaced3 add config store 2024-07-26 08:11:21 +08:00
xrain 82f7e0fc00 use Task insteadof while improve performance 2024-07-26 05:20:27 +08:00
xrain f4bc6dc080 fix synapse use mqtt 2024-07-26 05:03:28 +08:00
xrain 56b0490d1e fix log color 2024-07-24 21:50:46 +08:00
xrain 45e19c3561 fix log color 2024-07-24 21:43:31 +08:00
xrain 04b2be1bb7 fix bug 2024-07-21 13:50:12 +08:00
xrain f78c3a0e0d fix fullurl 不抛出异常了 2024-07-10 06:35:19 +08:00
xrain 506704fd90 fix fullurl 不抛出异常了 2024-07-10 06:29:36 +08:00
xrain 786051ddbf update pkg 2024-07-10 03:30:09 +08:00
xrain d9ff4ae422 fix upload url 2024-07-10 01:18:18 +08:00
xrain 986b4e74e6 new upload 2024-07-10 00:52:51 +08:00
xrain 2257ba5b2a new feature 2024-06-27 04:38:04 +08:00
xrain c40f8d664d default exception edit 2024-04-23 12:27:36 +08:00
xrain a1f10b9c09 class 添加默认方法,支持老的代码 2024-04-16 06:57:56 +08:00
xrain 6ef7aca8ae 将record切换回class, 不再使用CST时间,使用DateTime.Now 2024-04-16 06:29:21 +08:00
xrain 4171756c54 新增 ErrorWhenTrue和ErrorWhenFalse 2024-03-26 10:06:17 +08:00
xrain c68cfa6192 fix simapiauth to singleton 2024-03-24 17:40:48 +08:00
xrain 8344567ac6 新增了一个获取登陆信息的方法 2024-03-24 17:31:22 +08:00
xrain 99b26d99f6 fix code 2024-03-23 07:30:24 +08:00
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
xrain ab0da5415b update version 2023-03-28 06:39:55 +08:00
xrain 4d0f8e20a6 api model use record 2023-03-28 06:33:48 +08:00
xrain b5e4d57772 update package 2023-02-05 19:43:39 +08:00
xrain 239cd8bcbb fix error when exception response has started 2022-09-14 04:56:21 +08:00
xrain 62ddd6698e now simapiauth can use , for role 2022-09-02 09:47:41 +08:00
xrain b2a6e5f40f make storage bucket public 2022-08-17 20:26:25 +08:00
xrain 801f698dcf add storage get url 2022-08-17 19:37:39 +08:00
xrain 9c939426ba fix logger 2022-08-05 02:33:47 +08:00
xrain e45cc4d28d fix logger 2022-08-05 02:20:27 +08:00
xrain 6023cf2eb0 fix default option, add option description 2022-06-29 03:03:51 +08:00
xrain 63dcd0f13f update minio, default all option to false; 2022-06-29 02:50:15 +08:00
xrain 22704590f5 update util 2022-05-19 01:41:09 +08:00
xrain 98907ba5af add simutil cstNow, other times use this prop 2022-05-18 20:37:41 +08:00
xrain 7b0f0a9245 add cst time util 2022-05-18 20:15:25 +08:00
xrain 1c4fb06163 add json util 2022-05-16 11:26:42 +08:00
xrain e79ed47d39 fix upload stream data 2022-05-07 23:52:45 +08:00
xrain 6fdb3da059 update minio 2022-05-07 22:56:22 +08:00
xrain 55ea40b757 add string id only 2022-05-07 21:45:12 +08:00
xrain d252c1d302 fix login use string 2022-05-07 21:30:45 +08:00
xrain 74c6cb6027 update to .net6 2021-11-14 15:45:28 +08:00
xrain 98ec9ae231 update to .net6 2021-11-14 15:43:23 +08:00
xrain 18d2dfb86e add get upload url 2021-09-29 02:37:14 +08:00
xrain ef3f1bfa88 fix checkcell regex 2021-09-26 13:11:22 +08:00
xrain 01a2689549 fix ci 2021-07-10 18:39:32 +08:00
xrainandGitHub 916f046789 fix ci 2021-07-10 18:39:02 +08:00
xrain 51ac170a22 add logger 2021-06-28 05:45:29 +08:00
xrain c27011deea add logger 2021-06-28 05:36:54 +08:00
34 changed files with 1960 additions and 993 deletions
-21
View File
@@ -1,21 +0,0 @@
name: PublishNugetPackage
on: [create]
jobs:
publish:
name: Publish Project to Nuget
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: '5.0.100'
- name: Publish
run: |
version=`git describe --tags`
dotnet build --configuration release -p:PackageVersion=$version
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
env:
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
+24
View File
@@ -0,0 +1,24 @@
name: PublishNugetPackage
on:
push:
tags:
- "*"
jobs:
publish:
name: Publish Project to Nuget
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: "8.0.200"
- name: Publish
run: |
version=`git describe --tags`
dotnet build --configuration release -p:PackageVersion=$version
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
env:
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
+5 -6
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>
@@ -25,7 +25,7 @@ namespace SimApi.Attributes
//只检测一种用户类型的快捷方式 //只检测一种用户类型的快捷方式
public SimApiAuthAttribute(string type) public SimApiAuthAttribute(string type)
{ {
Types = new[] { type }; Types = type.Split(",");
} }
//设定特定类型的检测 //设定特定类型的检测
@@ -43,17 +43,16 @@ namespace SimApi.Attributes
public override void OnActionExecuting(ActionExecutingContext context) public override void OnActionExecuting(ActionExecutingContext context)
{ {
var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"]; var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"]!;
//检测是否登录 //检测是否登录
if (loginInfo == null) if (loginInfo == null)
{ {
throw new SimApiException(401); throw new SimApiException(401);
} }
//检测用户类型 //检测用户类型
if (Types.Intersect(loginInfo.Type).Count() == 0) if (!Types.Intersect(loginInfo.Type).Any())
{ {
throw new SimApiException(403); throw new SimApiException(403);
} }
} }
} }
}
+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"};
} }
} }
}
+9
View File
@@ -0,0 +1,9 @@
using System;
namespace SimApi.Attributes;
[AttributeUsage(AttributeTargets.Method)]
public class SynapseEventAttribute(string? name = null) : Attribute
{
public string? Name { get; } = 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;
}
}
+15 -8
View File
@@ -1,13 +1,21 @@
using System; using System.ComponentModel.DataAnnotations;
namespace SimApi.Communications;
namespace SimApi.Communications
{
/// <summary> /// <summary>
/// 只有ID的请求 /// 只有ID的请求
/// </summary> /// </summary>
public class SimApiIdOnlyRequest public class SimApiIdOnlyRequest
{ {
public int Id { get; set; } [Required] public int Id { get; set; }
}
/// <summary>
/// 只有ID的请求(字符串)
/// </summary>
public class SimApiStringIdOnlyRequest
{
[Required] public string? Id { get; set; }
} }
/// <summary> /// <summary>
@@ -16,7 +24,7 @@ namespace SimApi.Communications
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class SimApiOneFieldRequest<T> public class SimApiOneFieldRequest<T>
{ {
public T Data { get; set; } [Required] public T? Data { get; set; }
} }
/// <summary> /// <summary>
@@ -24,7 +32,6 @@ namespace SimApi.Communications
/// </summary> /// </summary>
public class SimApiBasePageRequest public class SimApiBasePageRequest
{ {
public int Page { get; set; } [Required] public int Page { get; set; }
public int Count { get; set; } [Required] public int Count { get; set; }
}
} }
+27 -79
View File
@@ -2,27 +2,20 @@
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>
public class SimApiBaseResponse public class SimApiBaseResponse(int code = 200, string message = "成功")
{ {
/// <summary> public int Code { get; set; } = code;
/// 错误代码 public string Message { get; set; } = message;
/// </summary>
public int Code { get; set; }
/// <summary>
/// 错误描述
/// </summary>
public string Message { get; set; }
/// <summary> /// <summary>
/// 默认错误代码对应提示信息 /// 默认错误代码对应提示信息
/// </summary> /// </summary>
private readonly Dictionary<int, string> MsgBox = new Dictionary<int, string>() private static readonly Dictionary<int, string> MsgBox = new()
{ {
{ 200, "成功" }, { 200, "成功" },
{ 204, "没有数据" }, { 204, "没有数据" },
@@ -33,56 +26,8 @@ namespace SimApi.Communications
{ 500, "服务器错误" } { 500, "服务器错误" }
}; };
/// <summary> public SimApiBaseResponse(int code) : this(code, MsgBox.GetValueOrDefault(code, "未知错误"))
/// 返回一个成功的空结果
/// </summary>
public SimApiBaseResponse()
{ {
SetCode(200);
}
/// <summary>
/// 返回指定代码的描述
/// </summary>
/// <param name="code">错误代码</param>
public SimApiBaseResponse(int code)
{
SetCode(code);
}
/// <summary>
/// 返回指定代码的结果,并自定义提示信息
/// </summary>
/// <param name="code">错误代码</param>
/// <param name="message">错误信息</param>
public SimApiBaseResponse(int code, string message)
{
SetCodeMsg(code, message);
}
/// <summary>
/// 设置响应结果的错误代码
/// </summary>
/// <param name="code">错误代码</param>
public void SetCode(int code)
{
Code = code;
Message = MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误";
}
/// <summary>
/// 设置响应结果的错误代码和错误描述
/// </summary>
/// <param name="code">错误代码</param>
/// <param name="message">错误描述</param>
public void SetCodeMsg(int code, string message)
{
SetCode(code);
if (!string.IsNullOrEmpty(message))
{
Message = message;
}
} }
/// <summary> /// <summary>
@@ -95,7 +40,10 @@ namespace SimApi.Communications
{ {
IgnoreReadOnlyProperties = true, IgnoreReadOnlyProperties = true,
PropertyNamingPolicy = JsonNamingPolicy.CamelCase, PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
Converters = {new JsonStringEnumConverter()} Converters =
{
new JsonStringEnumConverter()
}
}); });
} }
} }
@@ -104,32 +52,32 @@ namespace SimApi.Communications
/// 动态内容分页 /// 动态内容分页
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class SimApiBasePageResponse<T> : SimApiBaseResponse public class SimApiBasePageResponse<T>() : SimApiBaseResponse
{ {
/// <summary>
/// 动态内容列表
/// </summary>
public T List { get; set; } public T List { get; set; }
public int Page { get; set; } = 1;
//当前页码 public int Count { get; set; } = 20;
public int Page { get; set; }
//每页条数
public int Count { get; set; }
//总计条数
public int Total { get; set; } 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> /// <summary>
/// 动态Data返回 /// 动态Data返回
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class SimApiBaseResponse<T> : SimApiBaseResponse public class SimApiBaseResponse<T>() : SimApiBaseResponse
{ {
/// <summary>
/// 动态内容列表
/// </summary>
public T Data { get; set; } public T Data { get; set; }
public SimApiBaseResponse(T data) : this()
{
Data = data;
} }
} }
+5 -11
View File
@@ -1,14 +1,8 @@
using System; using System.Collections.Generic;
namespace SimApi.Communications
{ namespace SimApi.Communications;
/// <summary> /// <summary>
/// 登录信息中间件 /// 登录信息中间件
/// </summary> /// </summary>
public class SimApiLoginItem public record SimApiLoginItem(string Id, string[] Type,Dictionary<string,string>? Meta = null);
{
//登录用户的ID
public int Id { get; set; }
//登录用户来源
public string[] Type { get; set; }
}
}
+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.Configurations;
{
/// <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 };
} }
}
+75 -11
View File
@@ -1,19 +1,84 @@
using System; using System;
namespace SimApi.Configs namespace SimApi.Configurations;
{
public class SimApiOptions public class SimApiOptions
{ {
/// <summary>
/// 启用全部Cors,对于开发前后分离的时候很有用。
/// default: true
/// </summary>
public bool EnableCors { get; set; } = true; public bool EnableCors { get; set; } = true;
public bool EnableSimApiAuth { get; set; } = false;
public bool EnableSimApiDoc { get; set; } = true;
public bool EnableSimApiException { get; set; } = true;
public bool EnableSimApiStorage { get; set; } = false;
public bool EnableForwardHeaders { get; set; } = true;
public bool EnableLowerUrl { get; set; } = true;
public SimApiDocOptions SimApiDocOptions { get; set; } = new SimApiDocOptions();
public SimApiStorageOptions SimApiStorageOptions { get; set; } = new SimApiStorageOptions();
/// <summary>
/// 启用SimApiAuth,一个简单的基于Header Token的认证方式。
/// default: false
/// </summary>
public bool EnableSimApiAuth { get; set; } = false;
/// <summary>
/// 启用在线文档,启用后 访问 /swagger 可以查看对应的api文档。
/// default: false
/// </summary>
public bool EnableSimApiDoc { get; set; } = false;
/// <summary>
/// 启用异常拦截,启用后,所有的异常将被通过json反馈。
/// default: true
/// </summary>
public bool EnableSimApiException { get; set; } = true;
/// <summary>
/// 开启S3兼容的存储系统。
/// default: false
/// </summary>
public bool EnableSimApiStorage { get; set; } = false;
/// <summary>
/// 开启ForwardHeaders,开启后可以透传负载均衡的Headers
/// default: true
/// </summary>
public bool EnableForwardHeaders { get; set; } = true;
/// <summary>
/// 将所有的url都格式化为小写字母
/// default: true
/// </summary>
public bool EnableLowerUrl { get; set; } = true;
/// <summary>
/// 启用格式化的 Console Logger
/// default: false
/// </summary>
public bool EnableLogger { get; set; } = false;
/// <summary>
/// 是否启用Synapse
/// </summary>
public bool EnableSynapse { get; set; } = false;
/// <summary>
/// Swagger文档相关配置,需要启用 EnableSimApiDoc
/// </summary>
public SimApiDocOptions SimApiDocOptions { get; set; } = new();
/// <summary>
/// S3兼容的存储系统配置,需要启用 EnableSimApiStorage
/// </summary>
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)
{ {
@@ -25,4 +90,3 @@ namespace SimApi.Configs
options?.Invoke(SimApiStorageOptions); options?.Invoke(SimApiStorageOptions);
} }
} }
}
+20 -8
View File
@@ -1,11 +1,23 @@
namespace SimApi.Configs namespace SimApi.Configurations;
{
public class SimApiStorageOptions public class SimApiStorageOptions
{ {
public string Endpoint { get; set; } /// <summary>
public string ServeUrl { get; set; } /// S3 服务器入口地址
public string Bucket { get; set; } /// </summary>
public string AccessKey { get; set; } public string? Endpoint { get; set; }
public string SecretKey { get; set; }
} /// <summary>
/// S3 服务器文件访问地址
/// </summary>
public string? ServeUrl { get; set; }
/// <summary>
/// S3服务 Bucket
/// </summary>
public string? Bucket { get; set; }
public string? AccessKey { get; set; }
public string? SecretKey { get; set; }
} }
+19
View File
@@ -0,0 +1,19 @@
namespace SimApi.Configurations;
public class SimApiSynapseOptions
{
/// <summary>
/// Mqtt服务器的Websocket地址
/// </summary>
public string? Websocket { get; set; }
public string? Username { get; set; }
public string? Password { get; set; }
public string? SysName { get; set; }
public string? AppName { get; set; }
public string? AppId { get; set; }
public int RpcTimeout { get; set; } = 3;
public bool EnableConfigStore { get; set; } = true;
public bool DisableEventClient { get; set; } = false;
public bool DisableRpcClient { get; set; } = false;
}
+32 -14
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. 自动验证请求参数
@@ -19,7 +18,7 @@ namespace SimApi.Controllers
/// <summary> /// <summary>
/// 当前登录用户的ID /// 当前登录用户的ID
/// </summary> /// </summary>
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"]; protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"]!;
/// <summary> /// <summary>
/// 验证请求参数 /// 验证请求参数
@@ -29,16 +28,14 @@ namespace SimApi.Controllers
{ {
if (!context.ModelState.IsValid) if (!context.ModelState.IsValid)
{ {
foreach (var item in context.ModelState.Values) foreach (var item in context.ModelState.Values.Where(item =>
{ item.ValidationState == ModelValidationState.Invalid))
if (item.ValidationState == ModelValidationState.Invalid)
{ {
Error(400, item.Errors.First().ErrorMessage); Error(400, item.Errors.First().ErrorMessage);
break; break;
} }
} }
} }
}
/// <summary> /// <summary>
@@ -53,12 +50,12 @@ namespace SimApi.Controllers
} }
/// <summary> /// <summary>
/// 检测条件,根据条件返回报错 /// 检测条件,根据条件返回报错 如果condition是ture报错
/// </summary> /// </summary>
/// <param name="condition">检测条件</param> /// <param name="condition">检测条件</param>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误描述</param> /// <param name="message">错误描述</param>
protected static void ErrorWhen(bool condition, int code = 500, string message = "") protected static void ErrorWhen(bool condition, int code = 400, string message = "")
{ {
if (condition) if (condition)
{ {
@@ -66,13 +63,37 @@ namespace SimApi.Controllers
} }
} }
/// <summary>
/// 检测条件,根据条件返回报错 如果condition是ture报错
/// </summary>
/// <param name="condition">检测条件</param>
/// <param name="code">错误代码</param>
/// <param name="message">错误描述</param>
protected static void ErrorWhenTrue(bool condition, int code = 400, string message = "")
{
ErrorWhen(condition, code, message);
}
/// <summary>
/// 如果condition是false 报错
/// </summary>
/// <param name="condition"></param>
/// <param name="code"></param>
/// <param name="message"></param>
protected static void ErrorWhenFalse(bool condition, int code = 400, string message = "")
{
ErrorWhen(!condition, code, message);
}
/// <summary> /// <summary>
/// 检测给定的变量是否为NUll /// 检测给定的变量是否为NUll
/// </summary> /// </summary>
/// <param name="condition">检测条件</param> /// <param name="condition">检测条件</param>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误描述</param> /// <param name="message">错误描述</param>
protected static void ErrorWhenNull(object condition, int code = 404, string message = "") protected static void ErrorWhenNull(object? condition, int code = 404, string message = "请求的资源不存在")
{ {
ErrorWhen(condition == null, code, message); ErrorWhen(condition == null, code, message);
} }
@@ -85,7 +106,4 @@ namespace SimApi.Controllers
{ {
return new SimApiBaseResponse<string>(); return new SimApiBaseResponse<string>();
} }
}
} }
+19 -21
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>
@@ -25,9 +17,7 @@ namespace SimApi.Controllers
[ApiExplorerSettings(IgnoreApi = true)] [ApiExplorerSettings(IgnoreApi = true)]
public SimApiBaseResponse ExceptionHandler(int code) public SimApiBaseResponse ExceptionHandler(int code)
{ {
var response = new SimApiBaseResponse(); return new SimApiBaseResponse(code);
response.SetCode(code);
return response;
} }
/// <summary> /// <summary>
@@ -35,10 +25,13 @@ namespace SimApi.Controllers
/// </summary> /// </summary>
/// <returns></returns> /// <returns></returns>
[HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")] [HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
public SimApiBaseResponse<int> CheckLogin() public SimApiBaseResponse<string> CheckLogin()
{ {
ErrorWhenNull(LoginInfo, 401); ErrorWhenNull(LoginInfo, 401);
return new SimApiBaseResponse<int> {Data = LoginInfo.Id}; return new SimApiBaseResponse<string>
{
Data = LoginInfo.Id
};
} }
/// <summary> /// <summary>
@@ -48,15 +41,20 @@ namespace SimApi.Controllers
[HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")] [HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
public SimApiBaseResponse Logout() public SimApiBaseResponse Logout()
{ {
string token = null; string? token = null;
if (Request.Headers.ContainsKey("Token")) if (Request.Headers.TryGetValue("Token", out var value))
{ {
token = Request.Headers["Token"]; token = value;
} }
Auth.Logout(token); auth.Logout(token!);
return new SimApiBaseResponse(); return new SimApiBaseResponse();
} }
[HttpPost("/logined"),SimApiAuth]
public SimApiBaseResponse<SimApiLoginItem> UserInfo()
{
return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);
} }
} }
+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;
}
}
} }
+44 -27
View File
@@ -1,31 +1,28 @@
#nullable enable
using System; using System;
using System.Collections.Generic;
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>
/// <param name="id"></param> /// <param name="id"></param>
/// <param name="type"></param>
/// <param name="meta"></param>
/// <param name="token"></param>
/// <returns></returns> /// <returns></returns>
public string Login(int id, string type = "user", string token = null) public string Login(string id, Dictionary<string, string>? meta = null, string type = "user", string? token = null)
{ {
return Login(id, new[] { type }, token); return Login(id, meta, new[] { type }, token);
} }
/// <summary> /// <summary>
@@ -33,22 +30,44 @@ namespace SimApi.Helpers
/// </summary> /// </summary>
/// <param name="id"></param> /// <param name="id"></param>
/// <param name="type"></param> /// <param name="type"></param>
/// <param name="meta"></param>
/// <param name="uuid"></param>
/// <returns></returns> /// <returns></returns>
public string Login(int id, string[] type, string uuid = null) // ReSharper disable once MemberCanBePrivate.Global
public string Login(string id, Dictionary<string, string>? meta, string[] type, string? uuid = null)
{ {
if (uuid == null) uuid ??= Guid.NewGuid().ToString();
{ var loginItem = new SimApiLoginItem(id, type, meta);
uuid = Guid.NewGuid().ToString(); cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
}
var loginItem = new SimApiLoginItem
{
Id = id,
Type = type
};
Cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
return uuid; return uuid;
} }
/// <summary>
/// 设置登录的Meta信息
/// </summary>
/// <param name="token"></param>
/// <param name="meta"></param>
/// <returns></returns>
public bool SetMeta(string token, Dictionary<string, string> meta)
{
var login = GetLogin(token);
if (login == null) { return false; }
var newLogin = new SimApiLoginItem(login.Id, login.Type, login.Meta);
cache.SetString(token,JsonSerializer.Serialize(newLogin));
return true;
}
/// <summary>
/// 获取登陆信息
/// </summary>
/// <param name="token"></param>
/// <returns></returns>
public SimApiLoginItem? GetLogin(string token)
{
var login = cache.GetString(token);
return login != null ? JsonSerializer.Deserialize<SimApiLoginItem>(login) : default;
}
/// <summary> /// <summary>
/// 退出登陆 /// 退出登陆
/// </summary> /// </summary>
@@ -57,9 +76,7 @@ namespace SimApi.Helpers
{ {
if (!string.IsNullOrEmpty(uuid)) if (!string.IsNullOrEmpty(uuid))
{ {
Cache.Remove(uuid); cache.Remove(uuid);
} }
} }
}
} }
+116 -33
View File
@@ -1,29 +1,35 @@
using System; #nullable enable
using System;
using System.IO; using System.IO;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using Minio; using Minio;
using Minio.Exceptions; using Minio.DataModel.Args;
using SimApi.Configs; using SimApi.Configurations;
namespace SimApi.Helpers;
namespace SimApi.Helpers
{
public class SimApiStorage public class SimApiStorage
{ {
private MinioClient Mc { get; } private IMinioClient Mc { get; }
public MinioClient Client => Mc; public IMinioClient Client => Mc;
private string ServeUrl { get; } private string ServeUrl { get; }
private string Bucket { get; }
private string Endpoint { get; }
public string Bucket { get; }
private IHttpContextAccessor HttpContextAccessor { get; } private IHttpContextAccessor HttpContextAccessor { get; }
public SimApiStorage(SimApiOptions apiOptions, IHttpContextAccessor httpContextAccessor) public SimApiStorage(SimApiOptions apiOptions, IHttpContextAccessor httpContextAccessor)
{ {
var options = apiOptions.SimApiStorageOptions; var options = apiOptions.SimApiStorageOptions;
HttpContextAccessor = httpContextAccessor; HttpContextAccessor = httpContextAccessor;
Endpoint = options.Endpoint!;
var useSsl = false; var useSsl = false;
var endpoint = string.Empty; string endpoint;
if (options.Endpoint.StartsWith("http://")) if (options.Endpoint!.StartsWith("http://"))
{ {
endpoint = options.Endpoint.Replace("http://", string.Empty); endpoint = options.Endpoint.Replace("http://", string.Empty);
} }
@@ -37,48 +43,125 @@ namespace SimApi.Helpers
throw new Exception("SimApiStorage: Error Endpoint"); throw new Exception("SimApiStorage: Error Endpoint");
} }
ServeUrl = options.ServeUrl; ServeUrl = options.ServeUrl!;
Bucket = options.Bucket; if (ServeUrl.EndsWith('/')) throw new Exception("SimApiStorage: ServeUrl must not end with /");
Bucket = options.Bucket!;
var mcb = new MinioClient().WithEndpoint(endpoint)
.WithCredentials(options.AccessKey, options.SecretKey);
if (useSsl) if (useSsl)
{ {
Mc = new MinioClient(endpoint, options.AccessKey, options.SecretKey).WithSSL(); mcb = mcb.WithSSL();
}
else
{
Mc = new MinioClient(endpoint, options.AccessKey, options.SecretKey);
} }
bool found = Mc.BucketExistsAsync(Bucket).Result; Mc = mcb.Build();
var found = Mc.BucketExistsAsync(new BucketExistsArgs().WithBucket(Bucket)).Result;
if (!found) if (!found)
{ {
Mc.MakeBucketAsync(Bucket).Wait(); Mc.MakeBucketAsync(new MakeBucketArgs().WithBucket(Bucket)).Wait();
} }
} }
public string UploadFile(string path, Stream stream) /// <summary>
/// 获取上传的URL
/// </summary>
/// <param name="path"></param>
/// <param name="expire"></param>
/// <returns></returns>
public GetUploadUrlResponse GetUploadUrl(string path, int expire = 7200)
{ {
try CheckPath(path);
{ var obj = path.TrimStart('/');
Mc.PutObjectAsync(Bucket, path, stream, stream.Length).Wait(); var uploadUrl = Mc.PresignedPutObjectAsync(new PresignedPutObjectArgs().WithBucket(Bucket)
return null; .WithObject(obj).WithExpiry(expire)).Result;
} return new GetUploadUrlResponse(uploadUrl, $"{ServeUrl}{path}", path);
catch (MinioException e)
{
Console.WriteLine("Error occurred: " + e);
return e.Message;
}
} }
/// <summary>
/// 获取下载的URL
/// </summary>
/// <param name="path"></param>
/// <param name="expire"></param>
/// <returns></returns>
public string GetDownloadUrl(string path, int expire = 600)
{
CheckPath(path);
path = path.TrimStart('/');
return Mc.PresignedGetObjectAsync(new PresignedGetObjectArgs().WithBucket(Bucket).WithObject(path)
.WithExpiry(expire)).Result;
}
/// <summary>
/// 直接上传文件
/// </summary>
/// <param name="path"></param>
/// <param name="stream"></param>
/// <param name="contentType"></param>
public void UploadFile(string path, Stream stream, string contentType = "image/png")
{
CheckPath(path);
path = path.TrimStart('/');
Mc.PutObjectAsync(new PutObjectArgs().WithBucket(Bucket).WithObject(path).WithObjectSize(stream.Length)
.WithStreamData(stream).WithContentType(contentType)).Wait();
}
/// <summary>
/// 使用path获取完整的访问URL
/// </summary>
/// <param name="path"></param>
/// <returns></returns>
/// <exception cref="Exception"></exception>
public string FullUrl(string path) public string FullUrl(string path)
{ {
var httpRequest = HttpContextAccessor.HttpContext.Request; if (string.IsNullOrEmpty(path)) return path;
var url = $"{httpRequest.Scheme}://{httpRequest.Host}"; if(path.StartsWith("http://") || path.StartsWith("https://")) return path;
if (!(path.StartsWith('/') || path.StartsWith("~/"))) return path;
var httpRequest = HttpContextAccessor.HttpContext?.Request;
var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
if (string.IsNullOrEmpty(path)) if (string.IsNullOrEmpty(path))
{ {
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}";
} }
/// <summary>
/// 获取一个Path得访问URL
/// </summary>
/// <param name="path"></param>
/// <returns></returns>
public string? GetUrl(string? path)
{
if (string.IsNullOrEmpty(path)) return path;
if (path.StartsWith("~/"))
{
var httpRequest = HttpContextAccessor.HttpContext?.Request;
var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
return string.Concat(url, path.AsSpan(1, path.Length - 1));
}
if (path.StartsWith('/'))
{
return $"{ServeUrl}{path}";
}
return path;
}
/// <summary>
/// 从URL中获取相对路径 (如果url不是当前服务器的url,则原样返回)
/// </summary>
/// <param name="url"></param>
/// <returns></returns>
public string? GetPath(string? url)
{
return url?.Replace($"{Endpoint}/{Bucket}", string.Empty).Replace(ServeUrl,string.Empty);
}
private void CheckPath(string path)
{
if (!path.StartsWith('/')) throw new Exception("path must start with /");
} }
} }
public record GetUploadUrlResponse(string UploadUrl, string DownloadUrl, string Path);
+57 -14
View File
@@ -1,12 +1,37 @@
using System; using System;
using System.Linq;
using System.Security.Cryptography; using System.Security.Cryptography;
using System.Text; using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
using System.Text.Unicode;
namespace SimApi.Helpers;
namespace SimApi.Helpers
{
public static class SimApiUtil public static class SimApiUtil
{ {
/// <summary>
/// 当前CST时间
/// </summary>
public static DateTime CstNow => DateTime.UtcNow.AddHours(8);
/// <summary>
/// JSON序列化常规选项
/// </summary>
public static JsonSerializerOptions JsonOption => new()
{
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};
/// <summary>
/// 当前秒级时间戳
/// </summary>
public static double TimestampNow => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
/// <summary> /// <summary>
/// 检测手机号是否正确 /// 检测手机号是否正确
/// </summary> /// </summary>
@@ -14,7 +39,7 @@ namespace SimApi.Helpers
/// <returns></returns> /// <returns></returns>
public static bool CheckCell(string cell) public static bool CheckCell(string cell)
{ {
var regex = new Regex("^1[34578]\\d{9}$"); var regex = new Regex("^1[3456789]\\d{9}$");
return regex.IsMatch(cell); return regex.IsMatch(cell);
} }
@@ -26,23 +51,41 @@ 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 sourceBytes = Encoding.UTF8.GetBytes(source);
MD5 md5 = MD5.Create(); var result = MD5.HashData(sourceBytes);
byte[] result = md5.ComputeHash(sor); var stringBuilder = new StringBuilder(40);
StringBuilder strbul = new StringBuilder(40); foreach (var t in result)
for (int i = 0; i < result.Length; i++)
{ {
strbul.Append(result[i].ToString(mode)); stringBuilder.Append(t.ToString(mode));
} }
return strbul.ToString(); return stringBuilder.ToString();
} }
public static void Log(string message, string type = "Information") /// <summary>
/// 将对象序列化成JSON (控制台输出中文不会被编码)
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
public static string Json(object obj)
{ {
Console.WriteLine($"[ SimApi ][ {DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {type} ]"); return JsonSerializer.Serialize(obj, JsonOption);
Console.WriteLine(message);
Console.WriteLine("");
} }
/// <summary>
/// 分页
/// </summary>
/// <param name="query"></param>
/// <param name="page">页码</param>
/// <param name="count">每页数量</param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IQueryable<T> Paginate<T>(this IQueryable<T> query, int page, int count)
{
if (page < 1)
page = 1;
if (count <= 0)
count = 10;
return query.Skip((page - 1) * count).Take(count);
} }
} }
+35
View File
@@ -0,0 +1,35 @@
using System;
using Microsoft.Extensions.Logging;
using SimApi.Helpers;
namespace SimApi.Logger;
public class SimApiLogger(string name) : ILogger
{
public IDisposable BeginScope<TState>(TState state) => default!;
public bool IsEnabled(LogLevel logLevel) => true;
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception,
Func<TState, Exception, string> formatter)
{
Console.ForegroundColor = logLevel switch
{
LogLevel.Debug => ConsoleColor.DarkMagenta,
LogLevel.Information => ConsoleColor.DarkCyan,
LogLevel.Warning => ConsoleColor.Yellow,
LogLevel.Error => ConsoleColor.Red,
LogLevel.Critical => ConsoleColor.DarkRed,
_ => ConsoleColor.White
};
var message =
$"[ {name} ][ {DateTime.Now:yyyy-MM-dd HH:mm:ss:ffff} ][ {logLevel.ToString()} ]\n{state}\n";
if (exception != null)
{
message += $"{exception}\n";
}
Console.WriteLine(message);
Console.ResetColor();
}
}
+20
View File
@@ -0,0 +1,20 @@
using System.Collections.Concurrent;
using Microsoft.Extensions.Logging;
namespace SimApi.Logger;
public class SimApiLoggerProvider : ILoggerProvider
{
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers = new();
public ILogger CreateLogger(string categoryName)
{
return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
}
public void Dispose()
{
_loggers.Clear();
}
}
+13 -23
View File
@@ -3,39 +3,29 @@ using System.Threading.Tasks;
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using SimApi.Communications; using SimApi.Communications;
using SimApi.Helpers;
namespace SimApi.Middlewares;
namespace SimApi.Middlewares
{
/// <summary> /// <summary>
/// 认证信息获取中间件 /// 认证信息获取中间件
/// </summary> /// </summary>
public class SimApiAuthMiddleware public class SimApiAuthMiddleware(RequestDelegate next)
{ {
private RequestDelegate Next { get; } public Task Invoke(HttpContext httpContext, IDistributedCache cache, SimApiAuth auth)
public SimApiAuthMiddleware(RequestDelegate next)
{ {
Next = next; string? token = null;
if (httpContext.Request.Headers.TryGetValue("Token", out var header))
{
token = header;
} }
public Task Invoke(HttpContext httpContext, IDistributedCache cache) if (string.IsNullOrEmpty(token)) return next(httpContext);
{ var login = auth.GetLogin(token);
string token = null;
if (httpContext.Request.Headers.ContainsKey("Token"))
{
token = httpContext.Request.Headers["Token"];
}
if (!string.IsNullOrEmpty(token))
{
var login = cache.GetString(token);
if (login != null) if (login != null)
{ {
httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<SimApiLoginItem>(login)); httpContext.Items.Add("LoginInfo", login);
} }
} return next(httpContext);
return Next(httpContext);
}
} }
} }
+25 -34
View File
@@ -6,59 +6,50 @@ 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) switch (context.Response.StatusCode)
{
if (!new[] {301, 302}.Contains(context.Response.StatusCode))
{ {
case 200:
break;
case 404:
throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
case 301:
case 302:
break;
default:
throw new SimApiException(context.Response.StatusCode); throw new SimApiException(context.Response.StatusCode);
} }
} }
}
catch (SimApiException ex) catch (SimApiException ex)
{ {
if (string.IsNullOrEmpty(ex.Message)) response = string.IsNullOrEmpty(ex.Message)
{ ? new SimApiBaseResponse(ex.Code)
response.SetCode(ex.Code); : new SimApiBaseResponse(ex.Code, ex.Message);
}
else
{
response.SetCodeMsg(ex.Code, ex.Message);
}
ErrorResponse(context, response); ErrorResponse(context, response);
} }
catch (Exception ex) catch (Exception ex)
{ {
Log.LogError(ex.Message); log.LogError("{Msg}", ex.Message);
Log.LogError(ex.StackTrace); log.LogError("{Msg}", ex.StackTrace);
response.SetCodeMsg(500, ex.Message); response = new SimApiBaseResponse(500, ex.Message);
ErrorResponse(context, response); ErrorResponse(context, response);
} }
} }
@@ -68,11 +59,11 @@ namespace SimApi.Middlewares
/// </summary> /// </summary>
/// <param name="context"></param> /// <param name="context"></param>
/// <param name="response"></param> /// <param name="response"></param>
private void ErrorResponse(HttpContext context, SimApiBaseResponse response) private static void ErrorResponse(HttpContext context, SimApiBaseResponse response)
{ {
if (context.Response.HasStarted) return;
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());
} }
} }
}
+39 -22
View File
@@ -1,34 +1,47 @@
using System; using System;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq; using System.Linq;
using System.Text.Json; using SimApi.Helpers;
namespace SimApi.Models;
namespace SimApi.Models
{
public class SimApiBaseModel public class SimApiBaseModel
{ {
[Column(Order = 1)] public string Id { get; set; } = Guid.NewGuid().ToString();
[Column(Order = 9998)] public DateTime UpdatedAt { get; set; } = DateTime.Now;
[Column(Order = 9999)] public DateTime CreatedAt { get; set; } = DateTime.Now;
protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" }; protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" };
protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt"; protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt";
public void MapData<TS>(TS source, bool mapAll = false) public void MapData<TS>(TS source, bool mapAll = false)
{ {
//获取要赋值的源数据不为null的项目 //获取要赋值的源数据不为null的项目
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null) var sourceProps = source!.GetType().GetProperties().Where(x => x.GetValue(source) != null)
.Select(x => new {x.Name, x.PropertyType}) .Select(x => new
{
x.Name,
x.PropertyType
})
.ToDictionary(x => x.Name, x => x.PropertyType); .ToDictionary(x => x.Name, x => x.PropertyType);
//获取目标对象的属性信息 //获取目标对象的属性信息
var targetProps = GetType().GetProperties().Select(x => new {x.Name, x.PropertyType}) var targetProps = GetType().GetProperties().Select(x => new
.ToDictionary(x => x.Name, x => x.PropertyType);
foreach (var sp in sourceProps)
{ {
//检查源对象不为空的属性是否在目标对象中存在 x.Name,
if (targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] && x.PropertyType
(!MapperIgnoreField.Contains(sp.Key) || mapAll)) })
.ToDictionary(x => x.Name, x => x.PropertyType);
foreach (var sp in sourceProps.Where(sp =>
targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
(!MapperIgnoreField.Contains(sp.Key) || mapAll)))
{ {
GetType().GetProperty(sp.Key)? GetType().GetProperty(sp.Key)?
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source)); .SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
} }
}
UpdateTime(); UpdateTime();
} }
@@ -36,23 +49,28 @@ namespace SimApi.Models
public void MapData<TS>(TS source, string[] mapFields) public void MapData<TS>(TS source, string[] mapFields)
{ {
//获取要赋值的源数据不为null的项目 //获取要赋值的源数据不为null的项目
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null) var sourceProps = source!.GetType().GetProperties().Where(x => x.GetValue(source) != null)
.Select(x => new {x.Name, x.PropertyType}) .Select(x => new
{
x.Name,
x.PropertyType
})
.ToDictionary(x => x.Name, x => x.PropertyType); .ToDictionary(x => x.Name, x => x.PropertyType);
//获取目标对象的属性信息 //获取目标对象的属性信息
var targetProps = GetType().GetProperties().Select(x => new {x.Name, x.PropertyType}) var targetProps = GetType().GetProperties().Select(x => new
.ToDictionary(x => x.Name, x => x.PropertyType);
foreach (var sp in sourceProps)
{ {
//检查源对象不为空的属性是否在目标对象中存在 x.Name,
if (targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] && x.PropertyType
mapFields.Contains(sp.Key)) })
.ToDictionary(x => x.Name, x => x.PropertyType);
foreach (var sp in sourceProps.Where(sp =>
targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
mapFields.Contains(sp.Key)))
{ {
GetType().GetProperty(sp.Key)? GetType().GetProperty(sp.Key)?
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source)); .SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
} }
}
UpdateTime(); UpdateTime();
} }
@@ -66,4 +84,3 @@ namespace SimApi.Models
GetType().GetProperty(UpdatedTimeField)?.SetValue(this, DateTime.Now); GetType().GetProperty(UpdatedTimeField)?.SetValue(this, DateTime.Now);
} }
} }
}
+1 -1
View File
@@ -4,7 +4,7 @@
"anonymousAuthentication": true "anonymousAuthentication": true
}, },
"profiles": { "profiles": {
"YYApi": { "SimApi": {
"commandName": "Project", "commandName": "Project",
"launchBrowser": true, "launchBrowser": true,
"environmentVariables": { "environmentVariables": {
+3 -3
View File
@@ -1,7 +1,6 @@
# YYApi 基于Asp.net Core 3/5的一个基础辅助包 # SimApi 基于.Net的一个基础辅助包
![CI](https://github.com/YY-Tech/YYApi/workflows/CI/badge.svg)
[![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)
### 包含了以下组件: ### 包含了以下组件:
1. 统一的参数检测,基础认证服务 1. 统一的参数检测,基础认证服务
@@ -53,3 +52,4 @@ services.AddSimApi(options =>
options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>(); options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>();
}); });
``` ```
基于S3的存储,基于RabbitMq的事件RPC调用,自定义Logger格式,自定义响应格式
+6 -7
View File
@@ -14,23 +14,22 @@
<SynchReleaseVersion>false</SynchReleaseVersion> <SynchReleaseVersion>false</SynchReleaseVersion>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageVersion>5.0.2</PackageVersion> <PackageVersion>5.0.2</PackageVersion>
<TargetFrameworks>net5.0;netcoreapp3.1</TargetFrameworks> <TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(RunConfiguration)' == 'YYApi' " />
<ItemGroup> <ItemGroup>
<Folder Include="Helpers\"/> <Folder Include="Helpers\"/>
<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="3.1.13" /> <PackageReference Include="Minio" Version="6.0.3" />
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.1.4" /> <PackageReference Include="MQTTnet" Version="4.3.6.1152" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.1.4" /> <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.6.2" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.6.2" />
</ItemGroup> </ItemGroup>
<ProjectExtensions> <ProjectExtensions>
<MonoDevelop> <MonoDevelop>
+91 -23
View File
@@ -5,10 +5,13 @@ using Microsoft.Extensions.DependencyInjection;
using Microsoft.OpenApi.Models; using Microsoft.OpenApi.Models;
using SimApi.Middlewares; using SimApi.Middlewares;
using Microsoft.AspNetCore.HttpOverrides; using Microsoft.AspNetCore.HttpOverrides;
using SimApi.Configs; using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using SimApi.Configurations;
using SimApi.Logger;
namespace SimApi;
namespace SimApi
{
/// <summary> /// <summary>
/// 加入系统的扩展信息 /// 加入系统的扩展信息
/// </summary> /// </summary>
@@ -20,11 +23,19 @@ namespace SimApi
{ {
var simApiOptions = new SimApiOptions(); var simApiOptions = new SimApiOptions();
options?.Invoke(simApiOptions); options?.Invoke(simApiOptions);
if (simApiOptions.EnableLogger)
{
builder.AddLogging(logger =>
{
logger.ClearProviders();
logger.AddProvider(new SimApiLoggerProvider());
});
}
// 是否使用SIMAUTH // 是否使用 AUTH
if (simApiOptions.EnableSimApiAuth) if (simApiOptions.EnableSimApiAuth)
{ {
builder.AddScoped<SimApiAuth>(); builder.AddSingleton<SimApiAuth>();
} }
if (simApiOptions.EnableCors) if (simApiOptions.EnableCors)
@@ -33,6 +44,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)
{ {
@@ -41,7 +57,11 @@ namespace SimApi
{ {
foreach (var group in docOptions.ApiGroups) foreach (var group in docOptions.ApiGroups)
{ {
x.SwaggerDoc(group.Id, new OpenApiInfo {Title = group.Name, Description = group.Description}); x.SwaggerDoc(group.Id, new OpenApiInfo
{
Title = group.Name,
Description = group.Description
});
} }
x.EnableAnnotations(); x.EnableAnnotations();
@@ -59,7 +79,10 @@ namespace SimApi
new OpenApiSecurityScheme new OpenApiSecurityScheme
{ {
Reference = new OpenApiReference Reference = new OpenApiReference
{Type = ReferenceType.SecurityScheme, Id = "HeaderToken"} {
Type = ReferenceType.SecurityScheme,
Id = "HeaderToken"
}
}, },
new[] { "readAccess", "writeAccess" } new[] { "readAccess", "writeAccess" }
} }
@@ -119,7 +142,10 @@ namespace SimApi
new OpenApiSecurityScheme new OpenApiSecurityScheme
{ {
Reference = new OpenApiReference Reference = new OpenApiReference
{Type = ReferenceType.SecurityScheme, Id = "oauth2"} {
Type = ReferenceType.SecurityScheme,
Id = "oauth2"
}
}, },
new[] { "SimApiAuth" } new[] { "SimApiAuth" }
} }
@@ -129,7 +155,11 @@ namespace SimApi
if (haveSimApiAuth) if (haveSimApiAuth)
{ {
x.AddSecurityDefinition("HeaderToken", x.AddSecurityDefinition("HeaderToken",
new OpenApiSecurityScheme {Name = "Token", In = ParameterLocation.Header}); new OpenApiSecurityScheme
{
Name = "Token",
In = ParameterLocation.Header
});
} }
}); });
} }
@@ -137,17 +167,17 @@ namespace SimApi
// 使用Header转发,应对代理后获取真实ip // 使用Header转发,应对代理后获取真实ip
if (simApiOptions.EnableForwardHeaders) if (simApiOptions.EnableForwardHeaders)
{ {
builder.Configure<ForwardedHeadersOptions>(options => builder.Configure<ForwardedHeadersOptions>(fwOptions =>
{ {
options.ForwardedHeaders = ForwardedHeaders.All; fwOptions.ForwardedHeaders = ForwardedHeaders.All;
options.KnownNetworks.Clear(); fwOptions.KnownNetworks.Clear();
options.KnownProxies.Clear(); fwOptions.KnownProxies.Clear();
}); });
} }
if (simApiOptions.EnableLowerUrl) if (simApiOptions.EnableLowerUrl)
{ {
builder.AddRouting(options => options.LowercaseUrls = true); builder.AddRouting(rOptions => rOptions.LowercaseUrls = true);
} }
if (simApiOptions.EnableSimApiStorage) if (simApiOptions.EnableSimApiStorage)
@@ -160,6 +190,35 @@ namespace SimApi
return builder; return builder;
} }
public static IHost UseSimApi(this IHost builder)
{
var options = builder.Services.GetRequiredService<SimApiOptions>();
var logger = builder.Services.GetRequiredService<ILogger<SimApiOptions>>();
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
//请求一下检测存储错误
if (options.EnableSimApiStorage)
{
logger.LogInformation("开始配置SimApiStorage...");
builder.Services.GetService<SimApiStorage>();
}
if (options.EnableLowerUrl)
{
logger.LogInformation("开始配置使用URL小写...");
}
if (options.EnableSynapse)
{
var synapse = builder.Services.GetRequiredService<Synapse>();
synapse.Init();
}
return builder;
}
/// <summary> /// <summary>
/// 使用所有SimApi自定义中间件 /// 使用所有SimApi自定义中间件
/// </summary> /// </summary>
@@ -167,28 +226,32 @@ namespace SimApi
/// <returns></returns> /// <returns></returns>
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder) public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
{ {
var options = builder.ApplicationServices.GetService<SimApiOptions>(); var options = builder.ApplicationServices.GetRequiredService<SimApiOptions>();
var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiOptions>>();
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
if (options.EnableForwardHeaders) if (options.EnableForwardHeaders)
{ {
SimApiUtil.Log("开始配置ForwardedHeaders..."); logger.LogInformation("开始配置ForwardedHeaders...");
builder.UseForwardedHeaders(); builder.UseForwardedHeaders();
} }
if (options.EnableCors) if (options.EnableCors)
{ {
SimApiUtil.Log("开始配置Cors全部允许..."); logger.LogInformation("开始配置Cors全部允许...");
builder.UseCors("any"); builder.UseCors("any");
} }
if (options.EnableSimApiAuth) if (options.EnableSimApiAuth)
{ {
SimApiUtil.Log("开始配置SimApiAuth..."); logger.LogInformation("开始配置SimApiAuth...");
builder.UseMiddleware<SimApiAuthMiddleware>(); builder.UseMiddleware<SimApiAuthMiddleware>();
} }
if (options.EnableSimApiDoc) if (options.EnableSimApiDoc)
{ {
SimApiUtil.Log("开始配置SimApiDoc..."); logger.LogInformation("开始配置SimApiDoc...");
var docOptions = options.SimApiDocOptions; var docOptions = options.SimApiDocOptions;
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x => builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
{ {
@@ -206,23 +269,28 @@ namespace SimApi
if (options.EnableSimApiException) if (options.EnableSimApiException)
{ {
SimApiUtil.Log("开始配置SimApiException..."); logger.LogInformation("开始配置SimApiException...");
builder.UseMiddleware<SimApiExceptionMiddleware>(); builder.UseMiddleware<SimApiExceptionMiddleware>();
} }
//请求一下检测存储错误 //请求一下检测存储错误
if (options.EnableSimApiStorage) if (options.EnableSimApiStorage)
{ {
SimApiUtil.Log("开始配置SimApiStorage..."); logger.LogInformation("开始配置SimApiStorage...");
builder.ApplicationServices.GetService<SimApiStorage>(); builder.ApplicationServices.GetService<SimApiStorage>();
} }
if (options.EnableLowerUrl) if (options.EnableLowerUrl)
{ {
SimApiUtil.Log("开始配置使用URL小写..."); logger.LogInformation("开始配置使用URL小写...");
}
if (options.EnableSynapse)
{
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
synapse.Init();
} }
return builder; return builder;
} }
} }
}
+56
View File
@@ -0,0 +1,56 @@
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using MQTTnet;
using MQTTnet.Protocol;
namespace SimApi;
public partial class Synapse
{
public event EventHandler<ConfigStoreItem>? OnConfigChanged;
private Dictionary<string, string> CurrentConfig { get; } = new();
private bool FireSetConfig(string key, string value)
{
var topic = $"{Options.SysName}/synapse-config-store/{key}";
var message = new MqttApplicationMessageBuilder()
.WithTopic(topic)
.WithPayload(value)
.WithRetainFlag()
.Build();
if (!Client!.IsConnected) return false;
Client!.PublishAsync(message, CancellationToken.None).Wait();
logger.LogDebug("Synapse Config Set: {Config} => {Data}", key, value);
return true;
}
private string? FireGetConfig(string key)
{
return CurrentConfig.GetValueOrDefault(key);
}
private void RunConfigStoreServer()
{
var csTopicPrefix = $"{Options.SysName}/synapse-config-store/";
var eventSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
.WithTopicFilter(o =>
o.WithTopic($"{csTopicPrefix}+").WithRetainHandling(MqttRetainHandling.SendAtSubscribe))
.Build();
Client!.ApplicationMessageReceivedAsync += e =>
{
if (!e.ApplicationMessage.Topic.StartsWith(csTopicPrefix)) return Task.CompletedTask;
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
var eventName = e.ApplicationMessage.Topic.Replace(csTopicPrefix, string.Empty);
CurrentConfig[eventName] = reqBody;
OnConfigChanged?.Invoke(this, new ConfigStoreItem(eventName, reqBody));
logger.LogDebug("Synapse Config Changed: {Config} => {Data}", eventName, reqBody);
return Task.CompletedTask;
};
Client.SubscribeAsync(eventSubOpts).Wait();
}
public record ConfigStoreItem(string Key, string Value);
}
+33
View File
@@ -0,0 +1,33 @@
using System.Text.Json;
using System.Threading;
using Microsoft.Extensions.Logging;
using MQTTnet;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private bool FireEvent(string eventName, object? param)
{
string paramJson;
if (param is string strParam)
{
paramJson = strParam;
}
else
{
paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
}
var topic = $"{Options.SysName}/event/{Options.AppName}/{eventName}";
var message = new MqttApplicationMessageBuilder()
.WithTopic(topic)
.WithPayload(paramJson)
.WithRetainFlag(false)
.Build();
if (!Client!.IsConnected) return false;
Client.PublishAsync(message, CancellationToken.None).Wait();
logger.LogDebug("Synapse Event Publish: {Event}@{App} {Json}", eventName, Options.AppName, paramJson);
return true;
}
}
+63
View File
@@ -0,0 +1,63 @@
using System;
using System.Linq;
using System.Text.Json;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using MQTTnet;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private void RunEventServer()
{
var esTopicPrefix = $"{Options.SysName}/event/";
Client!.ApplicationMessageReceivedAsync += e =>
{
if (!e.ApplicationMessage.Topic.StartsWith(esTopicPrefix)) return Task.CompletedTask;
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
var eventName = e.ApplicationMessage.Topic.Replace(esTopicPrefix, string.Empty);
logger.LogDebug("Synapse Event Receive: {EventName}\n{Body}", eventName, reqBody);
var methods = EventRegistry
.Where(x => Regex.IsMatch(eventName,
"^" + Regex.Escape(x.Key!).Replace("\\+", "[^/]+").Replace("\\#", ".*") + "$"))
.ToArray();
foreach (var method in methods)
{
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(method.Class!);
var mt = callClass.GetType().GetMethod(method.Method!);
try
{
if (mt!.GetParameters().Length == 2)
{
var pt = mt!.GetParameters()[0].ParameterType;
mt.Invoke(callClass, pt == typeof(string)
? [eventName, reqBody]
: [eventName, JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption)]);
}
else
{
mt.Invoke(callClass, [eventName]);
}
}
catch (Exception ex)
{
logger.LogError("Synapse Event Processor Error: {Err}", ex.InnerException);
}
}
return Task.CompletedTask;
};
foreach (var ev in EventRegistry)
{
var topic = $"$queue/{esTopicPrefix}{ev.Key}";
var evSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
.WithTopicFilter(o => o.WithTopic(topic)).Build();
Client.SubscribeAsync(evSubOpts).Wait();
logger.LogDebug("Synapse Event Register Event Success: {EventName}\nFull Topic: {Topic}", ev.Key, topic);
}
}
}
+87
View File
@@ -0,0 +1,87 @@
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using MQTTnet;
using SimApi.Communications;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse
{
private Dictionary<string, TaskCompletionSource<string>> ResponseCompletionSources { get; } = new();
private void RunRpcClient()
{
var rcTopic = $"{Options.SysName}/{Options.AppName}/rpc/client/{Options.AppId}/";
var rcSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
.WithTopicFilter(o => o.WithTopic($"{rcTopic}+")).Build();
Client!.ApplicationMessageReceivedAsync += e =>
{
if (!e.ApplicationMessage.Topic.StartsWith(rcTopic)) return Task.CompletedTask;
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
var messageId = e.ApplicationMessage.Topic.Replace(rcTopic, string.Empty);
if (!ResponseCompletionSources.TryGetValue(messageId, out var tcs)) return Task.CompletedTask;
tcs.SetResult(reqBody);
ResponseCompletionSources.Remove(messageId);
return Task.CompletedTask;
};
Client.SubscribeAsync(rcSubOpts).Wait();
}
private string? FireRpc(string app, string action, object? param)
{
string paramJson;
if (param is string strParam)
{
paramJson = strParam;
}
else
{
paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
}
var topic = $"{Options.SysName}/{app}/rpc/server/{action}";
var messageId = Guid.NewGuid().ToString();
var tcs = new TaskCompletionSource<string>();
ResponseCompletionSources.Add(messageId, tcs);
var message = new MqttApplicationMessageBuilder()
.WithTopic(topic)
.WithPayload(paramJson)
.WithResponseTopic($"{Options.AppName},{Options.AppId}")
.WithContentType(messageId)
.WithRetainFlag(false)
.Build();
if (!Client!.IsConnected) return null;
Client.PublishAsync(message, CancellationToken.None).Wait();
logger.LogDebug(
"Synapse RPC Client Request: ({PropsMessageId}) {OptionsAppName} -> {Action}@{App}\n{ParamJson}", messageId,
Options.AppName, action, app, paramJson);
string response;
try
{
if (tcs.Task.Wait(Options.RpcTimeout * 1000))
{
response = tcs.Task.Result;
logger.LogDebug(
"Synapse RPC Client Response: ({BasicPropertiesCorrelationId}) {BasicPropertiesType}@{BasicPropertiesReplyTo} -> {OptionsAppName}\n{S}",
messageId, action, app, Options.AppName, response);
}
else
{
response = JsonSerializer.Serialize(new SimApiBaseResponse(502, "timeout"), SimApiUtil.JsonOption);
}
}
catch
{
response = JsonSerializer.Serialize(new SimApiBaseResponse(500, "Synapse RPC Client Error"),
SimApiUtil.JsonOption);
}
return response;
}
}
+98
View File
@@ -0,0 +1,98 @@
using System;
using System.Linq;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using MQTTnet;
using MQTTnet.Protocol;
using SimApi.Communications;
using SimApi.Exceptions;
using SimApi.Helpers;
using JsonSerializer = System.Text.Json.JsonSerializer;
namespace SimApi;
public partial class Synapse
{
private void RunRpcServer()
{
var rsTopicPrefix = $"{Options.SysName}/{Options.AppName}/rpc/server/";
var rsSubOpts = MqttFactory.CreateSubscribeOptionsBuilder()
.WithTopicFilter(o =>
o.WithTopic($"$queue/{rsTopicPrefix}+").WithRetainHandling(MqttRetainHandling.SendAtSubscribe))
.Build();
Client!.ApplicationMessageReceivedAsync += e =>
{
if (!e.ApplicationMessage.Topic.StartsWith(rsTopicPrefix)) return Task.CompletedTask;
var reqBody = e.ApplicationMessage.ConvertPayloadToString();
var action = e.ApplicationMessage.Topic.Replace(rsTopicPrefix, string.Empty);
var appInfo = e.ApplicationMessage.ResponseTopic.Split(",");
logger.LogDebug(
"Synapse RPC Server Receive: ({BasicPropertiesMessageId}) {BasicPropertiesReplyTo} -> {BasicPropertiesType}@{OptionsAppName}\n{S}",
e.ApplicationMessage.ContentType, appInfo[0], action, Options.AppName,
reqBody);
SimApiBaseResponse res;
var method = RpcRegistry.FirstOrDefault(x => x.Key == action);
if (method == null) return Task.CompletedTask;
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(method.Class!);
var mt = callClass.GetType().GetMethod(method.Method!);
try
{
var methodParams = mt!.GetParameters();
object? ret;
if (methodParams.Length == 0)
{
ret = mt.Invoke(callClass, []);
}
else
{
var pt = mt.GetParameters()[0].ParameterType;
var param = pt == typeof(string)
? [reqBody]
: new[] { JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption) };
ret = mt.Invoke(callClass, param);
}
res = new SimApiBaseResponse<object?>
{
Data = ret
};
}
catch (TargetInvocationException ex)
{
if (ex.InnerException is SimApiException ie)
{
logger.LogDebug("Synapse RPC调用错误: {Err}", ie.Message);
res = new SimApiBaseResponse(ie.Code, ie.Message);
}
else
{
res = new SimApiBaseResponse(500, ex.Message);
}
}
catch (Exception ex)
{
logger.LogDebug("Synapse RPC调用失败: {Err}", ex.Message);
res = new SimApiBaseResponse(500, ex.Message);
}
var returnJson = JsonSerializer.Serialize((object)res, SimApiUtil.JsonOption);
var reply = $"{Options.SysName}/{appInfo[0]}/rpc/client/{appInfo[1]}/{e.ApplicationMessage.ContentType}";
var message = new MqttApplicationMessageBuilder()
.WithTopic(reply)
.WithPayload(returnJson)
.WithRetainFlag(false)
.Build();
if (!Client.IsConnected) return Task.CompletedTask;
Client.PublishAsync(message, CancellationToken.None).Wait();
logger.LogDebug(
"Synapse Rpc Server Return: ({BasicPropertiesMessageId}) {BasicPropertiesType}@{OptionsAppName} -> {BasicPropertiesReplyTo}\n{ReturnJson}",
e.ApplicationMessage.ContentType, action, Options.AppName, appInfo[0], returnJson);
return Task.CompletedTask;
};
Client.SubscribeAsync(rsSubOpts).Wait();
}
}
+281
View File
@@ -0,0 +1,281 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using MQTTnet;
using MQTTnet.Client;
using MQTTnet.Formatter;
using SimApi.Attributes;
using SimApi.Communications;
using SimApi.Configurations;
using SimApi.Helpers;
namespace SimApi;
public partial class Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logger, IServiceProvider sp)
{
private SimApiSynapseOptions Options { get; } = simApiOptions.SimApiSynapseOptions;
private MqttFactory MqttFactory { get; } = new();
public IMqttClient? Client { get; set; }
private List<RegisterItem> EventRegistry { get; set; } = new();
private List<RegisterItem> RpcRegistry { get; set; } = new();
public void Init()
{
logger.LogDebug("Synapse初始化配置信息: {Json}", SimApiUtil.Json(Options));
if (string.IsNullOrEmpty(Options.AppName) || string.IsNullOrEmpty(Options.SysName))
{
logger.LogCritical("Synapse初始化失败: AppName 和 SysName 不能为空");
}
Options.AppId ??= Guid.NewGuid().ToString();
logger.LogInformation("Synapse Sys Name: {SysName}\nSynapse App Name: {AppName}\nSynapse App Id: {AppId}",
Options.SysName, Options.AppName, Options.AppId);
CreateConnection();
ProcessAttribute();
//事件客户端
if (Options.DisableEventClient)
{
logger.LogWarning("Synapse Event Client Disabled: DisableEventClient set true");
}
else
{
logger.LogInformation("Synapse Event Client Ready");
}
//RPC客户端
if (Options.DisableRpcClient)
{
logger.LogWarning("Synapse Rpc Client Disabled: DisableEventClient set true");
}
else
{
RunRpcClient();
logger.LogInformation("Synapse Rpc Client Ready, Client Timeout: {OptionsRpcTimeout}s", Options.RpcTimeout);
}
if (RpcRegistry.Count > 0)
{
RunRpcServer();
}
if (EventRegistry.Count > 0)
{
RunEventServer();
}
if (Options.EnableConfigStore)
{
RunConfigStoreServer();
logger.LogInformation("Synapse Config Store Ready [{SysName}] ...", Options.SysName);
}
}
/// <summary>
/// 调用RPC使用明确的返回值类型
/// </summary>
/// <param name="appName"></param>
/// <param name="method"></param>
/// <param name="param"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public SimApiBaseResponse<T> Rpc<T>(string appName, string method, dynamic? param = null)
{
var res = new SimApiBaseResponse(500, "Synapse Rpc Client Disabled!");
if (Options.DisableRpcClient)
{
logger.LogError("Synapse Rpc Client Disabled!");
}
else
{
var data = FireRpc(appName, method, param);
res = JsonSerializer.Deserialize<SimApiBaseResponse<T>>(data, SimApiUtil.JsonOption);
}
return (res as SimApiBaseResponse<T>)!;
}
/// <summary>
/// 调用RPC使用object作为返回值类型
/// </summary>
/// <param name="appName"></param>
/// <param name="method"></param>
/// <param name="param"></param>
/// <returns></returns>
public SimApiBaseResponse<object> Rpc(string appName, string method, dynamic? param = null)
{
return Rpc<object>(appName, method, param);
}
/// <summary>
///
/// </summary>
/// <param name="eventName"></param>
/// <param name="param"></param>
public bool Event(string eventName, dynamic? param = null)
{
if (!Options.DisableEventClient) return FireEvent(eventName, param);
logger.LogError("Synapse Event Client Disabled!");
return false;
}
/// <summary>
/// 设置一个系统配置项
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
/// <returns></returns>
public bool SetConfig(string key, string value)
{
if (Options.EnableConfigStore) return FireSetConfig(key, value);
logger.LogError("Synapse Config Store Disabled!");
return false;
}
/// <summary>
/// 读取一个配置项,如果没有则为空
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
public string? GetConfig(string key)
{
if (Options.EnableConfigStore) return FireGetConfig(key);
logger.LogError("Synapse Config Store Disabled!");
return null;
}
private void CreateConnection()
{
Client = MqttFactory.CreateMqttClient();
var clientOpts = new MqttClientOptionsBuilder().WithProtocolVersion(MqttProtocolVersion.V500)
.WithWebSocketServer(o => o.WithUri(Options.Websocket))
.WithCredentials(Options.Username, Options.Password)
.WithClientId($"{Options.AppName}:{Options.AppId}")
.Build();
Client!.ConnectAsync(clientOpts, CancellationToken.None).Wait();
Client.ConnectedAsync += _ =>
{
logger.LogInformation("Synapse MQTT[{AppName}:{AppId}] 连接成功...", Options.AppName, Options.AppId);
return Task.CompletedTask;
};
//重连
Client.DisconnectedAsync += async _ =>
{
logger.LogError("Synapse MQTT[{AppName}:{AppId}] 断开连接,开始重连...", Options.AppName, Options.AppId);
await Task.Delay(TimeSpan.FromSeconds(5));
try
{
logger.LogInformation("Synapse MQTT[{AppName}:{AppId}] 开始连接MQTT服务器...", Options.AppName, Options.AppId);
Client.ConnectAsync(clientOpts).Wait();
}
catch
{
logger.LogError("Synapse MQTT[{AppName}:{AppId}] 重连失败...", Options.AppName, Options.AppId);
}
};
}
private void ProcessAttribute()
{
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))!;
var tmp = new RegisterItem
{
Key = attribute.Name ?? method.Name,
Class = type,
Method = method.Name
};
if (tmp.Key.StartsWith('/') || tmp.Key.EndsWith('/'))
{
logger.LogError("Synapse Event Register Error: {Key} Can't start or end of '/'", tmp.Key);
continue;
}
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(tmp.Class!);
var mt = callClass.GetType().GetMethod(tmp.Method);
if (mt!.GetParameters().Length > 2 || mt.GetParameters().Length<1)
{
logger.LogError(
"Synapse Event Register Error: Only one or two parameter supported. {Key} -> {Method}@{Class}",
tmp.Key, tmp.Method, tmp.Class.Name);
continue;
}
EventRegistry.Add(tmp);
}
if (method.IsDefined(typeof(SynapseRpcAttribute), false))
{
var attribute =
(SynapseRpcAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseRpcAttribute))!;
var tmp = new RegisterItem
{
Key = attribute.Name ?? $"{type.Name}.{method.Name}",
Class = type,
Method = method.Name
};
if (tmp.Key.Contains('/') || tmp.Key.Contains('#') || tmp.Key.Contains('+'))
{
logger.LogError("Synapse Rpc Register Error: {Key} contains '/' , '#' , '+'", tmp.Key);
continue;
}
var callClass = sp.CreateScope().ServiceProvider.GetRequiredService(tmp.Class!);
var mt = callClass.GetType().GetMethod(tmp.Method);
if (mt!.GetParameters().Length > 1)
{
logger.LogError(
"Synapse Rpc Register Error: Only one or none parameter supported. {Key} -> {Method}@{Class}",
tmp.Key, tmp.Method, tmp.Class.Name);
continue;
}
if (RpcRegistry.Any(x => x.Key == tmp.Key))
{
logger.LogError("Synapse Rpc Register Error: {Key} Already Exists -> {Method}@{Class}", tmp.Key,
tmp.Method, tmp.Class.Name);
continue;
}
RpcRegistry.Add(tmp);
}
}
}
var events = EventRegistry.Aggregate(string.Empty,
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class!.Name}");
var rpcList = RpcRegistry.Aggregate(string.Empty,
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class!.Name}");
if (EventRegistry.Count > 0) logger.LogInformation(" >> Synapse System 读取Event方法:{Event}", events);
if (RpcRegistry.Count > 0) logger.LogInformation(" >> Synapse System 读取RPC方法:{Rpc}", rpcList);
}
}
public class RegisterItem
{
public string? Key { get; init; }
public Type? Class { get; init; }
public string? Method { get; init; }
}