造轮子之统一请求响应格式

合集 - Asp.Net Core造轮之旅：逐步构建自己的开发框架(38)

1.Asp.Net Core造轮之旅：逐步构建自己的开发框架-目录2023-07-242.asp.net core之Startup2023-07-243.asp.net core之依赖注入2023-07-254.asp.net core之中间件2023-07-265.asp.net core之Host2023-07-276.asp.net core之Kestrel2023-07-277.asp.net core之配置2023-07-278.asp.net core之Options2023-07-319.asp.net core之日志2023-08-0110.asp.net core之路由2023-08-0211.asp.net core之异常处理2023-08-0312.asp.net core之HttpClient2023-08-0413.asp.net core之实时应用2023-08-0414.asp.net core之EfCore2023-08-0715.造轮子之自动依赖注入2023-10-0816.造轮子之日志2023-10-0817.造轮子之统一业务异常处理2023-10-08

18.造轮子之统一请求响应格式2023-10-08

19.造轮子之缓存2023-10-0820.造轮子之ORM集成2023-10-0821.造轮子之asp.net core identity2023-10-0922.造轮子之自定义授权策略2023-10-0923.造轮子之权限管理2023-10-1024.造轮子之多语言管理2023-10-1125.造轮子之角色管理2023-10-1226.造轮子之用户管理2023-10-1227.造轮子之菜单管理2023-10-1228.造轮子之属性注入配合懒加载构建服务抽象基类2023-10-1229.造轮子之EventBus2023-10-1230.造轮子之消息实时推送2023-10-1331.造轮子之种子数据2023-10-1632.造轮子之集成GraphQL2023-10-1633.造轮子之设置管理2023-10-1934.造轮子之文件管理2023-10-2335.造轮子之单层应用总结篇2023-10-2636.单层应用升级到多层应用12024-01-2237.单层应用升级到多层应用22024-01-2238.单层应用升级到多层应用32024-01-23

收起

在上文中我们实现了统一业务异常处理，在异常响应中我们也使用了统一的响应格式返回给客户端。
接下来我们就讲一下约定统一的氢气响应格式。
在业务开发中，一个规范统一的请求响应格式可以提高我们的前后端开发对接效率，同时清晰的结构提高了可读性。

响应基类#

首先定义一个最基础的只提供Code和Message两个属性的基类

public class R
{
    public R()
    {
    }

    public R(string code, string message)
    {
        Code = code;
        Message = message;
    }

    public string Code { get; set; } = "0";
    public string Message { get; set; } = "success";

}

我们约定状态码0则是成功，Message成功默认为success。

泛型响应类#

业务请求中我们通常需要返回数据，所以一个统一格式泛型的响应类型就很有必要。我们直接继承R类型，添加一个泛型属性。

public class R<TData> : R
{
    public R(TData data) : base()
    {
        Data = data;
    }

    public TData Data { get; set; }
}

分页泛型响应类和分页请求基类#

除了我们普通的数据响应，我们很多情况也需要分页查询响应。那么单独构造一个分页专用泛型的响应类型和分页请求基类就很必要。

public class Page<TData> : R
{
    public Page(List<TData> data, long total) : base()
    {
        Data = data;
        Total = total;
    }

    public List<TData> Data { get; set; }
    public long Total { get; set; }
}

同样是继承R基类，添加一个泛型List属性和分页Total属性。
分页请求基类，我们分页请求大部分是固定的请求参数是页码，请求数据量，以及排序。所以我们把这三个属性抽象出来形成基类。后续复杂的分页业务查询即可继承此基类再额外增加查询条件。

public class PageRequest
{
    public int PageIndex { get; set; } = 1;
    public int PageSize { get; set; } = 10;
    public string OrderBy { get; set; } = "Id";
}

到这我们完成了我们基础的请求响应格式的统一。

轮子仓库地址https://github.com/Wheel-Framework/Wheel
欢迎进群催更。