C#怎么实现WebAPI返回统一格式 C#如何封装统一的API响应格式包含状态码消息和数据【框架】

老伟吖_9945

老伟吖_9945

2026-04-09

962人浏览

原创

直接用 actionresult 不够用,因其不提供统一的 code、message、data 响应结构,无法满足前端对业务状态码和标准化格式的需求。

c#怎么实现webapi返回统一格式 c#如何封装统一的api响应格式包含状态码消息和数据【框架】

为什么直接用 ActionResult<t></t> 不够用

因为前端需要稳定结构:每次响应都得带 code、message、data,而原生 ActionResult<t></t> 或 IActionResult 返回的是裸数据或 HTTP 状态码,不带业务状态码(比如 20001 表示参数错误),也不统一包裹 message。硬塞到控制器里手动 new 包装对象,重复代码多、易漏、难维护。

定义泛型响应类要避开三个坑

常见错误是把 code 设成 int 却没约定含义,或者让 data 为 object 导致序列化丢失泛型信息,又或者忘了处理 null 数据时的默认值。

  • code 建议用 int,但必须配套静态类(如 ApiResultCode)定义常量,避免魔数散落
  • data 必须声明为 TData 泛型字段,不是 object;否则反序列化时前端拿不到真实类型推导
  • 构造函数里对 data = default 要显式允许 null(尤其 TData 是值类型时),可加 where TData : class 或用可空泛型约束

示例精简版:

public class ApiResult<tdata>
{
    public int Code { get; set; }
    public string Message { get; set; } = string.Empty;
    public TData? Data { get; set; }

    public static ApiResult<tdata> Success(TData? data = default, string message = "OK") =>
        new() { Code = 200, Message = message, Data = data };

    public static ApiResult<tdata> Fail(int code, string message) =>
        new() { Code = code, Message = message };
}</tdata></tdata></tdata>

全局统一包装需绕过 ObjectResult 的自动转换

ASP.NET Core 默认把返回值直接序列化为 JSON,不会走你写的 ApiResult<t></t> 构造逻辑。想让所有 return Ok(xxx) 都变成 ApiResult.Success(xxx),不能靠中间件改响应体(太晚、已序列化),得在模型绑定后、序列化前拦截。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 最稳的方式是自定义 ActionFilter,重写 OnResultExecutionAsync
  • 只包装 ObjectResult 和 OkObjectResult,跳过 EmptyResult、StatusCodeResult 等原生状态响应
  • 注意判断 result.Value 是否已是 ApiResult 类型,避免套娃包装

关键逻辑节选:

if (result.Result is ObjectResult objectResult && 
    objectResult.Value != null && 
    objectResult.Value.GetType() != typeof(ApiResult))
{
    var genericType = typeof(ApiResult).MakeGenericType(objectResult.Value.GetType());
    var successMethod = typeof(ApiResult).GetMethod("Success").MakeGenericMethod(objectResult.Value.GetType());
    var wrapped = successMethod.Invoke(null, new[] { objectResult.Value, "OK" });
    context.Result = new OkObjectResult(wrapped);
}

异常也要进统一格式,但别吞掉 StatusCode

用 UseExceptionHandler 中间件捕获异常时,如果直接返回 ApiResult.Fail(500, ex.Message),HTTP 状态码仍是 200 —— 因为中间件默认用 OkObjectResult。前端靠状态码做网络层判断,不能丢。

  • 手动 new ObjectResult(new ApiResult<object>(...))</object> 并设置 StatusCode 字段
  • 或更干净地:抛出自定义异常(如 BusinessException),在 filter 里统一 catch 并映射到对应 code 和 StatusCode
  • 特别注意 ValidationException:ModelBinding 失败时走的是 BadRequestObjectResult,要单独适配,不然校验失败也返回 200 + 错误 code

真正容易被忽略的是:前端可能同时依赖 HTTP 状态码(如 401 跳登录)和业务 code(如 40001 表示 token 过期),两者得共存,不能只靠一个。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

952

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2711

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

865

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2615

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

292

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

389

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

309

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习