SpringMVC中的表現(xiàn)層結(jié)果封裝
一、為什么要將返回結(jié)果封裝?
當(dāng)前端發(fā)送一個(gè)請(qǐng)求,被處理后,我們之前的處理方式就是,對(duì)于增刪改操作,我們返回 true 或 false;對(duì)于查詢操作,我們就將查詢后的結(jié)果返回。
雖然使用該方式能夠?qū)⒄?qǐng)求結(jié)果返回,但是前端開發(fā)人員在解析返回的數(shù)據(jù)時(shí)就會(huì)非常麻煩,他們需要根據(jù)你不同的返回結(jié)果定義不同的解析方法,造成了巨大的工作量。
如果雙方之間能夠定義一種方式,每次后端開發(fā)人員在返回?cái)?shù)據(jù)時(shí)都返回指定格式的數(shù)據(jù),那么前端開發(fā)人員在解析數(shù)據(jù)時(shí)也就非常的方便迅速,這就使得在開發(fā)項(xiàng)目的過程中,不會(huì)因?yàn)檫@些無關(guān)緊要的問題而耗費(fèi)大量的時(shí)間。
二、封裝步驟
1、自定義封裝類
public class Result { private Integer code; private Object data; private String msg; public Result() { } public Result(Integer code, Object data) { this.code = code; this.data = data; } public Result(Integer code, Object data, String msg) { this.code = code; this.data = data; this.msg = msg; } }
因?yàn)槭菍⒈憩F(xiàn)層方法的返回結(jié)果進(jìn)行封裝,所以可以將 Result 封裝類定義在 controller 包中。
code
屬性存儲(chǔ)請(qǐng)求操作是否成功處理,使用統(tǒng)一的格式。data
屬性存儲(chǔ)請(qǐng)求操作成功處理后得到的數(shù)據(jù)。msg
屬性存儲(chǔ)一些提示信息,主要是請(qǐng)求處理失敗時(shí)的提示信息。
當(dāng)然,封裝類中還可以根據(jù)需要定義一些其他屬性,并不是說一定是這三種。
2、編寫 Code 類統(tǒng)一狀態(tài)碼
public class Code { public static final Integer INSERT_OK = 20011; public static final Integer DELETE_OK = 20021; public static final Integer UPDATE_OK = 20031; public static final Integer SELECT_OK = 20041; public static final Integer INSERT_ERR = 20010; public static final Integer DELETE_ERR = 20020; public static final Integer UPDATE_ERR = 20030; public static final Integer SELECT_ERR = 20040; public static final Integer SYSTEM_ERR = 50001; public static final Integer SYSTEM_TIMEOUT_ERR = 50002; public static final Integer SYSTEM_UNKNOW_ERR = 59999; public static final Integer BUSINESS_ERR = 60002; }
將狀態(tài)碼定義為常量,在需要是可以直接調(diào)用使用。以上僅列舉了一些常用的狀態(tài)碼,需要什么,都可以自己定義。
三、案例演示
1、需求分析
- 完成對(duì) user 表的增刪改、根據(jù)ID查、查詢?nèi)坎僮鳌?/li>
- 實(shí)體類、數(shù)據(jù)訪問層、業(yè)務(wù)邏輯層代碼在此就不再展示了,就是非常普通的增刪改查操作,重點(diǎn)介紹如何對(duì)返回結(jié)果封裝。
2、編寫 UserController 類
@RestController @RequestMapping("users") public class UserController { @Autowired private UserService userService; @PostMapping public Result insert(@RequestBody User user) { boolean insert = userService.insert(user); return new Result(insert ? Code.: Code.INSERT_ERR,insert); } @PutMapping public Result update(@RequestBody User user) { boolean update = userService.update(user); return new Result(update ? Code.UPDATE_OK : Code.UPDATE_ERR,update); } @DeleteMapping("/{id}") public Result delete(@PathVariable Integer id) { boolean delete = userService.delete(id); return new Result(delete ? Code.DELETE_OK : Code.DELETE_ERR,delete); } @GetMapping("/{id}") public Result selectById(@PathVariable Integer id) { User user = userService.selectById(id); Integer code = user != null ? Code.SELECT_OK : Code.SELECT_ERR; String msg = user != null ? "" : "查詢結(jié)果不存在,請(qǐng)重試!"; return new Result(code,user,msg); } @GetMapping public Result selectAll() { List<User> userList = userService.selectAll(); Integer code = userList != null ? Code.SELECT_OK : Code.SELECT_ERR; String msg = userList != null ? "" : "查詢結(jié)果不存在,請(qǐng)重試!"; return new Result(code,userList,msg); } }
采用 REST 風(fēng)格編寫。
仔細(xì)查看后會(huì)發(fā)現(xiàn),其實(shí)和我們之前寫的方法并沒有什么太大的區(qū)別,無非就是將返回值改為了 Result 類型,返回的不單單是 data 數(shù)據(jù),又多傳遞了 code 和 msg 值而已。
雖然僅有小的改變,但是卻大大的加快了項(xiàng)目的開發(fā)效率,給前后端開發(fā)人員減少了不少麻煩。
3、使用 Postman 工具測(cè)試
1)測(cè)試 insert 方法
code
值為 20011 表示 insert 新增操作成功執(zhí)行。data
返回了 true,同樣說明已經(jīng)成功執(zhí)行了 insert 操作。msg
為空則表示沒有提示信息,一般在錯(cuò)誤情況下才會(huì)刻意寫一些提示信息。
2)測(cè)試 update 方法
3)測(cè)試 delete 方法
根據(jù)返回結(jié)果,能夠很清晰的知道刪除操作并沒有成功執(zhí)行。這是因?yàn)閿?shù)據(jù)庫表中并沒有 id = 3 的數(shù)據(jù),所以刪除操作沒能成功執(zhí)行。
4)測(cè)試 selectById 方法
對(duì)于查詢操作,如果成功查詢到了數(shù)據(jù),就會(huì)將數(shù)據(jù)放到 data 中。
5)測(cè)試查詢?nèi)糠椒?/strong>
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
Spring中的攔截器HandlerInterceptor詳細(xì)解析
這篇文章主要介紹了Spring中的攔截器HandlerInterceptor詳細(xì)解析,HandlerInterceptor 是 Spring 框架提供的一個(gè)攔截器接口,用于在請(qǐng)求處理過程中攔截和處理請(qǐng)求,需要的朋友可以參考下2024-01-01idea設(shè)置在包里面在創(chuàng)建一個(gè)包方式
這篇文章主要介紹了idea設(shè)置在包里面在創(chuàng)建一個(gè)包方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-05-05java前后端傳值,參數(shù)有集合類型的數(shù)據(jù)時(shí)的兩種操作方式
這篇文章主要介紹了java前后端傳值,參數(shù)有集合類型的數(shù)據(jù)時(shí)的兩種操作方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-11-11JDK的一個(gè)Bug監(jiān)聽文件變更的初步實(shí)現(xiàn)思路
這篇文章主要介紹了JDK的一個(gè)Bug監(jiān)聽文件變更要小心了,本篇文章就帶大家簡(jiǎn)單實(shí)現(xiàn)一個(gè)對(duì)應(yīng)的功能,并分析一下對(duì)應(yīng)的Bug和優(yōu)缺點(diǎn),需要的朋友可以參考下2022-05-05Java線程和操作系統(tǒng)線程的關(guān)系解讀
這篇文章主要介紹了Java線程和操作系統(tǒng)線程的關(guān)系解讀,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-06-065分鐘快速學(xué)會(huì)spring boot整合Mybatis的方法
這篇文章主要給大家介紹了如何通過5分鐘快速學(xué)會(huì)spring boot整合Mybatis的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用spring boot具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-12-12