SpringBoot如何统一JSON信息返回
SpringBoot统一JSON信息返回
调用后端服务后的返回结果有多种类型
如:String
,Integer
,Boolean
,List
,Map
等,
在一个项目中,为了保持统一性,我们方法返回结果可以全部使用JSON
数据格式
如下:
{ "code":200, "msg":"成功", "data":"JSON数据" }
其中code
是本次请求处理结果对应的状态码,msg
是状态码对应的解释信息,data
是要返回的数据内容,可以是任意一个对象。
封装响应信息对象
public class ResponseEntity<T> implements Serializable { private static final long serialVersionUID = 3595741978061989861L; private Integer code;//状态码 private String msg;//状态码对应信息 private T data;//要返回的数据 public Integer getCode() { return code; } public void setCode(Integer code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } public T getData() { return data; } public void setData(T data) { this.data = data; } }
状态码,Http
请求状态码有多种,使用枚举列举
如下示例:
public enum ResponseEnum { SUCCESS(200, "成功"), FAIL(-1, "失败"), ERROR_400(400, "错误的请求"), ERROR_404(404, "访问资源不存在"), ERROR_500(500, "服务器异常"); private Integer code; private String msg; ResponseEnum(Integer code, String msg) { this.code = code; this.msg = msg; } public Integer getCode() { return code; } public void setCode(Integer code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } }
创建一个公共类,生成响应对象
public class ResponseUtil { /** * 成功返回 * @param object 返回数据 * @return */ public static ResponseEntity success(Object object){ ResponseEntity resp = new ResponseEntity(); resp.setCode(ResponseEnum.SUCCESS.getCode()); resp.setMsg(ResponseEnum.SUCCESS.getMsg()); resp.setData(object); return resp; } /** * 成功返回 无数据 * @return */ public static ResponseEntity success(){ return success(null); } /** * 失败返回 * @param responseEnum 响应标识 * @return */ public static ResponseEntity error(ResponseEnum responseEnum){ ResponseEntity resp = new ResponseEntity(); resp.setCode(responseEnum.getCode()); resp.setMsg(responseEnum.getMsg()); return resp; } }
Spring
中的控制器可以用 @Controller
和 @RestController
注解来声明,其中@Controller
标识当前控制器是SpringMvc
的控制器,要返回JSON
对象数据,需要和@ResponseBody
注解联合使用;
@RestController
主要用来构建Restful
风格接口,返回客户端的请求数据,相当于同时使用@Controller
和@ResponseBody
注解。
创建Pojo包及对应的实体类
public class DemoEntity { private Integer id; private String name; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } }
创建控制器
- @Controller
@Controller public class DemoController { @RequestMapping(value = "/users", method= RequestMethod.GET) @ResponseBody public ResponseEntity users(){ List<DemoEntity> list = new ArrayList<DemoEntity>(); DemoEntity demo = new DemoEntity(); demo.setId(1); demo.setName("蜗牛"); list.add(demo); DemoEntity demo1 = new DemoEntity(); demo1.setId(2); demo1.setName("葡萄"); list.add(demo1); return ResponseUtil.success(list); } }
测试:
启动服务后,在浏览器地址栏输入http://localhost:8080/users
,可以看到页面上的输出信息
{"code":200,"msg":"成功","data":[{"id":1,"name":"蜗牛"},{"id":2,"name":"葡萄"}]}
- @RestController
@RestController public class DemoRestController { @RequestMapping(value = "/users1", method= RequestMethod.GET) public ResponseEntity users(){ List<DemoEntity> list = new ArrayList<DemoEntity>(); DemoEntity demo = new DemoEntity(); demo.setId(1); demo.setName("蜗牛"); list.add(demo); DemoEntity demo1 = new DemoEntity(); demo1.setId(2); demo1.setName("葡萄"); list.add(demo1); return ResponseUtil.success(list); } }
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
Spring cloud gateway设置context-path服务路由404排查过程
这篇文章主要介绍了Spring cloud gateway设置context-path服务路由404排查过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-08-08SpringBoot中的server.context-path的实现
本文主要介绍了SpringBoot中的server.context-path的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2024-08-08Java报错:Error:java: 程序包org.springframework.boot不存在解决办法
建完springboot项目时,点击启动,有可能会报错,下面这篇文章主要给大家介绍了关于Java报错:Error:java: 程序包org.springframework.boot不存在的解决办法,需要的朋友可以参考下2024-02-02
最新评论