詳解如何在SpringBoot項(xiàng)目中使用統(tǒng)一返回結(jié)果

更新時(shí)間：2022年10月19日 16:23:47 作者：picacho_pkq

在一個(gè)完整的項(xiàng)目中，如果每一個(gè)控制器的方法都返回不同的結(jié)果，那么對項(xiàng)目的維護(hù)和擴(kuò)展都會(huì)很麻煩。因此，本文為大家準(zhǔn)備了SpringBoot項(xiàng)目中使用統(tǒng)一返回結(jié)果的方法，需要的可以參考一下

在一個(gè)完整的項(xiàng)目中，如果每一個(gè)控制器的方法都返回不同的結(jié)果，那么對項(xiàng)目的維護(hù)和擴(kuò)展都會(huì)很麻煩；并且現(xiàn)在主流的開發(fā)模式時(shí)前后端分離的模式，如果后端返回各式各樣的結(jié)果，那么在前后端聯(lián)調(diào)時(shí)會(huì)非常的麻煩，還會(huì)增加前后端的格外任務(wù)。

所以，在一個(gè)項(xiàng)目中統(tǒng)一返回結(jié)果就是一個(gè)十分必要和友好的做法。接下來就用一個(gè)簡單的demo來看看統(tǒng)一返回結(jié)果的效果。

1.創(chuàng)建Spring Boot項(xiàng)目

這里比較簡單，就不詳細(xì)介紹了；將多余的文件刪除，保持項(xiàng)目的整潔；引入必要的依賴。

demo的項(xiàng)目結(jié)構(gòu)

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

2.返回結(jié)果的封裝

在common包下創(chuàng)建Result結(jié)果類，將需要返回的必要數(shù)據(jù)封裝在Result結(jié)果類中；這里封裝三個(gè)屬性，第一個(gè)是返回的狀態(tài)碼，第二個(gè)是返回的描述信息，第三個(gè)是返回的數(shù)據(jù)，此數(shù)據(jù)是前端需要接收展示的數(shù)據(jù)。

Result.java

@Setter
@Getter
@ToString
public class Result<T> implements Serializable {
    private static final long serialVersionUID = 1L;
    private int resultCode;
    private String message;
    private T data;

    public Result(){

    }

    public Result(int resultCode, String message){
        this.resultCode = resultCode;
        this.message = message;
    }

    // 服務(wù)器處理失敗
    public Result failure(){
        return new Result(Constants.RESULT_CODE_SERVER_ERROR, "服務(wù)器錯(cuò)誤");
    }

}

創(chuàng)建Constants類，規(guī)定基本的狀態(tài)碼所代表的含義；這些狀態(tài)碼的基本規(guī)定需要符合常見的狀態(tài)碼含義，并且在一個(gè)項(xiàng)目能夠保證統(tǒng)一即可。

Constants.java

public class Constants {

    public static final int RESULT_CODE_SUCCESS = 200;  // 成功處理請求
    public static final int RESULT_CODE_BAD_REQUEST = 412;  // 請求錯(cuò)誤
    public static final int RESULT_CODE_NOT_LOGIN = 402;  // 未登錄
    public static final int RESULT_CODE_PARAM_ERROR = 406;  // 傳參錯(cuò)誤
    public static final int RESULT_CODE_SERVER_ERROR= 500;  // 服務(wù)器錯(cuò)誤

    // 等等，可以根據(jù)場景繼續(xù)添加
}

最后創(chuàng)建結(jié)果類生成器ResultGenerator類，用于生成結(jié)果類。

ResultGenerator.java

public class ResultGenerator {

    private static final String DEFAULT_SUCCESS_MESSAGE = "SUCCESS";
    private static final String DEFAULT_FAIL_MESSAGE = "FAIL";


    public static Result genSuccessResult(){
        Result result = new Result();
        result.setResultCode(Constants.RESULT_CODE_SUCCESS);
        result.setMessage(DEFAULT_FAIL_MESSAGE);
        return result;
    }


    public static Result genSuccessResult(String message){
        Result result = new Result();
        result.setResultCode(Constants.RESULT_CODE_SUCCESS);
        result.setMessage(message);
        return result;
    }

