Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2257ba5b2a | ||
|
|
c40f8d664d | ||
|
|
a1f10b9c09 | ||
|
|
6ef7aca8ae | ||
|
|
4171756c54 | ||
|
|
c68cfa6192 | ||
|
|
8344567ac6 | ||
|
|
99b26d99f6 | ||
|
|
cb291691d5 | ||
|
|
47a48d0103 | ||
|
|
4c50acc309 | ||
|
|
be9092bf3c | ||
|
|
345aaa261e | ||
|
|
f98cc6ff5a | ||
|
|
a3fff03ff6 | ||
|
|
caeb697421 | ||
|
|
ef721b227b | ||
|
|
56b5421290 | ||
|
|
ab0da5415b | ||
|
|
4d0f8e20a6 | ||
|
|
b5e4d57772 | ||
|
|
239cd8bcbb | ||
|
|
62ddd6698e | ||
|
|
b2a6e5f40f | ||
|
|
801f698dcf | ||
|
|
9c939426ba | ||
|
|
e45cc4d28d | ||
|
|
6023cf2eb0 | ||
|
|
63dcd0f13f | ||
|
|
22704590f5 | ||
|
|
98907ba5af | ||
|
|
7b0f0a9245 | ||
|
|
1c4fb06163 | ||
|
|
e79ed47d39 | ||
|
|
6fdb3da059 | ||
|
|
55ea40b757 | ||
|
|
d252c1d302 | ||
|
|
74c6cb6027 | ||
|
|
98ec9ae231 | ||
|
|
18d2dfb86e | ||
|
|
ef3f1bfa88 | ||
|
|
01a2689549 | ||
|
|
916f046789 | ||
|
|
51ac170a22 | ||
|
|
c27011deea | ||
|
|
b545af2365 | ||
|
|
ac9fd706f9 | ||
|
|
8b4d551af8 | ||
|
|
3445531972 | ||
|
|
2268ad0c8c | ||
|
|
0b6c6af51d | ||
|
|
1c8ea86fd3 | ||
|
|
f5e4cc97ba | ||
|
|
8550d663de | ||
|
|
a6f32c6e43 | ||
|
|
c8e11bb06f | ||
|
|
3ec378c4fa | ||
|
|
8f41ba0150 | ||
|
|
9bce77a08e | ||
|
|
8c7f4ac12f | ||
|
|
856c70d4ac | ||
|
|
dfa9fbf909 | ||
|
|
883315bc30 | ||
|
|
4ed517ac90 | ||
|
|
eacbbc3071 | ||
|
|
ee3a3a9d56 | ||
|
|
61672c5770 | ||
|
|
c6b9746603 | ||
|
|
f7e1b9be2a | ||
|
|
d0fe883e74 | ||
|
|
e4773f3154 | ||
|
|
ba7b3ecd60 | ||
|
|
f52c19938f | ||
|
|
83ab8ba385 | ||
|
|
7d70e8326a | ||
|
|
2abe486151 | ||
|
|
f1138a5a10 | ||
|
|
31df4a7593 | ||
|
|
dbc05c13ee | ||
|
|
e90cc2d86e | ||
|
|
3cbd8b7559 | ||
|
|
d54b71badb | ||
|
|
ddeb2948b7 | ||
|
|
fb1ce7d931 | ||
|
|
c117d9ef1f | ||
|
|
9b38ee9b39 | ||
|
|
116dd1a808 | ||
|
|
26753657b8 | ||
|
|
62ffe47d25 | ||
|
|
bb2f4641a3 | ||
|
|
aadc4128f0 | ||
|
|
a8ce74f35d | ||
|
|
44ed8dfd3c | ||
|
|
a7261fde58 | ||
|
|
453a15b9ad | ||
|
|
5a04f831a7 | ||
|
|
fdfde570c7 | ||
|
|
874f5b6cef | ||
|
|
86ec43f676 | ||
|
|
66334d6535 | ||
|
|
608fb26aa2 | ||
|
|
c4e852a0df | ||
|
|
d88ee5f50d | ||
|
|
ad53bb3530 | ||
|
|
e8d5496ef5 | ||
|
|
3edb472bfb |
@@ -0,0 +1,24 @@
|
||||
name: PublishNugetPackage
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "*"
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
name: Publish Project to Nuget
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Setup .NET Core
|
||||
uses: actions/setup-dotnet@v1
|
||||
with:
|
||||
dotnet-version: "8.0.200"
|
||||
- name: Publish
|
||||
run: |
|
||||
version=`git describe --tags`
|
||||
dotnet build --configuration release -p:PackageVersion=$version
|
||||
dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
|
||||
env:
|
||||
NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}
|
||||
@@ -1,16 +0,0 @@
|
||||
name: PublishToNuget
|
||||
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: publish to nuget
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 2
|
||||
- name: Publish NuGet
|
||||
uses: rohith/publish-nuget@v1.0.3
|
||||
with:
|
||||
nuget_key: ${{ secrets.NugetKey }}
|
||||
@@ -1,6 +1,7 @@
|
||||
# Created by .ignore support plugin (hsz.mobi)
|
||||
### C template
|
||||
# Prerequisites
|
||||
*.sln:
|
||||
*.d
|
||||
|
||||
# Object files
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// 检测登录中间件
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
|
||||
public class SimApiAuthAttribute : ActionFilterAttribute
|
||||
{
|
||||
private string[] Types { get; }
|
||||
|
||||
|
||||
//默认是user登录类型
|
||||
public SimApiAuthAttribute()
|
||||
{
|
||||
Types = new[] { "user" };
|
||||
}
|
||||
|
||||
//只检测一种用户类型的快捷方式
|
||||
public SimApiAuthAttribute(string type)
|
||||
{
|
||||
Types = type.Split(",");
|
||||
}
|
||||
|
||||
//设定特定类型的检测
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
using System;
|
||||
using Swashbuckle.AspNetCore.Annotations;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
/// <summary>
|
||||
/// 快捷自定义接口文档类
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
|
||||
public class SimApiDocAttribute : SwaggerOperationAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// 定义接口说明
|
||||
/// </summary>
|
||||
/// <param name="tag">接口分组</param>
|
||||
/// <param name="name">接口名称</param>
|
||||
public SimApiDocAttribute(string tag, string name)
|
||||
{
|
||||
Tags = new[] { tag };
|
||||
Summary = name;
|
||||
// Consumes = new[] {"application/json"};
|
||||
// Produces = new[] {"application/json"};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class SynapseEventAttribute : Attribute
|
||||
{
|
||||
public string Name { get; }
|
||||
|
||||
public SynapseEventAttribute(string name)
|
||||
{
|
||||
Name = name;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.Attributes;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class SynapseRpcAttribute : Attribute
|
||||
{
|
||||
public string Name { get; }
|
||||
|
||||
public SynapseRpcAttribute()
|
||||
{
|
||||
Name = null;
|
||||
}
|
||||
|
||||
public SynapseRpcAttribute(string name)
|
||||
{
|
||||
Name = name;
|
||||
}
|
||||
}
|
||||
@@ -1,98 +0,0 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
using Newtonsoft.Json.Serialization;
|
||||
|
||||
namespace YYApi.Communications
|
||||
{
|
||||
public class BaseResponse
|
||||
{
|
||||
/// <summary>
|
||||
/// 错误代码
|
||||
/// </summary>
|
||||
public int Code { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 错误描述
|
||||
/// </summary>
|
||||
public string Message { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 默认错误代码对应提示信息
|
||||
/// </summary>
|
||||
private readonly Dictionary<int, string> MsgBox = new Dictionary<int, string>()
|
||||
{
|
||||
{200, "成功"},
|
||||
{400, "参数错误"},
|
||||
{401, "需要登录"},
|
||||
{403, "无权访问"},
|
||||
{404, "接口不存在"},
|
||||
{500, "服务器错误"}
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// 返回一个成功的空结果
|
||||
/// </summary>
|
||||
public BaseResponse()
|
||||
{
|
||||
SetCode(200);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 返回指定代码的描述
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
public BaseResponse(int code)
|
||||
{
|
||||
SetCode(code);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 返回指定代码的结果,并自定义提示信息
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误信息</param>
|
||||
public BaseResponse(int code, string message)
|
||||
{
|
||||
SetCodeMsg(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 设置响应结果的错误代码
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
public void SetCode(int code)
|
||||
{
|
||||
Code = code;
|
||||
Message = MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 设置响应结果的错误代码和错误描述
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
public void SetCodeMsg(int code, string message)
|
||||
{
|
||||
SetCode(code);
|
||||
if (!string.IsNullOrEmpty(message))
|
||||
{
|
||||
Message = message;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 序列化为JSON字符串
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public override string ToString()
|
||||
{
|
||||
return JsonSerializer.Serialize(this, new JsonSerializerOptions
|
||||
{
|
||||
IgnoreReadOnlyProperties = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
Converters = {new JsonStringEnumConverter()}
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
using System.ComponentModel.DataAnnotations;
|
||||
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 只有ID的请求
|
||||
/// </summary>
|
||||
public class SimApiIdOnlyRequest
|
||||
{
|
||||
[Required] public int Id { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 只有ID的请求(字符串)
|
||||
/// </summary>
|
||||
public class SimApiStringIdOnlyRequest
|
||||
{
|
||||
[Required] public string Id { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态类型单字段请求
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiOneFieldRequest<T>
|
||||
{
|
||||
[Required] public T Data { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 基础分页请求
|
||||
/// </summary>
|
||||
public class SimApiBasePageRequest
|
||||
{
|
||||
[Required] public int Page { get; set; }
|
||||
[Required] public int Count { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,83 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 基础相应
|
||||
/// </summary>
|
||||
public class SimApiBaseResponse(int code = 200, string message = "成功")
|
||||
{
|
||||
public int Code { get; set; } = code;
|
||||
public string Message { get; set; } = message;
|
||||
|
||||
/// <summary>
|
||||
/// 默认错误代码对应提示信息
|
||||
/// </summary>
|
||||
private static readonly Dictionary<int, string> MsgBox = new()
|
||||
{
|
||||
{ 200, "成功" },
|
||||
{ 204, "没有数据" },
|
||||
{ 400, "参数错误" },
|
||||
{ 401, "需要登录" },
|
||||
{ 403, "无权访问" },
|
||||
{ 404, "接口不存在" },
|
||||
{ 500, "服务器错误" }
|
||||
};
|
||||
|
||||
public SimApiBaseResponse(int code) : this(code, MsgBox.GetValueOrDefault(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>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiBasePageResponse<T>() : SimApiBaseResponse
|
||||
{
|
||||
public T List { get; set; }
|
||||
public int Page { get; set; } = 1;
|
||||
public int Count { get; set; } = 20;
|
||||
public int Total { get; set; }
|
||||
|
||||
public SimApiBasePageResponse(T list, int page, int count, int total) : this()
|
||||
{
|
||||
List = list;
|
||||
Page = page;
|
||||
Count = count;
|
||||
Total = total;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 动态Data返回
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
public class SimApiBaseResponse<T>() : SimApiBaseResponse
|
||||
{
|
||||
public T Data { get; set; }
|
||||
|
||||
public SimApiBaseResponse(T data) : this()
|
||||
{
|
||||
Data = data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace SimApi.Communications;
|
||||
|
||||
/// <summary>
|
||||
/// 登录信息中间件
|
||||
/// </summary>
|
||||
public record SimApiLoginItem(string Id, string[] Type,Dictionary<string,string> Meta = null);
|
||||
@@ -0,0 +1,75 @@
|
||||
using System.Collections.Generic;
|
||||
using Swashbuckle.AspNetCore.SwaggerUI;
|
||||
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
/// <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>
|
||||
public SimApiDocGroupOption[] ApiGroups { get; set; } = new[]
|
||||
{
|
||||
new SimApiDocGroupOption
|
||||
{
|
||||
Id = "api",
|
||||
Name = "Api",
|
||||
Description = "Api接口文档"
|
||||
}
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// 授权配置
|
||||
/// </summary>
|
||||
public SimApiAuthOption ApiAuth { get; set; } = new SimApiAuthOption();
|
||||
|
||||
/// <summary>
|
||||
/// 文档页面标题
|
||||
/// </summary>
|
||||
public string DocumentTitle { get; set; } = "API接口文档";
|
||||
|
||||
/// <summary>
|
||||
/// 接口支持的调用方式
|
||||
/// </summary>
|
||||
public SubmitMethod[] SupportedMethod { get; set; } = new[] { SubmitMethod.Post };
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
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)
|
||||
{
|
||||
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);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiStorageOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// S3 服务器入口地址
|
||||
/// </summary>
|
||||
public string Endpoint { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// S3 服务器文件访问地址
|
||||
/// </summary>
|
||||
public string ServeUrl { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// S3服务 Bucket
|
||||
/// </summary>
|
||||
public string Bucket { get; set; }
|
||||
|
||||
public string AccessKey { get; set; }
|
||||
|
||||
public string SecretKey { get; set; }
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
namespace SimApi.Configurations;
|
||||
|
||||
public class SimApiSynapseOptions
|
||||
{
|
||||
public string MqHost { get; set; }
|
||||
|
||||
public int MqPort { get; set; }
|
||||
|
||||
public string MqUser { get; set; }
|
||||
|
||||
public string MqPass { get; set; }
|
||||
|
||||
public string MqVHost { get; set; } = "/";
|
||||
|
||||
public string SysName { get; set; }
|
||||
|
||||
public string AppName { get; set; }
|
||||
|
||||
public string AppId { get; set; }
|
||||
|
||||
public int RpcTimeout { get; set; } = 3;
|
||||
|
||||
public ushort EventProcessorNum { get; set; } = 20;
|
||||
|
||||
public ushort RpcProcessorNum { get; set; } = 20;
|
||||
|
||||
public bool DisableEventClient { get; set; } = false;
|
||||
|
||||
public bool DisableRpcClient { get; set; } = false;
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
using YYApi.Communications;
|
||||
using YYApi.Helpers;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using System.Linq;
|
||||
|
||||
namespace YYApi.Controllers
|
||||
{
|
||||
/// <summary>
|
||||
/// 基础控制器,所有控制器均继承本控制器
|
||||
/// 1. 自动验证请求参数
|
||||
/// 2. 报错返回
|
||||
/// 3. 错误回馈页面
|
||||
/// </summary>
|
||||
public class BaseController : Controller
|
||||
{
|
||||
protected int LoginId => int.Parse(HttpContext.Items["LoginId"].ToString());
|
||||
|
||||
/// <summary>
|
||||
/// 验证请求参数
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
{
|
||||
if (!context.ModelState.IsValid)
|
||||
{
|
||||
foreach (var item in context.ModelState.Values)
|
||||
{
|
||||
if (item.ValidationState == ModelValidationState.Invalid)
|
||||
{
|
||||
Error(400, item.Errors.First().ErrorMessage);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
protected static void Error(int code, string message = null)
|
||||
{
|
||||
throw new ApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhen(bool condition, int code, string message = null)
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 错误回馈页面
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("exception/{code:int}")]
|
||||
[ApiExplorerSettings(IgnoreApi = true)]
|
||||
public BaseResponse ExceptionHandler(int code)
|
||||
{
|
||||
var response = new BaseResponse();
|
||||
response.SetCode(code);
|
||||
return response;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,109 @@
|
||||
using SimApi.Communications;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.AspNetCore.Mvc.ModelBinding;
|
||||
using System.Linq;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
/// <summary>
|
||||
/// 基础控制器,所有控制器均继承本控制器
|
||||
/// 1. 自动验证请求参数
|
||||
/// 2. 报错返回
|
||||
/// 3. 错误回馈页面
|
||||
/// </summary>
|
||||
public class SimApiBaseController : Controller
|
||||
{
|
||||
/// <summary>
|
||||
/// 当前登录用户的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))
|
||||
{
|
||||
Error(400, item.Errors.First().ErrorMessage);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 错误返回
|
||||
/// </summary>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
|
||||
/// <returns></returns>
|
||||
protected static void Error(int code = 500, string message = "")
|
||||
{
|
||||
throw new SimApiException(code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhen(bool condition, int code = 400, string message = "")
|
||||
{
|
||||
if (condition)
|
||||
{
|
||||
Error(code, message);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 检测条件,根据条件返回报错 如果condition是ture报错
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenTrue(bool condition, int code = 400, string message = "")
|
||||
{
|
||||
ErrorWhen(condition, code, message);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 如果condition是false 报错
|
||||
/// </summary>
|
||||
/// <param name="condition"></param>
|
||||
/// <param name="code"></param>
|
||||
/// <param name="message"></param>
|
||||
protected static void ErrorWhenFalse(bool condition, int code = 400, string message = "")
|
||||
{
|
||||
ErrorWhen(!condition, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测给定的变量是否为NUll
|
||||
/// </summary>
|
||||
/// <param name="condition">检测条件</param>
|
||||
/// <param name="code">错误代码</param>
|
||||
/// <param name="message">错误描述</param>
|
||||
protected static void ErrorWhenNull(object condition, int code = 404, string message = "请求的资源不存在")
|
||||
{
|
||||
ErrorWhen(condition == null, code, message);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 上传文件
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
protected SimApiBaseResponse<string> UploadFile()
|
||||
{
|
||||
return new SimApiBaseResponse<string>();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Controllers;
|
||||
|
||||
[ApiExplorerSettings(GroupName = "api")]
|
||||
public class SimApiCommonController(SimApiAuth auth) : SimApiBaseController
|
||||
{
|
||||
/// <summary>
|
||||
/// 错误回馈页面
|
||||
/// </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>
|
||||
{
|
||||
Data = LoginInfo.Id
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
[HttpPost("/auth/logout"), SimApiDoc("认证", "退出登陆")]
|
||||
public SimApiBaseResponse Logout()
|
||||
{
|
||||
string token = null;
|
||||
|
||||
if (Request.Headers.TryGetValue("Token", out var value))
|
||||
{
|
||||
token = value;
|
||||
}
|
||||
|
||||
auth.Logout(token!);
|
||||
return new SimApiBaseResponse();
|
||||
}
|
||||
|
||||
[HttpPost("/logined"),SimApiAuth]
|
||||
public SimApiBaseResponse<SimApiLoginItem> UserInfo()
|
||||
{
|
||||
return new SimApiBaseResponse<SimApiLoginItem>(LoginInfo);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
using System;
|
||||
|
||||
namespace SimApi.Exceptions;
|
||||
|
||||
/// <summary>
|
||||
/// Api错误捕获异常
|
||||
/// </summary>
|
||||
public class SimApiException(int code, string message = "") : Exception(message)
|
||||
{
|
||||
public int Code { get; } = code;
|
||||
}
|
||||
-143
@@ -1,143 +0,0 @@
|
||||
using System;
|
||||
using YYApi.Helpers;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using Swashbuckle.AspNetCore.SwaggerUI;
|
||||
|
||||
namespace YYApi
|
||||
{
|
||||
/// <summary>
|
||||
/// 加入系统的扩展信息
|
||||
/// </summary>
|
||||
public static class Extensions
|
||||
{
|
||||
/// <summary>
|
||||
/// 添加自定义授权认证中间价
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddAuth(this IServiceCollection builder)
|
||||
{
|
||||
return builder.AddScoped<Auth>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 添加整个YYAPI
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <param name="title"></param>
|
||||
/// <param name="description"></param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddYYApi(this IServiceCollection builder, string title,
|
||||
string description = null)
|
||||
{
|
||||
return builder.AddAuth().AddApiDoc(title, description);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 添加Api文档服务
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <param name="title">文档标题</param>
|
||||
/// <param name="description">文档描述</param>
|
||||
/// <returns></returns>
|
||||
public static IServiceCollection AddApiDoc(this IServiceCollection builder, string title,
|
||||
string description = null)
|
||||
{
|
||||
return builder.AddSwaggerGen(x =>
|
||||
{
|
||||
x.SwaggerDoc("api", new OpenApiInfo {Title = title, Description = description});
|
||||
x.EnableAnnotations();
|
||||
x.AddSecurityRequirement(new OpenApiSecurityRequirement
|
||||
{
|
||||
{
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Reference = new OpenApiReference {Type = ReferenceType.SecurityScheme, Id = "HeaderToken"}
|
||||
},
|
||||
new[] {"readAccess", "writeAccess"}
|
||||
}
|
||||
});
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
new OpenApiSecurityScheme {Name = "Token", In = ParameterLocation.Header});
|
||||
});
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用异常中间价扩展
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseExceptionMiddleware(this IApplicationBuilder builder)
|
||||
{
|
||||
return builder.UseMiddleware<ExceptionMiddleware>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用文档UI
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <param name="title">文档标题</param>
|
||||
/// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseApiDoc(this IApplicationBuilder builder, string title,
|
||||
params SubmitMethod[] submitMethods)
|
||||
{
|
||||
return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x =>
|
||||
{
|
||||
x.RoutePrefix = "docs";
|
||||
x.DocumentTitle = title;
|
||||
x.SwaggerEndpoint("/docs/api.json", name: title);
|
||||
x.EnableValidator();
|
||||
if (submitMethods.Length > 0)
|
||||
{
|
||||
x.SupportedSubmitMethods(submitMethods);
|
||||
}
|
||||
else
|
||||
{
|
||||
x.SupportedSubmitMethods(SubmitMethod.Post);
|
||||
}
|
||||
|
||||
x.DisplayRequestDuration();
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// 同时使用Api文档和异常处理中间件
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <param name="title">文档标题</param>
|
||||
/// <param name="submitMethods">API提交方式定义</param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseDocAndException(this IApplicationBuilder builder, string title = "API文档",
|
||||
params SubmitMethod[] submitMethods)
|
||||
{
|
||||
return builder.UseExceptionMiddleware().UseApiDoc(title, submitMethods);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用自定义认证中间件(依赖IDistributedCache)
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseAuthMiddleware(this IApplicationBuilder builder)
|
||||
{
|
||||
return builder.UseMiddleware<AuthMiddleware>();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 使用所有YYApi自定义中间件
|
||||
/// </summary>
|
||||
/// <param name="builder"></param>
|
||||
/// <param name="title"></param>
|
||||
/// <param name="submitMethods"></param>
|
||||
/// <returns></returns>
|
||||
public static IApplicationBuilder UseYYApiMiddleware(this IApplicationBuilder builder, string title = "API文档",
|
||||
params SubmitMethod[] submitMethods)
|
||||
{
|
||||
return builder.UseExceptionMiddleware().UseApiDoc(title, submitMethods).UseMiddleware<AuthMiddleware>();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
using Swashbuckle.AspNetCore.Annotations;
|
||||
|
||||
namespace YYApi.Helpers
|
||||
{
|
||||
/// <summary>
|
||||
/// 快捷自定义接口文档类
|
||||
/// </summary>
|
||||
public class ApiDoc : SwaggerOperationAttribute
|
||||
{
|
||||
/// <summary>
|
||||
/// 定义接口说明
|
||||
/// </summary>
|
||||
/// <param name="tag">接口分组</param>
|
||||
/// <param name="name">接口名称</param>
|
||||
public ApiDoc(string tag, string name)
|
||||
{
|
||||
Tags = new[] {tag};
|
||||
Summary = name;
|
||||
// Consumes = new[] {"application/json"};
|
||||
// Produces = new[] {"application/json"};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,85 +0,0 @@
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc.Filters;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
|
||||
namespace YYApi.Helpers
|
||||
{
|
||||
/// <summary>
|
||||
/// 认证信息获取中间件
|
||||
/// </summary>
|
||||
public class AuthMiddleware
|
||||
{
|
||||
private RequestDelegate Next { get; }
|
||||
|
||||
public AuthMiddleware(RequestDelegate next)
|
||||
{
|
||||
Next = next;
|
||||
}
|
||||
|
||||
public Task Invoke(HttpContext httpContext, IDistributedCache cache)
|
||||
{
|
||||
string token = null;
|
||||
if (httpContext.Request.Headers.ContainsKey("Token"))
|
||||
{
|
||||
token = httpContext.Request.Headers["Token"];
|
||||
}
|
||||
|
||||
if (!string.IsNullOrEmpty(token))
|
||||
{
|
||||
var id = cache.GetString(token);
|
||||
if (id != null)
|
||||
{
|
||||
httpContext.Items.Add("LoginId", id);
|
||||
}
|
||||
}
|
||||
|
||||
return Next(httpContext);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 检测登录中间件
|
||||
/// </summary>
|
||||
public class CheckAuthAttribute : ActionFilterAttribute
|
||||
{
|
||||
public override void OnActionExecuting(ActionExecutingContext context)
|
||||
{
|
||||
if (context.HttpContext.Items["LoginId"] == null)
|
||||
{
|
||||
throw new ApiException(401);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 认证助手
|
||||
/// </summary>
|
||||
public class Auth
|
||||
{
|
||||
private IDistributedCache Cache { get; }
|
||||
|
||||
public Auth(IDistributedCache cache)
|
||||
{
|
||||
Cache = cache;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 产生一个Token记录并返回Token
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <returns></returns>
|
||||
public string SetId(int id)
|
||||
{
|
||||
var uuid = GetUUID();
|
||||
Cache.SetString(uuid, id.ToString());
|
||||
return uuid;
|
||||
}
|
||||
|
||||
private string GetUUID()
|
||||
{
|
||||
return Guid.NewGuid().ToString();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,71 +0,0 @@
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using YYApi.Communications;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace YYApi.Helpers
|
||||
{
|
||||
/// <summary>
|
||||
/// 异常处理中间件
|
||||
/// </summary>
|
||||
public class ExceptionMiddleware
|
||||
{
|
||||
private RequestDelegate Next { get; }
|
||||
private ILogger<ExceptionMiddleware> Log { get; }
|
||||
|
||||
public ExceptionMiddleware(RequestDelegate next, ILogger<ExceptionMiddleware> log)
|
||||
{
|
||||
Log = log;
|
||||
Next = next;
|
||||
}
|
||||
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
var response = new BaseResponse();
|
||||
try
|
||||
{
|
||||
await Next(context);
|
||||
}
|
||||
catch (ApiException ex)
|
||||
{
|
||||
response.SetCodeMsg(ex.Code, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Log.LogError(ex.Message);
|
||||
Log.LogError(ex.StackTrace);
|
||||
response.SetCodeMsg(500, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异常抛出错误
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
/// <param name="response"></param>
|
||||
private void ErrorResponse(HttpContext context, BaseResponse response)
|
||||
{
|
||||
context.Response.StatusCode = 200;
|
||||
context.Response.Headers.Add("Content-Type", "application/json");
|
||||
context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Api错误捕获异常
|
||||
/// </summary>
|
||||
public class ApiException : Exception
|
||||
{
|
||||
public int Code { get; }
|
||||
|
||||
public ApiException(int code, string message = "") : base(message)
|
||||
{
|
||||
Code = code;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
#nullable enable
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Text.Json;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using SimApi.Communications;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
/// <summary>
|
||||
/// 认证助手
|
||||
/// </summary>
|
||||
public class SimApiAuth(IDistributedCache cache)
|
||||
{
|
||||
/// <summary>
|
||||
/// 产生一个Token记录并返回Token
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <param name="meta"></param>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public string Login(string id, Dictionary<string, string>? meta = null, string type = "user", string? token = null)
|
||||
{
|
||||
return Login(id, meta, new[] { type }, token);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 产生一个Token并记录用户ID角色[多角色]
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <param name="type"></param>
|
||||
/// <param name="meta"></param>
|
||||
/// <param name="uuid"></param>
|
||||
/// <returns></returns>
|
||||
// ReSharper disable once MemberCanBePrivate.Global
|
||||
public string Login(string id, Dictionary<string, string>? meta, string[] type, string? uuid = null)
|
||||
{
|
||||
uuid ??= Guid.NewGuid().ToString();
|
||||
var loginItem = new SimApiLoginItem(id, type, meta);
|
||||
cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
|
||||
return uuid;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 设置登录的Meta信息
|
||||
/// </summary>
|
||||
/// <param name="token"></param>
|
||||
/// <param name="meta"></param>
|
||||
/// <returns></returns>
|
||||
public bool SetMeta(string token, Dictionary<string, string> meta)
|
||||
{
|
||||
var login = GetLogin(token);
|
||||
if (login == null) { return false; }
|
||||
var newLogin = new SimApiLoginItem(login.Id, login.Type, login.Meta);
|
||||
cache.SetString(token,JsonSerializer.Serialize(newLogin));
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 获取登陆信息
|
||||
/// </summary>
|
||||
/// <param name="token"></param>
|
||||
/// <returns></returns>
|
||||
public SimApiLoginItem? GetLogin(string token)
|
||||
{
|
||||
var login = cache.GetString(token);
|
||||
return login != null ? JsonSerializer.Deserialize<SimApiLoginItem>(login) : default;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 退出登陆
|
||||
/// </summary>
|
||||
/// <param name="uuid">登陆标识</param>
|
||||
public void Logout(string uuid)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(uuid))
|
||||
{
|
||||
cache.Remove(uuid);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Minio;
|
||||
using SimApi.Configurations;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
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)
|
||||
{
|
||||
var options = apiOptions.SimApiStorageOptions;
|
||||
HttpContextAccessor = httpContextAccessor;
|
||||
var useSsl = false;
|
||||
string endpoint;
|
||||
if (options.Endpoint.StartsWith("http://"))
|
||||
{
|
||||
endpoint = options.Endpoint.Replace("http://", string.Empty);
|
||||
}
|
||||
else if (options.Endpoint.StartsWith("https://"))
|
||||
{
|
||||
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>
|
||||
/// 获取上传的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}";
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Text.Unicode;
|
||||
|
||||
namespace SimApi.Helpers;
|
||||
|
||||
public static class SimApiUtil
|
||||
{
|
||||
/// <summary>
|
||||
/// 当前CST时间
|
||||
/// </summary>
|
||||
public static DateTime CstNow => DateTime.UtcNow.AddHours(8);
|
||||
|
||||
/// <summary>
|
||||
/// JSON序列化常规选项
|
||||
/// </summary>
|
||||
public static JsonSerializerOptions JsonOption => new()
|
||||
{
|
||||
Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// 当前秒级时间戳
|
||||
/// </summary>
|
||||
public static double TimestampNow => (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0)).TotalSeconds;
|
||||
|
||||
/// <summary>
|
||||
/// 检测手机号是否正确
|
||||
/// </summary>
|
||||
/// <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 sourceBytes = Encoding.UTF8.GetBytes(source);
|
||||
var result = MD5.HashData(sourceBytes);
|
||||
var stringBuilder = new StringBuilder(40);
|
||||
foreach (var t in result)
|
||||
{
|
||||
stringBuilder.Append(t.ToString(mode));
|
||||
}
|
||||
|
||||
return stringBuilder.ToString();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 将对象序列化成JSON (控制台输出中文不会被编码)
|
||||
/// </summary>
|
||||
/// <param name="obj"></param>
|
||||
/// <returns></returns>
|
||||
public static string Json(object obj)
|
||||
{
|
||||
return JsonSerializer.Serialize(obj, JsonOption);
|
||||
}
|
||||
|
||||
/// <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);
|
||||
}
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
using System;
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
using System.Text.RegularExpressions;
|
||||
|
||||
namespace YYApi.Helpers
|
||||
{
|
||||
public static class Util
|
||||
{
|
||||
/// <summary>
|
||||
/// 检测手机号是否正确
|
||||
/// </summary>
|
||||
/// <param name="cell">手机号码</param>
|
||||
/// <returns></returns>
|
||||
public static bool CheckCell(string cell)
|
||||
{
|
||||
var regex = new Regex("^1[34578]\\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")
|
||||
{
|
||||
byte[] sor = Encoding.UTF8.GetBytes(source);
|
||||
MD5 md5 = MD5.Create();
|
||||
byte[] result = md5.ComputeHash(sor);
|
||||
StringBuilder strbul = new StringBuilder(40);
|
||||
for (int i = 0; i < result.Length; i++)
|
||||
{
|
||||
strbul.Append(result[i].ToString(mode));
|
||||
}
|
||||
|
||||
return strbul.ToString();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
using System;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLogger(string name) : ILogger
|
||||
{
|
||||
public IDisposable BeginScope<TState>(TState state) => default!;
|
||||
|
||||
public bool IsEnabled(LogLevel logLevel) => true;
|
||||
|
||||
public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception,
|
||||
Func<TState, Exception, string> formatter)
|
||||
{
|
||||
Console.ForegroundColor = logLevel switch
|
||||
{
|
||||
LogLevel.Debug => ConsoleColor.DarkMagenta,
|
||||
LogLevel.Information => ConsoleColor.DarkCyan,
|
||||
LogLevel.Warning => ConsoleColor.Yellow,
|
||||
LogLevel.Error => ConsoleColor.Red,
|
||||
LogLevel.Critical => ConsoleColor.DarkRed,
|
||||
_ => ConsoleColor.White
|
||||
};
|
||||
var message =
|
||||
$"[ {name} ][ {DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss:ffff")} ][ {logLevel.ToString()} ]\n{state}\n";
|
||||
if (exception != null)
|
||||
{
|
||||
message += $"{exception}\n";
|
||||
}
|
||||
|
||||
Console.WriteLine(message);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLoggerConfiguration
|
||||
{
|
||||
public int EventId { get; set; }
|
||||
|
||||
public Dictionary<LogLevel, ConsoleColor> LogLevels { get; set; } = new()
|
||||
{
|
||||
[LogLevel.Information] = ConsoleColor.Green
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
using System.Collections.Concurrent;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace SimApi.Logger;
|
||||
|
||||
public class SimApiLoggerProvider : ILoggerProvider
|
||||
{
|
||||
private readonly ConcurrentDictionary<string, SimApiLogger> _loggers = new();
|
||||
|
||||
|
||||
public ILogger CreateLogger(string categoryName)
|
||||
{
|
||||
return _loggers.GetOrAdd(categoryName, name => new SimApiLogger(name));
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
_loggers.Clear();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
using System.Text.Json;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Caching.Distributed;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Middlewares;
|
||||
|
||||
/// <summary>
|
||||
/// 认证信息获取中间件
|
||||
/// </summary>
|
||||
public class SimApiAuthMiddleware(RequestDelegate next)
|
||||
{
|
||||
public Task Invoke(HttpContext httpContext, IDistributedCache cache, SimApiAuth auth)
|
||||
{
|
||||
string token = null;
|
||||
if (httpContext.Request.Headers.TryGetValue("Token", out var header))
|
||||
{
|
||||
token = header;
|
||||
}
|
||||
|
||||
if (!string.IsNullOrEmpty(token))
|
||||
{
|
||||
var login = auth.GetLogin(token);
|
||||
if (login != null)
|
||||
{
|
||||
httpContext.Items.Add("LoginInfo", login);
|
||||
}
|
||||
}
|
||||
|
||||
return next(httpContext);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,69 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using SimApi.Communications;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Exceptions;
|
||||
|
||||
namespace SimApi.Middlewares;
|
||||
|
||||
/// <summary>
|
||||
/// 异常处理中间件
|
||||
/// </summary>
|
||||
public class SimApiExceptionMiddleware(RequestDelegate next, ILogger<SimApiExceptionMiddleware> log)
|
||||
{
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
if (context.Request.Headers.TryGetValue("Query-Id", out var header))
|
||||
{
|
||||
context.Response.Headers["Query-Id"] = header;
|
||||
}
|
||||
|
||||
SimApiBaseResponse response;
|
||||
try
|
||||
{
|
||||
await next(context);
|
||||
switch (context.Response.StatusCode)
|
||||
{
|
||||
case 200:
|
||||
break;
|
||||
case 404:
|
||||
throw new SimApiException(context.Response.StatusCode, "请求的接口不存在");
|
||||
case 301:
|
||||
case 302:
|
||||
break;
|
||||
default:
|
||||
throw new SimApiException(context.Response.StatusCode);
|
||||
}
|
||||
}
|
||||
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("{Msg}", ex.Message);
|
||||
log.LogError("{Msg}", ex.StackTrace);
|
||||
response = new SimApiBaseResponse(500, ex.Message);
|
||||
ErrorResponse(context, response);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 异常抛出错误
|
||||
/// </summary>
|
||||
/// <param name="context"></param>
|
||||
/// <param name="response"></param>
|
||||
private static void ErrorResponse(HttpContext context, SimApiBaseResponse response)
|
||||
{
|
||||
if (context.Response.HasStarted) return;
|
||||
context.Response.StatusCode = 200;
|
||||
context.Response.Headers.Append("Content-Type", "application/json");
|
||||
context.Response.WriteAsync(response.ToString());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
using System;
|
||||
using System.ComponentModel.DataAnnotations.Schema;
|
||||
using System.Linq;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi.Models;
|
||||
|
||||
public class SimApiBaseModel
|
||||
{
|
||||
[Column(Order = 1)] public string Id { get; set; } = Guid.NewGuid().ToString();
|
||||
|
||||
[Column(Order = 9998)] public DateTime UpdatedAt { get; set; } = DateTime.Now;
|
||||
|
||||
[Column(Order = 9999)] public DateTime CreatedAt { get; set; } = DateTime.Now;
|
||||
|
||||
protected virtual string[] MapperIgnoreField { get; set; } = { "Id", "CreatedAt", "UpdatedAt" };
|
||||
|
||||
protected virtual string 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)?
|
||||
.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, DateTime.Now);
|
||||
}
|
||||
}
|
||||
@@ -2,5 +2,15 @@
|
||||
"iisSettings": {
|
||||
"windowsAuthentication": false,
|
||||
"anonymousAuthentication": true
|
||||
},
|
||||
"profiles": {
|
||||
"SimApi": {
|
||||
"commandName": "Project",
|
||||
"launchBrowser": true,
|
||||
"environmentVariables": {
|
||||
"ASPNETCORE_ENVIRONMENT": "Development"
|
||||
},
|
||||
"applicationUrl": "https://localhost:5001;http://localhost:5000"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
# YYApi 基于Asp.net Core 3的一个基础辅助包
|
||||
# SimApi 基于.Net的一个基础辅助包
|
||||
|
||||
[](https://github.com/simcu/simapi-net/actions/workflows/nuget-publish.yml)
|
||||
### 包含了以下组件:
|
||||
|
||||
1. 统一的参数检测,基础认证服务
|
||||
@@ -7,56 +8,48 @@
|
||||
|
||||
```C#
|
||||
using Models;
|
||||
using SimApi.Controllers;
|
||||
|
||||
namespace Controllers
|
||||
{
|
||||
public class BaseController : YYApi.Controllers.BaseController
|
||||
public class BaseController : SimApiBaseController
|
||||
{
|
||||
/// <summary>
|
||||
/// 获取登录用户信息
|
||||
/// </summary>
|
||||
protected User LoginInfo => (User) HttpContext.Items["LoginInfo"];
|
||||
protected SimApiLoginInfoItem LoginInfo => (SimApiLoginInfoItem) HttpContext.Items["LoginInfo"];
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. 基于Swagger的API文档服务
|
||||
|
||||
统一配置,现在只需要进行AddSimApi的配置, Configure中直接 UseSimApi即可。
|
||||
```C#
|
||||
#Startup.cs
|
||||
|
||||
services.AddApiDoc("文档名称", "文档描述");
|
||||
|
||||
app.UseApiDoc("名称",SubmitMethod[])
|
||||
|
||||
#控制器中可以直接使用特性
|
||||
|
||||
[ApiDoc("分组","名称")]
|
||||
services.AddSimApi(options =>
|
||||
{
|
||||
options.ConfigureSimApiDoc(options =>
|
||||
{
|
||||
options.ApiGroups = new[]
|
||||
{
|
||||
new SimApiDocGroupOption
|
||||
{Id = "admin", Name = "后台管理接口", Description = "本接口调用需要Scope:sac.api.admin"},
|
||||
new SimApiDocGroupOption
|
||||
{Id = "user-v1", Name = "用户中心接口", Description = "本接口调用需要Scope:sac.api.user"}
|
||||
};
|
||||
options.ApiAuth = new SimApiAuthOption
|
||||
{
|
||||
Type = new[] {"ClientCredentials", "Implicit", "AuthorizationCode"},
|
||||
Scopes = new Dictionary<string, string>
|
||||
{
|
||||
{"sac.api.user", "用户信息接口权限"},
|
||||
{"sac.api.admin", "后台管理API"}
|
||||
},
|
||||
AuthorizationUrl = "/connect/authorize",
|
||||
TokenUrl = "/connect/token"
|
||||
};
|
||||
});
|
||||
options.EnableSimApiStorage = true;
|
||||
options.SimApiStorageOptions = Configuration.GetSection("S3").Get<SimApiStorageOptions>();
|
||||
});
|
||||
```
|
||||
|
||||
3. 简单的基于Redis的登录TOKEN服务
|
||||
|
||||
```C#
|
||||
#Startup.cs
|
||||
service.AddAuth();
|
||||
```
|
||||
添加时候, 可以从DI中获取 Auth 类,调用 Auth.SetId(int) 将用户ID和生成的Token绑定,本方法返回缓存中的Key名称
|
||||
|
||||
```C#
|
||||
#Startup.cs
|
||||
app.UseAuthMiddleware();
|
||||
```
|
||||
调用本中间件,然后再需要登录认证的地方,使用 [CheckAuth] 特性,即可完成检测登录相关的操作,
|
||||
如果需要获取用户的ID, 只需要 直接使用 LoginId 属性即可获取
|
||||
|
||||
4. 统一返回
|
||||
所有Response 均需要继承 BaseResponse类
|
||||
|
||||
|
||||
5. 异常处理
|
||||
本异常中间件封装了API错误的异常处理,控制器可以使用 Error(int,string) 直接返回API错误
|
||||
|
||||
```C#
|
||||
#Startup.cs
|
||||
app.UseExceptionMiddleware();
|
||||
```
|
||||
基于S3的存储,基于RabbitMq的事件RPC调用,自定义Logger格式,自定义响应格式
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
<Version>0.2.3</Version>
|
||||
<Authors>xRain@SimcuTeam</Authors>
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>Simcu.SimApi</PackageId>
|
||||
<IsPackable>true</IsPackable>
|
||||
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
|
||||
<IncludeSymbols>true</IncludeSymbols>
|
||||
<ReleaseVersion>5.0.0</ReleaseVersion>
|
||||
<SynchReleaseVersion>false</SynchReleaseVersion>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
<PackageVersion>5.0.2</PackageVersion>
|
||||
<TargetFramework>net8.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Folder Include="Helpers\"/>
|
||||
<Folder Include="Communications\"/>
|
||||
<Folder Include="Controllers\"/>
|
||||
<Folder Include="Middlewares\"/>
|
||||
<Folder Include="Exceptions\"/>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Minio" Version="4.0.7"/>
|
||||
<PackageReference Include="RabbitMQ.Client" Version="6.6.0"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0"/>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0"/>
|
||||
</ItemGroup>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical"/>
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
</Project>
|
||||
@@ -0,0 +1,266 @@
|
||||
using System;
|
||||
using SimApi.Helpers;
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.OpenApi.Models;
|
||||
using SimApi.Middlewares;
|
||||
using Microsoft.AspNetCore.HttpOverrides;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Logger;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
/// <summary>
|
||||
/// 加入系统的扩展信息
|
||||
/// </summary>
|
||||
public static class SimApiExtensions
|
||||
{
|
||||
//**********快捷添加**************
|
||||
public static IServiceCollection AddSimApi(this IServiceCollection builder,
|
||||
Action<SimApiOptions> options = null)
|
||||
{
|
||||
var simApiOptions = new SimApiOptions();
|
||||
options?.Invoke(simApiOptions);
|
||||
if (simApiOptions.EnableLogger)
|
||||
{
|
||||
builder.AddLogging(logger =>
|
||||
{
|
||||
logger.ClearProviders();
|
||||
logger.AddProvider(new SimApiLoggerProvider());
|
||||
});
|
||||
}
|
||||
|
||||
// 是否使用 AUTH
|
||||
if (simApiOptions.EnableSimApiAuth)
|
||||
{
|
||||
builder.AddSingleton<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)
|
||||
{
|
||||
x.SwaggerDoc(group.Id, new OpenApiInfo
|
||||
{
|
||||
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
|
||||
{
|
||||
Type = ReferenceType.SecurityScheme,
|
||||
Id = "oauth2"
|
||||
}
|
||||
},
|
||||
new[] { "SimApiAuth" }
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (haveSimApiAuth)
|
||||
{
|
||||
x.AddSecurityDefinition("HeaderToken",
|
||||
new OpenApiSecurityScheme
|
||||
{
|
||||
Name = "Token",
|
||||
In = ParameterLocation.Header
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// 使用Header转发,应对代理后获取真实ip
|
||||
if (simApiOptions.EnableForwardHeaders)
|
||||
{
|
||||
builder.Configure<ForwardedHeadersOptions>(fwOptions =>
|
||||
{
|
||||
fwOptions.ForwardedHeaders = ForwardedHeaders.All;
|
||||
fwOptions.KnownNetworks.Clear();
|
||||
fwOptions.KnownProxies.Clear();
|
||||
});
|
||||
}
|
||||
|
||||
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>>();
|
||||
|
||||
logger.LogInformation("当前时区: {LocalId}", TimeZoneInfo.Local.Id);
|
||||
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;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
using System;
|
||||
using System.Text;
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Json;
|
||||
using System.Text.Unicode;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private void RunEventClient()
|
||||
{
|
||||
EventClientChannel = CreateChannel(0, "EventClient");
|
||||
}
|
||||
|
||||
private void FireEvent(string eventName, object param)
|
||||
{
|
||||
var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
|
||||
var router = $"event.{Options.AppName}.{eventName}";
|
||||
var props = EventClientChannel.CreateBasicProperties();
|
||||
props.AppId = Options.AppId;
|
||||
props.MessageId = Guid.NewGuid().ToString();
|
||||
props.ReplyTo = Options.AppName;
|
||||
props.Type = eventName;
|
||||
EventClientChannel.BasicPublish(Options.SysName, router, false, props, Encoding.UTF8.GetBytes(paramJson));
|
||||
Logger.LogDebug("Event Publish: {OptionsAppName}.{EventName}\n{ParamJson}", Options.AppName, eventName,
|
||||
paramJson);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using RabbitMQ.Client.Events;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private void RunEventServer()
|
||||
{
|
||||
EventServerChannel = CreateChannel(Options.EventProcessorNum, "EventServer");
|
||||
var queue = $"{Options.SysName}_{Options.AppName}_event";
|
||||
EventServerChannel.QueueDeclare(queue, true, false, true, null);
|
||||
foreach (var ev in EventRegistry.Where(ev => !ev.Key.Contains('*') && !ev.Key.Contains('#')))
|
||||
{
|
||||
EventServerChannel.QueueBind(queue, Options.SysName, $"event.{ev.Key}", null);
|
||||
}
|
||||
var consumer = new EventingBasicConsumer(EventServerChannel);
|
||||
consumer.Received += (ch, ea) =>
|
||||
{
|
||||
var reqBody = Encoding.UTF8.GetString(ea.Body.ToArray());
|
||||
Logger.LogDebug("Event Receive: {BasicPropertiesReplyTo}.{BasicPropertiesType}\n{S}",
|
||||
ea.BasicProperties.ReplyTo, ea.BasicProperties.Type, reqBody);
|
||||
|
||||
var key = ea.RoutingKey.Replace("event.", string.Empty);
|
||||
var method = EventRegistry.FirstOrDefault(x => x.Key == key);
|
||||
var callClass = Sp.CreateScope().ServiceProvider.GetRequiredService(method.Class);
|
||||
var mt = callClass.GetType().GetMethod(method.Method);
|
||||
var pt = mt.GetParameters()[0].ParameterType;
|
||||
try
|
||||
{
|
||||
mt.Invoke(callClass, pt == typeof(string)
|
||||
? new object[] { reqBody }
|
||||
: new[] { JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption) });
|
||||
EventServerChannel.BasicAck(ea.DeliveryTag, false);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Logger.LogError("Event Processor Error: {Err}", e.InnerException);
|
||||
EventServerChannel.BasicNack(ea.DeliveryTag, false, false);
|
||||
}
|
||||
};
|
||||
EventServerChannel.BasicConsume(queue, false, "", false, false, null, consumer);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Text;
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Json;
|
||||
using System.Text.Unicode;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Newtonsoft.Json.Serialization;
|
||||
using RabbitMQ.Client.Events;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private Dictionary<string, byte[]> ResponseCache { get; } = new();
|
||||
|
||||
private void RunRpcClient()
|
||||
{
|
||||
RpcClientChannel = CreateChannel(0, "RpcClient");
|
||||
var queue = $"{Options.SysName}_{Options.AppName}_client_{Options.AppId}";
|
||||
var router = $"client.{Options.AppName}.{Options.AppId}";
|
||||
RpcClientChannel.QueueDeclare(queue, true, false, true, null);
|
||||
RpcClientChannel.QueueBind(queue, Options.SysName, router, null);
|
||||
var consumer = new EventingBasicConsumer(RpcClientChannel);
|
||||
consumer.Received += (ch, ea) =>
|
||||
{
|
||||
ResponseCache.Add(ea.BasicProperties.CorrelationId, ea.Body.ToArray());
|
||||
RpcClientChannel.BasicAck(ea.DeliveryTag, false);
|
||||
Logger.LogDebug(
|
||||
"RPC Response: ({BasicPropertiesCorrelationId}) {BasicPropertiesType}@{BasicPropertiesReplyTo} -> {OptionsAppName}\n{S}",
|
||||
ea.BasicProperties.CorrelationId, ea.BasicProperties.Type, ea.BasicProperties.ReplyTo, Options.AppName,
|
||||
Encoding.UTF8.GetString(ea.Body.ToArray()));
|
||||
};
|
||||
RpcClientChannel.BasicConsume(queue, false, "", false, false, null, consumer);
|
||||
}
|
||||
|
||||
private string FireRpc(string app, string action, object param)
|
||||
{
|
||||
var paramJson = JsonSerializer.Serialize(param, SimApiUtil.JsonOption);
|
||||
var router = $"server.{app}";
|
||||
string response;
|
||||
var props = RpcClientChannel.CreateBasicProperties();
|
||||
props.AppId = Options.AppId;
|
||||
props.MessageId = Guid.NewGuid().ToString();
|
||||
props.Type = action;
|
||||
props.ReplyTo = Options.AppName;
|
||||
RpcClientChannel.BasicPublish(Options.SysName, router, false, props, Encoding.UTF8.GetBytes(paramJson));
|
||||
Logger.LogDebug("RPC Request: ({PropsMessageId}) {OptionsAppName} -> {Action}@{App}\n{ParamJson}",
|
||||
props.MessageId,
|
||||
Options.AppName, action, app, paramJson);
|
||||
var ts = SimApiUtil.TimestampNow;
|
||||
while (true)
|
||||
{
|
||||
if (SimApiUtil.TimestampNow - ts > Options.RpcTimeout)
|
||||
{
|
||||
response = JsonSerializer.Serialize(new SimApiBaseResponse(502, "timeout"), SimApiUtil.JsonOption);
|
||||
break;
|
||||
}
|
||||
if (ResponseCache.TryGetValue(props.MessageId, out var value))
|
||||
{
|
||||
response = Encoding.UTF8.GetString(value);
|
||||
ResponseCache.Remove(props.MessageId);
|
||||
break;
|
||||
}
|
||||
}
|
||||
return response;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using RabbitMQ.Client.Events;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Exceptions;
|
||||
using SimApi.Helpers;
|
||||
using JsonSerializer = System.Text.Json.JsonSerializer;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private void RunRpcServer()
|
||||
{
|
||||
RpcServerChannel = CreateChannel(Options.RpcProcessorNum, "RpcServer");
|
||||
var queue = $"{Options.SysName}_{Options.AppName}_server";
|
||||
var router = $"server.{Options.AppName}";
|
||||
RpcServerChannel.QueueDeclare(queue, true, false, true, null);
|
||||
RpcServerChannel.QueueBind(queue, Options.SysName, router, null);
|
||||
var consumer = new EventingBasicConsumer(RpcServerChannel);
|
||||
consumer.Received += (ch, ea) =>
|
||||
{
|
||||
var reqBody = Encoding.UTF8.GetString(ea.Body.ToArray());
|
||||
Logger.LogDebug(
|
||||
"RPC Receive: ({BasicPropertiesMessageId}) {BasicPropertiesReplyTo} -> {BasicPropertiesType}@{OptionsAppName}\n{S}",
|
||||
ea.BasicProperties.MessageId, ea.BasicProperties.ReplyTo, ea.BasicProperties.Type, Options.AppName,
|
||||
reqBody);
|
||||
var res = new SimApiBaseResponse(404, "method not found");
|
||||
var method = RpcRegistry.FirstOrDefault(x => x.Key == ea.BasicProperties.Type);
|
||||
if (method != null)
|
||||
{
|
||||
var callClass = Sp.CreateScope().ServiceProvider.GetRequiredService(method.Class);
|
||||
var mt = callClass.GetType().GetMethod(method.Method);
|
||||
var param = Array.Empty<object>();
|
||||
try
|
||||
{
|
||||
var pt = mt.GetParameters()[0].ParameterType;
|
||||
if (pt == typeof(string))
|
||||
{
|
||||
param = new[] { reqBody };
|
||||
}
|
||||
else
|
||||
{
|
||||
var paramObj = JsonSerializer.Deserialize(reqBody, pt, SimApiUtil.JsonOption);
|
||||
param = new[] { paramObj };
|
||||
}
|
||||
|
||||
var ret = mt.Invoke(callClass, param);
|
||||
res = new SimApiBaseResponse<object>
|
||||
{
|
||||
Data = ret
|
||||
};
|
||||
}
|
||||
catch (TargetInvocationException e)
|
||||
{
|
||||
if (e.InnerException is SimApiException ie)
|
||||
{
|
||||
Logger.LogDebug("RPC调用错误: {Err}", ie.Message);
|
||||
res = new SimApiBaseResponse(ie.Code, ie.Message);
|
||||
}
|
||||
else
|
||||
{
|
||||
res = new SimApiBaseResponse(500, e.Message);
|
||||
}
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Logger.LogDebug("RPC调用失败: {Err}", e.Message);
|
||||
res = new SimApiBaseResponse(500, e.Message);
|
||||
}
|
||||
}
|
||||
|
||||
var returnJson = JsonSerializer.Serialize((object)res, SimApiUtil.JsonOption);
|
||||
var reply = $"client.{ea.BasicProperties.ReplyTo}.{ea.BasicProperties.AppId}";
|
||||
var props = RpcServerChannel.CreateBasicProperties();
|
||||
props.AppId = Options.AppId;
|
||||
props.CorrelationId = ea.BasicProperties.MessageId;
|
||||
props.MessageId = Guid.NewGuid().ToString();
|
||||
props.ReplyTo = Options.AppName;
|
||||
props.Type = ea.BasicProperties.Type;
|
||||
RpcServerChannel.BasicPublish(Options.SysName, reply, false, props, Encoding.UTF8.GetBytes(returnJson));
|
||||
Logger.LogDebug(
|
||||
"Rpc Return: ({BasicPropertiesMessageId}) {BasicPropertiesType}@{OptionsAppName} -> {BasicPropertiesReplyTo}\n{ReturnJson}",
|
||||
ea.BasicProperties.MessageId, ea.BasicProperties.Type, Options.AppName, ea.BasicProperties.ReplyTo,
|
||||
returnJson);
|
||||
};
|
||||
RpcServerChannel.BasicConsume(queue, true, "", false, false, null, consumer);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,247 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using RabbitMQ.Client;
|
||||
using RabbitMQ.Client.Exceptions;
|
||||
using SimApi.Attributes;
|
||||
using SimApi.Communications;
|
||||
using SimApi.Configurations;
|
||||
using SimApi.Helpers;
|
||||
|
||||
namespace SimApi;
|
||||
|
||||
public partial class Synapse
|
||||
{
|
||||
private IServiceProvider Sp { get; }
|
||||
|
||||
private SimApiSynapseOptions Options { get; }
|
||||
|
||||
private ILogger<Synapse> Logger { get; }
|
||||
|
||||
private IConnection Connection { get; set; }
|
||||
|
||||
private IModel EventClientChannel { get; set; }
|
||||
|
||||
private IModel EventServerChannel { get; set; }
|
||||
|
||||
private IModel RpcClientChannel { get; set; }
|
||||
|
||||
private IModel RpcServerChannel { get; set; }
|
||||
|
||||
private List<RegisterItem> EventRegistry { get; set; }
|
||||
|
||||
private List<RegisterItem> RpcRegistry { get; set; }
|
||||
|
||||
public Synapse(SimApiOptions simApiOptions, ILogger<Synapse> logger, IServiceProvider sp)
|
||||
{
|
||||
Logger = logger;
|
||||
Sp = sp;
|
||||
Options = simApiOptions.SimApiSynapseOptions;
|
||||
}
|
||||
|
||||
public void Init()
|
||||
{
|
||||
ProcessAttribute();
|
||||
Logger.LogDebug("Synapse初始化配置信息: {Json}", SimApiUtil.Json(Options));
|
||||
if (string.IsNullOrEmpty(Options.AppName) || string.IsNullOrEmpty(Options.SysName))
|
||||
{
|
||||
Logger.LogCritical("Synapse初始化失败: AppName or SysName 错误");
|
||||
}
|
||||
|
||||
Options.AppId ??= Guid.NewGuid().ToString();
|
||||
Logger.LogInformation("System Name: {SysName}\nApp Name: {AppName}\nAppId: {AppId}", Options.SysName,
|
||||
Options.AppName, Options.AppId);
|
||||
CreateConnection();
|
||||
CheckAndCreateExchange();
|
||||
//事件客户端
|
||||
if (Options.DisableEventClient)
|
||||
{
|
||||
Logger.LogWarning("Event Client Disabled: DisableEventClient set true");
|
||||
}
|
||||
else
|
||||
{
|
||||
RunEventClient();
|
||||
Logger.LogInformation("Event Client Ready");
|
||||
}
|
||||
|
||||
//RPC客户端
|
||||
if (Options.DisableRpcClient)
|
||||
{
|
||||
Logger.LogWarning("Rpc Client Disabled: DisableEventClient set true");
|
||||
}
|
||||
else
|
||||
{
|
||||
RunRpcClient();
|
||||
Logger.LogInformation("Rpc Client Ready, Client Timeout: {OptionsRpcTimeout}s", Options.RpcTimeout);
|
||||
}
|
||||
|
||||
if (RpcRegistry.Count > 0)
|
||||
{
|
||||
RunRpcServer();
|
||||
}
|
||||
|
||||
if (EventRegistry.Count > 0)
|
||||
{
|
||||
RunEventServer();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
public SimApiBaseResponse<T> Rpc<T>(string appName, string method, dynamic param)
|
||||
{
|
||||
var res = new SimApiBaseResponse(500, "Rpc Client Disabled!");
|
||||
if (Options.DisableRpcClient)
|
||||
{
|
||||
Logger.LogError("Rpc Client Disabled!");
|
||||
}
|
||||
else
|
||||
{
|
||||
var data = FireRpc(appName, method, param);
|
||||
res = JsonSerializer.Deserialize<SimApiBaseResponse<T>>(data, SimApiUtil.JsonOption);
|
||||
}
|
||||
|
||||
return res as SimApiBaseResponse<T>;
|
||||
}
|
||||
|
||||
public SimApiBaseResponse<object> Rpc(string appName, string method, dynamic param)
|
||||
{
|
||||
return Rpc<object>(appName, method, param);
|
||||
}
|
||||
|
||||
public void Event(string eventName, dynamic param)
|
||||
{
|
||||
if (Options.DisableEventClient)
|
||||
{
|
||||
Logger.LogError("Event Client Disabled!");
|
||||
}
|
||||
else
|
||||
{
|
||||
FireEvent(eventName, param);
|
||||
}
|
||||
}
|
||||
|
||||
private void CreateConnection()
|
||||
{
|
||||
var factory = new ConnectionFactory
|
||||
{
|
||||
HostName = Options.MqHost,
|
||||
Port = Options.MqPort,
|
||||
VirtualHost = Options.MqVHost,
|
||||
UserName = Options.MqUser,
|
||||
Password = Options.MqPass
|
||||
};
|
||||
try
|
||||
{
|
||||
Connection = factory.CreateConnection();
|
||||
Logger.LogInformation("连接RabbitMQ服务器成功");
|
||||
}
|
||||
catch (BrokerUnreachableException e)
|
||||
{
|
||||
Logger.LogError("连接RabbitMQ失败: \n{Err}", e);
|
||||
}
|
||||
}
|
||||
|
||||
private IModel CreateChannel(ushort processNum = 0, string desc = "unknow")
|
||||
{
|
||||
IModel channel = null;
|
||||
try
|
||||
{
|
||||
var log = $"Channel [{desc}] 创建成功...";
|
||||
channel = Connection.CreateModel();
|
||||
if (processNum != 0)
|
||||
{
|
||||
channel.BasicQos(0, processNum, false);
|
||||
log += $"最大处理器数量: {processNum}";
|
||||
}
|
||||
|
||||
Logger.LogInformation(log);
|
||||
}
|
||||
catch (ConnectFailureException e)
|
||||
{
|
||||
Logger.LogError("Channel [{{Desc}}] 创建失败...\n {0}", e);
|
||||
}
|
||||
|
||||
return channel;
|
||||
}
|
||||
|
||||
private void CheckAndCreateExchange()
|
||||
{
|
||||
var channel = CreateChannel(0, "Exchange");
|
||||
try
|
||||
{
|
||||
channel.ExchangeDeclare(Options.SysName, ExchangeType.Topic, true, true, null);
|
||||
Logger.LogDebug("Register Exchange Success");
|
||||
}
|
||||
catch (ConnectFailureException e)
|
||||
{
|
||||
Logger.LogError("Failed to declare Exchange.\n {Err}", e);
|
||||
}
|
||||
|
||||
channel.Close();
|
||||
Logger.LogDebug("Exchange Channel Closed");
|
||||
}
|
||||
|
||||
private void ProcessAttribute()
|
||||
{
|
||||
EventRegistry = new List<RegisterItem>();
|
||||
RpcRegistry = new List<RegisterItem>();
|
||||
var stackTrace = new StackTrace();
|
||||
var callingMethod = stackTrace.GetFrame(stackTrace.FrameCount - 1).GetMethod();
|
||||
var assembly = callingMethod.DeclaringType.Assembly;
|
||||
var types = assembly.GetTypes(); // 获取程序集中的所有类型
|
||||
foreach (var type in types)
|
||||
{
|
||||
var methods = type.GetMethods(); // 获取类型中的所有方法
|
||||
foreach (var method in methods)
|
||||
{
|
||||
if (method.IsDefined(typeof(SynapseEventAttribute), false))
|
||||
{
|
||||
var attribute =
|
||||
(SynapseEventAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseEventAttribute));
|
||||
if (attribute != null)
|
||||
{
|
||||
EventRegistry.Add(new RegisterItem
|
||||
{
|
||||
Key = attribute.Name ?? method.Name,
|
||||
Class = type,
|
||||
Method = method.Name
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (method.IsDefined(typeof(SynapseRpcAttribute), false))
|
||||
{
|
||||
var attribute =
|
||||
(SynapseRpcAttribute)Attribute.GetCustomAttribute(method, typeof(SynapseRpcAttribute));
|
||||
if (attribute != null)
|
||||
{
|
||||
RpcRegistry.Add(new RegisterItem
|
||||
{
|
||||
Key = attribute.Name ?? $"{type.Name}.{method.Name}",
|
||||
Class = type,
|
||||
Method = method.Name
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var events = EventRegistry.Aggregate(string.Empty,
|
||||
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class.Name}");
|
||||
var rpcList = RpcRegistry.Aggregate(string.Empty,
|
||||
(current, ev) => current + $"\n |- {ev.Key} -> {ev.Method}@{ev.Class.Name}");
|
||||
Logger.LogInformation(">>> Synapse System 读取Event方法:{Event}\n>>>Synapse System 读取RPC方法:{Rpc}", events, rpcList);
|
||||
}
|
||||
}
|
||||
|
||||
public class RegisterItem
|
||||
{
|
||||
public string Key { get; set; }
|
||||
|
||||
public Type Class { get; set; }
|
||||
|
||||
public string Method { get; set; }
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netcoreapp3.1</TargetFramework>
|
||||
<OutputType>Library</OutputType>
|
||||
<PackOnBuild>true</PackOnBuild>
|
||||
<Version>0.1.0</Version>
|
||||
<Authors>xRain@YYTech</Authors>
|
||||
<Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
|
||||
<PackageId>YY-Tech.YYApi</PackageId>
|
||||
<IsPackable>true</IsPackable>
|
||||
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Folder Include="Helpers\" />
|
||||
<Folder Include="Communications\" />
|
||||
<Folder Include="Controllers\" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<Content Remove="Properties\launchSettings.json" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.0.0-rc4" />
|
||||
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.0.0-rc4" />
|
||||
</ItemGroup>
|
||||
<ProjectExtensions>
|
||||
<MonoDevelop>
|
||||
<Properties>
|
||||
<Policies>
|
||||
<DotNetNamingPolicy ResourceNamePolicy="FileFormatDefault" DirectoryNamespaceAssociation="PrefixedHierarchical" />
|
||||
</Policies>
|
||||
</Properties>
|
||||
</MonoDevelop>
|
||||
</ProjectExtensions>
|
||||
</Project>
|
||||
Reference in New Issue
Block a user