1.定义统一返回格式
namespace webapi; /// /// 统一数据响应格式 /// public class Results { /// /// 自定义的响应码,可以和http响应码一致,也可以不一致 /// public int Code { get; set; } /// /// 中文消息提示 /// public string? Msg { get; set; } /// /// 是否成功 /// public bool Success { get; set; } /// /// 响应的数据 /// public T? Data { get; set; } /// /// 返回的Token: 如果有值,则前端需要此这个值替旧的token值 /// public string? Token { get; set; } /// /// 设置数据的结果 /// /// 数据 /// public static Results DataResult(T data) { return new Results { Code = 1, Data = data, Msg = "请求成功", Success = true }; } /// /// 响应成功的结果 /// /// /// public static Results SuccessResult(string msg = "操作成功") { return new Results { Code = 1, Data = default, Msg = msg, Success = true }; } /// /// 响应失败的结果 /// /// /// public static Results FailResult(string msg = "请求失败") { return new Results { Code = -1, Data = default, Msg = msg, Success = false }; } /// /// 参数有误 /// /// /// public static Results InValidParameter(string msg = "参数有误") { return new Results { Code = -1, Data = default, Msg = msg, Success = false }; } /// /// 获取结果 /// /// /// /// /// /// public static Results GetResult(int code = 0, string? msg = null, T? data = default, bool success = true) { return new Results { Code = code, Data = data, Msg = msg, Success = success }; } /// /// 设置token结果 /// /// /// public static Results TokenResult(string token) { return new Results { Code = 1, Data = default, Msg = "请求成功", Success = true, Token = token }; } }
2.定义异常过滤器
using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.AspNetCore.Mvc; namespace webapi { /// /// 全局异常过滤器 /// public class ExceptionFilter : Attribute, IExceptionFilter { private readonly ILogger _logger; public ExceptionFilter(ILogger logger) { _logger = logger; } /// /// 当发生异常的时候会执行此方法 /// /// /// public void OnException(ExceptionContext context) { var values = context.RouteData.Values; var controller = values["controller"]; var action = values["action"]; _logger.LogError($"控制器:{controller},方法:{action},详细信息:\n"); WriteDetailErrorMsg(context.Exception); context.Result = new JsonResult(Results.FailResult(context.Exception.Message)); } /// /// 递归获取内部异常信息 /// /// /// private void WriteDetailErrorMsg(Exception exception) { if (exception.InnerException != null) { _logger.LogError(exception.StackTrace + "\n\n"); WriteDetailErrorMsg(exception.InnerException); } else { _logger.LogError("报错:" + exception.Message); _logger.LogError("堆栈跟踪:" + exception.StackTrace); } } } }
3.在控制器注入自定义的异常过滤器
builder.Services.AddControllers(opt => { opt.Filters.Add(); });
4.定义一个错误的api接口
[HttpDelete] public ActionResult Detele() { int i = 0;//除数不能为0; return Content((1 / i).ToString()); }
5.访问api接口
错误信息全记录到了,并输出到控制台,这里可以记录日志到文本文件或数据库。