Java设计通用的返回数据格式过程讲解

 更新时间:2023年05月17日 10:34:29   作者: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返回数据格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot启动时运行代码详解

    springboot启动时运行代码详解

    在本篇内容中我们给大家整理了关于在springboot启动时运行代码的详细图文步骤以及需要注意的地方讲解,有兴趣的朋友们学习下。
    2019-06-06
  • SpringBoot快速实现接口消息加密的过程详解

    SpringBoot快速实现接口消息加密的过程详解

    在项目中,为了保证数据的安全,我们常常会对传递的数据进行加密,常用的加密算法包括对称加密(AES)和非对称加密(RSA),博主选取码云上最简单的API加密项目进行下面的讲解,需要的朋友可以参考下
    2023-11-11
  • Java使用ByteArrayOutputStream 和 ByteArrayInputStream 避免重复读取配置文件的方法

    Java使用ByteArrayOutputStream 和 ByteArrayInputStream 避免重复读取配置文

    这篇文章主要介绍了Java使用ByteArrayOutputStream 和 ByteArrayInputStream 避免重复读取配置文件的方法,需要的朋友可以参考下
    2015-12-12
  • FeignClientFactoryBean创建动态代理详细解读

    FeignClientFactoryBean创建动态代理详细解读

    这篇文章主要介绍了FeignClientFactoryBean创建动态代理详细解读,当直接进去注册的方法中,一步步放下走,都是直接放bean的定义信息中放入值,然后转成BeanDefinitionHolder,最后在注册到IOC容器中,需要的朋友可以参考下
    2023-11-11
  • Java并发编程示例(四):可控的线程中断

    Java并发编程示例(四):可控的线程中断

    这篇文章主要介绍了Java并发编程示例(四):可控的线程中断,在本节,我们将使用一个线程查找指定目录及其子目录下文件来演示通过使用InterruptedException异常控制线程中断,需要的朋友可以参考下
    2014-12-12
  • Spring Boot 整合 Reactor实例详解

    Spring Boot 整合 Reactor实例详解

    这篇文章主要为大家介绍了Spring Boot 整合 Reactor实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • Java实现List转换为Map的方法小结

    Java实现List转换为Map的方法小结

    这篇文章主要为大家详细介绍了Java实现List转换为Map的一些常见的方法,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下
    2024-03-03
  • 浅谈一下数据库连接池Druid德鲁伊

    浅谈一下数据库连接池Druid德鲁伊

    数据库连接池就是一个容器持有多个数据库连接,当程序需要操作数据库的时候直接从池中取出连接,使用完之后再还回去,和线程池一个道理,需要的朋友可以参考下
    2023-05-05
  • java获取用户输入的字符串方法

    java获取用户输入的字符串方法

    今天小编就为大家分享一篇java获取用户输入的字符串方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • 如何给HttpServletRequest增加消息头

    如何给HttpServletRequest增加消息头

    这篇文章主要介绍了如何给HttpServletRequest增加消息头的实现方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06

最新评论