springboot接口返回xml,springboot定义接口

　　一.目标二。为什么要统一springboot的接口返回值的标准格式？第一种格式：response是字符串；第二种格式：response是Objct第三种格式：响应无效；第四种格式：响应为异常3；定义响应的标准格式4、初级程序员封装响应代码第一步：将标准格式转换成代码第二步：在枚举类中存储状态代码第三步：添加一个体验类5、高级程序员封装响应代码第一步：使用responseBodyAdvice技术实现响应的统一格式第二步：编写responseBodyAdvice的实现类。第一名：@ControllerAdvice评论第二名：beforeBodyWrite方法体的响应类型判断响应的统一格式。

　　00-1010找出为什么springboot，所有控制器的响应都要用统一的格式封装？学习用ResponseBodyAdvice接口和@ControllerAdvice进行注释

　　00-1010我们先来看看。springboot的默认响应是什么格式？

一、目标

@ get mapping(value=/getObject )public user VO getObject(){ user VO=new user VO()；VO . set username( agan )；返回VO；}上述springboot的返回值为

　　{ id: null，用户名 : agan ，密码 : null，电子邮件 : null，电话 : null， idCard: null，性别 : null，删除 : null，更新时间 : null，创建时间 : null}

　　00-1010 @ get mapping(value=/empty )public void empty(){ }上面springboot的返回值为null。

二、为什么要对springboot的接口返回值统一标准格式？

@ get mapping(value=/error )public void error(){ int I=9/0；}以上springboot的返回值为null。

　　{ 时间戳 : 2019-09-07t 10:35:56.658 0000 ，状态 : 500，错误 : 内部服务器错误，消息 : /由零，路径 3360 /用户/错误 }以上四种情况，如果你和客户端(app h5)开发者联合调试接口，会很困惑，因为没有统一

　　因此，我们应该统一回应的标准格式。

　　00-1010一般回复的标准格式由三部分组成：

　　1.status值：它表示这个请求响应的状态结果。

　　2 .响应描述：当前状态代码的描述。

　　3.data data:本次返回的数据。

　　{ 状态 33600， desc 3360 成功，数据 3360 测试 }

　　00-1010响应的统一封装有一定的技术含量。我们先来看看初级程序员的封装。网上很多教程都是这样写的。

　　lass="maodian">

步骤1：把标准格式转换为代码

{   "status":0,   "desc":"成功",   "data":"test"}

把以上格式转换为Result代码

@AllArgsConstructor@NoArgsConstructor@Datapublic class Result<T> {    /**     * 1.status状态值：代表本次请求response的状态结果。     */    private Integer status;    /**     * 2.response描述：对本次状态码的描述。     */    private String desc;    /**     * 3.data数据：本次返回的数据。     */    private T data;    /**     * 成功，创建ResResult：没data数据     */    public static Result suc() {        Result result = new Result();        result.setResultCode(ResultCode.SUCCESS);        return result;    }    /**     * 成功，创建ResResult：有data数据     */    public static Result suc(Object data) {        Result result = new Result();        result.setResultCode(ResultCode.SUCCESS);        result.setData(data);        return result;    }    /**     * 失败，指定status、desc     */    public static Result fail(Integer status, String desc) {        Result result = new Result();        result.setStatus(status);        result.setDesc(desc);        return result;    }    /**     * 失败，指定ResultCode枚举     */    public static Result fail(ResultCode resultCode) {        Result result = new Result();        result.setResultCode(resultCode);        return result;    }    /**     * 把ResultCode枚举转换为ResResult     */    private void setResultCode(ResultCode code) {        this.status = code.code();        this.desc = code.message();    }}

步骤2：把状态码存在枚举类里面

public enum ResultCode  {    /* 成功状态码 */    SUCCESS(0, "成功"),    /* 系统500错误*/    SYSTEM_ERROR(10000, "系统异常，请稍后重试"),    UNAUTHORIZED(10401, "签名验证失败"),    /* 参数错误：10001-19999 */    PARAM_IS_INVALID(10001, "参数无效"),    /* 用户错误：20001-29999*/    USER_HAS_EXISTED(20001, "用户名已存在"),    USER_NOT_FIND(20002, "用户名不存在");    private Integer code;    private String message;    ResultCode(Integer code, String message) {        this.code = code;        this.message = message;    }    public Integer code() {        return this.code;    }    public String message() {        return this.message;    }}

步骤3：加一个体验类

@Api(description = "用户接口")@RestController@RequestMapping("/user")@Slf4jpublic class UserController {    @GetMapping(value="/getResult")    public Result getResult(  ){        return Result.suc("test");    }}

结论：看到这里，应该有很多同学都知道这样封装代码有很大弊端。

　　因为今后你每写一个接口，都要手工指定Result.suc(）这行代码，多累啊？？

　　如果你写这种代码推广给你整个公司用，然后硬性规定代码必须这么写！！所有程序都会吐槽鄙视！！！！

五、高级程序员对response代码封装

如果你在公司推广你的编码规范，为了避免被公司其他程序员吐槽和鄙视，我们必须优化代码。

　　优化的目标：不要每个接口都手工指定Result返回值。

步骤1：采用ResponseBodyAdvice技术来实现response的统一格式

springboot提供了ResponseBodyAdvice来帮我们处理

　　ResponseBodyAdvice的作用：拦截Controller方法的返回值，统一处理返回值/响应体，一般用来做response的统一格式、加解密、签名等等。

　　先看下ResponseBodyAdvice这个接口的源码。

public interface ResponseBodyAdvice<T> {    /**     * 是否支持advice功能     * treu=支持，false=不支持     */    boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);    /**     *     * 处理response的具体业务方法     */    @Nullable    T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);}

步骤2：写一个ResponseBodyAdvice实现类

@ControllerAdvice(basePackages = "com.agan.boot")public class ResponseHandler implements ResponseBodyAdvice<Object> {    /**     * 是否支持advice功能     * treu=支持，false=不支持     */    @Override    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {        return true;    }    /**     *     * 处理response的具体业务方法     */    @Override    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {        if (o instanceof String) {            return JsonUtil.object2Json(Result.suc(o));        }        return Result.suc(o);    }}

以上代码，有2个地方需要重点讲解：

第1个地方：@ControllerAdvice 注解

@ControllerAdvice这是一个非常有用的注解，它的作用是增强Controller的扩展功能类。

　　那@ControllerAdvice对Controller增强了哪些扩展功能呢？主要体现在2方面：

　　对Controller全局数据统一处理，例如，我们这节课就是对response统一封装。对Controller全局异常统一处理，这个后面的课程会详细讲解。在使用@ControllerAdvice时，还要特别注意，加上basePackages,

@ControllerAdvice(basePackages = “com.agan.boot”)

因为如果不加的话，它可是对整个系统的Controller做了扩展功能，

　　它会对某些特殊功能产生冲突，例如不加的话，在使用swagger时会出现空白页异常。

第2个地方：beforeBodyWrite方法体的response类型判断

if (o instanceof String) {            return JsonUtil.object2Json(ResResult.suc(o));}

以上代码一定要加，因为Controller的返回值为String的时候，它是直接返回String,不是json，

　　故我们要手工做下json转换处理

　　以上为个人经验，希望能给大家一个参考，也希望大家多多支持盛行IT。

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。