SpringBoot統(tǒng)一API響應(yīng)結(jié)果封裝的示例詳解

更新時(shí)間：2025年03月27日 09:15:01 作者：青燈文案

在Spring Boot項(xiàng)目中,統(tǒng)一API響應(yīng)結(jié)果封裝是一種常用的技術(shù)實(shí)踐,旨在提高開發(fā)效率、降低代碼重復(fù)率,并提供一致的API響應(yīng)格式,從而簡(jiǎn)化前后端交互和錯(cuò)誤處理,感興趣的小伙伴可以了解下

封裝內(nèi)容

響應(yīng)結(jié)果封裝是將后端服務(wù)返回的響應(yīng)數(shù)據(jù)按照統(tǒng)一的格式進(jìn)行封裝，這個(gè)格式通常包括狀態(tài)碼、狀態(tài)信息（或稱為消息）、返回?cái)?shù)據(jù)等關(guān)鍵信息。

狀態(tài)碼（Code）：表示請(qǐng)求的處理結(jié)果，如成功、失敗、特定錯(cuò)誤等。狀態(tài)碼通常是一組預(yù)定義的整數(shù)或枚舉值。
狀態(tài)信息/消息（Message）：與狀態(tài)碼相對(duì)應(yīng)的文本描述，用于提供關(guān)于請(qǐng)求處理結(jié)果的更多信息。
返回?cái)?shù)據(jù)（Data）：實(shí)際業(yè)務(wù)處理的結(jié)果數(shù)據(jù)，其類型可能因API而異。

此外，有些封裝還會(huì)包含時(shí)間戳、請(qǐng)求ID等附加信息，以便于日志追蹤和問題排查。

封裝示例

1、Result

package com.wen.data;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 統(tǒng)一 API 響應(yīng)結(jié)果封裝
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Result<T> {

    private int code;

    private String message;

    private T data;

    public Result<T> setCode(ResultCode resultCode) {
        this.code = resultCode.code;
        this.message = resultCode.message;
        return this;
    }

    public Result<T> setMessage(String message) {
        this.message = message;
        return this;
    }

    public Result<T> setData(T data) {
        this.data = data;
        return this;
    }
}

2、ResultCode

package com.wen.data;

/**
 * 響應(yīng)碼枚舉
 */

public enum ResultCode {

    // 這里可以根據(jù)多個(gè)場(chǎng)景設(shè)置不同的響應(yīng)碼，供前端判斷問題并進(jìn)行解釋
    SUCCESS(1,"SUCCESS"),

    FAIL(400,"FAIL"),

    NOT_FOUND(401,"interface not found"),

    ERROR(500,"System Exception!");

    public int code;

    public String message;

    ResultCode(int code, String message){
        this.code = code;
        this.message = message;
    }
}

3、ResultGenerator

package com.wen.data;

/**
 * 響應(yīng)結(jié)果生成
 */

public class ResultGenerator {

    public static Result<?> genSuccessResult(){
        return new Result<>().setCode(ResultCode.SUCCESS);
    }

    public static Result<?> genSuccessResult(Object data){
        return new Result<>().setCode(ResultCode.SUCCESS).setData(data);
    }

    public static Result<?> genFailResult(String message){
        return new Result<>().setCode(ResultCode.FAIL).setMessage(message);
    }

    public static Result<?> genSpecialResult(ResultCode resultCode, String message){
        return new Result<>().setCode(resultCode).setMessage(message);
    }
}

4、TestController

package com.wen.controller;

import com.wen.data.Result;
import com.wen.data.ResultGenerator;
import com.wen.dto.TbUser;
import com.wen.service.TestService;
import org.apache.ibatis.annotations.Param;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private TestService testService;

    @GetMapping("/select")
    public Result<?> selectUserByPage(
    				@Param("pageSize") Integer pageSize, 
    				@Param("pageNumber") Integer pageNumber){
    	// 生成結(jié)果
        return ResultGenerator.genSuccessResult(testService.selectUserByPage(pageSize, pageNumber));
    }
}