Core

数据格式

Malagu 提供了一种开箱即用的方式,帮助使用者自动处理数据格式。

为了方便前端对后端接口返回值做统一处理,前端可能希望后端返回的结果格式是统一的,如果后端在每个接口处都做数据格式处理,显得繁琐而重复。或者基于 Malagu 框架提供的 ErrorHandler 和 View 接口做统一拦截处理。

如何配置数据格式

默认并没有开启统一数据格式功能。只有当我们配置了 malagu.mvc.jsonView.template 属性才会开启。默认 @malagu/mvc 组件提供了一个模式配置文件:malagu-json-wrapper.yml,所以我们只需要启用 json-wrapper 模式,则自动拥有了默认的统一数据格式,默认的数据格式如下:

# malagu.yml
malagu:
  mvc:
    jsonView:
      template: |
        {
          "message": "{{error}}",
          "success": {{success}},
          "data": {{model}}
        }

模版支持一些占位符,如下:

  1. {{model}} 接口的返回值
  2. {{success}} 接口是否调用成功(有误异常)
  3. {{error}} 错误信息,从 Error 对象的 message 中取
  4. {{code}} 错误吗,从 Error 对象的 code 或者 statusCode 中取

当然,你也可以在自己的属性配置文件中定义malagu.mvc.jsonView.template,也能开启统一数据格式功能。


Copyright © 2024 Zero (github@groupguanfang) 粤ICP备2023102563号