SpringBoot 統(tǒng)一公共返回類的實(shí)現(xiàn)
本文記錄下如何在工程中,配置后臺(tái)的統(tǒng)一公共返回類,這樣做目的是為了統(tǒng)一返回信息,方便項(xiàng)目進(jìn)行管理。使用技術(shù):SpringBoot+Swagger+Lombok
項(xiàng)目結(jié)構(gòu)

具體過程如下,在response文件夾下分別建立 CustomizeResultCode 接口,枚舉類ResultCode 實(shí)現(xiàn)CustomizeResultCode 接口和Result類:
1 配置自定義返回類接口,該接口中包含 錯(cuò)誤狀態(tài)碼和錯(cuò)誤信息
public interface CustomizeResultCode {
/*
獲取錯(cuò)誤碼
@return 錯(cuò)誤狀態(tài)碼
*/
Integer getCode();
/*
獲取錯(cuò)誤信息
@return 錯(cuò)誤信息
*/
String getMessage();
}
2 配置返回實(shí)現(xiàn)類,注意這里是個(gè)枚舉類,里面的編碼僅供參考,可以自定義
/**
* @Description: 返回碼定義
* 規(guī)定:
* #200表示成功
* #400表示錯(cuò)誤
* #1001~1999 區(qū)間表示參數(shù)錯(cuò)誤
* #2001~2999 區(qū)間表示用戶錯(cuò)誤
* #3001~3999 區(qū)間表示接口異常
* #后面對(duì)什么的操作自己在這里注明就行了
*/
public enum ResultCode implements CustomizeResultCode{
/* 成功 */
SUCCESS(200, "成功"),
/*錯(cuò)誤*/
ERROR(400,"錯(cuò)誤失敗"),
/* 默認(rèn)失敗 */
COMMON_FAIL(999, "失敗"),
/* 參數(shù)錯(cuò)誤:1000~1999 */
PARAM_NOT_VALID(1001, "參數(shù)無效"),
PARAM_IS_BLANK(1002, "參數(shù)為空"),
/* 用戶錯(cuò)誤 */
USER_NOT_LOGIN(2001, "用戶未登錄"),
USER_ACCOUNT_EXPIRED(2002, "賬號(hào)已過期"),
USER_CREDENTIALS_ERROR(2003, "密碼錯(cuò)誤"),
/*運(yùn)行時(shí)異常*/
ARITHMETIC_EXCEPTION(9001,"算數(shù)異常");
;
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 = "返回?cái)?shù)據(jù)")
private Map<String,Object> data=new HashMap<>();
/*
構(gòu)造方法私有化,里面的方法都為靜態(tài)方法
達(dá)到保護(hù)屬性的作用
*/
private Result(){
}
/*
使用鏈?zhǔn)骄幊?
該部分在項(xiàng)目組中一般是項(xiàng)目組長寫好的
*/
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();
//鏈?zhǔn)骄幊?
return Result.ok().data("users",list);
}
}
測(cè)試結(jié)果成功

到此這篇關(guān)于SpringBoot 統(tǒng)一公共返回類的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot 統(tǒng)一公共返回類內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
springmvc九大組件之HandlerAdapter詳解
這篇文章主要介紹了springmvc九大組件之HandlerAdapter詳解,RequestMappingHandlerAdapter支持的handler的類型是HandlerMethod,而HandlerMethod是通過解析@RequestMapping注解獲得的,需要的朋友可以參考下2023-11-11
IntelliJ IDEA創(chuàng)建普通的Java 項(xiàng)目及創(chuàng)建 Java 文件并運(yùn)行的教程
這篇文章主要介紹了IntelliJ IDEA創(chuàng)建普通的Java 項(xiàng)目及創(chuàng)建 Java 文件并運(yùn)行的教程,本文通過圖文并茂的形式給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-02-02
springboot攔截器過濾token,并返回結(jié)果及異常處理操作
這篇文章主要介紹了springboot攔截器過濾token,并返回結(jié)果及異常處理操作,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-09-09
Spring security如何重寫Filter實(shí)現(xiàn)json登錄
這篇文章主要介紹了Spring security 如何重寫Filter實(shí)現(xiàn)json登錄,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-09-09
使用Java代碼實(shí)現(xiàn)RocketMQ的生產(chǎn)與消費(fèi)消息
這篇文章介紹一下其他的小組件以及使用Java代碼實(shí)現(xiàn)生產(chǎn)者對(duì)消息的生成,消費(fèi)者消費(fèi)消息等知識(shí)點(diǎn),并通過代碼示例介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2024-07-07
Spring Boot mybatis-config 和 log4j 輸出sql 日志的方式
這篇文章主要介紹了Spring Boot mybatis-config 和 log4j 輸出sql 日志的方式,本文通過實(shí)例圖文相結(jié)合給大家介紹的非常詳細(xì),需要的朋友可以參考下2021-07-07
Java深入了解數(shù)據(jù)結(jié)構(gòu)之優(yōu)先級(jí)隊(duì)列(堆)
普通的隊(duì)列是一種先進(jìn)先出的數(shù)據(jù)結(jié)構(gòu),元素在隊(duì)列尾追加,而從隊(duì)列頭刪除。在優(yōu)先隊(duì)列中,元素被賦予優(yōu)先級(jí)。當(dāng)訪問元素時(shí),具有最高優(yōu)先級(jí)的元素最先刪除。優(yōu)先隊(duì)列具有最高級(jí)先出 (first in, largest out)的行為特征。通常采用堆數(shù)據(jù)結(jié)構(gòu)來實(shí)現(xiàn)2022-01-01

