自定义返回结果

说明

  • 本文介绍基于 Apache ShenYu 网关返回自定义的数据格式。
  • 网关需要统一的返回格式，如果需要自己定义格式，可以进行扩展。

默认实现

  • 默认的实现为 org.apache.shenyu.plugin.api.result.DefaultShenyuResult

  • 返回的数据格式如下：

  1. public class DefaultShenyuEntity implements Serializable {
  4.     private static final long serialVersionUID = -2792556188993845048L;
  7.     private Integer code;
  10.     private String message;
  13.     private Object data;
  16. }
  • 返回的 json 格式如下：
  1. {
  2.     "code": -100, //返回码,
  3.     "message": "您的参数错误,请检查相关文档!", //提示字段
  4.     "data": null  // 具体的数据
  5. }

扩展

  • 新增一个类 CustomShenyuResult 实现 org.apache.shenyu.plugin.api.result.ShenyuResult
  1. /**
  2.  * The interface shenyu result.
  3.  */
  4. public interface ShenyuResult<T> {
  7.     /**
  8.      * The response result.
  9.      *
  10.      * @param exchange the exchange
  11.      * @param formatted the formatted object
  12.      * @return the result object
  13.      */
  14.     default Object result(ServerWebExchange exchange, Object formatted) {
  15.         return formatted;
  16.     }
  19.     /**
  20.      * format the origin, default is json format.
  21.      *
  22.      * @param exchange the exchange
  23.      * @param origin the origin
  24.      * @return format origin
  25.      */
  26.     default Object format(ServerWebExchange exchange, Object origin) {
  27.         // basic data
  28.         if (ObjectTypeUtils.isBasicType(origin)) {
  29.             return origin;
  30.         }
  31.         // error result or rpc origin result.
  32.         return JsonUtils.toJson(origin);
  33.     }
  36.     /**
  37.      * the response context type, default is application/json.
  38.      *
  39.      * @param exchange the exchange
  40.      * @param formatted the formatted data that is origin data or byte[] convert string
  41.      * @return the context type
  42.      */
  43.     default MediaType contentType(ServerWebExchange exchange, Object formatted) {
  44.         return MediaType.APPLICATION_JSON;
  45.     }
  48.     /**
  49.      * Error t.
  50.      *
  51.      * @param code    the code
  52.      * @param message the message
  53.      * @param object  the object
  54.      * @return the t
  55.      */
  56.     T error(int code, String message, Object object);
  57. }

处理顺序：format->contextType->result。format方法进行数据的格式化，若数据为基本类型返回自身，其他类型转换为JSON，参数origin为原始数据，可根据情况执行格式化处理。contextType，若是基本类型，使用text/plain，默认为application/json，参数formatted为format方法处理之后的数据，可结合format的返回结果进行数据类型的自定义处理。result的参数formatted为format方法处理之后的数据，默认返回自身，可结合format的返回结果进行数据类型的自定义处理。

  • 其中泛型 T 为自定义的数据格式，返回它就好。

  • 把你新增的实现类注册成为Spring的bean，如下：

  1. @Bean
  2. public ShenyuResult<?> customShenyuResult() {
  3.     return new CustomShenyuResult();
  4. }