springboot logback日誌配置

時間 2019-11-13

原文原文鏈接

springboot 若是不使用外部tomcat的話，日誌是須要本身配置的，否則的話就只有控制檯的日誌，可是日誌又是咱們在項目上了生產環境，出問題時，檢查問題的惟一途徑，因此咱們要配置詳細的日誌。怎麼配置呢？其實很簡單！java

第一步：修改application-dev.properties的配置文件web

logging.config=classpath:xml/logback-boot.xml

上面的路徑時咱們放置日誌配置文件的路徑，咱們不用去單獨的引用log包，由於springboot自己就帶有log的包spring

這是我文件的路徑json

而後配置logback-boot.xml的內容，我是這樣寫的（坦白說是這樣抄的，哈哈）數組

<configuration>
    <!-- %m輸出的信息, %p日誌級別, %t線程名, %d日期, %c類的全名, %i索引 -->
    <!-- appender是configuration的子節點,是負責寫日誌的組件 -->
    <!-- ConsoleAppender把日誌輸出到控制檯 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss} %highlight(%-5level) (%file:%line\)- %m%n</pattern>
            <!-- 控制檯也要使用utf-8，不要使用gbk -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- RollingFileAppender:滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其餘文件 -->
    <!-- 1.先按日期存日誌，日期變了，將前一天的日誌文件名重命名爲xxx%日期%索引，新的日誌仍然是sys.log -->
    <!-- 2.若是日期沒有變化，可是當前日誌文件的大小超過1kb時，對當前日誌進行分割 重名名 -->
    <appender name="syslog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>log/ant-back.log</File>
        <!-- rollingPolicy:當發生滾動時，決定 RollingFileAppender 的行爲，涉及文件移動和重命名。 -->
        <!-- TimeBasedRollingPolicy： 最經常使用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 活動文件的名字會根據fileNamePattern的值，每隔一段時間改變一次 -->
            <!-- 文件名：log/sys.2017-12-05.0.log -->
            <fileNamePattern>log/ant-back.%d.%i.log</fileNamePattern>
            <!-- 每產生一個日誌文件，該日誌文件的保存期限爲120天 -->
            <maxHistory>120</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動文件的大小，默認值是10MB,本篇設置爲100MB -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <!-- pattern節點，用來設置日誌的輸入格式 -->
            <pattern>
                %d %p (%file:%line\)- %m%n
            </pattern>
            <!-- 記錄日誌的編碼 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- 控制檯日誌輸出級別 -->
    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>
    <!-- 指定項目中某個包，當有日誌操做行爲時的日誌記錄級別 -->
    <!-- com.example.ant爲根包，也就是隻要是發生在這個根包下面的全部日誌操做行爲的權限都是DEBUG -->
    <!-- 級別依次爲【從高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
    <logger name="com.example.ant" level="FATAL">
        <appender-ref ref="syslog"/>
    </logger>
</configuration>

這樣就完事了嗎？固然，這樣就已經配置結束了，咱們來測試一下。 tomcat

在咱們的根目錄生成了一個log文件夾，裏面有咱們配置的日誌，名字隨便起的！springboot

咱們能夠在更進一步的優化一下，咱們運行項目時會時常出現異常，那麼怎麼處理異常呢？app

咱們能夠寫一個通用的類來捕獲異常而且進行返回測試

package com.example.ant.common.exception;

import com.alibaba.fastjson.JSON;
import com.example.ant.common.bean.ResponseModel;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.ConversionNotSupportedException;
import org.springframework.beans.TypeMismatchException;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.io.IOException;

/**
 * 描述：全局異常處理類
 *  異常處理攔截器
 * User: 曾遠征
 * Date: 2018-09-18
 * Time: 20:15
 */
@CrossOrigin
@ControllerAdvice
@ResponseBody
@Slf4j
public class GlobalExceptionHandler {

    //運行時異常
    @ExceptionHandler(RuntimeException.class)
    public String runtimeExceptionHandler(RuntimeException ex) {
        log.error("運行時異常",ex);
        return exceptionFormat(ex);
    }

    //空指針異常
    @ExceptionHandler(NullPointerException.class)
    public String nullPointerExceptionHandler(NullPointerException ex) {
        log.error("空指針異常",ex);
        return exceptionFormat(ex);
    }

    //類型轉換異常
    @ExceptionHandler(ClassCastException.class)
    public String classCastExceptionHandler(ClassCastException ex) {
        log.error("類型轉換異常",ex);
        return exceptionFormat(ex);
    }

