項目構建基礎-統一結果，統一異常，統一日誌

時間  2019-12-31
標籤 項目 構建 基礎 統一 結果 異常 日誌 简体版
原文   原文鏈接

統一結果返回

目前的先後端開發大部分數據的傳輸格式都是json，所以定義一個統一規範的數據格式有利於先後端的交互與UI的展現。php

統一結果的通常形式

  1. 是否響應成功；
  2. 響應狀態碼；
  3. 狀態碼描述；
  4. 響應數據
  5. 其餘標識符

結果類枚舉

  • 前三者可定義結果枚舉，如：success，code，message
@Getter
public enum ResultCodeEnum {
    SUCCESS(true,20000,"成功"),
    UNKNOWN_ERROR(false,20001,"未知錯誤"),,
    PARAM_ERROR(false,20002,"參數錯誤"),
    ;

    // 響應是否成功
    private Boolean success;
    // 響應狀態碼
    private Integer code;
    // 響應信息
    private String message;

    ResultCodeEnum(boolean success, Integer code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }
}
複製代碼

統一結果類

  • 第5個屬於自定義返回，利用前4者可定義統一返回對象

注意：html

  1. 外接只能夠調用統一返回類的方法，不能夠直接建立，影刺構造器私有；
  2. 內置靜態方法，返回對象；
  3. 爲便於自定義統一結果的信息，建議使用鏈式編程，將返回對象設類自己，即return this;
  4. 響應數據因爲爲json格式，可定義爲JsonObject或Map形式；
@Data
public class R {
    private Boolean success;

    private Integer code;

    private String message;

    private Map<String, Object> data = new HashMap<>();

    // 構造器私有
    private R(){}

    // 通用返回成功
    public static R ok() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
        r.setCode(ResultCodeEnum.SUCCESS.getCode());
        r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
        return r;
    }

    // 通用返回失敗，未知錯誤
    public static R error() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.UNKNOWN_ERROR.getSuccess());
        r.setCode(ResultCodeEnum.UNKNOWN_ERROR.getCode());
        r.setMessage(ResultCodeEnum.UNKNOWN_ERROR.getMessage());
        return r;
    }

    // 設置結果，形參爲結果枚舉
    public static R setResult(ResultCodeEnum result) {
        R r = new R();
        r.setSuccess(result.getSuccess());
        r.setCode(result.getCode());
        r.setMessage(result.getMessage());
        return r;
    }

    /**------------使用鏈式編程，返回類自己-----------**/
    
    // 自定義返回數據
    public R data(Map<String,Object> map) {
        this.setData(map);
        return this;
    }

    // 通用設置data
    public R data(String key,Object value) {
        this.data.put(key, value);
        return this;
    }

    // 自定義狀態信息
    public R message(String message) {
        this.setMessage(message);
        return this;
    }

    // 自定義狀態碼
    public R code(Integer code) {
        this.setCode(code);
        return this;
    }

    // 自定義返回結果
    public R success(Boolean success) {
        this.setSuccess(success);
        return this;
    }
}
複製代碼

控制層返回

  • 視圖層使用統一結果
@RestController
@RequestMapping("/api/v1/users")
public class TeacherAdminController {

    @Autowired
    private UserService userService;

    @GetMapping
    public R list() {
        List<Teacher> list = teacherService.list(null);
        return R.ok().data("itms", list).message("用戶列表");
    }
}    
複製代碼
  • json結果
{
  "success": true,
  "code": 20000,
  "message": "查詢用戶列表",
  "data": {
    "itms": [
      {
        "id": "1",
        "username": "admin",
        "role": "ADMIN",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      },{
        "id": "2",
        "username": "zhangsan",
        "role": "USER",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      }
    ]
  }
}
複製代碼

統一結果類的使用參考了mybatis-plus中R對象的設計java

統一異常處理

使用統一返回結果時，還有一種狀況，就是程序的保存是因爲運行時異常致使的結果，有些異常咱們能夠沒法提早預知，不能正常走到咱們return的R對象返回。web

所以，咱們須要定義一個統一的全局異常來捕獲這些信息，並做爲一種結果返回控制層spring

@ControllerAdvice

該註解爲統一異常處理的核心sql

是一種做用於控制層的切面通知（Advice），該註解可以將通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一個類型，並應用到全部控制器上編程

該類中的設計思路：json

  1. 使用@ExceptionHandler註解捕獲指定或自定義的異常；
  2. 使用@ControllerAdvice集成@ExceptionHandler的方法到一個類中；
  3. 必須定義一個通用的異常捕獲方法，便於捕獲未定義的異常信息；
  4. 自定一個異常類，捕獲針對項目或業務的異常;
  5. 異常的對象信息補充到統一結果枚舉中；

自定義全局異常類

@Data
public class CMSException extends RuntimeException {
    private Integer code;

    public CMSException(Integer code, String message) {
        super(message);
        this.code = code;
    }

    public CMSException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }

    @Override
    public String toString() {
        return "CMSException{" + "code=" + code + ", message=" + this.getMessage() + '}';
    }
}
複製代碼

統一異常處理器

// ...
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class GlobalExceptionHandler {

    /**-------- 通用異常處理方法 --------**/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        e.printStackTrace();
        return R.error();	// 通用異常結果
    }

    /**-------- 指定異常處理方法 --------**/
    @ExceptionHandler(NullPointerException.class)
    @ResponseBody
    public R error(NullPointerException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.NULL_POINT);
    }

    @ExceptionHandler(HttpClientErrorException.class)
    @ResponseBody
    public R error(IndexOutOfBoundsException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.HTTP_CLIENT_ERROR);
    }
    
    /**-------- 自定義定異常處理方法 --------**/
    @ExceptionHandler(CMSException.class)
    @ResponseBody
    public R error(CMSException e) {
        e.printStackTrace();
        return R.error().message(e.getMessage()).code(e.getCode());
    }
}
複製代碼

