SpringMVC中的表現(xiàn)層結果封裝
一、為什么要將返回結果封裝？
當前端發(fā)送一個請求，被處理后，我們之前的處理方式就是，對于增刪改操作，我們返回 true 或 false；對于查詢操作，我們就將查詢后的結果返回。
雖然使用該方式能夠將請求結果返回，但是前端開發(fā)人員在解析返回的數(shù)據(jù)時就會非常麻煩，他們需要根據(jù)你不同的返回結果定義不同的解析方法，造成了巨大的工作量。
如果雙方之間能夠定義一種方式，每次后端開發(fā)人員在返回數(shù)據(jù)時都返回指定格式的數(shù)據(jù)，那么前端開發(fā)人員在解析數(shù)據(jù)時也就非常的方便迅速，這就使得在開發(fā)項目的過程中，不會因為這些無關緊要的問題而耗費大量的時間。
二、封裝步驟
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;
}
}因為是將表現(xiàn)層方法的返回結果進行封裝，所以可以將 Result 封裝類定義在 controller 包中。
code屬性存儲請求操作是否成功處理，使用統(tǒng)一的格式。data屬性存儲請求操作成功處理后得到的數(shù)據(jù)。msg屬性存儲一些提示信息，主要是請求處理失敗時的提示信息。
當然，封裝類中還可以根據(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、需求分析
- 完成對 user 表的增刪改、根據(jù)ID查、查詢?nèi)坎僮鳌?/li>
- 實體類、數(shù)據(jù)訪問層、業(yè)務邏輯層代碼在此就不再展示了，就是非常普通的增刪改查操作，重點介紹如何對返回結果封裝。
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 ? "" : "查詢結果不存在，請重試！";
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 ? "" : "查詢結果不存在，請重試！";
return new Result(code,userList,msg);
}
}采用 REST 風格編寫。
仔細查看后會發(fā)現(xiàn)，其實和我們之前寫的方法并沒有什么太大的區(qū)別，無非就是將返回值改為了 Result 類型，返回的不單單是 data 數(shù)據(jù)，又多傳遞了 code 和 msg 值而已。
雖然僅有小的改變，但是卻大大的加快了項目的開發(fā)效率，給前后端開發(fā)人員減少了不少麻煩。
3、使用 Postman 工具測試
1）測試 insert 方法
code值為 20011 表示 insert 新增操作成功執(zhí)行。data返回了 true，同樣說明已經(jīng)成功執(zhí)行了 insert 操作。msg為空則表示沒有提示信息，一般在錯誤情況下才會刻意寫一些提示信息。
2）測試 update 方法
3）測試 delete 方法
根據(jù)返回結果，能夠很清晰的知道刪除操作并沒有成功執(zhí)行。這是因為數(shù)據(jù)庫表中并沒有 id = 3 的數(shù)據(jù)，所以刪除操作沒能成功執(zhí)行。
4）測試 selectById 方法
對于查詢操作，如果成功查詢到了數(shù)據(jù)，就會將數(shù)據(jù)放到 data 中。
5）測試查詢?nèi)糠椒?/strong>
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要為大家詳細介紹了Spring注入值到Bean的三種方式，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-07-07
這篇文章主要為大家介紹了Spring容器中已經(jīng)存在的Bean替換示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-06-06
Spring中的攔截器HandlerInterceptor詳細解析
這篇文章主要介紹了Spring中的攔截器HandlerInterceptor詳細解析,HandlerInterceptor 是 Spring 框架提供的一個攔截器接口,用于在請求處理過程中攔截和處理請求,需要的朋友可以參考下2024-01-01
這篇文章主要介紹了idea設置在包里面在創(chuàng)建一個包方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05
java前后端傳值,參數(shù)有集合類型的數(shù)據(jù)時的兩種操作方式
這篇文章主要介紹了java前后端傳值,參數(shù)有集合類型的數(shù)據(jù)時的兩種操作方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11
JDK的一個Bug監(jiān)聽文件變更的初步實現(xiàn)思路
這篇文章主要介紹了JDK的一個Bug監(jiān)聽文件變更要小心了,本篇文章就帶大家簡單實現(xiàn)一個對應的功能，并分析一下對應的Bug和優(yōu)缺點，需要的朋友可以參考下2022-05-05
這篇文章主要介紹了Java線程和操作系統(tǒng)線程的關系解讀，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-06-06
正則表達式，又稱正規(guī)表示法、常規(guī)表示法（英語：Regular Expression，在代碼中常簡寫為regex、regexp或RE），計算機科學的一個概念2017-05-05
5分鐘快速學會spring boot整合Mybatis的方法
這篇文章主要給大家介紹了如何通過5分鐘快速學會spring boot整合Mybatis的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用spring boot具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-12-12
java中的CountDownLatch、Semaphore、CyclicBarrier這些類又不屬于鎖，它們和鎖又有很多共同點，都是為了協(xié)同多線程的執(zhí)行，都是一種同步器，所以這里就借用同步來取名字了，也就是“同步系列”的來源。下面小編來簡單介紹下2019-05-05