Spring Boot 2.x如何統(tǒng)一返回值

這篇文章主要介紹了Spring Boot 2.x如何統(tǒng)一返回值，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

為什么要統(tǒng)一返回值

在我們做后端應(yīng)用的時(shí)候，前后端分離的情況下，我們經(jīng)常會(huì)定義一個(gè)數(shù)據(jù)格式，通常會(huì)包含code，message，data這三個(gè)必不可少的信息來(lái)方便我們的交流，下面我們直接來(lái)看代碼

ReturnVO

package indi.viyoung.viboot.util;

import java.util.Properties;

/**
 * 統(tǒng)一定義返回類
 *
 * @author yangwei
 * @since 2018/12/20
 */
public class ReturnVO {

    private static final Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + "/viboot-common/src/main/resources/response.properties");

    /**
     * 返回代碼
     */
    private String code;

    /**
     * 返回信息
     */
    private String message;

    /**
     * 返回?cái)?shù)據(jù)
     */
    private Object data;


    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    /**
     * 默認(rèn)構(gòu)造，返回操作正確的返回代碼和信息
     */
    public ReturnVO() {
        this.setCode(properties.getProperty(ReturnCode.SUCCESS.val()));
        this.setMessage(properties.getProperty(ReturnCode.SUCCESS.msg()));
    }

    /**
     * 構(gòu)造一個(gè)返回特定代碼的ReturnVO對(duì)象
     * @param code
     */
    public ReturnVO(ReturnCode code) {
        this.setCode(properties.getProperty(code.val()));
        this.setMessage(properties.getProperty(code.msg()));
    }

    /**
     * 默認(rèn)值返回，默認(rèn)返回正確的code和message
     * @param data
     */
    public ReturnVO(Object data) {
        this.setCode(properties.getProperty(ReturnCode.SUCCESS.val()));
        this.setMessage(properties.getProperty(ReturnCode.SUCCESS.msg()));
        this.setData(data);
    }

    /**
     * 構(gòu)造返回代碼，以及自定義的錯(cuò)誤信息
     * @param code
     * @param message
     */
    public ReturnVO(ReturnCode code, String message) {
        this.setCode(properties.getProperty(code.val()));
        this.setMessage(message);
    }

    /**
     * 構(gòu)造自定義的code，message，以及data
     * @param code
     * @param message
     * @param data
     */
    public ReturnVO(ReturnCode code, String message, Object data) {
        this.setCode(code.val());
        this.setMessage(message);
        this.setData(data);
    }

    @Override
    public String toString() {
        return "ReturnVO{" +
                "code='" + code + '\'' +
                ", message='" + message + '\'' +
                ", data=" + data +
                '}';
    }
}

在這里，我提供了幾個(gè)構(gòu)造方法以供不同情況下使用。代碼的注釋已經(jīng)寫得很清楚了，大家也可以應(yīng)該看的比較清楚~

ReturnCode

細(xì)心的同學(xué)可能發(fā)現(xiàn)了，我單獨(dú)定義了一個(gè)ReturnCode枚舉類用于存儲(chǔ)代碼和返回的Message：

package indi.viyoung.viboot.util;

/**
 * @author yangwei
 * @since 2018/12/20
 */
public enum ReturnCode {

    /** 操作成功 */
    SUCCESS("SUCCESS_CODE", "SUCCESS_MSG"),

    /** 操作失敗 */
    FAIL("FAIL_CODE", "FAIL_MSG"),

    /** 空指針異常 */
    NullpointerException("NPE_CODE", "NPE_MSG"),

    /** 自定義異常之返回值為空 */
    NullResponseException("NRE_CODE", "NRE_MSG");


    private ReturnCode(String value, String msg){
        this.val = value;
        this.msg = msg;
    }

    public String val() {
        return val;
    }

    public String msg() {
        return msg;
    }

    private String val;
    private String msg;
}

這里，我并沒(méi)有將需要存儲(chǔ)的數(shù)據(jù)直接放到枚舉中，而是放到了一個(gè)配置文件中，這樣既可以方便我們進(jìn)行相關(guān)信息的修改，并且閱讀起來(lái)也是比較方便。

SUCCESS_CODE=2000
SUCCESS_MSG=操作成功

FAIL_CODE=5000
FAIL_MSG=操作失敗

NPE_CODE=5001
NPE_MSG=空指針異常

NRE_CODE=5002
NRE_MSG=返回值為空

注意，這里的屬性名和屬性值分別與枚舉類中的value和msg相對(duì)應(yīng)，這樣，我們才可以方便的去通過(guò)I/O流去讀取。

這里需要注意一點(diǎn)，如果你使用的是IDEA編輯器，需要修改以下的配置，這樣你編輯配置文件的時(shí)候?qū)懙氖侵形?，?shí)際上保存的是ASCII字節(jié)碼。

下面，來(lái)看一下讀取的工具類：

package indi.viyoung.viboot.util;

import java.io.*;
import java.util.Iterator;
import java.util.Properties;

/**
 * 讀取*.properties中的屬性
 * @author vi
 * @since 2018/12/24 7:33 PM
 */
public class ReadPropertiesUtil {

    public static Properties getProperties(String propertiesPath){
        Properties properties = new Properties();
        try {
            InputStream inputStream = new BufferedInputStream(new FileInputStream(propertiesPath));
            properties.load(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return properties;
    }
}

這里我直接寫了一個(gè)靜態(tài)的方法，傳入的參數(shù)是properties文件的位置，這樣的話，本文最初代碼中的也就得到了解釋。

    private static final Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + "/viboot-common/src/main/resources/response.properties");

使用ReturnVO

