SpringMVC中的表現(xiàn)層結(jié)果封裝
一、為什么要將返回結(jié)果封裝？
當前端發(fā)送一個請求，被處理后，我們之前的處理方式就是，對于增刪改操作，我們返回 true 或 false；對于查詢操作，我們就將查詢后的結(jié)果返回。
雖然使用該方式能夠?qū)⒄埱蠼Y(jié)果返回，但是前端開發(fā)人員在解析返回的數(shù)據(jù)時就會非常麻煩，他們需要根據(jù)你不同的返回結(jié)果定義不同的解析方法，造成了巨大的工作量。
如果雙方之間能夠定義一種方式，每次后端開發(fā)人員在返回數(shù)據(jù)時都返回指定格式的數(shù)據(jù)，那么前端開發(fā)人員在解析數(shù)據(jù)時也就非常的方便迅速，這就使得在開發(fā)項目的過程中，不會因為這些無關(guān)緊要的問題而耗費大量的時間。
二、封裝步驟
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)層方法的返回結(jié)果進行封裝，所以可以將 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è)務(wù)邏輯層代碼在此就不再展示了，就是非常普通的增刪改查操作，重點介紹如何對返回結(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é)果不存在，請重試！";
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é)果不存在，請重試！";
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ù)返回結(jié)果，能夠很清晰的知道刪除操作并沒有成功執(zhí)行。這是因為數(shù)據(jù)庫表中并沒有 id = 3 的數(shù)據(jù)，所以刪除操作沒能成功執(zhí)行。
4）測試 selectById 方法
對于查詢操作，如果成功查詢到了數(shù)據(jù)，就會將數(shù)據(jù)放到 data 中。
5）測試查詢?nèi)糠椒?/strong>
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了SpringBoot啟動過程的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-07-07
java實現(xiàn)自定義時鐘并實現(xiàn)走時功能
這篇文章主要為大家詳細介紹了java實現(xiàn)自定義時鐘并實現(xiàn)走時功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-06-06
Visual?Studio?Code配置Tomcat運行Java?Web項目詳細步驟
VS Code是一款非常棒的文本編輯器,具有配置簡單、功能豐富、輕量簡潔的特點,并且極其適合處理中小規(guī)模的代碼,這篇文章主要給大家介紹了關(guān)于Visual?Studio?Code配置Tomcat運行Java?Web項目的詳細步驟,需要的朋友可以參考下2023-11-11
這篇文章主要為大家詳細介紹了Java如何代碼實現(xiàn)導(dǎo)出文件為壓縮包,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2024-02-02
今天小編就為大家分享一篇關(guān)于zookeeper服務(wù)優(yōu)化的一些建議，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-03-03
Java實現(xiàn)批量導(dǎo)出導(dǎo)入數(shù)據(jù)及附件文件zip包
這篇文章主要為大家詳細介紹了Java實現(xiàn)批量導(dǎo)出導(dǎo)入數(shù)據(jù)及附件文件zip包的方法，文中的示例代碼講解詳細，感興趣的小伙伴可以了解一2022-09-09
這篇文章主要介紹了學習Java內(nèi)存模型JMM的心得以及對其原理做了深入的介紹，有興趣的朋友學習下吧。2017-12-12
spring整合redis以及使用RedisTemplate的方法
本篇文章主要介紹了spring整合redis以及使用RedisTemplate的方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-05-05
package打包一個springcloud項目的某個微服務(wù)報錯問題
這篇文章主要介紹了package打包一個springcloud項目的某個微服務(wù)報錯問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
本文給大家介紹Java常用集合與映射的線程安全問題小結(jié),本文通過實例代碼給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧2025-04-04