    public static Result genSuccessResult(Object data){
        Result result = new Result();
        result.setResultCode(Constants.RESULT_CODE_SUCCESS);
        result.setMessage(DEFAULT_SUCCESS_MESSAGE);
        result.setData(data);
        return result;
    }

    public static Result genFailResult(String message){
        Result result = new Result();
        result.setResultCode(Constants.RESULT_CODE_SERVER_ERROR);
        if(StringUtils.isEmpty(message)){
            result.setMessage(DEFAULT_FAIL_MESSAGE);
        }else{
            result.setMessage(message);
        }
        return result;
    }
    
    public static Result genNullResult(String message){
        Result result = new Result();
        result.setResultCode(Constants.RESULT_CODE_BAD_REQUEST);
        result.setMessage(message);
        return result;
    }
    
    public static Result genErrorResult(int code, String message){
        Result result = new Result();
        result.setResultCode(code);
        result.setMessage(message);
        return result;
    }
}

3.后端接口實(shí)現(xiàn)

這里實(shí)現(xiàn)簡單的增刪改查，并且應(yīng)用統(tǒng)一返回結(jié)果。

3.1 創(chuàng)建實(shí)體類

User.java

@Setter
@Getter
@Generated
@ToString
public class User {
    private Integer id;
    private String name;
    private String password;
}

3.2 創(chuàng)建dao層

UserDao.java

public interface UserDao {


    /**
     * 查詢所有的用戶
     * @return
     */
    public List<User> findAllUsers();

    /**
     * 根據(jù)主鍵查詢用戶
     * @param id
     * @return
     */
    public User getUserById(Integer id);

    /**
     * 添加一個(gè)用戶
     * @param user
     * @return
     */
    public int insertUser(User user);

    /**
     * 修改一個(gè)用戶信息
     * @param user
     * @return
     */
    public int updateUser(User user);

    /**
     * 刪除一個(gè)用戶
     * @param id
     * @return
     */
    public int deleteUser(Integer id);
    
}

userDao.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.picacho.dao.UserDao">
    <resultMap type="com.picacho.entity.User" id="UserResult">
        <result property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="password" column="password"/>
    </resultMap>

    <select id="findAllUsers" resultMap="UserResult">
        select id,name,password from tb_user
        order by id desc
    </select>

    <select id="getUserById" resultMap="UserResult">
        select id,name,password from tb_user
        where id = #{id}
    </select>

    <insert id="insertUser" parameterType="com.picacho.entity.User">
        insert into tb_user(name,password)
        values(#{name},#{password})
    </insert>

    <update id="updateUser" parameterType="com.picacho.entity.User">
        update tb_user
        set
            name=#{name},password=#{password}
        where id=#{id}
    </update>

    <delete id="deleteUser" parameterType="int">
        delete from tb_user where id=#{id}
    </delete>

</mapper>

3.3 創(chuàng)建Controller層

這里基本沒有任何業(yè)務(wù)邏輯可言，只是單純的增刪改查，所以也就不太需要業(yè)務(wù)層了。

UserController.java

@Controller
public class UserController {

    @Autowired
    UserDao userDao;


    /**
     * 查詢所有用戶
     * @return
     */
    @RequestMapping(value = "/users", method = RequestMethod.GET)
    @ResponseBody
    public Result<List<User>> queryAll(){
        List<User> users = userDao.findAllUsers();
        return ResultGenerator.genSuccessResult(users);
    }

    /**
     * 查詢一個(gè)用戶
     * @param id
     * @return
     */
    @RequestMapping(value = "/users/{id}", method = RequestMethod.GET)
    @ResponseBody
    public Result<User> queryOne(@PathVariable("id") Integer id){
        if(id == null || id < 1){
            return ResultGenerator.genFailResult("缺少參數(shù)");
        }
        User user = userDao.getUserById(id);
        if(user == null){
            return ResultGenerator.genFailResult("無此數(shù)據(jù)");
        }
        return  ResultGenerator.genSuccessResult(user);
    }


    /**
     * 添加一個(gè)用戶
     * @param user
     * @return
     */
    @RequestMapping(value = "/users", method = RequestMethod.POST)
    @ResponseBody
    public Result<Boolean> insert(@RequestBody User user){
        if(StringUtils.isEmpty(user.getName()) || StringUtils.isEmpty(user.getPassword())){
            return ResultGenerator.genFailResult("缺少參數(shù)");
        }
        return ResultGenerator.genSuccessResult(userDao.insertUser(user) > 0);
    }

    /**
     * 修改用戶信息
     * @param user
     * @return
     */
    @RequestMapping(value = "/users", method = RequestMethod.PUT)
    @ResponseBody
    public Result<Boolean> update(@RequestBody User user){
        if(user.getId() == null || user.getId() < 1 || StringUtils.isEmpty(user.getName()) || StringUtils.isEmpty(user.getPassword())){
            return ResultGenerator.genFailResult("缺少參數(shù)");
        }
        User tempUser = userDao.getUserById(user.getId());
        if(tempUser == null){
            return ResultGenerator.genFailResult("參數(shù)異常");
        }
        tempUser.setName(user.getName());
        tempUser.setPassword(user.getPassword());
        return ResultGenerator.genSuccessResult(userDao.updateUser(tempUser) > 0);
    }

    /**
     * 刪除一個(gè)用戶
     * @param id
     * @return
     */
    @RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE)
    @ResponseBody
    public Result<Boolean> delete(@PathVariable("id") Integer id){
        if(id == null || id < 1){
            return ResultGenerator.genFailResult("缺少參數(shù)");
        }
        return ResultGenerator.genSuccessResult(userDao.deleteUser(id) > 0);
    }
 }

