本系列文章介紹從0開(kāi)始搭建一個(gè)基于分布式的醫(yī)療掛號(hào)系統(tǒng)。本次四篇文章完成了醫(yī)院設(shè)置微服務(wù)模塊的后端接口，為了方便開(kāi)發(fā)，對(duì)接口的返回結(jié)果、全局異常、全局日志進(jìn)行了統(tǒng)一處理。 同時(shí)，為了方便進(jìn)行訪問(wèn)測(cè)試，還整合了Swagger2工具，這些通用的模塊中，除了全局日志被放在醫(yī)院設(shè)置微服務(wù)模塊的配置資源中，其余都統(tǒng)一被抽取在common模塊中。具體實(shí)現(xiàn)可參考下面文章：

• 醫(yī)院設(shè)置微服務(wù) | 模塊搭建
• 醫(yī)院設(shè)置微服務(wù) | 接口開(kāi)發(fā)
• 通用模塊 | 整合Swagger2
• 通用模塊 | 統(tǒng)一返回結(jié)果、統(tǒng)一異常處理、統(tǒng)一日志處理

---

作者：Hudie
微信公眾號(hào)/CSDN博客：編程一只蝶
項(xiàng)目已開(kāi)源至gitee：https://gitee.com/guo-qianliang/yygh_parent
項(xiàng)目已開(kāi)源至github：https://github.com/Guoqianliang/yygh_parent

一、統(tǒng)一返回結(jié)果

在實(shí)際開(kāi)發(fā)中，是一個(gè)后端團(tuán)隊(duì)一起開(kāi)發(fā)，每個(gè)人做不同的模塊，開(kāi)發(fā)不同的接口，最終進(jìn)行調(diào)用進(jìn)而顯示。因此可以把所有返回結(jié)果做一個(gè)統(tǒng)一的約定。讓所有的接口都返回相同的數(shù)據(jù)格式，這樣利于前端的顯示與解析。

統(tǒng)一返回結(jié)果類的運(yùn)用

上圖這一操作需要通過(guò)統(tǒng)一返回結(jié)果類 和統(tǒng)一返回結(jié)果狀態(tài)信息類 來(lái)實(shí)現(xiàn)。

1.統(tǒng)一返回結(jié)果類

/**
 * 全局統(tǒng)一返回結(jié)果類
 */
@Data
@ApiModel(value = "全局統(tǒng)一返回結(jié)果")
public class Result<T> {
    @ApiModelProperty(value = "返回碼")
    private Integer code;

    @ApiModelProperty(value = "返回消息")
    private String message;

    @ApiModelProperty(value = "返回?cái)?shù)據(jù)")
    private T data;

    public Result() {
    }

    protected static <T> Result<T> build(T data) {
        Result<T> result = new Result<T>();
        if (data != null) {
            result.setData(data);
        }
        return result;
    }

    public static <T> Result<T> build(T body, ResultCodeEnum resultCodeEnum) {
        Result<T> result = build(body);
        result.setCode(resultCodeEnum.getCode());
        result.setMessage(resultCodeEnum.getMessage());
        return result;
    }

    public static <T> Result<T> build(Integer code, String message) {
        Result<T> result = build(null);
        result.setCode(code);
        result.setMessage(message);
        return result;
    }

    public static <T> Result<T> ok() {
        return Result.ok(null);
    }

    /**
     * 操作成功
     * @param data
     * @param <T>
     * @return
     */
    public static <T> Result<T> ok(T data) {
        Result<T> result = build(data);
        return build(data, ResultCodeEnum.SUCCESS);
    }

    public static <T> Result<T> fail() {
        return Result.fail(null);
    }

    /**
     * 操作失敗
     * @param data
     * @param <T>
     * @return
     */
    public static <T> Result<T> fail(T data) {
        Result<T> result = build(data);
        return build(data, ResultCodeEnum.FAIL);
    }

    public Result<T> message(String msg) {
        this.setMessage(msg);
        return this;
    }

    public Result<T> code(Integer code) {
        this.setCode(code);
        return this;
    }

    public boolean isOk() {
        if (this.getCode().intValue() == ResultCodeEnum.SUCCESS.getCode().intValue()) {
            return true;
        }
        return false;
    }
}

2.統(tǒng)一返回狀態(tài)信息類

/**
 * 統(tǒng)一返回結(jié)果狀態(tài)信息類
 */
@Getter
public enum ResultCodeEnum {

    SUCCESS(200, "成功"),
    FAIL(201, "失敗"),
    PARAM_ERROR(202, "參數(shù)不正確"),
    SERVICE_ERROR(203, "服務(wù)異常"),
    DATA_ERROR(204, "數(shù)據(jù)異常"),
    DATA_UPDATE_ERROR(205, "數(shù)據(jù)版本異常"),

