無侵入式 統一返回JSON格式

其實本沒有沒打算寫這篇博客的，但還是要寫一下寫這篇博客的起因是因為，現在呆著的這家公司居然沒有統一的API返回格式，詢問主管他居然告訴我用HTTP狀態(tài)碼就夠用了（fxxk），天哪HTTP狀態(tài)碼真的夠用嗎？在仔細的閱讀了項目源碼后發(fā)現，在API請求的是居然沒有業(yè)務異常（黑人問好）。好吧 居然入坑了只能遵照項目風格了，懶得吐槽了。

因為項目已經開發(fā)了半年多了, 要是全部接口都做修改工作量還是挺大的, 只能用這種無侵入式的方案來解決.

定義JSON格式

定義返回JSON格式

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

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

code: 返回狀態(tài)碼

message: 返回信息的描述

data: 返回值

定義JavaBean字段

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

@ToString
@Getter
@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請求?*/
????private?HttpStatus?httpStatus;
????/**?業(yè)務異常碼?*/
????private?Integer?code;
????/**?業(yè)務異常信息描述?*/
????private?String?message;

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

狀態(tài)碼和信息以及http狀態(tài)碼就能一一對應了便于維護, 有同學有疑問了為什么要用到http狀態(tài)碼呀,因為我要兼容項目以前的代碼, 沒有其他原因, 當然其他同學不喜歡http狀態(tài)碼的可以吧源碼中HttpStatus給刪除了定義返回體類

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

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

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

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

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

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

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

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

因為使用構造方法進行創(chuàng)建對象太麻煩了, 我們使用靜態(tài)方法來創(chuàng)建對象這樣簡單明了

Result實體返回測試

@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);
????}
}

到這里我們已經簡單的實現了統一JSON格式了, 但是我們也發(fā)現了一個問題了,想要返回統一的JSON格式需要返回Result Object才可以, 我明明返回Object可以了, 為什么要重復勞動, 有沒有解決方法, 當然是有的啦, 下面我們開始優(yōu)化我們的代碼吧

統一返回JSON格式進階-全局處理(@RestControllerAdvice)

我?guī)煾到洺８嬖V我的一句話: “你就是一個小屁孩, 你遇到的問題都已經不知道有多少人遇到過了, 你會想到的問題, 已經有前輩想到過了. 你準備解決的問題, 已經有人把坑填了”。是不是很雞湯, 是不是很勵志, 讓我對前輩們充滿著崇拜, 事實上他對我說的是: “自己去百度”, 這五個大字, 其實這五個大字已經說明上明的B話了, 通過不斷的百度和Google發(fā)現了很多的解決方案.

我們都知道使用@ResponseBody注解會把返回Object序列化成JSON字符串,就先從這個入手吧, 大致就是在序列化前把Object賦值給Result Object就可以了, 大家可以觀摩org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice和org.springframework.web.bind.annotation.ResponseBody
@ResponseBody繼承類
我們已經決定從@ResponseBody注解入手了就創(chuàng)建一個注解類繼承@ResponseBody, 很干凈什么都沒有哈哈,@ResponseResultBody 可以標記在類和方法上這樣我們就可以跟自由的進行使用了

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,?ElementType.METHOD})
@Documented
@ResponseBody
public?@interface?ResponseResultBody?{

}

ResponseBodyAdvice繼承類

@RestControllerAdvice
public?class?ResponseResultBodyAdvice?implements?ResponseBodyAdvice