快捷導(dǎo)航

SpringBoot全局處理統(tǒng)一返回類型方式

更新時(shí)間：2023年07月21日 14:38:59 作者：Ray丿雷

這篇文章主要介紹了SpringBoot全局處理統(tǒng)一返回類型方式，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

SpringBoot全局處理統(tǒng)一返回類型

在日常開發(fā)中，我們會定義各種各樣的返回類型，不便于后期維護(hù)，也不便于前臺進(jìn)行數(shù)據(jù)處理；有些項(xiàng)目會封裝一個(gè)統(tǒng)一的返回類型，讓開發(fā)人員用這個(gè)封裝類返回，但是隨著項(xiàng)目人員的變更，如果沒有統(tǒng)一的要求規(guī)范，后期也會變得不可控，而且代碼的耦合度也太高。

基于此場景，我們封裝了一個(gè)統(tǒng)一返回類型（響應(yīng)狀態(tài)、返回?cái)?shù)據(jù)等），并設(shè)置全局統(tǒng)一處理。

接口調(diào)用返回如下所示：

{
	"code": 200,   //響應(yīng)狀態(tài)
	"cost": 0,     //請求耗時(shí)，在本文章不做演示
	"data": "test",//返回?cái)?shù)據(jù)
	"msg": "成功"   //響應(yīng)描述
}

需要的依賴

首先添加需要的依賴

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.9</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

Result（返回類）

然后，我們定義一個(gè)返回類，全局返回統(tǒng)一采用本模板返回，包含一個(gè)前端常用字段，還有一些初始化對象的方法。

package com.gml.springboot2.entity;
import com.gml.springboot2.enums.ResultEnum;
import lombok.Data;
import java.io.Serializable;
/**
 * @author gml
 * @description  全局統(tǒng)一返回類型
 * @date 2019/11/29
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result<T> implements Serializable {
    /**
     * 成功數(shù)據(jù)
     */
    private T data;
    /**
     * 響應(yīng)編碼200為成功
     */
    private Integer code;
    /**
     * 請求消耗時(shí)間
     */
    private long cost;
    /**
     * 描述
     */
    private String msg;
    /**
     * 請求id
     */
    private String requestId;
    public Result(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public static Result create(Integer code, String msg){
        Result result = new Result(code, msg);
        return result;
    }
    /**
     * 無數(shù)據(jù)返回成功
     * @return
     */
    public static Result createSuccess() {
        return create(ResultEnum.SUCCESS.getCode(), ResultEnum.SUCCESS.getMsg());
    }
    /**
     * 有數(shù)據(jù)返回成功
     * @param data
     * @param <T>
     * @return
     */
    public static <T> Result<T> createSuccess(T data) {
        return createSuccess().setData(data);
    }
    /**
     * 無描述返回失敗
     * @return
     */
    public static Result createFail() {
        return create(ResultEnum.Fail.getCode(), ResultEnum.Fail.getMsg());
    }
    /**
     * 自定義返回失敗描述
     * @param code
     * @param msg
     * @return
     */
    public static Result createFail(Integer code, String msg) {
        return create(code, msg);
    }
    public Result setData(T data){
        this.data = data;
        return this;
    }
}

全局設(shè)置

實(shí)現(xiàn)ResponseBodyAdvice接口，ResponseBodyAdvice是Spring4.1新加入的接口，在消息體被HttpMessageConverter寫入之前允許Controller中的方法調(diào)整響應(yīng)中的內(nèi)容，比如做一些返回處理。

ResponseBodyAdvice接口里面一共定義了兩個(gè)方法

supports：進(jìn)行一些邏輯判斷是否需要進(jìn)行后續(xù)的beforeBodyWrite的方法
beforeBodyWrite：進(jìn)行一些返回處理

然后一定一個(gè)類實(shí)現(xiàn)ResponseBodyAdvice接口，代碼如下：

package com.gml.springboot2.config;
import com.alibaba.fastjson.JSONObject;
import com.gml.springboot2.entity.Result;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import java.util.Objects;
/**
 * @author gml
 * @description
 * @date 2019/11/29
 */
@RestControllerAdvice
public class CommonResponseAdvice implements ResponseBodyAdvice {
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return filter(methodParameter);
    }
    /**
     * 根據(jù)返回類型來判斷是否需要進(jìn)行后續(xù)操作
     * @param methodParameter
     * @return
     */
    private boolean filter(MethodParameter methodParameter) {
        return true;
    }
    /**
     *
     * @param returnValue           返回值
     * @param methodParameter       Controller方法返回類型
     * @param mediaType
     * @param aClass
     * @param serverHttpRequest
     * @param serverHttpResponse
     * @return
     */
    @Override
    public Object beforeBodyWrite(Object returnValue, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        Result result;
        //獲取返回值類型
        String returnClassType = returnType.getParameterType().getSimpleName();
        //如果返回值類型為void，則默認(rèn)返回成功
        if("void".equals(returnClassType)){
            result = Result.createSuccess();
        }else if ("Result".equals(returnClassType)){
            result = (Result) returnValue;
        }else if ("String".equals(returnClassType)){
            //json的轉(zhuǎn)換會出問題
            result = Result.createSuccess(returnValue);
            result.setCost(cost);
            return JSON.toJSONString(result);
        }else {
            if (Objects.isNull(returnValue)){
                result = Result.createSuccess();
            }else {
                result = Result.createSuccess(returnValue);
            }
        }
        //一定要轉(zhuǎn)換為String，否則會報(bào)錯(cuò)
        return result;
    }
}

測試

寫一個(gè)Controller，測試一下返回值

package com.gml.springboot2.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author gml
 * @description
 * @date 2019/11/29
 */
@RestController
public class TestController {
    @RequestMapping("/test")
    public String test(){
        return "返回?cái)?shù)據(jù)";
    }
}

瀏覽器訪問如下圖