// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
|
//
|
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
|
//
|
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
|
|
namespace Admin.NET.Core;
|
|
/// <summary>
|
/// 全局规范化结果
|
/// </summary>
|
[UnifyModel(typeof(AdminResult<>))]
|
public class AdminResultProvider : IUnifyResultProvider
|
{
|
/// <summary>
|
/// JWT 授权异常返回值
|
/// </summary>
|
/// <param name="context"></param>
|
/// <param name="metadata"></param>
|
/// <returns></returns>
|
public IActionResult OnAuthorizeException(DefaultHttpContext context, ExceptionMetadata metadata)
|
{
|
return new JsonResult(RESTfulResult(metadata.StatusCode, data: metadata.Data, msg: metadata.Errors), UnifyContext.GetSerializerSettings(context));
|
}
|
|
/// <summary>
|
/// 异常返回值
|
/// </summary>
|
/// <param name="context"></param>
|
/// <param name="metadata"></param>
|
/// <returns></returns>
|
public IActionResult OnException(ExceptionContext context, ExceptionMetadata metadata)
|
{
|
return new JsonResult(RESTfulResult(metadata.StatusCode, data: metadata.Data, msg: metadata.Errors), UnifyContext.GetSerializerSettings(context));
|
}
|
|
/// <summary>
|
/// 成功返回值
|
/// </summary>
|
/// <param name="context"></param>
|
/// <param name="data"></param>
|
/// <returns></returns>
|
public IActionResult OnSucceeded(ActionExecutedContext context, object data)
|
{
|
return new JsonResult(RESTfulResult(StatusCodes.Status200OK, true, data), UnifyContext.GetSerializerSettings(context));
|
}
|
|
/// <summary>
|
/// 验证失败返回值
|
/// </summary>
|
/// <param name="context"></param>
|
/// <param name="metadata"></param>
|
/// <returns></returns>
|
public IActionResult OnValidateFailed(ActionExecutingContext context, ValidationMetadata metadata)
|
{
|
return new JsonResult(RESTfulResult(metadata.StatusCode ?? StatusCodes.Status400BadRequest, data: metadata.Data, msg: metadata.ValidationResult), UnifyContext.GetSerializerSettings(context));
|
}
|
|
/// <summary>
|
/// 特定状态码返回值
|
/// </summary>
|
/// <param name="context"></param>
|
/// <param name="statusCode"></param>
|
/// <param name="unifyResultSettings"></param>
|
/// <returns></returns>
|
public async Task OnResponseStatusCodes(HttpContext context, int statusCode, UnifyResultSettingsOptions unifyResultSettings)
|
{
|
// 设置响应状态码
|
UnifyContext.SetResponseStatusCodes(context, statusCode, unifyResultSettings);
|
|
switch (statusCode)
|
{
|
// 处理 401 状态码
|
case StatusCodes.Status401Unauthorized:
|
var msg = "401 登录已过期，请重新登录";
|
// 若存在身份验证失败消息，则返回消息内容
|
if (context.Items.TryGetValue(SignatureAuthenticationDefaults.AuthenticateFailMsgKey, out var authFailMsg))
|
msg = authFailMsg + "";
|
await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, msg: msg),
|
App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
|
break;
|
// 处理 403 状态码
|
case StatusCodes.Status403Forbidden:
|
await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, msg: "403 禁止访问，没有权限"),
|
App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
|
break;
|
// 处理 302 状态码
|
case StatusCodes.Status302Found:
|
if (context.Response.Headers.TryGetValue("Location", out var redirectUrl))
|
{
|
context.Response.Redirect(redirectUrl);
|
}
|
else
|
{
|
var errorMessage = "302 跳转失败，没有提供 Location 头信息";
|
await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, msg: errorMessage),
|
App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
|
}
|
break;
|
}
|
}
|
|
/// <summary>
|
/// 返回成功结果集
|
/// </summary>
|
/// <param name="message"></param>
|
/// <param name="data"></param>
|
/// <returns></returns>
|
public static AdminResult<object> Ok(string message, object data = default)
|
{
|
return RESTfulResult(StatusCodes.Status200OK, true, data, message);
|
}
|
|
/// <summary>
|
/// 返回失败结果集
|
/// </summary>
|
/// <param name="message"></param>
|
/// <param name="code"></param>
|
/// <param name="data"></param>
|
/// <returns></returns>
|
public static AdminResult<object> Error(string message, int code = StatusCodes.Status400BadRequest, object data = default)
|
{
|
return RESTfulResult(code, false, data, message);
|
}
|
|
/// <summary>
|
/// 返回 RESTful 风格结果集
|
/// </summary>
|
/// <param name="statusCode"></param>
|
/// <param name="succeeded"></param>
|
/// <param name="data"></param>
|
/// <param name="msg"></param>
|
/// <returns></returns>
|
private static AdminResult<object> RESTfulResult(int statusCode, bool succeeded = default, object data = default, object msg = default)
|
{
|
//// 统一返回值脱敏处理
|
//if (data?.GetType() == typeof(String))
|
//{
|
// data = App.GetRequiredService<ISensitiveDetectionProvider>().ReplaceAsync(data.ToString(), '*').GetAwaiter().GetResult();
|
//}
|
//else if (data?.GetType() == typeof(JsonResult))
|
//{
|
// data = App.GetRequiredService<ISensitiveDetectionProvider>().ReplaceAsync(JSON.Serialize(data), '*').GetAwaiter().GetResult();
|
//}
|
|
return new AdminResult<object>
|
{
|
Code = statusCode,
|
Message = msg is null or string ? (msg + "") : JSON.Serialize(msg),
|
Result = data,
|
Type = succeeded ? "success" : "error",
|
Extras = UnifyContext.Take(),
|
Time = DateTime.Now
|
};
|
}
|
}
|
|
/// <summary>
|
/// 全局返回结果
|
/// </summary>
|
/// <typeparam name="T"></typeparam>
|
public class AdminResult<T>
|
{
|
/// <summary>
|
/// 状态码
|
/// </summary>
|
public int Code { get; set; }
|
|
/// <summary>
|
/// 类型success、warning、error
|
/// </summary>
|
public string Type { get; set; }
|
|
/// <summary>
|
/// 错误信息
|
/// </summary>
|
public string Message { get; set; }
|
|
/// <summary>
|
/// 数据
|
/// </summary>
|
public T Result { get; set; }
|
|
/// <summary>
|
/// 附加数据
|
/// </summary>
|
public object Extras { get; set; }
|
|
/// <summary>
|
/// 时间
|
/// </summary>
|
public DateTime Time { get; set; }
|
}
|
