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