upgrade to c#12

This commit is contained in:
2024-03-23 07:29:43 +08:00
parent 47a48d0103
commit cb291691d5
21 changed files with 1013 additions and 1100 deletions
+41 -48
View File
@@ -5,61 +5,54 @@ 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> private string[] Types { get; }
/// 检测登录中间件
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] //默认是user登录类型
public class SimApiAuthAttribute : ActionFilterAttribute public SimApiAuthAttribute()
{ {
private string[] Types { get; } Types = new[] { "user" };
}
//只检测一种用户类型的快捷方式
public SimApiAuthAttribute(string type)
{
Types = type.Split(",");
}
//默认是user登录类型 //设定特定类型的检测
public SimApiAuthAttribute() public SimApiAuthAttribute(string[] types)
{
Types = types;
}
//只检测一种用户类型的快捷方式
public SimApiAuthAttribute(string type, string url)
{
Types = new[] { type };
new HttpPostAttribute(url);
}
public override void OnActionExecuting(ActionExecutingContext context)
{
var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"];
//检测是否登录
if (loginInfo == null)
{ {
Types = new[] throw new SimApiException(401);
{
"user"
};
} }
//检测用户类型
//只检测一种用户类型的快捷方式 if (!Types.Intersect(loginInfo.Type).Any())
public SimApiAuthAttribute(string type)
{ {
Types = type.Split(","); throw new SimApiException(403);
}
//设定特定类型的检测
public SimApiAuthAttribute(string[] types)
{
Types = types;
}
//只检测一种用户类型的快捷方式
public SimApiAuthAttribute(string type, string url)
{
Types = new[]
{
type
};
new HttpPostAttribute(url);
}
public override void OnActionExecuting(ActionExecutingContext context)
{
var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"];
//检测是否登录
if (loginInfo == null)
{
throw new SimApiException(401);
}
//检测用户类型
if (!Types.Intersect(loginInfo.Type).Any())
{
throw new SimApiException(403);
}
} }
} }
} }
+15 -16
View File
@@ -1,25 +1,24 @@
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>
/// 快捷自定义接口文档类 /// 定义接口说明
/// </summary> /// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)] /// <param name="tag">接口分组</param>
public class SimApiDocAttribute : SwaggerOperationAttribute /// <param name="name">接口名称</param>
public SimApiDocAttribute(string tag, string name)
{ {
/// <summary> Tags = new[] { tag };
/// 定义接口说明 Summary = name;
/// </summary> // Consumes = new[] {"application/json"};
/// <param name="tag">接口分组</param> // Produces = new[] {"application/json"};
/// <param name="name">接口名称</param>
public SimApiDocAttribute(string tag, string name)
{
Tags = new[] { tag };
Summary = name;
// Consumes = new[] {"application/json"};
// Produces = new[] {"application/json"};
}
} }
} }
+19 -20
View File
@@ -1,23 +1,22 @@
namespace SimApi.Communications namespace SimApi.Communications;
{
/// <summary>
/// 只有ID的请求
/// </summary>
public record SimApiIdOnlyRequest(int Id);
/// <summary> /// <summary>
/// 只有ID的请求(字符串) /// 只有ID的请求
/// </summary> /// </summary>
public record SimApiStringIdOnlyRequest(string Id); public record SimApiIdOnlyRequest(int Id);
/// <summary> /// <summary>
/// 动态类型单字段请求 /// 只有ID的请求(字符串)
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> public record SimApiStringIdOnlyRequest(string Id);
public record SimApiOneFieldRequest<T>(T Data);
/// <summary> /// <summary>
/// 基础分页请求 /// 动态类型单字段请求
/// </summary> /// </summary>
public record SimApiBasePageRequest(int Page, int Count); /// <typeparam name="T"></typeparam>
} public record SimApiOneFieldRequest<T>(T Data);
/// <summary>
/// 基础分页请求
/// </summary>
public record SimApiBasePageRequest(int Page, int Count);
+51 -62
View File
@@ -2,75 +2,64 @@
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 record SimApiBaseResponse(int Code = 200, string Message = "成功")
{ {
/// <summary> /// <summary>
/// 基础相应 /// 默认错误代码对应提示信息
/// </summary> /// </summary>
public record SimApiBaseResponse(int Code = 200, string Message = "成功") private static readonly Dictionary<int, string> MsgBox = new()
{ {
/// <summary> { 200, "成功" },
/// 默认错误代码对应提示信息 { 204, "没有数据" },
/// </summary> { 400, "参数错误" },
private static readonly Dictionary<int, string> MsgBox = new() { 401, "需要登录" },
{ { 403, "无权访问" },
{ { 404, "接口不存在" },
200, "成功" { 500, "服务器错误" }
}, };
{
204, "没有数据"
},
{
400, "参数错误"
},
{
401, "需要登录"
},
{
403, "无权访问"
},
{
404, "接口不存在"
},
{
500, "服务器错误"
}
};
public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误") public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误")
{ {
}
/// <summary>
/// 序列化为JSON字符串
/// </summary>
/// <returns></returns>
public override string ToString()
{
return JsonSerializer.Serialize(this, new JsonSerializerOptions
{
IgnoreReadOnlyProperties = true,
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
Converters =
{
new JsonStringEnumConverter()
}
});
}
} }
/// <summary> /// <summary>
/// 动态内容分页 /// 序列化为JSON字符串
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <returns></returns>
public record SimApiBasePageResponse<T> public override string ToString()
(T List, int Page = 1, int Count = 1, int Total = 1, int Code = 200, {
string Message = "成功") : SimApiBaseResponse(Code, Message); return JsonSerializer.Serialize(this, new JsonSerializerOptions
{
/// <summary> IgnoreReadOnlyProperties = true,
/// 动态Data返回 PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
/// </summary> Converters =
/// <typeparam name="T"></typeparam> {
public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code, new JsonStringEnumConverter()
Message); }
});
}
} }
/// <summary>
/// 动态内容分页
/// </summary>
/// <typeparam name="T"></typeparam>
public record SimApiBasePageResponse<T>(
T List,
int Page = 1,
int Count = 1,
int Total = 1,
int Code = 200,
string Message = "成功") : SimApiBaseResponse(Code, Message);
/// <summary>
/// 动态Data返回
/// </summary>
/// <typeparam name="T"></typeparam>
public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code,
Message);
+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);
}
+63 -61
View File
@@ -1,73 +1,75 @@
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 string Id { get; set; }
/// <summary>
/// 文档名称
/// </summary>
public string Name { get; set; }
/// <summary>
/// 文档描述
/// </summary>
public string Description { get; set; }
}
/// <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 AuthorizationUrl { get; set; }
public string TokenUrl { get; set; }
public Dictionary<string, string> Scopes { get; set; }
}
/// <summary>
/// 文档配置
/// </summary>
public class SimApiDocOptions
{ {
/// <summary> /// <summary>
/// 文档组配置 /// 文档组配置
/// </summary> /// </summary>
public class SimApiDocGroupOption public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
{ {
/// <summary> new SimApiDocGroupOption
/// 文档标识
/// </summary>
public string Id { get; set; }
/// <summary>
/// 文档名称
/// </summary>
public string Name { get; set; }
/// <summary>
/// 文档描述
/// </summary>
public string Description { get; set; }
}
/// <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 AuthorizationUrl { get; set; }
public string TokenUrl { get; set; }
public Dictionary<string, string> Scopes { get; set; }
}
/// <summary>
/// 文档配置
/// </summary>
public class SimApiDocOptions
{
/// <summary>
/// 文档组配置
/// </summary>
public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
{ {
new SimApiDocGroupOption Id = "api",
{ Name = "Api",
Id = "api", Description = "Api接口文档"
Name = "Api", }
Description = "Api接口文档" };
}
};
/// <summary> /// <summary>
/// 授权配置 /// 授权配置
/// </summary> /// </summary>
public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption(); public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
/// <summary> /// <summary>
/// 文档页面标题 /// 文档页面标题
/// </summary> /// </summary>
public string DocumentTitle { get; set; } = "API接口文档"; public string DocumentTitle { get; set; } = "API接口文档";
/// <summary> /// <summary>
/// 接口支持的调用方式 /// 接口支持的调用方式
/// </summary> /// </summary>
public SubmitMethod[] SupportedMethod { get; set; } = new[] {SubmitMethod.Post}; public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
}
} }
+83 -84
View File
@@ -1,93 +1,92 @@
using System; using System;
namespace SimApi.Configs namespace SimApi.Configs;
public class SimApiOptions
{ {
public class SimApiOptions /// <summary>
/// 启用全部Cors,对于开发前后分离的时候很有用。
/// default: true
/// </summary>
public bool EnableCors { get; set; } = true;
/// <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)
{ {
/// <summary> options?.Invoke(SimApiSynapseOptions);
/// 启用全部Cors,对于开发前后分离的时候很有用。 }
/// default: true
/// </summary>
public bool EnableCors { get; set; } = true;
/// <summary> public void ConfigureSimApiSynapse(SimApiSynapseOptions options)
/// 启用SimapiAuth,一个简单的基于Header Token的认证方式。 {
/// default: false SimApiSynapseOptions = options;
/// </summary> }
public bool EnableSimApiAuth { get; set; } = false;
/// <summary> public void ConfigureSimApiDoc(Action<SimApiDocOptions> options = null)
/// 启用在线文档,启用后 访问 /swagger 可以查看对应的api文档。 {
/// default: false options?.Invoke(SimApiDocOptions);
/// </summary> }
public bool EnableSimApiDoc { get; set; } = false;
/// <summary> public void ConfigureSimApiStorage(Action<SimApiStorageOptions> options = null)
/// 启用异常拦截,启用后,所有的异常将被通过json反馈。 {
/// default: true options?.Invoke(SimApiStorageOptions);
/// </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)
{
options?.Invoke(SimApiDocOptions);
}
public void ConfigureSimApiStorage(Action<SimApiStorageOptions> options = null)
{
options?.Invoke(SimApiStorageOptions);
}
} }
} }
+17 -18
View File
@@ -1,24 +1,23 @@
namespace SimApi.Configs namespace SimApi.Configs;
public class SimApiStorageOptions
{ {
public class SimApiStorageOptions /// <summary>
{ /// S3 服务器入口地址
/// <summary> /// </summary>
/// S3 服务器入口地址 public string Endpoint { get; set; }
/// </summary>
public string Endpoint { get; set; }
/// <summary> /// <summary>
/// S3 服务器文件访问地址 /// S3 服务器文件访问地址
/// </summary> /// </summary>
public string ServeUrl { get; set; } public string ServeUrl { get; set; }
/// <summary> /// <summary>
/// S3服务 Bucket /// S3服务 Bucket
/// </summary> /// </summary>
public string Bucket { get; set; } public string Bucket { get; set; }
public string AccessKey { get; set; } public string AccessKey { get; set; }
public string SecretKey { get; set; } public string SecretKey { get; set; }
}
} }
+61 -63
View File
@@ -4,84 +4,82 @@ 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> /// <summary>
/// 基础控制器,所有控制器均继承本控制器 /// 当前登录用户的ID
/// 1. 自动验证请求参数
/// 2. 报错返回
/// 3. 错误回馈页面
/// </summary> /// </summary>
public class SimApiBaseController : Controller protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
/// <summary>
/// 验证请求参数
/// </summary>
/// <param name="context"></param>
public override void OnActionExecuting(ActionExecutingContext context)
{ {
/// <summary> if (!context.ModelState.IsValid)
/// 当前登录用户的ID
/// </summary>
protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"];
/// <summary>
/// 验证请求参数
/// </summary>
/// <param name="context"></param>
public override void OnActionExecuting(ActionExecutingContext context)
{ {
if (!context.ModelState.IsValid) foreach (var item in context.ModelState.Values.Where(item =>
item.ValidationState == ModelValidationState.Invalid))
{ {
foreach (var item in context.ModelState.Values.Where(item => Error(400, item.Errors.First().ErrorMessage);
item.ValidationState == ModelValidationState.Invalid)) break;
{
Error(400, item.Errors.First().ErrorMessage);
break;
}
} }
} }
}
/// <summary> /// <summary>
/// 错误返回 /// 错误返回
/// </summary> /// </summary>
/// <param name="code">错误代码</param> /// <param name="code">错误代码</param>
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param> /// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
/// <returns></returns> /// <returns></returns>
protected static void Error(int code = 500, string message = "") protected static void Error(int code = 500, string message = "")
{ {
throw new SimApiException(code, message); throw new SimApiException(code, message);
} }
/// <summary> /// <summary>
/// 检测条件,根据条件返回报错 /// 检测条件,根据条件返回报错
/// </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 = 500, string message = "")
{
if (condition)
{ {
if (condition) Error(code, message);
{
Error(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);
} }
/// <summary> /// <summary>
/// 上传文件 /// 上传文件
/// </summary> /// </summary>
/// <returns></returns> /// <returns></returns>
protected SimApiBaseResponse<string> UploadFile() protected SimApiBaseResponse<string> UploadFile()
{ {
return new SimApiBaseResponse<string>(null); return new SimApiBaseResponse<string>(null);
}
} }
} }
+39 -48
View File
@@ -1,60 +1,51 @@
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")] /// <summary>
public class YYCommonController : SimApiBaseController /// 错误回馈页面
/// </summary>
/// <param name="code">错误代码</param>
/// <returns></returns>
[HttpGet("exception/{code:int}")]
[ApiExplorerSettings(IgnoreApi = true)]
public SimApiBaseResponse ExceptionHandler(int code)
{ {
private SimApiAuth Auth { get; } return new SimApiBaseResponse(code);
}
public YYCommonController(SimApiAuth auth) /// <summary>
/// 检测用户登陆的控制器
/// </summary>
/// <returns></returns>
[HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
public SimApiBaseResponse<string> CheckLogin()
{
ErrorWhenNull(LoginInfo, 401);
return new SimApiBaseResponse<string>(LoginInfo.Id);
}
/// <summary>
/// 退出登陆
/// </summary>
/// <returns></returns>
[HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
public SimApiBaseResponse Logout()
{
string token = null;
if (Request.Headers.ContainsKey("Token"))
{ {
Auth = auth; token = Request.Headers["Token"];
} }
/// <summary> auth.Logout(token);
/// 错误回馈页面 return new SimApiBaseResponse();
/// </summary>
/// <param name="code">错误代码</param>
/// <returns></returns>
[HttpGet("exception/{code:int}")]
[ApiExplorerSettings(IgnoreApi = true)]
public SimApiBaseResponse ExceptionHandler(int code)
{
return new SimApiBaseResponse(code);
}
/// <summary>
/// 检测用户登陆的控制器
/// </summary>
/// <returns></returns>
[HttpPost("/auth/check"), SimApiDoc("认证", "检测登陆")]
public SimApiBaseResponse<string> CheckLogin()
{
ErrorWhenNull(LoginInfo, 401);
return new SimApiBaseResponse<string>(LoginInfo.Id);
}
/// <summary>
/// 退出登陆
/// </summary>
/// <returns></returns>
[HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
public SimApiBaseResponse Logout()
{
string token = null;
if (Request.Headers.ContainsKey("Token"))
{
token = Request.Headers["Token"];
}
Auth.Logout(token);
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;
} }
+33 -45
View File
@@ -1,60 +1,48 @@
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>
/// 认证助手 /// 产生一个Token记录并返回Token
/// </summary> /// </summary>
public class SimApiAuth /// <param name="id"></param>
/// <returns></returns>
public string Login(string id, string type = "user", string token = null)
{ {
private IDistributedCache Cache { get; } return Login(id, new[] { type }, token);
}
public SimApiAuth(IDistributedCache cache) /// <summary>
{ /// 产生一个Token并记录用户ID角色[多角色]
Cache = cache; /// </summary>
} /// <param name="id"></param>
/// <param name="type"></param>
/// <returns></returns>
public string Login(string id, string[] type, string uuid = null)
{
uuid ??= Guid.NewGuid().ToString();
var loginItem = new SimApiLoginItem(id, type);
cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
return uuid;
}
/// <summary> /// <summary>
/// 产生一个Token记录并返回Token /// 退出登陆
/// </summary> /// </summary>
/// <param name="id"></param> /// <param name="uuid">登陆标识</param>
/// <returns></returns> public void Logout(string uuid)
public string Login(string id, string type = "user", string token = null) {
if (!string.IsNullOrEmpty(uuid))
{ {
return Login(id, new[] cache.Remove(uuid);
{
type
}, token);
}
/// <summary>
/// 产生一个Token并记录用户ID角色[多角色]
/// </summary>
/// <param name="id"></param>
/// <param name="type"></param>
/// <returns></returns>
public string Login(string id, string[] type, string uuid = null)
{
uuid ??= Guid.NewGuid().ToString();
var loginItem = new SimApiLoginItem(id, type);
Cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
return uuid;
}
/// <summary>
/// 退出登陆
/// </summary>
/// <param name="uuid">登陆标识</param>
public void Logout(string uuid)
{
if (!string.IsNullOrEmpty(uuid))
{
Cache.Remove(uuid);
}
} }
} }
} }
+83 -85
View File
@@ -2,102 +2,100 @@
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; }
public MinioClient Client => Mc;
private string ServeUrl { get; }
public string Bucket { get; }
private IHttpContextAccessor HttpContextAccessor { get; }
public SimApiStorage(SimApiOptions apiOptions, IHttpContextAccessor httpContextAccessor)
{ {
private MinioClient Mc { get; } var options = apiOptions.SimApiStorageOptions;
HttpContextAccessor = httpContextAccessor;
public MinioClient Client => Mc; var useSsl = false;
string endpoint;
private string ServeUrl { get; } if (options.Endpoint.StartsWith("http://"))
public string Bucket { get; }
private IHttpContextAccessor HttpContextAccessor { get; }
public SimApiStorage(SimApiOptions apiOptions, IHttpContextAccessor httpContextAccessor)
{ {
var options = apiOptions.SimApiStorageOptions; endpoint = options.Endpoint.Replace("http://", string.Empty);
HttpContextAccessor = httpContextAccessor; }
var useSsl = false; else if (options.Endpoint.StartsWith("https://"))
string endpoint; {
if (options.Endpoint.StartsWith("http://")) endpoint = options.Endpoint.Replace("https://", string.Empty);
{ useSsl = true;
endpoint = options.Endpoint.Replace("http://", string.Empty); }
} else
else if (options.Endpoint.StartsWith("https://")) {
{ throw new Exception("SimApiStorage: Error Endpoint");
endpoint = options.Endpoint.Replace("https://", string.Empty);
useSsl = true;
}
else
{
throw new Exception("SimApiStorage: Error Endpoint");
}
ServeUrl = options.ServeUrl;
Bucket = options.Bucket;
var mcb = new MinioClient().WithEndpoint(endpoint)
.WithCredentials(options.AccessKey, options.SecretKey);
if (useSsl)
{
mcb = mcb.WithSSL();
}
Mc = mcb.Build();
var found = Mc.BucketExistsAsync(new BucketExistsArgs().WithBucket(Bucket)).Result;
if (!found)
{
Mc.MakeBucketAsync(new MakeBucketArgs().WithBucket(Bucket)).Wait();
}
} }
/// <summary> ServeUrl = options.ServeUrl;
/// 获取上传的URL Bucket = options.Bucket;
/// </summary> var mcb = new MinioClient().WithEndpoint(endpoint)
/// <param name="path"></param> .WithCredentials(options.AccessKey, options.SecretKey);
/// <param name="expire"></param> if (useSsl)
/// <returns></returns>
public string GetUploadUrl(string path, int expire = 7200)
{ {
return Mc.PresignedPutObjectAsync(new PresignedPutObjectArgs().WithBucket(Bucket) mcb = mcb.WithSSL();
.WithObject(path).WithExpiry(expire)).Result;
} }
Mc = mcb.Build();
/// <summary> var found = Mc.BucketExistsAsync(new BucketExistsArgs().WithBucket(Bucket)).Result;
/// 获取下载的URL if (!found)
/// </summary>
/// <param name="path"></param>
/// <param name="expire"></param>
/// <returns></returns>
public string GetDownloadUrl(string path, int expire = 600)
{ {
return Mc.PresignedGetObjectAsync(new PresignedGetObjectArgs().WithBucket(Bucket).WithObject(path) Mc.MakeBucketAsync(new MakeBucketArgs().WithBucket(Bucket)).Wait();
.WithExpiry(expire)).Result;
}
public string UploadFile(string path, Stream stream, string contentType = "image/png")
{
Mc.PutObjectAsync(new PutObjectArgs().WithBucket(Bucket).WithObject(path).WithObjectSize(stream.Length)
.WithStreamData(stream).WithContentType(contentType)).Wait();
return null;
}
public string FullUrl(string path)
{
var httpRequest = HttpContextAccessor.HttpContext?.Request;
var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
if (string.IsNullOrEmpty(path))
{
return path;
}
return path.StartsWith("~") ? url + path.Substring(1, path.Length - 1) : $"{ServeUrl}{path}";
} }
} }
/// <summary>
/// 获取上传的URL
/// </summary>
/// <param name="path"></param>
/// <param name="expire"></param>
/// <returns></returns>
public string GetUploadUrl(string path, int expire = 7200)
{
return Mc.PresignedPutObjectAsync(new PresignedPutObjectArgs().WithBucket(Bucket)
.WithObject(path).WithExpiry(expire)).Result;
}
/// <summary>
/// 获取下载的URL
/// </summary>
/// <param name="path"></param>
/// <param name="expire"></param>
/// <returns></returns>
public string GetDownloadUrl(string path, int expire = 600)
{
return Mc.PresignedGetObjectAsync(new PresignedGetObjectArgs().WithBucket(Bucket).WithObject(path)
.WithExpiry(expire)).Result;
}
public string UploadFile(string path, Stream stream, string contentType = "image/png")
{
Mc.PutObjectAsync(new PutObjectArgs().WithBucket(Bucket).WithObject(path).WithObjectSize(stream.Length)
.WithStreamData(stream).WithContentType(contentType)).Wait();
return null;
}
public string FullUrl(string path)
{
var httpRequest = HttpContextAccessor.HttpContext?.Request;
var url = $"{httpRequest?.Scheme}://{httpRequest?.Host}";
if (string.IsNullOrEmpty(path))
{
return path;
}
return path.StartsWith('~') ? string.Concat(url, path.AsSpan(1, path.Length - 1)) : $"{ServeUrl}{path}";
}
} }
+56 -57
View File
@@ -7,69 +7,68 @@ 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>
/// 当前CST时间
/// </summary>
public static DateTime CstNow => DateTime.UtcNow.AddHours(8);
/// <summary>
/// JSON序列化常规选项
/// </summary>
public static JsonSerializerOptions JsonOption => new()
{ {
/// <summary> Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
/// 当前CST时间 PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
/// </summary> DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
public static DateTime CstNow => DateTime.UtcNow.AddHours(8); };
/// <summary> /// <summary>
/// JSON序列化常规选项 /// 当前秒级时间戳
/// </summary> /// </summary>
public static JsonSerializerOptions JsonOption => new() public static double TimestampNow => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
/// <summary>
/// 检测手机号是否正确
/// </summary>
/// <param name="cell">手机号码</param>
/// <returns></returns>
public static bool CheckCell(string cell)
{
var regex = new Regex("^1[3456789]\\d{9}$");
return regex.IsMatch(cell);
}
/// <summary>
/// MD5加密字符串
/// </summary>
/// <param name="source">源字符串</param>
/// <param name="mode">加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位</param>
/// <returns></returns>
public static string Md5(string source, string mode = "x2")
{
var sor = Encoding.UTF8.GetBytes(source);
var md5 = MD5.Create();
var result = md5.ComputeHash(sor);
var strbul = new StringBuilder(40);
foreach (var t in result)
{ {
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All), strbul.Append(t.ToString(mode));
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>
/// <param name="cell">手机号码</param>
/// <returns></returns>
public static bool CheckCell(string cell)
{
var regex = new Regex("^1[3456789]\\d{9}$");
return regex.IsMatch(cell);
} }
/// <summary> return strbul.ToString();
/// MD5加密字符串 }
/// </summary>
/// <param name="source">源字符串</param>
/// <param name="mode">加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位</param>
/// <returns></returns>
public static string Md5(string source, string mode = "x2")
{
var sor = Encoding.UTF8.GetBytes(source);
var md5 = MD5.Create();
var result = md5.ComputeHash(sor);
var strbul = new StringBuilder(40);
foreach (var t in result)
{
strbul.Append(t.ToString(mode));
}
return strbul.ToString(); /// <summary>
} /// 将对象序列化成JSON (控制台输出中文不会被编码)
/// </summary>
/// <summary> /// <param name="obj"></param>
/// 将对象序列化成JSON (控制台输出中文不会被编码) /// <returns></returns>
/// </summary> public static string Json(object obj)
/// <param name="obj"></param> {
/// <returns></returns> return JsonSerializer.Serialize(obj, JsonOption);
public static string Json(object obj)
{
return JsonSerializer.Serialize(obj, JsonOption);
}
} }
} }
+22 -30
View File
@@ -2,40 +2,32 @@ 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 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)
{ {
private string Name { get; } Console.ForegroundColor = logLevel switch
public SimApiLogger(string name)
{ {
Name = name; LogLevel.Debug => ConsoleColor.DarkMagenta,
} LogLevel.Information => ConsoleColor.DarkCyan,
LogLevel.Warning => ConsoleColor.Yellow,
public IDisposable BeginScope<TState>(TState state) => default!; LogLevel.Error => ConsoleColor.Red,
LogLevel.Critical => ConsoleColor.DarkRed,
public bool IsEnabled(LogLevel logLevel) => true; _ => ConsoleColor.White
};
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, var message =
Func<TState, Exception, string> formatter) $"[ {name} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
if (exception != null)
{ {
Console.ForegroundColor = logLevel switch message += $"{exception}\n";
{
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} ][ {SimApiUtil.CstNow.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
if (exception != null)
{
message += $"{exception}\n";
}
Console.WriteLine(message);
} }
Console.WriteLine(message);
} }
} }
+12 -14
View File
@@ -1,22 +1,20 @@
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();
public ILogger CreateLogger(string categoryName)
{ {
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers = return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
new ConcurrentDictionary<string, SimApiLogger>(); }
public void Dispose()
public ILogger CreateLogger(string categoryName) {
{ _loggers.Clear();
return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
}
public void Dispose()
{
_loggers.Clear();
}
} }
} }
+16 -24
View File
@@ -4,38 +4,30 @@ using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Distributed; using Microsoft.Extensions.Caching.Distributed;
using SimApi.Communications; using SimApi.Communications;
namespace SimApi.Middlewares namespace SimApi.Middlewares;
/// <summary>
/// 认证信息获取中间件
/// </summary>
public class SimApiAuthMiddleware(RequestDelegate next)
{ {
/// <summary> public Task Invoke(HttpContext httpContext, IDistributedCache cache)
/// 认证信息获取中间件
/// </summary>
public class SimApiAuthMiddleware
{ {
private RequestDelegate Next { get; } string token = null;
if (httpContext.Request.Headers.TryGetValue("Token", out var header))
public SimApiAuthMiddleware(RequestDelegate next)
{ {
Next = next; token = header;
} }
public Task Invoke(HttpContext httpContext, IDistributedCache cache) if (!string.IsNullOrEmpty(token))
{ {
string token = null; var login = cache.GetString(token);
if (httpContext.Request.Headers.ContainsKey("Token")) if (login != null)
{ {
token = httpContext.Request.Headers["Token"]; httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<SimApiLoginItem>(login));
} }
if (!string.IsNullOrEmpty(token))
{
var login = cache.GetString(token);
if (login != null)
{
httpContext.Items.Add("LoginInfo", JsonSerializer.Deserialize<SimApiLoginItem>(login));
}
}
return Next(httpContext);
} }
return next(httpContext);
} }
} }
+43 -57
View File
@@ -6,75 +6,61 @@ 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> public async Task InvokeAsync(HttpContext context)
/// 异常处理中间件
/// </summary>
public class SimApiExceptionMiddleware
{ {
private RequestDelegate Next { get; } if (context.Request.Headers.TryGetValue("Query-Id", out var header))
private ILogger<SimApiExceptionMiddleware> Log { get; }
public SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
{ {
Log = log; context.Response.Headers["Query-Id"] = header;
Next = next;
} }
public async Task InvokeAsync(HttpContext context) SimApiBaseResponse response;
try
{ {
if (context.Request.Headers.ContainsKey("Query-Id")) await next(context);
if (context.Response.StatusCode != 200)
{ {
context.Response.Headers["Query-Id"] = context.Request.Headers["Query-Id"]; if (!new[] { 301, 302 }.Contains(context.Response.StatusCode))
}
var response = new SimApiBaseResponse();
try
{
await Next(context);
if (context.Response.StatusCode != 200)
{ {
if (!new[] throw new SimApiException(context.Response.StatusCode);
{
301, 302
}.Contains(context.Response.StatusCode))
{
throw new SimApiException(context.Response.StatusCode);
}
} }
} }
catch (SimApiException ex)
{
response = string.IsNullOrEmpty(ex.Message)
? new SimApiBaseResponse(ex.Code)
: new SimApiBaseResponse(ex.Code, ex.Message);
ErrorResponse(context, response);
}
catch (Exception ex)
{
Log.LogError(ex.Message);
Log.LogError(ex.StackTrace);
response = new SimApiBaseResponse(500, ex.Message);
ErrorResponse(context, response);
}
} }
catch (SimApiException ex)
/// <summary>
/// 异常抛出错误
/// </summary>
/// <param name="context"></param>
/// <param name="response"></param>
private void ErrorResponse(HttpContext context, SimApiBaseResponse response)
{ {
if (!context.Response.HasStarted) response = string.IsNullOrEmpty(ex.Message)
{ ? new SimApiBaseResponse(ex.Code)
context.Response.StatusCode = 200; : new SimApiBaseResponse(ex.Code, ex.Message);
context.Response.Headers.Add("Content-Type", "application/json");
context.Response.WriteAsync(response.ToString()); ErrorResponse(context, response);
} }
catch (Exception ex)
{
log.LogError(ex.Message);
log.LogError(ex.StackTrace);
response = new SimApiBaseResponse(500, ex.Message);
ErrorResponse(context, response);
}
}
/// <summary>
/// 异常抛出错误
/// </summary>
/// <param name="context"></param>
/// <param name="response"></param>
private void ErrorResponse(HttpContext context, SimApiBaseResponse response)
{
if (!context.Response.HasStarted)
{
context.Response.StatusCode = 200;
context.Response.Headers.Append("Content-Type", "application/json");
context.Response.WriteAsync(response.ToString());
} }
} }
} }
+75 -77
View File
@@ -1,91 +1,89 @@
using System; using System;
using System.ComponentModel.DataAnnotations.Schema; 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();
[Column(Order = 9998)]
public DateTime UpdatedAt { get; set; } = SimApiUtil.CstNow;
[Column(Order = 9999)]
public DateTime CreatedAt { get; set; } = SimApiUtil.CstNow;
protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" };
protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt";
public void MapData<TS>(TS source, bool mapAll = false)
{ {
[Column(Order = 1)] //获取要赋值的源数据不为null的项目
public string Id { get; set; } = Guid.NewGuid().ToString(); var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
.Select(x => new
[Column(Order = 9998)]
public DateTime UpdatedAt { get; set; } = SimApiUtil.CstNow;
[Column(Order = 9999)]
public DateTime CreatedAt { get; set; } = SimApiUtil.CstNow;
protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" };
protected virtual string UpdatedTimeField { get; set; } = "UpdatedAt";
public void MapData<TS>(TS source, bool mapAll = false)
{
//获取要赋值的源数据不为null的项目
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
.Select(x => new
{
x.Name,
x.PropertyType
})
.ToDictionary(x => x.Name, x => x.PropertyType);
//获取目标对象的属性信息
var targetProps = GetType().GetProperties().Select(x => new
{
x.Name,
x.PropertyType
})
.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)? x.Name,
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source)); x.PropertyType
} })
.ToDictionary(x => x.Name, x => x.PropertyType);
UpdateTime(); //获取目标对象的属性信息
} var targetProps = GetType().GetProperties().Select(x => new
public void MapData<TS>(TS source, string[] mapFields)
{
//获取要赋值的源数据不为null的项目
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
.Select(x => new
{
x.Name,
x.PropertyType
})
.ToDictionary(x => x.Name, x => x.PropertyType);
//获取目标对象的属性信息
var targetProps = GetType().GetProperties().Select(x => new
{
x.Name,
x.PropertyType
})
.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)? x.Name,
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source)); x.PropertyType
} })
.ToDictionary(x => x.Name, x => x.PropertyType);
UpdateTime(); foreach (var sp in sourceProps.Where(sp =>
} targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
(!MapperIgnoreField.Contains(sp.Key) || mapAll)))
/// <summary>
/// 更新update时间
/// </summary>
/// <returns></returns>
public void UpdateTime()
{ {
GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow); GetType().GetProperty(sp.Key)?
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
} }
UpdateTime();
}
public void MapData<TS>(TS source, string[] mapFields)
{
//获取要赋值的源数据不为null的项目
var sourceProps = source.GetType().GetProperties().Where(x => x.GetValue(source) != null)
.Select(x => new
{
x.Name,
x.PropertyType
})
.ToDictionary(x => x.Name, x => x.PropertyType);
//获取目标对象的属性信息
var targetProps = GetType().GetProperties().Select(x => new
{
x.Name,
x.PropertyType
})
.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)?
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
}
UpdateTime();
}
/// <summary>
/// 更新update时间
/// </summary>
/// <returns></returns>
public void UpdateTime()
{
GetType().GetProperty(UpdatedTimeField)?.SetValue(this, SimApiUtil.CstNow);
} }
} }
+38 -38
View File
@@ -1,42 +1,42 @@
<Project Sdk="Microsoft.NET.Sdk.Web"> <Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup> <PropertyGroup>
<OutputType>Library</OutputType> <OutputType>Library</OutputType>
<PackOnBuild>true</PackOnBuild> <PackOnBuild>true</PackOnBuild>
<Version>0.2.3</Version> <Version>0.2.3</Version>
<Authors>xRain@SimcuTeam</Authors> <Authors>xRain@SimcuTeam</Authors>
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description> <Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
<PackageId>Simcu.SimApi</PackageId> <PackageId>Simcu.SimApi</PackageId>
<IsPackable>true</IsPackable> <IsPackable>true</IsPackable>
<SymbolPackageFormat>snupkg</SymbolPackageFormat> <SymbolPackageFormat>snupkg</SymbolPackageFormat>
<IncludeSymbols>true</IncludeSymbols> <IncludeSymbols>true</IncludeSymbols>
<ReleaseVersion>5.0.0</ReleaseVersion> <ReleaseVersion>5.0.0</ReleaseVersion>
<SynchReleaseVersion>false</SynchReleaseVersion> <SynchReleaseVersion>false</SynchReleaseVersion>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageVersion>5.0.2</PackageVersion> <PackageVersion>5.0.2</PackageVersion>
<TargetFrameworks>net7.0;net8.0</TargetFrameworks> <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>
</ProjectExtensions> </ProjectExtensions>
</Project> </Project>
+228 -229
View File
@@ -9,257 +9,256 @@ 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> //**********快捷添加**************
/// 加入系统的扩展信息 public static IServiceCollection AddSimApi(this IServiceCollection builder,
/// </summary> Action<SimApiOptions> options = null)
public static class SimApiExtensions
{ {
//**********快捷添加************** var simApiOptions = new SimApiOptions();
public static IServiceCollection AddSimApi(this IServiceCollection builder, options?.Invoke(simApiOptions);
Action<SimApiOptions> options = null) if (simApiOptions.EnableLogger)
{ {
var simApiOptions = new SimApiOptions(); builder.AddLogging(logger =>
options?.Invoke(simApiOptions);
if (simApiOptions.EnableLogger)
{ {
builder.AddLogging(logger => logger.ClearProviders();
logger.AddProvider(new SimApiLoggerProvider());
});
}
// 是否使用 AUTH
if (simApiOptions.EnableSimApiAuth)
{
builder.AddScoped<SimApiAuth>();
}
if (simApiOptions.EnableCors)
{
builder.AddCors(cors => cors.AddPolicy("any",
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); }));
}
if (simApiOptions.EnableSynapse)
{
builder.AddSingleton<Synapse>();
}
// 使用SimApiDoc
if (simApiOptions.EnableSimApiDoc)
{
var docOptions = simApiOptions.SimApiDocOptions;
builder.AddSwaggerGen(x =>
{
foreach (var group in docOptions.ApiGroups)
{ {
logger.ClearProviders(); x.SwaggerDoc(group.Id, new OpenApiInfo
logger.AddProvider(new SimApiLoggerProvider()); {
}); Title = group.Name,
} Description = group.Description
// 是否使用 AUTH });
if (simApiOptions.EnableSimApiAuth) }
{
builder.AddScoped<SimApiAuth>();
}
if (simApiOptions.EnableCors) x.EnableAnnotations();
{ var haveOauth = false;
builder.AddCors(cors => cors.AddPolicy("any", var haveSimApiAuth = false;
policy => { policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin(); })); var oauthFlows = new OpenApiOAuthFlows();
} foreach (var auth in docOptions.ApiAuth.Type)
if (simApiOptions.EnableSynapse)
{
builder.AddSingleton<Synapse>();
}
// 使用SimApiDoc
if (simApiOptions.EnableSimApiDoc)
{
var docOptions = simApiOptions.SimApiDocOptions;
builder.AddSwaggerGen(x =>
{ {
foreach (var group in docOptions.ApiGroups) switch (auth)
{ {
x.SwaggerDoc(group.Id, new OpenApiInfo case "SimApiAuth":
{ x.AddSecurityRequirement(new OpenApiSecurityRequirement
Title = group.Name,
Description = group.Description
});
}
x.EnableAnnotations();
var haveOauth = false;
var haveSimApiAuth = false;
var oauthFlows = new OpenApiOAuthFlows();
foreach (var auth in docOptions.ApiAuth.Type)
{
switch (auth)
{
case "SimApiAuth":
x.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme
{
Reference = new OpenApiReference
{
Type = ReferenceType.SecurityScheme,
Id = "HeaderToken"
}
},
new[] { "readAccess", "writeAccess" }
}
});
haveSimApiAuth = true;
break;
case "ClientCredentials":
oauthFlows.ClientCredentials = new OpenApiOAuthFlow
{
TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
case "Implicit":
oauthFlows.Implicit = new OpenApiOAuthFlow
{
AuthorizationUrl = new Uri(docOptions.ApiAuth.AuthorizationUrl,
UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
case "AuthorizationCode":
oauthFlows.AuthorizationCode = new OpenApiOAuthFlow
{
TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
AuthorizationUrl = new Uri(docOptions.ApiAuth.AuthorizationUrl,
UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
case "Password":
oauthFlows.Password = new OpenApiOAuthFlow
{
TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
}
}
if (haveOauth)
{
x.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
{
Type = SecuritySchemeType.OAuth2,
Flows = oauthFlows,
Description = docOptions.ApiAuth.Description,
In = ParameterLocation.Header
});
x.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{ {
new OpenApiSecurityScheme
{ {
Reference = new OpenApiReference new OpenApiSecurityScheme
{ {
Type = ReferenceType.SecurityScheme, Reference = new OpenApiReference
Id = "oauth2" {
} Type = ReferenceType.SecurityScheme,
}, Id = "HeaderToken"
new[] { "SimApiAuth" } }
} },
}); new[] { "readAccess", "writeAccess" }
}
});
haveSimApiAuth = true;
break;
case "ClientCredentials":
oauthFlows.ClientCredentials = new OpenApiOAuthFlow
{
TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
case "Implicit":
oauthFlows.Implicit = new OpenApiOAuthFlow
{
AuthorizationUrl = new Uri(docOptions.ApiAuth.AuthorizationUrl,
UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
case "AuthorizationCode":
oauthFlows.AuthorizationCode = new OpenApiOAuthFlow
{
TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
AuthorizationUrl = new Uri(docOptions.ApiAuth.AuthorizationUrl,
UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
case "Password":
oauthFlows.Password = new OpenApiOAuthFlow
{
TokenUrl = new Uri(docOptions.ApiAuth.TokenUrl, UriKind.RelativeOrAbsolute),
Scopes = docOptions.ApiAuth.Scopes
};
haveOauth = true;
break;
} }
}
if (haveSimApiAuth) if (haveOauth)
{
x.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
{ {
x.AddSecurityDefinition("HeaderToken", Type = SecuritySchemeType.OAuth2,
Flows = oauthFlows,
Description = docOptions.ApiAuth.Description,
In = ParameterLocation.Header
});
x.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme new OpenApiSecurityScheme
{ {
Name = "Token", Reference = new OpenApiReference
In = ParameterLocation.Header {
}); Type = ReferenceType.SecurityScheme,
} Id = "oauth2"
}); }
} },
new[] { "SimApiAuth" }
}
});
}
// 使用Header转发,应对代理后获取真实ip if (haveSimApiAuth)
if (simApiOptions.EnableForwardHeaders)
{
builder.Configure<ForwardedHeadersOptions>(fwOptions =>
{ {
fwOptions.ForwardedHeaders = ForwardedHeaders.All; x.AddSecurityDefinition("HeaderToken",
fwOptions.KnownNetworks.Clear(); new OpenApiSecurityScheme
fwOptions.KnownProxies.Clear(); {
}); Name = "Token",
} In = ParameterLocation.Header
});
if (simApiOptions.EnableLowerUrl) }
{ });
builder.AddRouting(rOptions => rOptions.LowercaseUrls = true);
}
if (simApiOptions.EnableSimApiStorage)
{
builder.AddHttpContextAccessor();
builder.AddSingleton<SimApiStorage>();
}
builder.AddSingleton(simApiOptions);
return builder;
} }
/// <summary> // 使用Header转发,应对代理后获取真实ip
/// 使用所有SimApi自定义中间件 if (simApiOptions.EnableForwardHeaders)
/// </summary>
/// <param name="builder"></param>
/// <returns></returns>
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
{ {
var options = builder.ApplicationServices.GetRequiredService<SimApiOptions>(); builder.Configure<ForwardedHeadersOptions>(fwOptions =>
var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiOptions>>();
if (options.EnableForwardHeaders)
{ {
logger.LogInformation("开始配置ForwardedHeaders..."); fwOptions.ForwardedHeaders = ForwardedHeaders.All;
builder.UseForwardedHeaders(); fwOptions.KnownNetworks.Clear();
} fwOptions.KnownProxies.Clear();
});
if (options.EnableCors)
{
logger.LogInformation("开始配置Cors全部允许...");
builder.UseCors("any");
}
if (options.EnableSimApiAuth)
{
logger.LogInformation("开始配置SimApiAuth...");
builder.UseMiddleware<SimApiAuthMiddleware>();
}
if (options.EnableSimApiDoc)
{
logger.LogInformation("开始配置SimApiDoc...");
var docOptions = options.SimApiDocOptions;
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
{
x.DocumentTitle = docOptions.DocumentTitle;
foreach (var group in docOptions.ApiGroups)
{
x.SwaggerEndpoint($"/swagger/{group.Id}.json", name: group.Name);
}
x.EnableValidator();
x.SupportedSubmitMethods(docOptions.SupportedMethod);
x.DisplayRequestDuration();
});
}
if (options.EnableSimApiException)
{
logger.LogInformation("开始配置SimApiException...");
builder.UseMiddleware<SimApiExceptionMiddleware>();
}
//请求一下检测存储错误
if (options.EnableSimApiStorage)
{
logger.LogInformation("开始配置SimApiStorage...");
builder.ApplicationServices.GetService<SimApiStorage>();
}
if (options.EnableLowerUrl)
{
logger.LogInformation("开始配置使用URL小写...");
}
if (options.EnableSynapse)
{
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
synapse.Init();
}
return builder;
} }
if (simApiOptions.EnableLowerUrl)
{
builder.AddRouting(rOptions => rOptions.LowercaseUrls = true);
}
if (simApiOptions.EnableSimApiStorage)
{
builder.AddHttpContextAccessor();
builder.AddSingleton<SimApiStorage>();
}
builder.AddSingleton(simApiOptions);
return builder;
}
/// <summary>
/// 使用所有SimApi自定义中间件
/// </summary>
/// <param name="builder"></param>
/// <returns></returns>
public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder)
{
var options = builder.ApplicationServices.GetRequiredService<SimApiOptions>();
var logger = builder.ApplicationServices.GetRequiredService<ILogger<SimApiOptions>>();
if (options.EnableForwardHeaders)
{
logger.LogInformation("开始配置ForwardedHeaders...");
builder.UseForwardedHeaders();
}
if (options.EnableCors)
{
logger.LogInformation("开始配置Cors全部允许...");
builder.UseCors("any");
}
if (options.EnableSimApiAuth)
{
logger.LogInformation("开始配置SimApiAuth...");
builder.UseMiddleware<SimApiAuthMiddleware>();
}
if (options.EnableSimApiDoc)
{
logger.LogInformation("开始配置SimApiDoc...");
var docOptions = options.SimApiDocOptions;
builder.UseSwagger(x => x.RouteTemplate = "/swagger/{documentName}.json").UseSwaggerUI(x =>
{
x.DocumentTitle = docOptions.DocumentTitle;
foreach (var group in docOptions.ApiGroups)
{
x.SwaggerEndpoint($"/swagger/{group.Id}.json", name: group.Name);
}
x.EnableValidator();
x.SupportedSubmitMethods(docOptions.SupportedMethod);
x.DisplayRequestDuration();
});
}
if (options.EnableSimApiException)
{
logger.LogInformation("开始配置SimApiException...");
builder.UseMiddleware<SimApiExceptionMiddleware>();
}
//请求一下检测存储错误
if (options.EnableSimApiStorage)
{
logger.LogInformation("开始配置SimApiStorage...");
builder.ApplicationServices.GetService<SimApiStorage>();
}
if (options.EnableLowerUrl)
{
logger.LogInformation("开始配置使用URL小写...");
}
if (options.EnableSynapse)
{
var synapse = builder.ApplicationServices.GetRequiredService<Synapse>();
synapse.Init();
}
return builder;
} }
} }