    //IO異常
    @ExceptionHandler(IOException.class)
    public String iOExceptionHandler(IOException ex) {
        log.error("IO異常",ex);
        return exceptionFormat(ex);
    }

    //未知方法異常
    @ExceptionHandler(NoSuchMethodException.class)
    public String noSuchMethodExceptionHandler(NoSuchMethodException ex) {
        log.error("未知方法異常",ex);
        return exceptionFormat(ex);
    }

    //數組越界異常
    @ExceptionHandler(IndexOutOfBoundsException.class)
    public String indexOutOfBoundsExceptionHandler(IndexOutOfBoundsException ex) {
        log.error("數組越界異常",ex);
        return exceptionFormat(ex);
    }

    //400錯誤
    @ExceptionHandler({HttpMessageNotReadableException.class})
    public String requestNotReadable(HttpMessageNotReadableException ex) {
        log.error("400..requestNotReadable");
        return exceptionFormat(ex);
    }

    //400錯誤
    @ExceptionHandler({TypeMismatchException.class})
    public String requestTypeMismatch(TypeMismatchException ex) {
        log.error("400..TypeMismatchException");
        return exceptionFormat(ex);
    }

    //400錯誤
    @ExceptionHandler({MissingServletRequestParameterException.class})
    public String requestMissingServletRequest(MissingServletRequestParameterException ex) {
        log.error("400..MissingServletRequest");
        return exceptionFormat(ex);
    }

    //405錯誤
    @ExceptionHandler({HttpRequestMethodNotSupportedException.class})
    public String request405(HttpRequestMethodNotSupportedException ex) {
        log.error("405...異常",ex);
        return exceptionFormat(ex);
    }

    //406錯誤
    @ExceptionHandler({HttpMediaTypeNotAcceptableException.class})
    public String request406(HttpMediaTypeNotAcceptableException ex) {
        log.error("406...",ex);
        return exceptionFormat(ex);
    }

    //500錯誤
    @ExceptionHandler({ConversionNotSupportedException.class, HttpMessageNotWritableException.class})
    public String server500(RuntimeException ex) {
        log.error("500...",ex);
        return exceptionFormat(ex);
    }

    //棧溢出
    @ExceptionHandler({StackOverflowError.class})
    public String requestStackOverflow(StackOverflowError ex) {
        log.error("棧溢出異常",ex);
        return exceptionFormat(ex);
    }

    //其餘錯誤
    @ExceptionHandler({Exception.class})
    public String exception(Exception ex) {
        log.error("其餘異常",ex);
        return exceptionFormat(ex);
    }

    private <T extends Throwable> String exceptionFormat(T ex) {
        return JSON.toJSONString(ResponseModel.error(ex.getMessage()));
    }
}

ResponseModel類是我本身寫的一個通用返回的方法，比較簡單，代碼以下優化

package com.example.ant.common.bean;

import com.alibaba.fastjson.JSON;
import lombok.Data;

import java.io.Serializable;

/**
 * 描述：統一返回值處理
 * User: 曾遠征
 * Date: 2018-09-01
 * Time: 21:06
 */
@Data
public class ResponseModel implements Serializable {


    private boolean status;
    private String msg;
    private Object data;

    public ResponseModel() {
    }

    public static ResponseModel error() {
        return new ResponseModel(false, null, null);
    }

    public static ResponseModel error(String msg) {
        return new ResponseModel(false, msg, null);
    }

    public static ResponseModel success() {
        return new ResponseModel(true, null, null);
    }

    public static ResponseModel success(String msg) {
        return new ResponseModel(true, msg, null);
    }

    public static ResponseModel success(Object data) {
        return new ResponseModel(true, null, JSON.toJSONString(data));
    }

    public static ResponseModel success(String msg, Object data) {
        return new ResponseModel(true, msg, JSON.toJSONString(data));
    }

    public ResponseModel(boolean status, String msg, Object data) {
        this.status = status;
        this.msg = msg;
        this.data = data;
    }

}

這個異常處理只能捕獲controller層的異常，爲何呢？由於@ControllerAdvice這個註解

咱們來測試一下

如上圖，我故意在代碼裏面寫了一個異常。咱們運行項目跑起來

頁面提示信息，在看看日誌記錄

咱們的日誌文件也捕獲到了，好了，這樣就結束了。很是簡單。