自定义返回结果

说明

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

默认实现

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

• 返回的数据格式如下：

public class DefaultShenyuEntity implements Serializable {
    private static final long serialVersionUID = -2792556188993845048L;
    private Integer code;
    private String message;
    private Object data;
}

• 返回的 json 格式如下：

{    "code": -100, //返回码,    "message": "您的参数错误,请检查相关文档!", //提示字段    "data": null  // 具体的数据}

扩展

• 新增一个类 CustomShenyuResult 实现 org.apache.shenyu.plugin.api.result.ShenyuResult

/** * The interface shenyu result. */public interface ShenyuResult<T> {
    /**     * The response result.     *     * @param exchange the exchange     * @param formatted the formatted object     * @return the result object     */    default Object result(ServerWebExchange exchange, Object formatted) {        return formatted;    }
    /**     * format the origin, default is json format.     *     * @param exchange the exchange     * @param origin the origin     * @return format origin     */    default Object format(ServerWebExchange exchange, Object origin) {        // basic data        if (ObjectTypeUtils.isBasicType(origin)) {            return origin;        }        // error result or rpc origin result.        return JsonUtils.toJson(origin);    }
    /**     * the response context type, default is application/json.     *     * @param exchange the exchange     * @param formatted the formatted data that is origin data or byte[] convert string     * @return the context type     */    default MediaType contentType(ServerWebExchange exchange, Object formatted) {        return MediaType.APPLICATION_JSON;    }
    /**     * Error t.     *     * @param code    the code     * @param message the message     * @param object  the object     * @return the t     */    T error(int code, String message, Object object);}

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

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

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

@Beanpublic ShenyuResult<?> customShenyuResult() {    return new CustomShenyuResult();}