// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
|
//
|
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
|
//
|
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
|
|
namespace Admin.NET.Plugin.GoView;
|
|
/// <summary>
|
/// GoView 规范化结果
|
/// </summary>
|
[UnifyModel(typeof(GoViewResult<>))]
|
public class GoViewResultProvider : IUnifyResultProvider
|
{
|
/// <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, errors: metadata.Errors));
|
}
|
|
/// <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));
|
}
|
|
/// <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, errors: metadata.ValidationResult));
|
}
|
|
/// <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:
|
await context.Response.WriteAsJsonAsync(RESTfulResult(886, errors: "401 登录已过期，请重新登录"),
|
App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
|
break;
|
// 处理 403 状态码
|
case StatusCodes.Status403Forbidden:
|
await context.Response.WriteAsJsonAsync(RESTfulResult(statusCode, errors: "403 禁止访问，没有权限"),
|
App.GetOptions<JsonOptions>()?.JsonSerializerOptions);
|
break;
|
|
default: break;
|
}
|
}
|
|
/// <summary>
|
/// 返回 RESTful 风格结果集
|
/// </summary>
|
/// <param name="statusCode"></param>
|
/// <param name="succeeded"></param>
|
/// <param name="data"></param>
|
/// <param name="errors"></param>
|
/// <returns></returns>
|
private static GoViewResult<object> RESTfulResult(int statusCode, bool succeeded = default, object data = default, object errors = default)
|
{
|
return new GoViewResult<object>
|
{
|
Code = statusCode,
|
Msg = errors is null or string ? (errors + "") : JSON.Serialize(errors),
|
Data = data,
|
Count = data != null && data.GetType().IsGenericType && data.GetType().GetGenericTypeDefinition() == typeof(List<>) ? ((IList)data).Count : null
|
};
|
}
|
}
|
|
/// <summary>
|
/// GoView 返回结果
|
/// </summary>
|
/// <typeparam name="T"></typeparam>
|
public class GoViewResult<T>
|
{
|
/// <summary>
|
/// 状态码
|
/// </summary>
|
public int Code { get; set; }
|
|
/// <summary>
|
/// 信息
|
/// </summary>
|
public string Msg { get; set; }
|
|
/// <summary>
|
/// 数据
|
/// </summary>
|
public T Data { get; set; }
|
|
/// <summary>
|
/// 总数
|
/// </summary>
|
public int? Count { get; set; }
|
}
|