4.前端部分

這里前端使用ajax來與后端進(jìn)行交互，所以前端資源只需要引入jquery即可。

<script src="https://cdn.staticfile.org/jquery/1.12.0/jquery.min.js"></script>

user-test.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>統(tǒng)一返回結(jié)果 ｜ 請求測試</title>
</head>
<body class="hold-transition login-page">
<div style="width:720px;margin:7% auto">
    <div class="content">
        <div class="container-fluid">
            <div class="row">
                <div class="col-lg-6">
                    <hr>
                    <div class="card">
                        <div class="card-header">
                            <h5 class="m-0">詳情查詢接口測試</h5>
                        </div>
                        <div class="card-body">
                            <input id="queryId" type="number" placeholder="請輸入id字段">
                            <h6 class="card-title">查詢接口返回?cái)?shù)據(jù)如下：</h6>
                            <p class="card-text" id="result0"></p>
                            <a href="#" class="btn btn-primary" onclick="requestQuery()">發(fā)送詳情查詢請求</a>
                        </div>
                    </div>
                    <br>
                    <hr>
                    <div class="card">
                        <div class="card-header">
                            <h5 class="m-0">列表查詢接口測試</h5>
                        </div>
                        <div class="card-body">
                            <h6 class="card-title">查詢接口返回?cái)?shù)據(jù)如下：</h6>
                            <p class="card-text" id="result1"></p>
                            <a href="#" class="btn btn-primary" onclick="requestQueryList()">發(fā)送列表查詢請求</a>
                        </div>
                    </div>
                    <br>
                    <hr>
                    <div class="card">
                        <div class="card-header">
                            <h5 class="m-0">添加接口測試</h5>
                        </div>
                        <div class="card-body">
                            <input id="addName" type="text" placeholder="請輸入name字段">
                            <input id="addPassword" type="text" placeholder="請輸入password字段">
                            <h6 class="card-title">添加接口返回?cái)?shù)據(jù)如下：</h6>
                            <p class="card-text" id="result2"></p>
                            <a href="#" class="btn btn-primary" onclick="requestAdd()">發(fā)送添加請求</a>
                        </div>
                    </div>
                    <br>
                    <hr>
                    <div class="card">
                        <div class="card-header">
                            <h5 class="m-0">修改接口測試</h5>
                        </div>
                        <div class="card-body">
                            <input id="updateId" type="number" placeholder="請輸入id字段">
                            <input id="updateName" type="text" placeholder="請輸入name字段">
                            <input id="updatePassword" type="text" placeholder="請輸入password字段">
                            <h6 class="card-title">修改接口返回?cái)?shù)據(jù)如下：</h6>
                            <p class="card-text" id="result3"></p>
                            <a href="#" class="btn btn-primary" onclick="requestUpdate()">發(fā)送修改請求</a>
                        </div>
                    </div>
                    <br>
                    <hr>
                    <div class="card">
                        <div class="card-header">
                            <h5 class="m-0">刪除接口測試</h5>
                        </div>
                        <div class="card-body">
                            <input id="deleteId" type="number" placeholder="請輸入id字段">
                            <h6 class="card-title">刪除接口返回?cái)?shù)據(jù)如下：</h6>
                            <p class="card-text" id="result4"></p>
                            <a href="#" class="btn btn-primary" onclick="requestDelete()">發(fā)送刪除請求</a>
                        </div>
                    </div>
                    <hr>
                </div>
            </div>
        </div>
    </div>
