自定义返回结果

说明

  • 本文介绍基于 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.  public interface ShenyuResult<T> {
  4.      /**
  5.       * Success t.
  6.       *
  7.       * @param code    the code
  8.       * @param message the message
  9.       * @param object  the object
  10.       * @return the t
  11.       */
  12.      T success(int code, String message, Object object);
  15.      /**
  16.       * Error t.
  17.       *
  18.       * @param code    the code
  19.       * @param message the message
  20.       * @param object  the object
  21.       * @return the t
  22.       */
  23.      T error(int code, String message, Object object);
  24.  }

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

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

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