java api返回值的标准化详解

  

  

        {“状态”:200年,“消息”:“操作成功”,“数据”:“{\ \“id”: 1, \“\”, \“张三\“}”}      

  

对象被封装在base.util.ResponseUtils类型下,返回值是标准的ResponseEntity对象,返回体进行了二次封装,主要有<代码>状态,<代码>消息和<代码> 数据组成,返回方法有好的和okMessage,如果真是返回消息,不需要对象,可以选择使用<代码> okMessage> 好>   

封装的返回对象:

        @Builder   @ getter   @NoArgsConstructor   @AllArgsConstructor   静态类ResponseBody {      私人int状态;   私人字符串消息;   私人对象数据;   }      

  

对于http错误来说有很多种,基本可以定为代码在400到500之间的,像客户端参数问题就是<代码> 400 -坏请求,而没有认证就是<代码> 401 -未经授权的> 403 -禁止>   资源没有发现就是<代码> 404 -未找到> 405 -方法不允许等。

  

使用标准http响应状态码

        @GetMapping (GET_HTTP_ERROR)   ResponseEntity<& # 63;比;getHttpError()抛出IOException {   .build返回ResponseEntity.badRequest () ();   }   @Test   公共空间getHttpError()抛出异常{   mockMvc   .perform (   get (LindDemo.GET_HTTP_ERROR)   .accept (MediaType.APPLICATION_JSON_UTF8))   .andExpect(状态(). (400));      }      

响应的结果

        MockHttpServletResponse:   状态=400   错误消息=零   头={}   内容类型=零   身体=转发URL=零   重定向URL=零   饼干=[]      

使用我们封装的状态状态码

        @GetMapping (GET_ERROR)   ResponseEntity<& # 63;比;getError()抛出IOException {   返回ResponseUtils.badRequest(“传入的参数非法!”);   }      @Test   公共空间getError()抛出异常{   mockMvc   .perform (   get (LindDemo.GET_ERROR)   .accept (MediaType.APPLICATION_JSON_UTF8))   .isOk .andExpect(状态()());      }      

响应的结果

        MockHttpServletResponse:   状态=200   错误消息=零   头={- type=(application/json; charset=utf - 8)}   内容类型application/json=; charset=utf - 8   身体={“状态”:400年,“消息”:“传入的参数非法!”,“数据”:{}}   转发URL=零   重定向URL=零   饼干=[]      

通过上面的响应结果可以看的到,我们封装的请求httpcode还是200,只不过把请求错误400年状态码写在了身体
  对象里,目前这种方法用的比较,多像一些第三方接口用的都是这种方式,他们会规定相应的响应规范。

  

<强>

  

事实上,两种响应体都没有问题,关键在于开发之间的规则要确定,不要在项目里两者兼用!

  

以上所述是小编给大家介绍的java api返回值的标准化详解整合,希望对大家有所帮助,如果大家有任何疑问请给我留的言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!

java api返回值的标准化详解