Python 官方文档:入门教程 => 点击学习
目录一、目标二、为什么要对SpringBoot的接口返回值统一标准格式?第一种格式:response为String第二种格式:response为Objct第三种格式:response
response统一格式
我们先来看下,springboot默认情况下的response是什么格式的
@GetMapping(value="/getStr")
public String getStr( ){
return "test";
}
以上springboot的返回值为
test
@GetMapping(value="/getObject")
public UserVO getObject( ){
UserVO vo=new UserVO();
vo.setUsername("agan");
return vo;
}
以上springboot的返回值为
{
"id": null,
"username": "agan",
"passWord": null,
"email": null,
"phone": null,
"idCard": null,
"sex": null,
"deleted": null,
"updateTime": null,
"createTime": null
}
@GetMapping(value="/empty")
public void empty( ){
}
以上springboot的返回值为空
@GetMapping(value="/error")
public void error( ){
int i=9/0;
}
以上springboot的返回值为空
{
"timestamp": "2019-09-07T10:35:56.658+0000",
"status": 500,
"error": "Internal Server Error",
"message": "/ by zero",
"path": "/user/error"
}
以上4种,情况,如果你和客户端(app h5)开发人联调接口,他们会很懵逼,因为你给他们的接口没有一个统一的格式,客户端开发人员,不知道如何处理返回值。
故,我们应该统一response的标准格式。
一般的response的标准格式包含3部分:
1.status状态值:代表本次请求response的状态结果。
2.response描述:对本次状态码的描述。
3.data数据:本次返回的数据。
{
"status":0,
"desc":"成功",
"data":"test"
}
对response的统一封装,是有一定的技术含量的,我们先来看下,初级程序员的封装,网上很多教程都是这么写的。
{
"status":0,
"desc":"成功",
"data":"test"
}
把以上格式转换为Result代码
@AllArgsConstructor
@NoArgsConstructor
@Data
public class Result<T> {
private Integer status;
private String desc;
private T data;
public static Result suc() {
Result result = new Result();
result.setResultCode(ResultCode.SUCCESS);
return result;
}
public static Result suc(Object data) {
Result result = new Result();
result.setResultCode(ResultCode.SUCCESS);
result.setData(data);
return result;
}
public static Result fail(Integer status, String desc) {
Result result = new Result();
result.setStatus(status);
result.setDesc(desc);
return result;
}
public static Result fail(ResultCode resultCode) {
Result result = new Result();
result.setResultCode(resultCode);
return result;
}
private void setResultCode(ResultCode code) {
this.status = code.code();
this.desc = code.message();
}
}
public enum ResultCode {
SUCCESS(0, "成功"),
SYSTEM_ERROR(10000, "系统异常,请稍后重试"),
UNAUTHORIZED(10401, "签名验证失败"),
PARAM_IS_INVALID(10001, "参数无效"),
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;
}
}
@api(description = "用户接口")
@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {
@GetMapping(value="/getResult")
public Result getResult( ){
return Result.suc("test");
}
}
结论:看到这里,应该有很多同学都知道这样封装代码有很大弊端。
因为今后你每写一个接口,都要手工指定Result.suc()这行代码,多累啊??
如果你写这种代码推广给你整个公司用,然后硬性规定代码必须这么写!!所有程序都会吐槽鄙视!!!!
如果你在公司推广你的编码规范,为了避免被公司其他程序员吐槽和鄙视,我们必须优化代码。
优化的目标:不要每个接口都手工指定Result返回值。
springboot提供了ResponseBodyAdvice来帮我们处理
ResponseBodyAdvice的作用:拦截Controller方法的返回值,统一处理返回值/响应体,一般用来做response的统一格式、加解密、签名等等。
先看下ResponseBodyAdvice这个接口的源码。
public interface ResponseBodyAdvice<T> {
boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);
@Nullable
T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
}
@ControllerAdvice(basePackages = "com.agan.boot")
public class ResponseHandler implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
return true;
}
@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个地方需要重点讲解:
@ControllerAdvice这是一个非常有用的注解,它的作用是增强Controller的扩展功能类。
那@ControllerAdvice对Controller增强了哪些扩展功能呢?主要体现在2方面:
在使用@ControllerAdvice时,还要特别注意,加上basePackages,
@ControllerAdvice(basePackages = “com.agan.boot”)
因为如果不加的话,它可是对整个系统的Controller做了扩展功能,
它会对某些特殊功能产生冲突,例如 不加的话,在使用swagger时会出现空白页异常。
if (o instanceof String) {
return JsonUtil.object2Json(ResResult.suc(o));
}
以上代码一定要加,因为Controller的返回值为String的时候,它是直接返回String,不是json,
故我们要手工做下json转换处理
以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。
--结束END--
本文标题: 关于springboot的接口返回值统一标准格式
本文链接: https://www.lsjlt.com/news/148001.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑,方便收藏和打印~
2024-03-01
2024-03-01
2024-03-01
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
2024-02-29
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
0