SpringBoot 統(tǒng)一公共返回類的實現

更新時間：2022年01月18日 09:43:03 作者：qq_29750461

本文主要介紹了SpringBoot 統(tǒng)一公共返回類的實現，配置后臺的統(tǒng)一公共返回類，這樣做目的是為了統(tǒng)一返回信息，文中示例代碼介紹的很詳細，感興趣的可以了解一下

項目結構

在這里插入圖片描述

具體過程如下，在response文件夾下分別建立 CustomizeResultCode 接口，枚舉類ResultCode 實現CustomizeResultCode 接口和Result類：

1 配置自定義返回類接口，該接口中包含錯誤狀態(tài)碼和錯誤信息

public interface CustomizeResultCode {
    /*
    獲取錯誤碼
    @return 錯誤狀態(tài)碼
     */
    Integer getCode();
    /*
    獲取錯誤信息
    @return 錯誤信息
     */
    String getMessage();
}

2 配置返回實現類，注意這里是個枚舉類，里面的編碼僅供參考，可以自定義

/**
 * @Description: 返回碼定義
 * 規(guī)定:
 * #200表示成功
 * #400表示錯誤
 * #1001～1999 區(qū)間表示參數錯誤
 * #2001～2999 區(qū)間表示用戶錯誤
 * #3001～3999 區(qū)間表示接口異常
 * #后面對什么的操作自己在這里注明就行了
 */
public enum ResultCode implements CustomizeResultCode{
    /* 成功 */
    SUCCESS(200, "成功"),
    /*錯誤*/
    ERROR(400,"錯誤失敗"),

    /* 默認失敗 */
    COMMON_FAIL(999, "失敗"),

    /* 參數錯誤：1000～1999 */
    PARAM_NOT_VALID(1001, "參數無效"),
    PARAM_IS_BLANK(1002, "參數為空"),

    /* 用戶錯誤 */
    USER_NOT_LOGIN(2001, "用戶未登錄"),
    USER_ACCOUNT_EXPIRED(2002, "賬號已過期"),
    USER_CREDENTIALS_ERROR(2003, "密碼錯誤"),
    /*運行時異常*/
    ARITHMETIC_EXCEPTION(9001,"算數異常");
    ;
    private Integer code;
    private String message;
    ResultCode(Integer code,String message){
        this.code=code;
        this.message=message;
    }
    @Override
    public Integer getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }
}

3 定義具體的返回類方法

@Data
public class Result {
    @ApiModelProperty(value = "是否成功")
    private Boolean success;
    @ApiModelProperty (value= "返回碼")
    private Integer code;
    @ApiModelProperty(value = "返回消息")
    private String message;
    @ApiModelProperty(value = "返回數據")
    private Map<String,Object> data=new HashMap<>();
    /*
    構造方法私有化，里面的方法都為靜態(tài)方法
    達到保護屬性的作用
     */
    private Result(){

    }
    /*
    使用鏈式編程
    該部分在項目組中一般是項目組長寫好的
     */
    public static Result ok(){
        Result result=new Result();
        result.setSuccess(true);
        result.setCode(ResultCode.SUCCESS.getCode());
        result.setMessage(ResultCode.SUCCESS.getMessage());
        return result;
    }

    public static Result error(){
        Result result=new Result();
        result.setSuccess(false);
        result.setCode(ResultCode.ERROR.getCode());
        result.setMessage(ResultCode.ERROR.getMessage());
        return result;
    }
    /*
    自定義返回成功與否
     */
    public Result success(Boolean success){
        this.setSuccess(success);
        return this;
    }
    public Result message(String message){
        this.setMessage(message);
        return this;
    }
    public Result code(Integer code){
        this.setCode(code);
        return this;
    }
    public Result data(String key,Object value){
        this.data.put(key,value);
        return this;
    }
    public Result data(Map<String,Object>map){
        this.setData(map);
        return this;
    }
}

統(tǒng)一返回類使用

Controller在下面的文件中

在這里插入圖片描述

@RestController
@EnableAutoConfiguration
@RequestMapping("/system/info")
@Api(value = "系統(tǒng)模塊",tags="系統(tǒng)接口")
public class DController {
    @Autowired
    private DService dService;
    @GetMapping
    @ApiOperation(value = "信息列表",notes = "查詢所有信息")
    public Result findDs(){

        List<Doctordict>list=dService.list();
        //鏈式編程
        return Result.ok().data("users",list);
    }
 }

測試結果成功

在這里插入圖片描述