Compare commits

..
11 Commits
Author SHA1 Message Date
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
28 changed files with 1112 additions and 1133 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`
+9 -16
View File
@@ -5,24 +5,21 @@ 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>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class SimApiAuthAttribute : ActionFilterAttribute
{ {
/// <summary>
/// 检测登录中间件
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class SimApiAuthAttribute : ActionFilterAttribute
{
private string[] Types { get; } private string[] Types { get; }
//默认是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);
} }
@@ -61,5 +55,4 @@ namespace SimApi.Attributes
throw new SimApiException(403); throw new SimApiException(403);
} }
} }
}
} }
+7 -8
View File
@@ -1,14 +1,14 @@
using System; using System;
using Swashbuckle.AspNetCore.Annotations; using Swashbuckle.AspNetCore.Annotations;
namespace SimApi.Attributes namespace SimApi.Attributes;
/// <summary>
/// 快捷自定义接口文档类
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class SimApiDocAttribute : SwaggerOperationAttribute
{ {
/// <summary>
/// 快捷自定义接口文档类
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class SimApiDocAttribute : SwaggerOperationAttribute
{
/// <summary> /// <summary>
/// 定义接口说明 /// 定义接口说明
/// </summary> /// </summary>
@@ -21,5 +21,4 @@ namespace SimApi.Attributes
// Consumes = new[] {"application/json"}; // Consumes = new[] {"application/json"};
// Produces = new[] {"application/json"}; // Produces = new[] {"application/json"};
} }
}
} }
+32 -18
View File
@@ -1,23 +1,37 @@
namespace SimApi.Communications using System.ComponentModel.DataAnnotations;
namespace SimApi.Communications;
/// <summary>
/// 只有ID的请求
/// </summary>
public class SimApiIdOnlyRequest
{ {
/// <summary> [Required] public int Id { get; set; }
/// 只有ID的请求 }
/// </summary>
public record SimApiIdOnlyRequest(int Id);
/// <summary> /// <summary>
/// 只有ID的请求(字符串) /// 只有ID的请求(字符串)
/// </summary> /// </summary>
public record SimApiStringIdOnlyRequest(string Id); public class SimApiStringIdOnlyRequest
{
[Required] public string Id { get; set; }
}
/// <summary> /// <summary>
/// 动态类型单字段请求 /// 动态类型单字段请求
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public record SimApiOneFieldRequest<T>(T Data); public class SimApiOneFieldRequest<T>
{
[Required] public T Data { get; set; }
}
/// <summary> /// <summary>
/// 基础分页请求 /// 基础分页请求
/// </summary> /// </summary>
public record SimApiBasePageRequest(int Page, int Count); public class SimApiBasePageRequest
{
[Required] public int Page { get; set; }
[Required] public int Count { get; set; }
} }
+36 -42
View File
@@ -2,42 +2,31 @@
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>
public class SimApiBaseResponse(int code = 200, string message = "成功")
{ {
/// <summary> public int Code { get; set; } = code;
/// 基础相应 public string Message { get; set; } = message;
/// </summary>
public record SimApiBaseResponse(int Code = 200, string Message = "成功")
{
/// <summary> /// <summary>
/// 默认错误代码对应提示信息 /// 默认错误代码对应提示信息
/// </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.GetValueOrDefault(code, "未知错误"))
{ {
} }
@@ -57,20 +46,25 @@ namespace SimApi.Communications
} }
}); });
} }
} }
/// <summary> /// <summary>
/// 动态内容分页 /// 动态内容分页
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public record SimApiBasePageResponse<T> public class SimApiBasePageResponse<T> : SimApiBaseResponse
(T List, int Page = 1, int Count = 1, int Total = 1, int Code = 200, {
string Message = "成功") : SimApiBaseResponse(Code, Message); public T List { get; set; }
public int Page { get; set; } = 1;
public int Count { get; set; } = 20;
public int Total { get; set; }
}
/// <summary> /// <summary>
/// 动态Data返回 /// 动态Data返回
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code, public class SimApiBaseResponse<T> : SimApiBaseResponse
Message); {
public T Data { get; set; }
} }
+6 -7
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);
}
+28 -26
View File
@@ -1,14 +1,13 @@
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>
public class SimApiDocGroupOption
{ {
/// <summary>
/// 文档组配置
/// </summary>
public class SimApiDocGroupOption
{
/// <summary> /// <summary>
/// 文档标识 /// 文档标识
/// </summary> /// </summary>
@@ -23,25 +22,29 @@ namespace SimApi.Configs
/// 文档描述 /// 文档描述
/// </summary> /// </summary>
public string Description { get; set; } public string Description { get; set; }
} }
/// <summary>
/// 授权配置, Type支持 "SimApiAuth","ClientCredentials","Implicit","AuthorizationCode"
/// </summary>
public class SimApiAuthOption
{
public string[] Type { get; set; } = new[] { "SimApiAuth" };
/// <summary>
/// 授权配置, Type支持 "SimApiAuth","ClientCredentials","Implicit","AuthorizationCode"
/// </summary>
public class SimApiAuthOption
{
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 TokenUrl { get; set; }
public Dictionary<string, string> Scopes { get; set; }
}
/// <summary> public string AuthorizationUrl { get; set; }
/// 文档配置
/// </summary> public string TokenUrl { get; set; }
public class SimApiDocOptions
{ public Dictionary<string, string> Scopes { get; set; }
}
/// <summary>
/// 文档配置
/// </summary>
public class SimApiDocOptions
{
/// <summary> /// <summary>
/// 文档组配置 /// 文档组配置
/// </summary> /// </summary>
@@ -68,6 +71,5 @@ namespace SimApi.Configs
/// <summary> /// <summary>
/// 接口支持的调用方式 /// 接口支持的调用方式
/// </summary> /// </summary>
public SubmitMethod[] SupportedMethod { get; set; } = new[] {SubmitMethod.Post}; public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
}
} }
+6 -7
View File
@@ -1,9 +1,9 @@
using System; using System;
namespace SimApi.Configs namespace SimApi.Configs;
public class SimApiOptions
{ {
public class SimApiOptions
{
/// <summary> /// <summary>
/// 启用全部Cors,对于开发前后分离的时候很有用。 /// 启用全部Cors,对于开发前后分离的时候很有用。
/// default: true /// default: true
@@ -61,14 +61,14 @@ namespace SimApi.Configs
/// <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 SimApiSynapseOptions(); public SimApiSynapseOptions SimApiSynapseOptions { get; set; } = new();
public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions> options = null) public void ConfigureSimApiSynapse(Action<SimApiSynapseOptions> options = null)
{ {
@@ -89,5 +89,4 @@ namespace SimApi.Configs
{ {
options?.Invoke(SimApiStorageOptions); options?.Invoke(SimApiStorageOptions);
} }
}
} }
+3 -4
View File
@@ -1,7 +1,7 @@
namespace SimApi.Configs namespace SimApi.Configs;
public class SimApiStorageOptions
{ {
public class SimApiStorageOptions
{
/// <summary> /// <summary>
/// S3 服务器入口地址 /// S3 服务器入口地址
/// </summary> /// </summary>
@@ -20,5 +20,4 @@ namespace SimApi.Configs
public string AccessKey { get; set; } public string AccessKey { get; set; }
public string SecretKey { get; set; } public string SecretKey { get; set; }
}
} }
+35 -13
View File
@@ -4,18 +4,17 @@ 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>
/// 基础控制器,所有控制器均继承本控制器
/// 1. 自动验证请求参数
/// 2. 报错返回
/// 3. 错误回馈页面
/// </summary>
public class SimApiBaseController : Controller
{ {
/// <summary>
/// 基础控制器,所有控制器均继承本控制器
/// 1. 自动验证请求参数
/// 2. 报错返回
/// 3. 错误回馈页面
/// </summary>
public class SimApiBaseController : Controller
{
/// <summary> /// <summary>
/// 当前登录用户的ID /// 当前登录用户的ID
/// </summary> /// </summary>
@@ -51,7 +50,7 @@ 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>
@@ -64,6 +63,30 @@ 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 = 500, 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 = 500, string message = "")
{
ErrorWhen(!condition, code, message);
}
/// <summary> /// <summary>
/// 检测给定的变量是否为NUll /// 检测给定的变量是否为NUll
/// </summary> /// </summary>
@@ -81,7 +104,6 @@ namespace SimApi.Controllers
/// <returns></returns> /// <returns></returns>
protected SimApiBaseResponse<string> UploadFile() protected SimApiBaseResponse<string> UploadFile()
{ {
return new SimApiBaseResponse<string>(null); return new SimApiBaseResponse<string>();
}
} }
} }
+12 -18
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")]
public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
{ {
[ApiExplorerSettings(GroupName = "api")]
public class YYCommonController : SimApiBaseController
{
private SimApiAuth Auth { get; }
public YYCommonController(SimApiAuth auth)
{
Auth = auth;
}
/// <summary> /// <summary>
/// 错误回馈页面 /// 错误回馈页面
/// </summary> /// </summary>
@@ -36,7 +28,10 @@ namespace SimApi.Controllers
public SimApiBaseResponse<string> CheckLogin() public SimApiBaseResponse<string> CheckLogin()
{ {
ErrorWhenNull(LoginInfo, 401); ErrorWhenNull(LoginInfo, 401);
return new SimApiBaseResponse<string>(LoginInfo.Id); return new SimApiBaseResponse<string>
{
Data = LoginInfo.Id
};
} }
/// <summary> /// <summary>
@@ -48,13 +43,12 @@ namespace SimApi.Controllers
{ {
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();
} }
}
} }
+8 -13
View File
@@ -1,16 +1,11 @@
using System; using System;
namespace SimApi.Exceptions
{
/// <summary>
/// Api错误捕获异常
/// </summary>
public class SimApiException : Exception
{
public int Code { get; }
public SimApiException(int code, string message = "") : base(message) namespace SimApi.Exceptions;
{
Code = code; /// <summary>
} /// Api错误捕获异常
} /// </summary>
public class SimApiException(int code, string message = "") : Exception(message)
{
public int Code { get; } = code;
} }
+24 -21
View File
@@ -1,34 +1,26 @@
#nullable enable
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>
public class SimApiAuth(IDistributedCache cache)
{ {
/// <summary>
/// 认证助手
/// </summary>
public class SimApiAuth
{
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="token"></param>
/// <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>
@@ -36,15 +28,27 @@ namespace SimApi.Helpers
/// </summary> /// </summary>
/// <param name="id"></param> /// <param name="id"></param>
/// <param name="type"></param> /// <param name="type"></param>
/// <param name="uuid"></param>
/// <returns></returns> /// <returns></returns>
public string Login(string id, string[] type, string uuid = null) public string Login(string id, string[] type, string uuid = null)
{ {
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;
} }
/// <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>
@@ -53,8 +57,7 @@ namespace SimApi.Helpers
{ {
if (!string.IsNullOrEmpty(uuid)) if (!string.IsNullOrEmpty(uuid))
{ {
Cache.Remove(uuid); cache.Remove(uuid);
}
} }
} }
} }
+4 -6
View File
@@ -2,13 +2,12 @@
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; }
public MinioClient Client => Mc; public MinioClient Client => Mc;
@@ -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}";
}
} }
} }
+39 -20
View File
@@ -1,30 +1,36 @@
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.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 +51,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 +70,23 @@ 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)
});
} }
/// <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);
} }
} }
+5 -12
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(string name) : ILogger
{ {
public class SimApiLogger : ILogger
{
private string Name { get; }
public SimApiLogger(string name)
{
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;
@@ -30,12 +23,12 @@ namespace SimApi.Logger
_ => ConsoleColor.White _ => ConsoleColor.White
}; };
var message = var message =
$"[ {Name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n"; $"[ {name} ][ {DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
if (exception != null) if (exception != null)
{ {
message += $"{exception}\n"; message += $"{exception}\n";
} }
Console.WriteLine(message); Console.WriteLine(message);
} }
}
} }
+4 -6
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 = new();
{
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers =
new ConcurrentDictionary<string, SimApiLogger>();
public ILogger CreateLogger(string categoryName) public ILogger CreateLogger(string categoryName)
@@ -18,5 +17,4 @@ namespace SimApi.Logger
{ {
_loggers.Clear(); _loggers.Clear();
} }
}
} }
+13 -20
View File
@@ -3,39 +3,32 @@ 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>
public class SimApiAuthMiddleware(RequestDelegate next)
{ {
/// <summary> public Task Invoke(HttpContext httpContext, IDistributedCache cache, SimApiAuth auth)
/// 认证信息获取中间件
/// </summary>
public class SimApiAuthMiddleware
{
private RequestDelegate Next { get; }
public SimApiAuthMiddleware(RequestDelegate next)
{
Next = next;
}
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))
{ {
var login = cache.GetString(token); var login = auth.GetLogin(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);
}
} }
} }
+14 -28
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>
public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
{ {
/// <summary>
/// 异常处理中间件
/// </summary>
public class SimApiExceptionMiddleware
{
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());
} }
} }
}
} }
+12 -10
View File
@@ -1,16 +1,19 @@
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 [Column(Order = 1)] public string Id { get; set; } = Guid.NewGuid().ToString();
{
protected virtual string[] MapperIgnoreField { get; set; } = [Column(Order = 9998)] public DateTime UpdatedAt { get; set; } = DateTime.Now;
{
"Id", "CreatedAt", "UpdatedAt" [Column(Order = 9999)] public DateTime CreatedAt { get; set; } = DateTime.Now;
};
protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" };
protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt"; protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt";
@@ -78,7 +81,6 @@ namespace SimApi.Models
/// <returns></returns> /// <returns></returns>
public void UpdateTime() public void UpdateTime()
{ {
GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow); GetType().GetProperty(UpdatedTimeField)?.SetValue(this, DateTime.Now);
}
} }
} }
+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格式,自定义响应格式
+11 -11
View File
@@ -14,27 +14,27 @@
<SynchReleaseVersion>false</SynchReleaseVersion> <SynchReleaseVersion>false</SynchReleaseVersion>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageVersion>5.0.2</PackageVersion> <PackageVersion>5.0.2</PackageVersion>
<TargetFramework>net7.0</TargetFramework> <TargetFramework>net8.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<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="Exceptions\" /> <Folder Include="Exceptions\"/>
</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="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>
<ProjectExtensions> <ProjectExtensions>
<MonoDevelop> <MonoDevelop>
<Properties> <Properties>
<Policies> <Policies>
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical" /> <DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical"/>
</Policies> </Policies>
</Properties> </Properties>
</MonoDevelop> </MonoDevelop>
+7 -8
View File
@@ -9,13 +9,13 @@ using Microsoft.Extensions.Logging;
using SimApi.Configs; using SimApi.Configs;
using SimApi.Logger; using SimApi.Logger;
namespace SimApi namespace SimApi;
/// <summary>
/// 加入系统的扩展信息
/// </summary>
public static class SimApiExtensions
{ {
/// <summary>
/// 加入系统的扩展信息
/// </summary>
public static class SimApiExtensions
{
//**********快捷添加************** //**********快捷添加**************
public static IServiceCollection AddSimApi(this IServiceCollection builder, public static IServiceCollection AddSimApi(this IServiceCollection builder,
Action<SimApiOptions> options = null) Action<SimApiOptions> options = null)
@@ -33,7 +33,7 @@ namespace SimApi
// 是否使用 AUTH // 是否使用 AUTH
if (simApiOptions.EnableSimApiAuth) if (simApiOptions.EnableSimApiAuth)
{ {
builder.AddScoped<SimApiAuth>(); builder.AddSingleton<SimApiAuth>();
} }
if (simApiOptions.EnableCors) if (simApiOptions.EnableCors)
@@ -261,5 +261,4 @@ namespace SimApi
return builder; return builder;
} }
}
} }
+2 -5
View File
@@ -4,6 +4,7 @@ using System.Text.Encodings.Web;
using System.Text.Json; using System.Text.Json;
using System.Text.Unicode; using System.Text.Unicode;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using SimApi.Helpers;
namespace SimApi; namespace SimApi;
@@ -16,11 +17,7 @@ public partial class Synapse
private void FireEvent(string eventName, object param) private void FireEvent(string eventName, object param)
{ {
var paramJson = JsonSerializer.Serialize(param, new JsonSerializerOptions var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
{
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
});
var router = $"event.{Options.AppName}.{eventName}"; var router = $"event.{Options.AppName}.{eventName}";
var props = EventClientChannel.CreateBasicProperties(); var props = EventClientChannel.CreateBasicProperties();
props.AppId = Options.AppId; props.AppId = Options.AppId;
+2 -7
View File
@@ -5,6 +5,7 @@ using System.Text.Json;
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using RabbitMQ.Client.Events; using RabbitMQ.Client.Events;
using SimApi.Helpers;
namespace SimApi; namespace SimApi;
@@ -35,13 +36,7 @@ public partial class Synapse
{ {
mt.Invoke(callClass, pt == typeof(string) mt.Invoke(callClass, pt == typeof(string)
? new object[] { reqBody } ? new object[] { reqBody }
: new[] : new[] { JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption) });
{
JsonSerializer.Deserialize(reqBody, pt, new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
})
});
EventServerChannel.BasicAck(ea.DeliveryTag, false); EventServerChannel.BasicAck(ea.DeliveryTag, false);
} }
catch (Exception e) catch (Exception e)
+5 -14
View File
@@ -36,15 +36,11 @@ public partial class Synapse
RpcClientChannel.BasicConsume(queue, false, "", false, false, null, consumer); RpcClientChannel.BasicConsume(queue, false, "", false, false, null, consumer);
} }
private object FireRpc(string app, string action, object param) private string FireRpc(string app, string action, object param)
{ {
var paramJson = JsonSerializer.Serialize(param, new JsonSerializerOptions var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
{
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
});
var router = $"server.{app}"; var router = $"server.{app}";
SimApiBaseResponse response; string response;
var props = RpcClientChannel.CreateBasicProperties(); var props = RpcClientChannel.CreateBasicProperties();
props.AppId = Options.AppId; props.AppId = Options.AppId;
props.MessageId = Guid.NewGuid().ToString(); props.MessageId = Guid.NewGuid().ToString();
@@ -59,17 +55,12 @@ public partial class Synapse
{ {
if (SimApiUtil.TimestampNow - ts > Options.RpcTimeout) if (SimApiUtil.TimestampNow - ts > Options.RpcTimeout)
{ {
response = new SimApiBaseResponse(502, "timeout"); response = JsonSerializer.Serialize(new SimApiBaseResponse(502, "timeout"), SimApiUtil.JsonOption);
break; break;
} }
if (ResponseCache.TryGetValue(props.MessageId, out var value)) if (ResponseCache.TryGetValue(props.MessageId, out var value))
{ {
response = JsonSerializer.Deserialize<SimApiBaseResponse<object>>( response = Encoding.UTF8.GetString(value);
Encoding.UTF8.GetString(value), new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All)
});
ResponseCache.Remove(props.MessageId); ResponseCache.Remove(props.MessageId);
break; break;
} }
+8 -15
View File
@@ -2,9 +2,6 @@ using System;
using System.Linq; using System.Linq;
using System.Reflection; using System.Reflection;
using System.Text; using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
using System.Text.Unicode;
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging;
using RabbitMQ.Client.Events; using RabbitMQ.Client.Events;
@@ -48,20 +45,20 @@ public partial class Synapse
} }
else else
{ {
var paramObj = JsonSerializer.Deserialize(reqBody, pt, new JsonSerializerOptions var paramObj = JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption);
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
});
param = new[] { paramObj }; param = new[] { paramObj };
} }
var ret = mt.Invoke(callClass, param); var ret = mt.Invoke(callClass, param);
res = new SimApiBaseResponse<object>(ret); res = new SimApiBaseResponse<object>
{
Data = ret
};
} }
catch (TargetInvocationException e) catch (TargetInvocationException e)
{ {
if (e.InnerException is SimApiException) if (e.InnerException is SimApiException ie)
{ {
var ie = e.InnerException as SimApiException;
Logger.LogDebug("RPC调用错误: {Err}", ie.Message); Logger.LogDebug("RPC调用错误: {Err}", ie.Message);
res = new SimApiBaseResponse(ie.Code, ie.Message); res = new SimApiBaseResponse(ie.Code, ie.Message);
} }
@@ -77,11 +74,7 @@ public partial class Synapse
} }
} }
var returnJson = JsonSerializer.Serialize((object)res, new JsonSerializerOptions var returnJson = JsonSerializer.Serialize((object)res, SimApiUtil.JsonOption);
{
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
});
var reply = $"client.{ea.BasicProperties.ReplyTo}.{ea.BasicProperties.AppId}"; var reply = $"client.{ea.BasicProperties.ReplyTo}.{ea.BasicProperties.AppId}";
var props = RpcServerChannel.CreateBasicProperties(); var props = RpcServerChannel.CreateBasicProperties();
props.AppId = Options.AppId; props.AppId = Options.AppId;
+2 -1
View File
@@ -96,7 +96,8 @@ public partial class Synapse
} }
else else
{ {
res = FireRpc(appName, method, param); var data = FireRpc(appName, method, param);
res = JsonSerializer.Deserialize<SimApiBaseResponse<T>>(data, SimApiUtil.JsonOption);
} }
return res as SimApiBaseResponse<T>; return res as SimApiBaseResponse<T>;
} }