    @RequestMapping("/test")
    public ReturnVO test(){
        try {
           //省略
            //省略
        }  catch (Exception e) {
            e.printStackTrace();
        }
        return new ReturnVO();
    }

下面我們可以去訪問(wèn)這個(gè)接口，看看會(huì)得到什么：

但是，現(xiàn)在問(wèn)題又來(lái)了，因?yàn)?code>try...catch...的存在，總是會(huì)讓代碼變得重復(fù)度很高，一個(gè)接口你都至少要去花三到十秒去寫這個(gè)接口，如果不知道編輯器的快捷鍵，更是一種噩夢(mèng)。我們只想全心全意的去關(guān)注實(shí)現(xiàn)業(yè)務(wù)，而不是花費(fèi)大量的時(shí)間在編寫一些重復(fù)的"剛需"代碼上。

使用AOP進(jìn)行全局異常的處理

（這里，我只是對(duì)全局異常處理進(jìn)行一個(gè)簡(jiǎn)單的講解，后面也就是下一節(jié)中會(huì)詳細(xì)的講述）

/**
 * 統(tǒng)一封裝返回值和異常處理
 *
 * @author vi
 * @since 2018/12/20 6:09 AM
 */
@Slf4j
@Aspect
@Order(5)
@Component
public class ResponseAop {

    private static final Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + "/viboot-common/src/main/resources/response.properties");

    /**
     * 切點(diǎn)
     */
    @Pointcut("execution(public * indi.viyoung.viboot.*.controller..*(..))")
    public void httpResponse() {
    }

    /**
     * 環(huán)切
     */
    @Around("httpResponse()")
    public ReturnVO handlerController(ProceedingJoinPoint proceedingJoinPoint) {
        ReturnVO returnVO = new ReturnVO();
        try {
             //獲取方法的執(zhí)行結(jié)果
            Object proceed = proceedingJoinPoint.proceed();
            //如果方法的執(zhí)行結(jié)果是ReturnVO，則將該對(duì)象直接返回
            if (proceed instanceof ReturnVO) {
                returnVO = (ReturnVO) proceed;
            } else {
                //否則，就要封裝到ReturnVO的data中
                returnVO.setData(proceed);
            }
        }  catch (Throwable throwable) {
             //如果出現(xiàn)了異常，調(diào)用異常處理方法將錯(cuò)誤信息封裝到ReturnVO中并返回
            returnVO = handlerException(throwable);
        }
        return returnVO;
    }

    /**
     * 異常處理
     */ 
    private ReturnVO handlerException(Throwable throwable) {
        ReturnVO returnVO = new ReturnVO();
        //這里需要注意，返回枚舉類中的枚舉在寫的時(shí)候應(yīng)該和異常的名稱相對(duì)應(yīng)，以便動(dòng)態(tài)的獲取異常代碼和異常信息
        //獲取異常名稱的方法
        String errorName = throwable.toString();
        errorName = errorName.substring(errorName.lastIndexOf(".") + 1);
        //直接獲取properties文件中的內(nèi)容
         returnVO.setMessage(properties.getProperty(ReturnCode.valueOf(errorName).msg()));
        returnVO.setCode(properties.getProperty(ReturnCode.valueOf(errorName).val()));
        return returnVO;
    }
}

如果，我們需要在每一個(gè)項(xiàng)目中都可以這么去做，需要將這個(gè)類放到一個(gè)公用的模塊中，然后在pom中導(dǎo)入這個(gè)模塊

        <dependency>
            <groupId>indi.viyoung.course</groupId>
            <artifactId>viboot-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

這里需要注意一點(diǎn)，必須保證你的切點(diǎn)的正確書寫??！否則就會(huì)導(dǎo)致切點(diǎn)無(wú)效，同時(shí)需要在啟動(dòng)類中配置：

@ComponentScan(value = "indi.viyoung.viboot.*")

導(dǎo)入的正是common包下的所有文件，以保證可以將ResponseAop這個(gè)類加載到Spring的容器中。

下面我們來(lái)測(cè)試一下，訪問(wèn)我們經(jīng)過(guò)修改后的編寫的findAll接口：

    @RequestMapping("/findAll")
    public Object findAll(){
        return userService.list();
    }

PS：這里我將返回值統(tǒng)一為Object，以便數(shù)據(jù)存入data，實(shí)際類型應(yīng)是Service接口的返回類型。如果沒(méi)有返回值的話，那就可以new一個(gè)ReturnVO對(duì)象直接通過(guò)構(gòu)造方法賦值即可。關(guān)于返回類型為ReturnVO的判斷，代碼中也已經(jīng)做了特殊的處理，并非存入data，而是直接返回。

下面，我們修改一下test方法，讓他拋出一個(gè)我們自定義的查詢返回值為空的異常：

    @RequestMapping("/test")
    public ReturnVO test(){
        throw new NullResponseException();
    }

下面，我們?cè)賮?lái)訪問(wèn)以下test接口：

可以看到，正如我們properties中定義的那樣，我們得到了我們想要的消息。

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“Spring Boot 2.x如何統(tǒng)一返回值”這篇文章對(duì)大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，更多相關(guān)知識(shí)等著你來(lái)學(xué)習(xí)!