Spring Boot 無(wú)侵入式 實(shí)現(xiàn)API接口統(tǒng)一JSON格式返回

其實(shí)本沒(méi)有沒(méi)打算寫這篇博客的，但還是要寫一下寫這篇博客的起因是因?yàn)椋F(xiàn)在呆著的這家公司居然沒(méi)有統(tǒng)一的API返回格式?，詢問(wèn)主管他居然告訴我用HTTP狀態(tài)碼就夠用了（fxxk），天哪HTTP狀態(tài)碼真的夠用嗎？

在仔細(xì)的閱讀了項(xiàng)目源碼后發(fā)現(xiàn)，在API請(qǐng)求的是居然沒(méi)有業(yè)務(wù)異常（黑人問(wèn)好）。好吧 居然入坑了只能遵照項(xiàng)目風(fēng)格了，懶得吐槽了。

因?yàn)轫?xiàng)目已經(jīng)開發(fā)了半年多了, 要是全部接口都做修改工作量還是挺大的, 只能用這種無(wú)侵入式的方案來(lái)解決.

項(xiàng)目源代碼: https://github.com/469753862/galaxy-blogs/tree/master/code/responseResult

定義JSON格式

定義返回JSON格式

后端返回給前端一般情況下使用JSON格式, 定義如下

{
????"code":?200,
????"message":?"OK",
????"data":?{

????}
}

• code: 返回狀態(tài)碼
• message: 返回信息的描述
• data: 返回值

定義JavaBean字段

定義狀態(tài)碼枚舉類

@ToString
@Getter
public?enum?ResultStatus?{

????SUCCESS(HttpStatus.OK,?200,?"OK"),
????BAD_REQUEST(HttpStatus.BAD_REQUEST,?400,?"Bad?Request"),
????INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR,?500,?"Internal?Server?Error"),;

????/**?返回的HTTP狀態(tài)碼,??符合http請(qǐng)求?*/
????private?HttpStatus?httpStatus;
????/**?業(yè)務(wù)異常碼?*/
????private?Integer?code;
????/**?業(yè)務(wù)異常信息描述?*/
????private?String?message;

????ResultStatus(HttpStatus?httpStatus,?Integer?code,?String?message)?{
????????this.httpStatus?=?httpStatus;
????????this.code?=?code;
????????this.message?=?message;
????}
}

狀態(tài)碼和信息以及http狀態(tài)碼就能一一對(duì)應(yīng)了便于維護(hù), 有同學(xué)有疑問(wèn)了為什么要用到http狀態(tài)碼呀,因?yàn)槲乙嫒蓓?xiàng)目以前的代碼, 沒(méi)有其他原因, 當(dāng)然其他同學(xué)不喜歡http狀態(tài)碼的可以吧源碼中HttpStatus給刪除了

定義返回體類

@Getter
@ToString
public?class?Result<T>?{
????/**?業(yè)務(wù)錯(cuò)誤碼?*/
????private?Integer?code;
????/**?信息描述?*/
????private?String?message;
????/**?返回參數(shù)?*/
????private?T?data;

????private?Result(ResultStatus?resultStatus,?T?data)?{
????????this.code?=?resultStatus.getCode();
????????this.message?=?resultStatus.getMessage();
????????this.data?=?data;
????}

????/**?業(yè)務(wù)成功返回業(yè)務(wù)代碼和描述信息?*/
????public?static?Result?success()?{
????????return?new?Result(ResultStatus.SUCCESS,?null);
????}

????/**?業(yè)務(wù)成功返回業(yè)務(wù)代碼,描述和返回的參數(shù)?*/
????public?static??Result?success(T?data)?{
????????return?new?Result(ResultStatus.SUCCESS,?data);
????}

????/**?業(yè)務(wù)成功返回業(yè)務(wù)代碼,描述和返回的參數(shù)?*/
????public?static??Result?success(ResultStatus?resultStatus,?T?data)?{
????????if?(resultStatus?==?null)?{
????????????return?success(data);
????????}
????????return?new?Result(resultStatus,?data);
????}

????/**?業(yè)務(wù)異常返回業(yè)務(wù)代碼和描述信息?*/
????public?static??Result?failure()?{
????????return?new?Result(ResultStatus.INTERNAL_SERVER_ERROR,?null);
????}

????/**?業(yè)務(wù)異常返回業(yè)務(wù)代碼,描述和返回的參數(shù)?*/
????public?static??Result?failure(ResultStatus?resultStatus)?{
????????return?failure(resultStatus,?null);
????}

????/**?業(yè)務(wù)異常返回業(yè)務(wù)代碼,描述和返回的參數(shù)?*/
????public?static??Result?failure(ResultStatus?resultStatus,?T?data)?{
????????if?(resultStatus?==?null)?{
????????????return?new?Result(ResultStatus.INTERNAL_SERVER_ERROR,?null);
????????}
????????return?new?Result(resultStatus,?data);
????}
}

因?yàn)槭褂脴?gòu)造方法進(jìn)行創(chuàng)建對(duì)象太麻煩了, 我們使用靜態(tài)方法來(lái)創(chuàng)建對(duì)象這樣簡(jiǎn)單明了

Result實(shí)體返回測(cè)試

@RestController
@RequestMapping("/hello")
public?class?HelloController?{

????private?static?final?HashMap?INFO;

????static?{
????????INFO?=?new?HashMap<>();
????????INFO.put("name",?"galaxy");
????????INFO.put("age",?"70");
????}

????@GetMapping("/hello")
????public?Map?hello()?{
????????return?INFO;
????}

????@GetMapping("/result")
????@ResponseBody
????public?Result>?helloResult()?{
????????return?Result.success(INFO);
????}
}

到這里我們已經(jīng)簡(jiǎn)單的實(shí)現(xiàn)了統(tǒng)一JSON格式了, 但是我們也發(fā)現(xiàn)了一個(gè)問(wèn)題了,想要返回統(tǒng)一的JSON格式需要返回Result