</div>

<!-- jQuery -->
<script src="https://cdn.staticfile.org/jquery/1.12.0/jquery.min.js"></script>
<script type="text/javascript">
    function requestQuery() {
        var id = $("#queryId").val();
        if (typeof id == "undefined" || id == null || id == "" || id < 0) {
            return false;
        }
        $.ajax({
            type: "GET",//方法類型
            dataType: "json",//預(yù)期服務(wù)器返回的數(shù)據(jù)類型
            url: "/users/" + id,
            contentType: "application/json; charset=utf-8",
            success: function (result) {
                $("#result0").html(JSON.stringify(result));
            },
            error: function () {
                $("#result0").html("接口異常，請聯(lián)系管理員！");
            }
        });
    }

    function requestQueryList() {
        $.ajax({
            type: "GET",//方法類型
            dataType: "json",//預(yù)期服務(wù)器返回的數(shù)據(jù)類型
            url: "/users",
            contentType: "application/json; charset=utf-8",
            success: function (result) {
                $("#result1").html(JSON.stringify(result));
            },
            error: function () {
                $("#result1").html("接口異常，請聯(lián)系管理員！");
            }
        });
    }

    function requestAdd() {
        var name = $("#addName").val();
        var password = $("#addPassword").val();
        var data = {"name": name, "password": password}
        $.ajax({
            type: "POST",//方法類型
            dataType: "json",//預(yù)期服務(wù)器返回的數(shù)據(jù)類型
            url: "/users",
            contentType: "application/json; charset=utf-8",
            data: JSON.stringify(data),
            success: function (result) {
                $("#result2").html(JSON.stringify(result));
            },
            error: function () {
                $("#result2").html("接口異常，請聯(lián)系管理員！");
            }
        });
    }

    function requestUpdate() {
        var id = $("#updateId").val();
        var name = $("#updateName").val();
        var password = $("#updatePassword").val();
        var data = {"id": id, "name": name, "password": password}
        $.ajax({
            type: "PUT",//方法類型
            dataType: "json",//預(yù)期服務(wù)器返回的數(shù)據(jù)類型
            url: "/users",
            contentType: "application/json; charset=utf-8",
            data: JSON.stringify(data),
            success: function (result) {
                $("#result3").html(JSON.stringify(result));
            },
            error: function () {
                $("#result3").html("接口異常，請聯(lián)系管理員！");
            }
        });
    }

    function requestDelete() {
        var id = $("#deleteId").val();
        if (typeof id == "undefined" || id == null || id == "" || id < 0) {
            return false;
        }
        $.ajax({
            type: "DELETE",//方法類型
            dataType: "json",//預(yù)期服務(wù)器返回的數(shù)據(jù)類型
            url: "/users/" + id,
            contentType: "application/json; charset=utf-8",
            success: function (result) {
                $("#result4").html(JSON.stringify(result));
            },
            error: function () {
                $("#result4").html("接口異常，請聯(lián)系管理員！");
            }
        });
    }
</script>
</body>
</html>