Java設(shè)計(jì)通用的返回?cái)?shù)據(jù)格式過(guò)程講解
相信在做B/S模式的項(xiàng)目時(shí),我們請(qǐng)求server端時(shí)通常遇到返回?cái)?shù)據(jù)的處理,對(duì)返回?cái)?shù)據(jù)的格式處理方式多樣,隨著JSON的流行,現(xiàn)在很多的項(xiàng)目server端返回client端的數(shù)據(jù)多數(shù)以JSON格式返回,同時(shí)結(jié)合其它需要,通常加一下?tīng)顟B(tài)碼和信息之類(lèi),給前端處理帶來(lái)很大的方便,那我們今天就來(lái)看看一種通用返回結(jié)果的設(shè)計(jì)和應(yīng)用;
一,通用返回結(jié)果的信息類(lèi)
這個(gè)主要是做返回結(jié)果信息的載體類(lèi),含有關(guān)鍵的結(jié)果代碼,結(jié)果信息,結(jié)果數(shù)據(jù),基本滿(mǎn)足前端的需要關(guān)鍵信息,其中數(shù)據(jù)以泛型使其可以保存任意數(shù)據(jù)類(lèi)型,通用代碼如下:
public class ResultInfo<T> { //通用返回信息對(duì)象類(lèi) private int code; //返回狀態(tài)碼 private String msg; //返回信息 private T data; //返回?cái)?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é)果信息的方法類(lèi)
提供各種通用的返回方法,以便在Controller層直接使用,通常設(shè)計(jì)如下:
public class Result { //通用返回結(jié)果的方法類(lèi) private static final int okCode = 0; private static final int failCode = 1; private static final String okMsg = "操作成功"; private static final String failMsg = "操作失敗"; //以上這些通??梢远x為一種枚舉類(lèi),然后使用 //成功返回方法 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 ... /** * 用戶(hù)對(duì)外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; //需另外定義,此處省略 /** * 保存用戶(hù), * 返回格式: {"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("保存失敗,過(guò)程出現(xiàn)異常"); } } /** * 根據(jù)記錄ID獲取用戶(hù)記錄信息, * 返回格式: {"code":xx,"msg":"yyy","data":User對(duì)象JSON格式字符串} */ @PostMapping(value="/getById") @ResponseBody public ResultInfo<User> getById(@RequestBody UserParam param){ try{ User user = userService.getById(param); return Ok("查詢(xún)成功", user); //通用方法Ok()使用 } catch (Exception e) { Logger.error("controller UserController.getById() error, param: {}, info: {}", param, e) return Fail("查詢(xún)失敗,過(guò)程出現(xiàn)異常",null); //通用方法Fail()使用 } } }
后記,項(xiàng)目主要框架代碼,不全,但可以很清楚看清設(shè)計(jì)和使用了
到此這篇關(guān)于Java設(shè)計(jì)通用的返回?cái)?shù)據(jù)格式過(guò)程講解的文章就介紹到這了,更多相關(guān)Java返回?cái)?shù)據(jù)格式內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
關(guān)于@Value注入List,Map及設(shè)置默認(rèn)值問(wèn)題
這篇文章主要介紹了@Value注入List,Map及設(shè)置默認(rèn)值問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-05-05Java實(shí)現(xiàn)淘寶秒殺聚劃算搶購(gòu)自動(dòng)提醒源碼
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)淘寶秒殺聚劃算搶購(gòu)自動(dòng)提醒源碼,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-02-02Java線(xiàn)程讓步y(tǒng)ield用法實(shí)例分析
這篇文章主要介紹了Java線(xiàn)程讓步y(tǒng)ield用法,結(jié)合實(shí)例形式分析了java中yield()方法的功能、原理及線(xiàn)程讓步操作的相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2019-09-09Java實(shí)現(xiàn)復(fù)制文件并命名的超簡(jiǎn)潔寫(xiě)法
這篇文章主要介紹了Java實(shí)現(xiàn)復(fù)制文件并命名的超簡(jiǎn)潔寫(xiě)法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11Linux下Java Python啟動(dòng)管理腳本方便程序管理
這篇文章主要為大家介紹了Linux下Java/Python啟動(dòng)管理腳本方便程序管理,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11