    LOGIN_AUTH(208, "未登陸"),
    PERMISSION(209, "沒(méi)有權(quán)限"),

    CODE_ERROR(210, "驗(yàn)證碼錯(cuò)誤"),
    //    LOGIN_MOBLE_ERROR(211, "賬號(hào)不正確"),
    LOGIN_DISABLED_ERROR(212, "改用戶已被禁用"),
    REGISTER_MOBLE_ERROR(213, "手機(jī)號(hào)已被使用"),
    LOGIN_AURH(214, "需要登錄"),
    LOGIN_ACL(215, "沒(méi)有權(quán)限"),

    URL_ENCODE_ERROR(216, "URL編碼失敗"),
    ILLEGAL_CALLBACK_REQUEST_ERROR(217, "非法回調(diào)請(qǐng)求"),
    FETCH_ACCESSTOKEN_FAILD(218, "獲取accessToken失敗"),
    FETCH_USERINFO_ERROR(219, "獲取用戶信息失敗"),
    //LOGIN_ERROR( 23005, "登錄失敗"),

    PAY_RUN(220, "支付中"),
    CANCEL_ORDER_FAIL(225, "取消訂單失敗"),
    CANCEL_ORDER_NO(225, "不能取消預(yù)約"),

    HOSCODE_EXIST(230, "醫(yī)院編號(hào)已經(jīng)存在"),
    NUMBER_NO(240, "可預(yù)約號(hào)不足"),
    TIME_NO(250, "當(dāng)前時(shí)間不可以預(yù)約"),

    SIGN_ERROR(300, "簽名錯(cuò)誤"),
    HOSPITAL_OPEN(310, "醫(yī)院未開(kāi)通，暫時(shí)不能訪問(wèn)"),
    HOSPITAL_LOCK(320, "醫(yī)院被鎖定，暫時(shí)不能訪問(wèn)"),
    ;

    private Integer code;
    private String message;

    private ResultCodeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }
}

二、統(tǒng)一異常處理

spring boot 默認(rèn)情況下會(huì)將異常映射到 /error 進(jìn)行異常處理，這樣的提示十分不友好，下面使用自定義異常處理，可以提供更友好的展示。

1.自定義異常類

/**
 * 自定義全局異常類
 *
 */
@Data
@ApiModel(value = "自定義全局異常類")
public class YyghException extends RuntimeException {

    @ApiModelProperty(value = "異常狀態(tài)碼")
    private Integer code;

    /**
     * 通過(guò)狀態(tài)碼和錯(cuò)誤消息創(chuàng)建異常對(duì)象
     * @param message
     * @param code
     */
    public YyghException(String message, Integer code) {
        super(message);
        this.code = code;
    }

    /**
     * 接收枚舉類型對(duì)象
     * @param resultCodeEnum
     */
    public YyghException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }

    @Override
    public String toString() {
        return "YyghException{" +
                "code=" + code +
                ", message=" + this.getMessage() +
                '}';
    }
}

2.全局異常處理

下面代碼中兩個(gè)方法的@ExceptionHandler注解，分別傳入系統(tǒng)異常Exception類和自定義異常YyghException類，當(dāng)出現(xiàn)系統(tǒng)異常時(shí)會(huì)運(yùn)行系統(tǒng)的Exception方法，當(dāng)出現(xiàn)自定義異常時(shí)會(huì)運(yùn)行YyghException方法。

/**
 * @Description: 統(tǒng)一異常處理類
 * @author Guoqianliang
 * @date 20:56 - 2021/4/7
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 全局異常處理
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result error(Exception e) {
        e.printStackTrace();
        return Result.fail();
    }

    /**
     * 自定義異常處理
     * @param e
     * @return
     */
    @ExceptionHandler(YyghException.class)
    @ResponseBody
    public Result error(YyghException e) {
        e.printStackTrace();
        return Result.fail();
    }
}

使用自定義異常時(shí)，不會(huì)自動(dòng)調(diào)用，需要手動(dòng)拋出異常，舉例如下：

手動(dòng)拋出異常

三、統(tǒng)一日志處理

日志記錄器(Logger)的行為是分等級(jí)的，常用的4個(gè)級(jí)別如下：

• DEBUG < INFO < WARN < ERROR

級(jí)別越高，打印的信息越多。默認(rèn)情況下，springboot從控制臺(tái)打印出來(lái)的日志級(jí)別只有INFO及以上級(jí)別，通過(guò)：logging.level.root=debug可以修改日志級(jí)別。

