快捷導(dǎo)航

Java設(shè)計通用的返回數(shù)據(jù)格式過程講解

更新時間：2023年05月17日 10:34:29 作者：shenzhenNBA

現(xiàn)在很多的項目server端返回client端的數(shù)據(jù)多數(shù)以JSON格式返回，同時結(jié)合其它需要，通常加一下狀態(tài)碼和信息之類，給前端處理帶來很大的方便，這篇文章就用Java設(shè)計了通用的返回數(shù)據(jù)格式，感興趣的同學(xué)可以參考下文

相信在做B/S模式的項目時，我們請求server端時通常遇到返回數(shù)據(jù)的處理，對返回數(shù)據(jù)的格式處理方式多樣，隨著JSON的流行，現(xiàn)在很多的項目server端返回client端的數(shù)據(jù)多數(shù)以JSON格式返回，同時結(jié)合其它需要，通常加一下狀態(tài)碼和信息之類，給前端處理帶來很大的方便，那我們今天就來看看一種通用返回結(jié)果的設(shè)計和應(yīng)用；

一，通用返回結(jié)果的信息類

這個主要是做返回結(jié)果信息的載體類，含有關(guān)鍵的結(jié)果代碼，結(jié)果信息，結(jié)果數(shù)據(jù)，基本滿足前端的需要關(guān)鍵信息，其中數(shù)據(jù)以泛型使其可以保存任意數(shù)據(jù)類型，通用代碼如下：

public class ResultInfo<T> {
	//通用返回信息對象類
	private int code;   //返回狀態(tài)碼
	private String msg;	//返回信息
	private T data;     //返回數(shù)據(jù)
	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...
}

二，通用返回結(jié)果信息的方法類

提供各種通用的返回方法，以便在Controller層直接使用，通常設(shè)計如下：

public class Result {
	//通用返回結(jié)果的方法類
	private static final int okCode = 0;
	private static final int failCode = 1;
	private static final String okMsg = "操作成功";
	private static final String failMsg = "操作失敗";
	//以上這些通?？梢远x為一種枚舉類，然后使用
	//成功返回方法
	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
* 通用返回結(jié)果的應(yīng)用
*/
@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("失敗，參數(shù)異常");  //通用方法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("保存失敗，過程出現(xiàn)異常");
		}		
	}
	/**
	* 根據(jù)記錄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("查詢失敗，過程出現(xiàn)異常",null); //通用方法Fail()使用
		}
	}	
}

后記，項目主要框架代碼，不全，但可以很清楚看清設(shè)計和使用了

到此這篇關(guān)于Java設(shè)計通用的返回數(shù)據(jù)格式過程講解的文章就介紹到這了,更多相關(guān)Java返回數(shù)據(jù)格式內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: