回目錄:JHipster一知半解
Logback配置
Logback是由log4j創(chuàng)始人設(shè)計(jì)的另一個(gè)開源日志組件,是log4j的一個(gè)改良版本癞尚。
主要分為logback-core粗截,logback-classic惋耙,logback-access三個(gè)模塊
1. 引入與生效過程
作為spring-boot項(xiàng)目,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的幾個(gè)依賴包
<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進(jìn)行日志初始化(具體在findPossibleStaticLoggerBinderPathSet())函數(shù)中婿屹,用ClassLoader動態(tài)查找LOGGER_BINDER路徑灭美,從而發(fā)現(xiàn)logback,有興趣可以自行斷點(diǎn)查看昂利。
2. 配置
spring-boot本身對幾個(gè)主流的日志系統(tǒng)都做了基礎(chǔ)的配置届腐,也就是說,即使什么也不做蜂奸,只需要上面引入的strater-logging犁苏,也能獲得基本的配置能力。
具體代碼在org.springframework.boot.logging.LoggingApplicationListener中窝撵,這個(gè)監(jiān)聽器傀顾,監(jiān)聽到應(yīng)用程序啟動(main()函數(shù)里面的run()方法),調(diào)用
this.loggingSystem.beforeInitialize()碌奉;
實(shí)際上是org.springframework.boot.logging.logback.LogbackLoggingSystem就進(jìn)行了對應(yīng)的初始化工作短曾,這里配置了logback默認(rèn)的配置文件base.xml,另外Spring Boot 提供了兩個(gè)輸出端的配置文件console-appender.xml和file-appender.xml赐劣,base.xml引用了這兩個(gè)配置文件嫉拐。
當(dāng)然JHipster不會僅僅采用默認(rèn)的配置,在src/main/resources目錄里面魁兼,定義了logback-spring.xml作為項(xiàng)目logback的配置婉徘。
2.1. 首先,include了默認(rèn)的base.xml咐汞,作為基礎(chǔ)盖呼。
2.2. 由于默認(rèn)的root level="INFO",那么這里面就針對需要修改的類化撕,進(jìn)行對應(yīng)等級調(diào)整几晤,如com.ryantenney設(shè)置為WARN,io.undertow.websockets.jsr就設(shè)置為ERROR植阴,org.apache.catalina.startup.DigesterFactory設(shè)置為OFF
2.3. 默認(rèn)生成的appender蟹瘾,只配置生效了CONSOLE圾浅,但同時(shí)也很貼心地寫好并注釋了FILE的appender,需要的話憾朴,取消注釋狸捕,即可生效。(微服務(wù)架構(gòu)目標(biāo)是動態(tài)伸縮众雷,如果還是每個(gè)服務(wù)都保存自己的日志文件灸拍,有點(diǎn)低效,推薦整合ELK砾省,統(tǒng)一收集日志信息)
3. aop.logging的LoggingAspect
這個(gè)配置是基于spring的AOP株搔,對需要debug的類,進(jìn)行額外的日志打印功能纯蛾。
3.1. 構(gòu)造函數(shù)
public LoggingAspect(Environment env) {
this.env = env;
}
用來把spring啟動的環(huán)境變量傳遞進(jìn)來,可以在logAfterThrowing()看到纵隔,根據(jù)生效的profile不同翻诉,打印的日志也是不同的。
3.2. 切點(diǎn)
springBeanPointcut()是從類注解的角度捌刮,有加上@Repository碰煌,@Service,@RestController的绅作。
applicationPackagePointcut()是從類位置的角度芦圾,位于項(xiàng)目中repository,service俄认,web.rest包中的个少。
3.3. 統(tǒng)一的異常打印logAfterThrowing
如果業(yè)務(wù)處理出現(xiàn)異常,這里統(tǒng)一捕捉眯杏,并根據(jù)激活的profile不同夜焦,日志格式有所不同
3.4 統(tǒng)一的日志登記logAround
針對需要擴(kuò)展的業(yè)務(wù)處理部分,如果log.isDebugEnabled()岂贩,則在方法的處理之前辨嗽,和之后都打印出對應(yīng)的日志九孩,方便調(diào)試。
4. 動態(tài)改變log日志等級web.rest.LogsResource
spring-boot是1.5版本后才在actuator增加了loggers端點(diǎn)了,JHipster在spring還沒有此功能前就自定義了一個(gè)rest端點(diǎn)完成對應(yīng)的工作体箕。
代碼相對簡單,兩個(gè)方法继阻,一個(gè)get办龄,一個(gè)put。都是獲取LoggerContext部念,然后進(jìn)行相應(yīng)的操作弃酌。
web.rest.vm氨菇。LoggerVM
JHipster使用了VM作為前后端傳遞對象視圖模型,LoggerVM只有2個(gè)屬性妓湘,name和level查蓉,這樣就簡化了前后端的數(shù)據(jù)傳遞,畢竟我們的目標(biāo)只是顯示和修改日志的等級設(shè)置榜贴,傳遞整個(gè)Logger對象顯然不適合豌研。
資源和書籍推薦
logback的使用和logback.xml詳解 (https://www.cnblogs.com/warking/p/5710303.html)
Logback用戶手冊中文版(鏈接:http://pan.baidu.com/s/1hsH0JaO 密碼:pq1z)