java接⼝返回值_javaapi返回值的标准化详解
api返回值的标准化
例如
{"status":200,"message":"操作成功","data":"{\"id\":1,\"name\":\"张三\"}"}
封装返回对象
对象被封装在base.util.ResponseUtils类型下，返回值是标准的ResponseEntity对象，返回体进⾏了⼆次封装，主要有
status,messsage和data组成，返回⽅法有ok和okMessage，如果真是返回消息，不需要对象，可以选择使⽤okMessage，反之使⽤ok ⽅法。
封装的返回对象：
@Builder
@Getter
@NoArgsConstructor
@AllArgsConstructor
java接口有没有构造方法
static class ResponseBody {
private int status;
private String message;
private Object data;
}
httpError和我们封装的httpError
对于http error来说有很多种，基本可以定为code在400到500之间的，像客户端参数问题就是400- bad request,⽽没有认证就是401-Unauthorized，认证但没有对应的权限就是403-Forbidden，请求的
资源没有发现就是404-Not Found，请求⽅式错误(⽅法是post，你发起请求⽤了get)就是405- Method Not Allowed等。
使⽤标准http响应状态码
@GetMapping(GET_HTTP_ERROR)
ResponseEntity> getHttpError() throws IOException {
return ResponseEntity.badRequest().build();
}
@Test
public void getHttpError() throws Exception {
mockMvc
.perform(
get(LindDemo.GET_HTTP_ERROR)
.accept(MediaType.APPLICATION_JSON_UTF8))
.
andExpect(status().is(400));
}
响应的结果
MockHttpServletResponse:
Status = 400
Error message = null
Headers = {}
Content type = null
Body =
Forwarded URL = null
Redirected URL = null
Cookies = []
使⽤我们封装的status状态码
@GetMapping(GET_ERROR)
ResponseEntity> getError() throws IOException {
return ResponseUtils.badRequest("传⼊的参数⾮法！");
}
@Test
public void getError() throws Exception {
mockMvc
.perform(
get(LindDemo.GET_ERROR)
.
accept(MediaType.APPLICATION_JSON_UTF8))
.andExpect(status().isOk());
}
响应的结果
MockHttpServletResponse:
Status = 200
Error message = null
Headers = {Content-Type=[application/json;charset=UTF-8]}
Content type = application/json;charset=UTF-8
Body = {"status":400,"message":"传⼊的参数⾮法！","data":{}}
Forwarded URL = null
Redirected URL = null
Cookies = []
通过上⾯的响应结果可以看到，我们封装的请求httpcode还是200，只不过把请求错误400状态码写在了body
对象⾥，⽬前这种⽅法⽤的⽐较多，像⼀些第三⽅接⼝⽤的都是这种⽅式，他们会规定相应的响应规范。
总结
事实上，两种响应体都没有问题，关键在于开发之间的规则要确定，不要在项⽬⾥两者兼⽤！
以上所述是⼩编给⼤家介绍的java api返回值的标准化详解整合，希望对⼤家有所帮助，如果⼤家有任何疑问请给我留⾔，⼩编会及时回复⼤家的。在此也⾮常感谢⼤家对脚本之家⽹站的⽀持！

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。