下面給出一個(gè)日志模塊，通過(guò)此模板可以將日志持久化到本地文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds">
    <!-- 日志級(jí)別從低到高分為T(mén)RACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設(shè)置為WARN，則低于WARN的信息都不會(huì)輸出 -->
    <!-- scan:當(dāng)此屬性設(shè)置為true時(shí)，配置文件如果發(fā)生改變，將會(huì)被重新加載，默認(rèn)值為true -->
    <!-- scanPeriod:設(shè)置監(jiān)測(cè)配置文件是否有修改的時(shí)間間隔，如果沒(méi)有給出時(shí)間單位，默認(rèn)單位是毫秒。當(dāng)scan為true時(shí)，此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。 -->
    <!-- debug:當(dāng)此屬性設(shè)置為true時(shí)，將打印出logback內(nèi)部日志信息，實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。 -->

    <contextName>logback</contextName>
    <!-- name的值是變量的名稱，value的值時(shí)變量定義的值。通過(guò)定義的值會(huì)被插入到logger上下文中。定義變量后，可以使“${}”來(lái)使用變量。 -->
    <property name="log.path" value="E:/IntelliJ_IDEA/workspace/yygh_parent/yygh_log"/>

    <!-- 彩色日志 -->
    <!-- 配置格式變量：CONSOLE_LOG_PATTERN 彩色日志格式 -->
    <!-- magenta:洋紅 -->
    <!-- boldMagenta:粗紅-->
    <!-- cyan:青色 -->
    <!-- white:白色 -->
    <!-- magenta:洋紅 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/>


    <!--輸出到控制臺(tái)-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是為開(kāi)發(fā)使用，只配置最底級(jí)別，控制臺(tái)輸出的日志級(jí)別是大于或等于此級(jí)別的日志信息-->
        <!-- 例如：如果此處配置了INFO級(jí)別，則后面其他位置即使配置了DEBUG級(jí)別的日志，也不會(huì)被輸出 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設(shè)置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--輸出到文件-->

    <!-- 時(shí)間滾動(dòng)輸出 level為 INFO 日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${log.path}/log_info.log</file>
        <!--日志文件輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志歸檔路徑以及格式 -->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天數(shù)-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只記錄info級(jí)別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時(shí)間滾動(dòng)輸出 level為 WARN 日志 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日志文件輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設(shè)置字符集 -->
        </encoder>
        <!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天數(shù)-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只記錄warn級(jí)別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 時(shí)間滾動(dòng)輸出 level為 ERROR 日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${log.path}/log_error.log</file>
        <!--日志文件輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此處設(shè)置字符集 -->
        </encoder>
        <!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天數(shù)-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只記錄ERROR級(jí)別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--
        <logger>用來(lái)設(shè)置某一個(gè)包或者具體的某一個(gè)類的日志打印級(jí)別、以及指定<appender>。
        <logger>僅有一個(gè)name屬性，
        一個(gè)可選的level和一個(gè)可選的addtivity屬性。
        name:用來(lái)指定受此logger約束的某一個(gè)包或者具體的某一個(gè)類。
        level:用來(lái)設(shè)置打印級(jí)別，大小寫(xiě)無(wú)關(guān)：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
              如果未設(shè)置此屬性，那么當(dāng)前l(fā)ogger將會(huì)繼承上級(jí)的級(jí)別。
    -->
    <!--
        使用mybatis的時(shí)候，sql語(yǔ)句是debug下才會(huì)打印，而這里我們只配置了info，所以想要查看sql語(yǔ)句的話，有以下兩種操作：
        第一種把<root level="INFO">改成<root level="DEBUG">這樣就會(huì)打印sql，不過(guò)這樣日志那邊會(huì)出現(xiàn)很多其他消息
        第二種就是單獨(dú)給mapper下目錄配置DEBUG模式，代碼如下，這樣配置sql語(yǔ)句會(huì)打印，其他還是正常DEBUG級(jí)別：
     -->
    <!--開(kāi)發(fā)環(huán)境:打印控制臺(tái)-->
    <springProfile name="dev">
        <!--可以輸出項(xiàng)目中的debug日志，包括mybatis的sql日志-->
        <logger name="com.guli" level="INFO"/>

        <!--
            root節(jié)點(diǎn)是必選節(jié)點(diǎn)，用來(lái)指定最基礎(chǔ)的日志輸出級(jí)別，只有一個(gè)level屬性
            level:用來(lái)設(shè)置打印級(jí)別，大小寫(xiě)無(wú)關(guān)：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，默認(rèn)是DEBUG
            可以包含零個(gè)或多個(gè)appender元素。
        -->
        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="INFO_FILE"/>
            <appender-ref ref="WARN_FILE"/>
            <appender-ref ref="ERROR_FILE"/>
        </root>
    </springProfile>


    <!--生產(chǎn)環(huán)境:輸出到文件-->
    <springProfile name="pro">

        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="DEBUG_FILE"/>
            <appender-ref ref="INFO_FILE"/>
            <appender-ref ref="ERROR_FILE"/>
            <appender-ref ref="WARN_FILE"/>
        </root>
    </springProfile>

</configuration>