api model use record

This commit is contained in:
2023-03-28 06:33:48 +08:00
parent b5e4d57772
commit 4d0f8e20a6
8 changed files with 68 additions and 175 deletions
+5 -21
View File
@@ -1,39 +1,23 @@
using System; namespace SimApi.Communications
namespace SimApi.Communications
{ {
/// <summary> /// <summary>
/// 只有ID的请求 /// 只有ID的请求
/// </summary> /// </summary>
public class SimApiIdOnlyRequest public record SimApiIdOnlyRequest(int Id);
{
public int Id { get; set; }
}
/// <summary> /// <summary>
/// 只有ID的请求(字符串) /// 只有ID的请求(字符串)
/// </summary> /// </summary>
public class SimApiStringIdOnlyRequest public record SimApiStringIdOnlyRequest(string Id);
{
public string Id { get; set; }
}
/// <summary> /// <summary>
/// 动态类型单字段请求 /// 动态类型单字段请求
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class SimApiOneFieldRequest<T> public record SimApiOneFieldRequest<T>(T Data);
{
public T Data { get; set; }
}
/// <summary> /// <summary>
/// 基础分页请求 /// 基础分页请求
/// </summary> /// </summary>
public class SimApiBasePageRequest public record SimApiBasePageRequest(int Page, int Count);
{
public int Page { get; set; }
public int Count { get; set; }
}
} }
+33 -92
View File
@@ -7,82 +7,38 @@ namespace SimApi.Communications
/// <summary> /// <summary>
/// 基础相应 /// 基础相应
/// </summary> /// </summary>
public class SimApiBaseResponse public record SimApiBaseResponse(int Code = 200, string Message = "成功")
{ {
/// <summary>
/// 错误代码
/// </summary>
public int Code { get; set; }
/// <summary>
/// 错误描述
/// </summary>
public string Message { get; set; }
/// <summary> /// <summary>
/// 默认错误代码对应提示信息 /// 默认错误代码对应提示信息
/// </summary> /// </summary>
private readonly Dictionary<int, string> MsgBox = new Dictionary<int, string>() private static readonly Dictionary<int, string> MsgBox = new()
{ {
{200, "成功"}, {
{204, "没有数据"}, 200, "成功"
{400, "参数错误"}, },
{401, "需要登录"}, {
{403, "无权访问"}, 204, "没有数据"
{404, "接口不存在"}, },
{500, "服务器错误"} {
400, "参数错误"
},
{
401, "需要登录"
},
{
403, "无权访问"
},
{
404, "接口不存在"
},
{
500, "服务器错误"
}
}; };
/// <summary> public SimApiBaseResponse(int code) : this(code, MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误")
/// 返回一个成功的空结果
/// </summary>
public SimApiBaseResponse()
{ {
SetCode(200);
}
/// <summary>
/// 返回指定代码的描述
/// </summary>
/// <param name="code">错误代码</param>
public SimApiBaseResponse(int code)
{
SetCode(code);
}
/// <summary>
/// 返回指定代码的结果,并自定义提示信息
/// </summary>
/// <param name="code">错误代码</param>
/// <param name="message">错误信息</param>
public SimApiBaseResponse(int code, string message)
{
SetCodeMsg(code, message);
}
/// <summary>
/// 设置响应结果的错误代码
/// </summary>
/// <param name="code">错误代码</param>
public void SetCode(int code)
{
Code = code;
Message = MsgBox.ContainsKey(code) ? MsgBox[code] : "未知错误";
}
/// <summary>
/// 设置响应结果的错误代码和错误描述
/// </summary>
/// <param name="code">错误代码</param>
/// <param name="message">错误描述</param>
public void SetCodeMsg(int code, string message)
{
SetCode(code);
if (!string.IsNullOrEmpty(message))
{
Message = message;
}
} }
/// <summary> /// <summary>
@@ -95,7 +51,10 @@ namespace SimApi.Communications
{ {
IgnoreReadOnlyProperties = true, IgnoreReadOnlyProperties = true,
PropertyNamingPolicy = JsonNamingPolicy.CamelCase, PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
Converters = {new JsonStringEnumConverter()} Converters =
{
new JsonStringEnumConverter()
}
}); });
} }
} }
@@ -104,32 +63,14 @@ namespace SimApi.Communications
/// 动态内容分页 /// 动态内容分页
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class SimApiBasePageResponse<T> : SimApiBaseResponse public record SimApiBasePageResponse<T>
{ (T List, int Page = 1, int Count = 1, int Total = 1, int Code = 200,
/// <summary> string Message = "成功") : SimApiBaseResponse(Code, Message);
/// 动态内容列表
/// </summary>
public T List { get; set; }
//当前页码
public int Page { get; set; }
//每页条数
public int Count { get; set; }
//总计条数
public int Total { get; set; }
}
/// <summary> /// <summary>
/// 动态Data返回 /// 动态Data返回
/// </summary> /// </summary>
/// <typeparam name="T"></typeparam> /// <typeparam name="T"></typeparam>
public class SimApiBaseResponse<T> : SimApiBaseResponse public record SimApiBaseResponse<T>(T Data, int Code = 200, string Message = "成功") : SimApiBaseResponse(Code,
{ Message);
/// <summary>
/// 动态内容列表
/// </summary>
public T Data { get; set; }
}
} }
+2 -11
View File
@@ -1,16 +1,7 @@
using System; namespace SimApi.Communications
namespace SimApi.Communications
{ {
/// <summary> /// <summary>
/// 登录信息中间件 /// 登录信息中间件
/// </summary> /// </summary>
public class SimApiLoginItem public record SimApiLoginItem(string Id, string[] Type);
{
//登录用户的ID
public string Id { get; set; }
//登录用户来源
public string[] Type { get; set; }
}
} }
+5 -7
View File
@@ -29,13 +29,11 @@ namespace SimApi.Controllers
{ {
if (!context.ModelState.IsValid) if (!context.ModelState.IsValid)
{ {
foreach (var item in context.ModelState.Values) foreach (var item in context.ModelState.Values.Where(item =>
item.ValidationState == ModelValidationState.Invalid))
{ {
if (item.ValidationState == ModelValidationState.Invalid) Error(400, item.Errors.First().ErrorMessage);
{ break;
Error(400, item.Errors.First().ErrorMessage);
break;
}
} }
} }
} }
@@ -83,7 +81,7 @@ namespace SimApi.Controllers
/// <returns></returns> /// <returns></returns>
protected SimApiBaseResponse<string> UploadFile() protected SimApiBaseResponse<string> UploadFile()
{ {
return new SimApiBaseResponse<string>(); return new SimApiBaseResponse<string>(null);
} }
} }
} }
+2 -7
View File
@@ -25,9 +25,7 @@ namespace SimApi.Controllers
[ApiExplorerSettings(IgnoreApi = true)] [ApiExplorerSettings(IgnoreApi = true)]
public SimApiBaseResponse ExceptionHandler(int code) public SimApiBaseResponse ExceptionHandler(int code)
{ {
var response = new SimApiBaseResponse(); return new SimApiBaseResponse(code);
response.SetCode(code);
return response;
} }
/// <summary> /// <summary>
@@ -38,10 +36,7 @@ namespace SimApi.Controllers
public SimApiBaseResponse<string> CheckLogin() public SimApiBaseResponse<string> CheckLogin()
{ {
ErrorWhenNull(LoginInfo, 401); ErrorWhenNull(LoginInfo, 401);
return new SimApiBaseResponse<string> return new SimApiBaseResponse<string>(LoginInfo.Id);
{
Data = LoginInfo.Id
};
} }
/// <summary> /// <summary>
+7 -12
View File
@@ -25,7 +25,10 @@ namespace SimApi.Helpers
/// <returns></returns> /// <returns></returns>
public string Login(string id, string type = "user", string token = null) public string Login(string id, string type = "user", string token = null)
{ {
return Login(id, new[] { type }, token); return Login(id, new[]
{
type
}, token);
} }
/// <summary> /// <summary>
@@ -36,15 +39,8 @@ namespace SimApi.Helpers
/// <returns></returns> /// <returns></returns>
public string Login(string id, string[] type, string uuid = null) public string Login(string id, string[] type, string uuid = null)
{ {
if (uuid == null) uuid ??= Guid.NewGuid().ToString();
{ var loginItem = new SimApiLoginItem(id, type);
uuid = Guid.NewGuid().ToString();
}
var loginItem = new SimApiLoginItem
{
Id = id,
Type = type
};
Cache.SetString(uuid, JsonSerializer.Serialize(loginItem)); Cache.SetString(uuid, JsonSerializer.Serialize(loginItem));
return uuid; return uuid;
} }
@@ -60,6 +56,5 @@ namespace SimApi.Helpers
Cache.Remove(uuid); Cache.Remove(uuid);
} }
} }
} }
} }
+4 -9
View File
@@ -47,14 +47,9 @@ namespace SimApi.Middlewares
} }
catch (SimApiException ex) catch (SimApiException ex)
{ {
if (string.IsNullOrEmpty(ex.Message)) response = string.IsNullOrEmpty(ex.Message)
{ ? new SimApiBaseResponse(ex.Code)
response.SetCode(ex.Code); : new SimApiBaseResponse(ex.Code, ex.Message);
}
else
{
response.SetCodeMsg(ex.Code, ex.Message);
}
ErrorResponse(context, response); ErrorResponse(context, response);
} }
@@ -62,7 +57,7 @@ namespace SimApi.Middlewares
{ {
Log.LogError(ex.Message); Log.LogError(ex.Message);
Log.LogError(ex.StackTrace); Log.LogError(ex.StackTrace);
response.SetCodeMsg(500, ex.Message); response = new SimApiBaseResponse(500, ex.Message);
ErrorResponse(context, response); ErrorResponse(context, response);
} }
} }
+10 -16
View File
@@ -32,15 +32,12 @@ namespace SimApi.Models
x.PropertyType x.PropertyType
}) })
.ToDictionary(x => x.Name, x => x.PropertyType); .ToDictionary(x => x.Name, x => x.PropertyType);
foreach (var sp in sourceProps) 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)?
if (targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] && .SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
(!MapperIgnoreField.Contains(sp.Key) || mapAll))
{
GetType().GetProperty(sp.Key)?
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
}
} }
UpdateTime(); UpdateTime();
@@ -64,15 +61,12 @@ namespace SimApi.Models
x.PropertyType x.PropertyType
}) })
.ToDictionary(x => x.Name, x => x.PropertyType); .ToDictionary(x => x.Name, x => x.PropertyType);
foreach (var sp in sourceProps) foreach (var sp in sourceProps.Where(sp =>
targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] &&
mapFields.Contains(sp.Key)))
{ {
//检查源对象不为空的属性是否在目标对象中存在 GetType().GetProperty(sp.Key)?
if (targetProps.ContainsKey(sp.Key) && sp.Value == targetProps[sp.Key] && .SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
mapFields.Contains(sp.Key))
{
GetType().GetProperty(sp.Key)?
.SetValue(this, source.GetType().GetProperty(sp.Key)?.GetValue(source));
}
} }
UpdateTime(); UpdateTime();