回目錄:JHipster一知半解
Logback配置
Logback是由log4j創(chuàng)始人設(shè)計的另一個開源日志組件,是log4j的一個改良版本。
主要分為logback-core,logback-classic,logback-access三個模塊
1. 引入與生效過程
作為spring-boot項目,Pom.xml中增加了對spring-boot-starter-logging的依賴。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
在spring-boot-starter-logging*.jar中,也就說引入了logback的幾個依賴包
<dependencies>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jul-to-slf4j</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
</dependency>
</dependencies>
那么在spring-boot的啟動中,slf4j的LoggerFactory就能自動識別到用了logback進行日志初始化(具體在findPossibleStaticLoggerBinderPathSet())函數(shù)中,用ClassLoader動態(tài)查找LOGGER_BINDER路徑,從而發(fā)現(xiàn)logback,有興趣可以自行斷點查看。
2. 配置
spring-boot本身對幾個主流的日志系統(tǒng)都做了基礎(chǔ)的配置,也就是說,即使什么也不做,只需要上面引入的strater-logging,也能獲得基本的配置能力。
具體代碼在org.springframework.boot.logging.LoggingApplicationListener中,這個監(jiān)聽器,監(jiān)聽到應(yīng)用程序啟動(main()函數(shù)里面的run()方法),調(diào)用
this.loggingSystem.beforeInitialize();
實際上是org.springframework.boot.logging.logback.LogbackLoggingSystem就進行了對應(yīng)的初始化工作,這里配置了logback默認的配置文件base.xml,另外Spring Boot 提供了兩個輸出端的配置文件console-appender.xml和file-appender.xml,base.xml引用了這兩個配置文件。
當然JHipster不會僅僅采用默認的配置,在src/main/resources目錄里面,定義了logback-spring.xml作為項目logback的配置。
2.1. 首先,include了默認的base.xml,作為基礎(chǔ)。
2.2. 由于默認的root level="INFO",那么這里面就針對需要修改的類,進行對應(yīng)等級調(diào)整,如com.ryantenney設(shè)置為WARN,io.undertow.websockets.jsr就設(shè)置為ERROR,org.apache.catalina.startup.DigesterFactory設(shè)置為OFF
2.3. 默認生成的appender,只配置生效了CONSOLE,但同時也很貼心地寫好并注釋了FILE的appender,需要的話,取消注釋,即可生效。(微服務(wù)架構(gòu)目標是動態(tài)伸縮,如果還是每個服務(wù)都保存自己的日志文件,有點低效,推薦整合ELK,統(tǒng)一收集日志信息)
3. aop.logging的LoggingAspect
這個配置是基于spring的AOP,對需要debug的類,進行額外的日志打印功能。
3.1. 構(gòu)造函數(shù)
public LoggingAspect(Environment env) {
this.env = env;
}
用來把spring啟動的環(huán)境變量傳遞進來,可以在logAfterThrowing()看到,根據(jù)生效的profile不同,打印的日志也是不同的。
3.2. 切點
springBeanPointcut()是從類注解的角度,有加上@Repository,@Service,@RestController的。
applicationPackagePointcut()是從類位置的角度,位于項目中repository,service,web.rest包中的。
3.3. 統(tǒng)一的異常打印logAfterThrowing
如果業(yè)務(wù)處理出現(xiàn)異常,這里統(tǒng)一捕捉,并根據(jù)激活的profile不同,日志格式有所不同
3.4 統(tǒng)一的日志登記logAround
針對需要擴展的業(yè)務(wù)處理部分,如果log.isDebugEnabled(),則在方法的處理之前,和之后都打印出對應(yīng)的日志,方便調(diào)試。
4. 動態(tài)改變log日志等級web.rest.LogsResource
spring-boot是1.5版本后才在actuator增加了loggers端點了,JHipster在spring還沒有此功能前就自定義了一個rest端點完成對應(yīng)的工作。
代碼相對簡單,兩個方法,一個get,一個put。都是獲取LoggerContext,然后進行相應(yīng)的操作。
web.rest.vm。LoggerVM
JHipster使用了VM作為前后端傳遞對象視圖模型,LoggerVM只有2個屬性,name和level,這樣就簡化了前后端的數(shù)據(jù)傳遞,畢竟我們的目標只是顯示和修改日志的等級設(shè)置,傳遞整個Logger對象顯然不適合。
資源和書籍推薦
logback的使用和logback.xml詳解 (https://www.cnblogs.com/warking/p/5710303.html)
Logback用戶手冊中文版(鏈接:http://pan.baidu.com/s/1hsH0JaO 密碼:pq1z)