SpringMVC中的表現層結果封裝

更新時間：2022年11月16日 09:13:25 作者：準Java全棧開發(fā)工程師

這篇文章主要介紹了SpringMVC中的表現層結果封裝，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

一、為什么要將返回結果封裝？

當前端發(fā)送一個請求，被處理后，我們之前的處理方式就是，對于增刪改操作，我們返回 true 或 false；對于查詢操作，我們就將查詢后的結果返回。

雖然使用該方式能夠將請求結果返回，但是前端開發(fā)人員在解析返回的數據時就會非常麻煩，他們需要根據你不同的返回結果定義不同的解析方法，造成了巨大的工作量。

如果雙方之間能夠定義一種方式，每次后端開發(fā)人員在返回數據時都返回指定格式的數據，那么前端開發(fā)人員在解析數據時也就非常的方便迅速，這就使得在開發(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;
    }
}

因為是將表現層方法的返回結果進行封裝，所以可以將 Result 封裝類定義在 controller 包中。

code屬性存儲請求操作是否成功處理，使用統一的格式。
data屬性存儲請求操作成功處理后得到的數據。
msg屬性存儲一些提示信息，主要是請求處理失敗時的提示信息。

當然，封裝類中還可以根據需要定義一些其他屬性，并不是說一定是這三種。

2、編寫 Code 類統一狀態(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)碼定義為常量，在需要是可以直接調用使用。以上僅列舉了一些常用的狀態(tài)碼，需要什么，都可以自己定義。

三、案例演示

1、需求分析

完成對 user 表的增刪改、根據ID查、查詢全部操作。
實體類、數據訪問層、業(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ā)現，其實和我們之前寫的方法并沒有什么太大的區(qū)別，無非就是將返回值改為了 Result 類型，返回的不單單是 data 數據，又多傳遞了 code 和 msg 值而已。

雖然僅有小的改變，但是卻大大的加快了項目的開發(fā)效率，給前后端開發(fā)人員減少了不少麻煩。