Springboot異常紀錄檔輸出
2020-10-28 18:00:02
一 lombok外掛使用：
引入依賴,在專案中使用Lombok可以減少很多重複程式碼的書寫。比如說getter/setter/toString等方法的編寫 ↓
<!--lombok用來簡化實體類-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.20</version>
</dependency>
idea中安裝lombok外掛↓
建立包 entity 編寫實體類 User.java（此處使用了 Lombok 簡化程式碼） ↓`
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
點選檢視註解編譯結果↓
統一例外處理
我們想讓異常結果也顯示為統一的返回結果物件,並且統一處理系統的異常資訊,那麼需要統一例外處理,
建立統一例外處理類GlobalExceptionHandler.java ↓
package com.ywj.handler;
import com.ywj.constants.ResultCodeEnum;
import com.ywj.exception.MyException;
import com.ywj.util.ExceptionUtil;
import com.ywj.vo.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
//全域性例外處理
@ExceptionHandler(Exception.class)
@ResponseBody
public R error(Exception e){
//e.printStackTrace();//輸出異常堆疊資訊
log.error(e.getMessage());
return R.error();
}
//特定例外處理
@ExceptionHandler(ArithmeticException.class)
@ResponseBody
public R error(ArithmeticException e){
//e.printStackTrace();//輸出異常堆疊資訊
//log.error(e.getMessage());
log.info("錯誤資訊----------------------------");
log.error(e.getMessage());
return R.setResult(ResultCodeEnum.MY_ERROR);
}
//自定義例外處理
@ExceptionHandler(MyException.class)
@ResponseBody
public R error(MyException e){
//e.printStackTrace();//輸出異常堆疊資訊
//log.error(e.getMessage());
log.error(ExceptionUtil.getMessage(e));
return R.error().message(e.getMessage()).code(e.getCode());
}
}
建立MyException.java通用異常類,繼承RuntimeException↓
package com.ywj.exception;
import com.ywj.constants.ResultCodeEnum;
import lombok.Data;
@Data
//@ApiModel(value = "自定義全域性異常類")
public class MyException extends RuntimeException {
//@ApiModelProperty(value = "狀態碼")
private Integer code;
/**
* 接收狀態碼和錯誤訊息
* @param code
* @param message
*/
public MyException(Integer code, String message){
super(message);
this.code = code;
}
public MyException(ResultCodeEnum resultCodeEnum){
super(resultCodeEnum.getMessage());
this.code = resultCodeEnum.getCode();
}
@Override
public String toString() {
return "MyException{" +
"code=" + code +
", message=" + this.getMessage() +
'}';
}
}
業務中需要的位置丟擲自定義異常↓
package com.ywj.controller;
import com.ywj.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class IndexController {
@GetMapping("/")
public String index(Model model){
//System.out.println(10/0);
if (true){
throw new MyException(10086, "自定義異常");
}
System.out.println("index");
model.addAttribute("name", "ywj");
return "index";
}
}
依賴的其他類補充說明↓
統一結果返回類R↓
package com.ywj.vo;
import com.ywj.constants.ResultCodeEnum;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
@Data
//@ApiModel(value="全域性統一返回結果")
public class R {
//@ApiModelProperty(value = "是否成功")
private Boolean success;
//@ApiModelProperty(value = "返回碼")
private Integer code;
//@ApiModelProperty(value = "返回訊息")
private String message;
//@ApiModelProperty(value = "返回資料")
private Map<String, Object> data = new HashMap<String, Object>();
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_REASON.getSuccess());
r.setCode(ResultCodeEnum.UNKNOWN_REASON.getCode());
r.setMessage(ResultCodeEnum.UNKNOWN_REASON.getMessage());
return r;
}
public R data(Map<String, Object> map){
this.setData(map);
return this;
}
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;
}
public static R setResult(ResultCodeEnum resultCodeEnum){
R r = new R();
r.setSuccess(resultCodeEnum.getSuccess());
r.setCode(resultCodeEnum.getCode());
r.setMessage(resultCodeEnum.getMessage());
return r;
}
}
結果列舉常數類ResultCodeEnum↓
package com.ywj.constants;
import lombok.Getter;
@Getter
public enum ResultCodeEnum {
SUCCESS(true, 20000,"成功"),
UNKNOWN_REASON(false, 20001, "未知錯誤"),
BAD_SQL_GRAMMAR(false, 21001, "sql語法錯誤"),
JSON_PARSE_ERROR(false, 21002, "json解析異常"),
PARAM_ERROR(false, 21003, "引數不正確"),
FILE_UPLOAD_ERROR(false, 21004, "檔案上傳錯誤"),
EXCEL_DATA_IMPORT_ERROR(false, 21005, "Excel資料匯入錯誤"),
MY_ERROR(false, 21006, "算術異常錯誤");
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;
}
}
異常棧資訊輸出工具類ExceptionUtil↓
package com.ywj.util;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
public class ExceptionUtil {
public static String getMessage(Exception e) {
StringWriter sw = null;
PrintWriter pw = null;
try {
sw = new StringWriter();
pw = new PrintWriter(sw);
// 將出錯的棧資訊輸出到printWriter中
e.printStackTrace(pw);
pw.flush();
sw.flush();
} finally {
if (sw != null) {
try {
sw.close();
} catch (IOException e1) {
e1.printStackTrace();
}
}
if (pw != null) {
pw.close();
}
}
return sw.toString();
}
}
上面只是解釋說明一下,直接拷貝資料資料夾的相關類到公司包即可,比如拷貝到ywj包下,專案結構如下↓
統一紀錄檔輸出
設定紀錄檔級別↓
紀錄檔記錄器（Logger）的行為是分等級的。如下表所示：
分為：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL
預設情況下，spring boot從控制檯列印出來的紀錄檔級別只有INFO及以上級別，可以設定紀錄檔級別↓
# 設定紀錄檔級別
logging.level.root=WARN
以上方式只能將紀錄檔列印在控制檯上 ↑
Logback紀錄檔↓
spring boot內部使用Logback作為紀錄檔實現的框架。
Logback和log4j非常相似，如果你對log4j很熟悉，那對logback很快就會得心應手。
logback相對於log4j的一些優點：https://blog.csdn.net/caisini_vc/article/details/48551287
設定logback紀錄檔↓
刪除application.properties中的紀錄檔設定
安裝idea彩色紀錄檔外掛：grep-console
resources 中建立 logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds">
<!-- 紀錄檔級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設定為WARN，則低於WARN的資訊都不會輸出 -->
<!-- scan:當此屬性設定為true時，組態檔如果發生改變，將會被重新載入，預設值為true -->
<!-- scanPeriod:設定監測組態檔是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。預設的時間間隔為1分鐘。 -->
<!-- debug:當此屬性設定為true時，將列印出logback內部紀錄檔資訊，實時檢視logback執行狀態。預設值為false。 -->
<contextName>logback</contextName>
<!-- name的值是變數的名稱，value的值時變數定義的值。通過定義的值會被插入到logger上下文中。定義變數後，可以使「${}」來使用變數。 -->
<property name="log.path" value="E:/ywj_log/edu" />
<!-- 彩色紀錄檔 -->
<!-- 設定格式變數：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)"/>
<!--輸出到控制檯-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此紀錄檔appender是為開發使用，只設定最底級別，控制檯輸出的紀錄檔級別是大於或等於此級別的紀錄檔資訊-->
<!-- 例如：如果此處設定了INFO級別，則後面其他位置即使設定了DEBUG級別的紀錄檔，也不會被輸出 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 設定字元集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--輸出到檔案-->
<!-- 時間捲動輸出 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>
<!-- 紀錄檔記錄器的捲動策略，按日期，按大小記錄 -->
<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>
<!--紀錄檔檔案保留天數-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此紀錄檔檔案只記錄info級別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 時間捲動輸出 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> <!-- 此處設定字元集 -->
</encoder>
<!-- 紀錄檔記錄器的捲動策略，按日期，按大小記錄 -->
<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>
<!--紀錄檔檔案保留天數-->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- 此紀錄檔檔案只記錄warn級別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 時間捲動輸出 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> <!-- 此處設定字元集 -->
</encoder>
<!-- 紀錄檔記錄器的捲動策略，按日期，按大小記錄 -->
<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>
<!--紀錄檔檔案保留天數-->
<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，
如果未設定此屬性，那麼當前logger將會繼承上級的級別。
-->
<!--
使用mybatis的時候，sql語句是debug下才會列印，而這裡我們只設定了info，所以想要檢視sql語句的話，有以下兩種操作：
第一種把<root level="INFO">改成<root level="DEBUG">這樣就會列印sql，不過這樣紀錄檔那邊會出現很多其他訊息
第二種就是單獨給mapper下目錄設定DEBUG模式，程式碼如下，這樣設定sql語句會列印，其他還是正常DEBUG級別：
-->
<!--開發環境:列印控制檯-->
<springProfile name="dev">
<!--可以輸出專案中的debug紀錄檔，包括mybatis的sql紀錄檔-->
<logger name="com.ywj" level="INFO" />
<!--
root節點是必選節點，用來指定最基礎的紀錄檔輸出級別，只有一個level屬性
level:用來設定列印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，預設是DEBUG
可以包含零個或多個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>
<!--生產環境:輸出到檔案-->
<springProfile name="pro">
<!--可以輸出專案中的debug紀錄檔，包括mybatis的sql紀錄檔-->
<logger name="com.ywj" level="WARN" />
<root level="INFO">
<appender-ref ref="ERROR_FILE" />
<appender-ref ref="WARN_FILE" />
</root>
</springProfile>
</configuration>
最後,別忘了,在application.yml組態檔中用profiles啟用dev開發環境或其他環境比如生產環境pro等↓
server:
port: 8888
spring:
mvc:
view:
prefix: /WEB-INF/jsp/
suffix: .jsp
profiles:
active: dev
#logging:
# level:
# root: warn
複製貼上即可
其實,上面都只是解釋一下,不想太麻煩,直接拷貝資料資料夾的裡面的相關類和紀錄檔組態檔到專案中即可↑↓
