您好,登錄后才能下訂單哦!
小編給大家分享一下Springboot異常日志輸出方式的示例分析,希望大家閱讀完這篇文章之后都有所收獲,下面讓我們一起去探討吧!
引入依賴,在項(xiàng)目中使用Lombok可以減少很多重復(fù)代碼的書寫。比如說getter/setter/toString等方法的編寫 ↓
<!--lombok用來簡化實(shí)體類--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.20</version> </dependency>
idea中安裝lombok插件↓
創(chuàng)建包 entity 編寫實(shí)體類 User.java(此處使用了 Lombok 簡化代碼) ↓`
@Data public class User { private Long id; private String name; private Integer age; private String email; }
點(diǎn)擊查看注解編譯結(jié)果↓
我們想讓異常結(jié)果也顯示為統(tǒng)一的返回結(jié)果對象,并且統(tǒng)一處理系統(tǒng)的異常信息,那么需要統(tǒng)一異常處理,
創(chuàng)建統(tǒng)一異常處理類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()); } }
創(chuàng)建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 = "狀態(tài)碼") private Integer code; /** * 接收狀態(tài)碼和錯誤消息 * @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() + '}'; } }
業(yè)務(wù)中需要的位置拋出自定義異?!?/p>
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"; } }
依賴的其他類補(bǔ)充說明↓
統(tǒng)一結(jié)果返回類R↓
package com.ywj.vo; import com.ywj.constants.ResultCodeEnum; import lombok.Data; import java.util.HashMap; import java.util.Map; @Data //@ApiModel(value="全局統(tǒng)一返回結(jié)果") public class R { //@ApiModelProperty(value = "是否成功") private Boolean success; //@ApiModelProperty(value = "返回碼") private Integer code; //@ApiModelProperty(value = "返回消息") private String message; //@ApiModelProperty(value = "返回?cái)?shù)據(jù)") 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; } }
結(jié)果枚舉常量類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, "參數(shù)不正確"), FILE_UPLOAD_ERROR(false, 21004, "文件上傳錯誤"), EXCEL_DATA_IMPORT_ERROR(false, 21005, "Excel數(shù)據(jù)導(dǎo)入錯誤"), MY_ERROR(false, 21006, "算術(shù)異常錯誤"); private Boolean success;//響應(yīng)是否成功 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(); } }
上面只是解釋說明一下,直接拷貝資料文件夾的相關(guān)類到公司包即可,比如拷貝到y(tǒng)wj包下,項(xiàng)目結(jié)構(gòu)如下↓
日志記錄器(Logger)的行為是分等級的。如下表所示:
分為:OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL
默認(rèn)情況下,spring boot從控制臺打印出來的日志級別只有INFO及以上級別,可以配置日志級別↓
# 設(shè)置日志級別 logging.level.root=WARN
以上方式只能將日志打印在控制臺上 ↑
spring boot內(nèi)部使用Logback作為日志實(shí)現(xiàn)的框架。
Logback和log4j非常相似,如果你對log4j很熟悉,那對logback很快就會得心應(yīng)手。
刪除application.properties中的日志配置
resources 中創(chuàng)建 logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="10 seconds"> <!-- 日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設(shè)置為WARN,則低于WARN的信息都不會輸出 --> <!-- scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會被重新加載,默認(rèn)值為true --> <!-- scanPeriod:設(shè)置監(jiān)測配置文件是否有修改的時(shí)間間隔,如果沒有給出時(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í)變量定義的值。通過定義的值會被插入到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是為開發(fā)使用,只配置最底級別,控制臺輸出的日志級別是大于或等于此級別的日志信息--> <!-- 例如:如果此處配置了INFO級別,則后面其他位置即使配置了DEBUG級別的日志,也不會被輸出 --> <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í)間滾動輸出 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> <!--日志文件保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文件只記錄info級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時(shí)間滾動輸出 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> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <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級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>warn</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 時(shí)間滾動輸出 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> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <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級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- <logger>用來設(shè)置某一個(gè)包或者具體的某一個(gè)類的日志打印級別、以及指定<appender>。 <logger>僅有一個(gè)name屬性, 一個(gè)可選的level和一個(gè)可選的addtivity屬性。 name:用來指定受此logger約束的某一個(gè)包或者具體的某一個(gè)類。 level:用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, 如果未設(shè)置此屬性,那么當(dāng)前l(fā)ogger將會繼承上級的級別。 --> <!-- 使用mybatis的時(shí)候,sql語句是debug下才會打印,而這里我們只配置了info,所以想要查看sql語句的話,有以下兩種操作: 第一種把<root level="INFO">改成<root level="DEBUG">這樣就會打印sql,不過這樣日志那邊會出現(xiàn)很多其他消息 第二種就是單獨(dú)給mapper下目錄配置DEBUG模式,代碼如下,這樣配置sql語句會打印,其他還是正常DEBUG級別: --> <!--開發(fā)環(huán)境:打印控制臺--> <springProfile name="dev"> <!--可以輸出項(xiàng)目中的debug日志,包括mybatis的sql日志--> <logger name="com.ywj" level="INFO" /> <!-- root節(jié)點(diǎn)是必選節(jié)點(diǎn),用來指定最基礎(chǔ)的日志輸出級別,只有一個(gè)level屬性 level:用來設(shè)置打印級別,大小寫無關(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"> <!--可以輸出項(xiàng)目中的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開發(fā)環(huán)境或其他環(huán)境比如生產(chǎn)環(huán)境pro等↓
server: port: 8888 spring: mvc: view: prefix: /WEB-INF/jsp/ suffix: .jsp profiles: active: dev #logging: # level: # root: warn
其實(shí),上面都只是解釋一下,不想太麻煩,直接拷貝資料文件夾的里面的相關(guān)類和日志配置文件到項(xiàng)目中即可↑↓
看完了這篇文章,相信你對“Springboot異常日志輸出方式的示例分析”有了一定的了解,如果想了解更多相關(guān)知識,歡迎關(guān)注億速云行業(yè)資訊頻道,感謝各位的閱讀!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。