Java设计通用的返回数据格式过程讲解
作者：shenzhenNBA
现在很多的项目server端返回client端的数据多数以JSON格式返回，同时结合其它需要，通常加一下状态码和信息之类，给前端处理带来很大的方便，这篇文章就用Java设计了通用的返回数据格式，感兴趣的同学可以参考下文
相信在做B/S模式的项目时，我们请求server端时通常遇到返回数据的处理，对返回数据的格式处理方式多样，随着JSON的流行，现在很多的项目server端返回client端的数据多数以JSON格式返回，同时结合其它需要，通常加一下状态码和信息之类，给前端处理带来很大的方便，那我们今天就来看看一种通用返回结果的设计和应用；
一，通用返回结果的信息类
这个主要是做返回结果信息的载体类，含有关键的结果代码，结果信息，结果数据，基本满足前端的需要关键信息，其中数据以泛型使其可以保存任意数据类型，通用代码如下：
public class ResultInfo<T> {
//通用返回信息对象类
private int code; //返回状态码
private String msg; //返回信息
private T data; //返回数据
public ResultInfo<T> setCode(int code){
this.code = code;
return this;
}
public int getCode(){
return this.code;
}
public ResultInfo<T> setMsg(String msg){
this.msg = msg;
return this;
}
public String getMsg(){
return this.msg;
}
public ResultInfo<T> setData(T data){
this.data = data;
return this;
}
public T getData(){
return this.data;
}
//more functon here...
}二，通用返回结果信息的方法类
提供各种通用的返回方法，以便在Controller层直接使用，通常设计如下：
public class Result {
//通用返回结果的方法类
private static final int okCode = 0;
private static final int failCode = 1;
private static final String okMsg = "操作成功";
private static final String failMsg = "操作失败";
//以上这些通常可以定义为一种枚举类，然后使用
//成功返回方法
public static <T> ResultInfo<T> Ok(){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(okCode).setMsg(okMsg);
return r;
}
public static <T> ResultInfo<T> Ok(String msg){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(okCode).setMsg(msg);
return r;
}
public static <T> ResultInfo<T> Ok(T data){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(okCode).setMsg(okMsg).setData(data);
return r;
}
public static <T> ResultInfo<T> Ok(String msg, T data){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(okCode).setMsg(msg).setData(data);
return r;
}
//失败返回方法
public static <T> ResultInfo<T> Fail(){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(failCode).setMsg(failMsg);
return r;
}
public static <T> ResultInfo<T> Fail(String msg){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(failCode).setMsg(msg);
return r;
}
public static <T> ResultInfo<T> Fail(T data){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(failCode).setMsg(failMsg).setData(data);
return r;
}
public static <T> ResultInfo<T> Fail(String msg, T data){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(failCode).setMsg(msg).setData(data);
return r;
}
//通用返回方法
public static <T> ResultInfo<T> result(int code, String msg){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(code).setMsg(msg);
return r;
}
public static <T> ResultInfo<T> result(int code, String msg, T data){
ResultInfo<T> r = new ResultInfo<T>();
r.setCode(code).setMsg(msg).setData(data);
return r;
}
}三，在Controller层中的使用
package com.xxx.yyy.zzz.controller;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.xxx.yyy.zzz.util.ResultInfo;
import com.xxx.yyy.zzz.util.Result;
import com.xxx.yyy.zzz.model.User;
import com.xxx.yyy.zzz.service.UserService;
import org.springframework.stereotype.Controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResquestBody;
// more import ...
/**
* 用户对外API
* @author shenzhenNBA
* @since 2020.03.05
* 通用返回结果的应用
*/
@RequestMapping("/user")
@Controller
public class UserController {
private static Log Logger = LogFactory.getLog(UserController.class);
@Autowired
UserService userService; //需另外定义,此处省略
/**
* 保存用户,
* 返回格式: {"code":xx,"msg":"yyy","data":null}
*/
@PostMapping(value="/save")
@ResponseBody
public ResultInfo<String> saveUser(@RequestBody User param){
try{
int num = userService.saveUser(param);
if (0 == num) {
return Ok("保存成功"); //通用方法Ok()使用
} else if (1 == num) {
return Fail("失败，参数异常"); //通用方法Fail()使用
} else if (2 == num) {
return Fail("失败，保持操作失败");
} else {
return Fail("失败，未知异常");
}
} catch (Exception e) {
Logger.error("controller UserController.saveUser() error, param: {}, info: {}", param, e)
return Fail("保存失败，过程出现异常");
}
}
/**
* 根据记录ID获取用户记录信息,
* 返回格式: {"code":xx,"msg":"yyy","data":User对象JSON格式字符串}
*/
@PostMapping(value="/getById")
@ResponseBody
public ResultInfo<User> getById(@RequestBody UserParam param){
try{
User user = userService.getById(param);
return Ok("查询成功", user); //通用方法Ok()使用
} catch (Exception e) {
Logger.error("controller UserController.getById() error, param: {}, info: {}", param, e)
return Fail("查询失败，过程出现异常",null); //通用方法Fail()使用
}
}
}后记，项目主要框架代码，不全，但可以很清楚看清设计和使用了
到此这篇关于Java设计通用的返回数据格式过程讲解的文章就介绍到这了,更多相关Java返回数据格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！