控制層展現

如下爲展現當遇到null指定異常時，返回的結果信息後端

{
  "success": false,
  "code": 20007,
  "message": "空指針異常",
  "data": {}
}
複製代碼

本節介紹統一異常較爲簡略，推薦博客SpringBoot之全局異常處理api

統一日誌收集

日誌是追蹤錯誤定位問題的關鍵，尤爲在生產環境中，須要及時修復熱部署，不會提供開發者debug的環境，此時日誌將會是最快解決問題的關鍵

日誌的框架比較豐富，因爲spring boot對logback的集成，所以推薦使用logback在項目中使用。

Logback

關於logback的配置和介紹，能夠參考官網或推薦博客glmapper的logback博客，logback-spring.xml配置文件

配置

如下直接貼出配置信息，介紹信息科直接參考備註

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，若是設置爲WARN，則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置爲true時，配置文檔若是發生改變，將會被從新加載，默認值爲true -->
<!-- scanPeriod:設置監測配置文檔是否有修改的時間間隔，若是沒有給出時間單位，默認單位是毫秒。 當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。 -->
<!-- debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。 -->
<configuration scan="true" scanPeriod="10 seconds">
    <contextName>logback</contextName>

    <!-- name的值是變量的名稱，value的值時變量定義的值。經過定義的值會被插入到logger上下文中。定義後，可使「${}」來使用變量。 -->
    <property name="log.path" value="D:/Documents/logs/edu" />

    <!--0. 日誌格式和顏色渲染 -->
    <!-- 彩色日誌依賴的渲染類 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日誌格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <!--1. 輸出到控制檯-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日誌appender是爲開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--2. 輸出到文檔-->
    <!-- 2.1 level爲 DEBUG 日誌，時間滾動輸出 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
        <file>${log.path}/edu_debug.log</file>
        <!--日誌文檔輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 設置字符集 -->
        </encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日誌歸檔 -->
            <fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文檔保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文檔只記錄debug級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 2.2 level爲 INFO 日誌，時間滾動輸出 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
        <file>${log.path}/edu_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>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 天天日誌歸檔路徑以及格式 -->
            <fileNamePattern>${log.path}/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文檔保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文檔只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

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

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

    <!-- <logger>用來設置某一個包或者具體的某一個類的日誌打印級別、 以及指定<appender>。<logger>僅有一個name屬性， 一個可選的level和一個可選的addtivity屬性。 name:用來指定受此logger約束的某一個包或者具體的某一個類。 level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF， 還有一個特俗值INHERITED或者同義詞NULL，表明強制執行上級的級別。 若是未設置此屬性，那麼當前logger將會繼承上級的級別。 addtivity:是否向上級logger傳遞打印信息。默認是true。 <logger name="org.springframework.web" level="info"/> <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/> -->

    <!-- 使用mybatis的時候，sql語句是debug下才會打印，而這裏咱們只配置了info，因此想要查看sql語句的話，有如下兩種操做： 第一種把<root level="info">改爲<root level="DEBUG">這樣就會打印sql，不過這樣日誌那邊會出現不少其餘消息 第二種就是單獨給dao下目錄配置debug模式，代碼以下，這樣配置sql語句會打印，其餘仍是正常info級別： 【logging.level.org.mybatis=debug logging.level.dao=debug】 -->

    <!-- root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性 level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF， 不能設置爲INHERITED或者同義詞NULL。默認是DEBUG 能夠包含零個或多個元素，標識這個appender將會添加到這個logger。 -->

    <!-- 4. 最終的策略 -->
    <!-- 4.1 開發環境:打印控制檯-->
    <springProfile name="dev">
        <logger name="com.cms" level="info"/>
        <root level="info">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="ERROR_FILE" />
        </root>
    </springProfile>


    <!-- 4.2 生產環境:輸出到文檔-->
    <springProfile name="pro">
        <logger name="com.cms" level="warn"/>
        <root level="info">
            <appender-ref ref="ERROR_FILE" />
            <appender-ref ref="WARN_FILE" />
        </root>
    </springProfile>

</configuration>
複製代碼

日誌收集異常信息

日誌信息每每伴隨着異常信息的輸出，所以，咱們須要修改統一異常的處理器，將異常信息以流的方式寫到日誌文件中

  • 異常信息文件工具類
@Slf4j
public class ExceptionUtil {

    /** * 打印異常信息 */
    public static String getMessage(Exception e) {
        String swStr = null;
        try (StringWriter sw = new StringWriter(); PrintWriter pw = new PrintWriter(sw)) {
            e.printStackTrace(pw);
            pw.flush();
            sw.flush();
            swStr = sw.toString();
        } catch (IOException ex) {
            ex.printStackTrace();
            log.error(ex.getMessage());
        }
        return swStr;
    }
}
複製代碼
  • 修改統一異常處理器，將異常方法中的直接打印改成日誌輸入並打印
// ...
import lombok.extern.slf4j.Slf4j;

@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**-------- 通用異常處理方法 --------**/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        // e.printStackTrace();
        log.error(ExceptionUtil.getMessage(e));
        return R.error();
    }
    
   // ...
}   
複製代碼

注意

  1. 日誌的環境即spring.profiles.acticve，跟隨項目啓動；
  2. 啓動後，便可到自定目錄查找到生成的日誌文件；
  3. 本地idea調試時，推薦Grep Console插件可實現控制檯的自定義顏色輸出
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程