1、Logback简介
Logback是由log4j创始人设计的又一个开源日志组件。
相比于log4j,Logback重写了内核,在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了,
logback和log4j。初始化内存加载也更小;
logback当前分成三个模块:logback-core,logback- classic和logback-access。
logback-core是其它两个模块的基础模块。
logback-classic是log4j的一个 改良版本。
参数配置。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。
logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。
2、Spring Boot 默认日志Logback
Spring Boot在所有内部日志中使用Commons Logging,但是默认配置也提供了对常用日志的支持,如:Java Util Logging,Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。
vsftpd配置。默认情况下,Spring Boot会用Logback来记录日志,并用INFO级别输出到控制台。在运行应用程序和其他例子时,你应该已经看到很多INFO级别的日志了。
从上图可以看到,日志输出内容元素具体如下:
03+配置、
3、添加依赖
---
标识实际日志的开始Spring Boot项目在引入spring-boot-starter依赖时,其中默认已包含了spring-boot-starter-logging,该依赖内容就是
Spring Boot 默认的日志框架 logback,所以不需要再单独引入。
logback配置文件路径?例如:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
spring-boot-starter-web中已包含了spring-boot-starter依赖
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId><version>2.0.4.RELEASE</version><scope>compile</scope>
</dependency>
4、控制台输出
TRACE < DEBUG < INFO < WARN < ERROR < FATAL。
iis配置。如果设置为 WARN ,则低于 WARN 的信息都不会输出。
Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。
您还可以通过启动您的应用程序 --debug 标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:
5、文件输出
默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。如果要编写除控制台输出之外的日志文件,则需在application.properties中设置logging.file或logging.path属性。
logback异步日志、默认情况下,日志文件的大小达到10MB时会切分一次,产生新的日志文件,默认级别为:ERROR、WARN、INFO
如果只配置 logging.file,会在项目的当前路径下生成一个 xxx.log 日志文件。
如果只配置 logging.path,在 /var/log文件夹生成一个日志文件为 spring.log
注:二者不能同时使用,如若同时使用,则只有logging.file生效
6、日志级别控制
所有支持的日志记录系统都可以在Spring环境中设置记录级别(例如在application.properties中)
格式为:logging.level.* = LEVEL
logging.level:日志级别控制前缀,*为包名或Logger名
LEVEL:选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
eg:
#配置打印mybatis的SQL日志
logging.level.com.solin.template.dao=DEBUG
7、自定义文件配置
根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:
Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml),命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项。上面是默认的命名规则,并且放在src/main/resources下面即可。如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,可以通过logging.config属性指定自定义的名字:
logging.config=classpath:logging-config.xml
虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时Profile使用不同的日志配置,这个功能会很有用。
一般不需要这个属性,而是直接在logback-spring.xml中使用springProfile配置,不需要logging.config指定不同环境使用不同配置文件
8、根节点<configuration>包含的属性
根节点<configuration>共包含有5个
子节点,分别是:
(1)子节点一:设置上下文名称<contextName>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
<contextName>logback</contextName>
(2)子节点二:设置变量<property>
用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
<property name="LOG_HOME" value="D:\\opt\\logs" />
(3)子节点三:<appender>
appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
#####控制台输出ConsoleAppender:
<!--输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <!--<filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>ERROR</level></filter>--><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %highlight([%-5level] %logger{50} - %msg%n)</pattern><charset>GBK</charset></encoder>
</appender>
<encoder>
表示对日志进行编码:
%d{HH: mm:ss.SSS}
——日志输出时间%thread
——输出日志的进程名字,这在Web应用以及异步任务处理中很有用%-5level
——日志级别,并且使用5个字符靠左对齐%logger{36}
——日志输出者的名字%msg
——日志消息%n
——平台的换行符ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉,不然你控制台会发现没日志~
输出到文件RollingFileAppender
另一种常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender
用于切分文件日志:
<!--输出到文件-->
<appender name="SYSTEM_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 过滤器,只打印ERROR级别的日志 --><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter><rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"><!--日志文件输出的文件名--><FileNamePattern>${LOG_HOME}/${PROJECT_NAME}.error.%d{yyyy-MM-dd}.%i.log</FileNamePattern><!--日志文件保留天数--><MaxHistory>15</MaxHistory><!--日志文件最大的大小--><MaxFileSize>10MB</MaxFileSize></rollingPolicy><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] %logger{50} - %msg%n</pattern><charset>UTF-8</charset></encoder>
</appender>
其中重要的是rollingPolicy
的定义,上例中<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
定义了日志的切分方式——把每一天的日志归档到一个文件中,<maxHistory>30</maxHistory>
表示只保留最近30天的日志,以防止日志填满整个磁盘空间。同理,可以使用%d{yyyy-MM-dd_HH-mm}
来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>
用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志。
(4)子节点四:<root>
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
<root level="INFO"><appender-ref ref="CONSOLE" /><appender-ref ref="SYSTEM_FILE" />
</root>
(5)子节点五:<logger>
<logger>
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>
。<logger>
仅有一个name属性,一个可选的level和一个可选的additivity属性。
logger在实际使用的时候有两种情况
先来看一看代码中如何使用
package com.solin.controller;
@Controller
public class LearnController {private Logger logger = LoggerFactory.getLogger(this.getClass());@RequestMapping(value = "/login",method = RequestMethod.POST)@ResponseBodypublic Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){//日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。logger.trace("日志输出 trace");logger.debug("日志输出 debug");logger.info("日志输出 info");logger.warn("日志输出 warn");logger.error("日志输出 error");Map<String,Object> map =new HashMap<String,Object>();String userName=request.getParameter("userName");String password=request.getParameter("password");if(!userName.equals("") && password!=""){User user =new User(userName,password);request.getSession().setAttribute("user",user);map.put("result","1");}else{map.put("result","0");}return map;}
}
这是一个登录的判断的方法,我们引入日志,并且打印不同级别的日志,然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。
第一种:带有logger的配置,不指定级别,不指定appender
<logger name="com.solin.controller"/>
<logger name="com.solin.controller" />
将控制controller包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“info”;
没有设置addtivity,默认为true,将此logger的打印信息向上级传递;
没有设置appender,此logger本身不打印任何信息。<root level="info">
将root的打印级别设置为“info”,指定了名字为“console”的appender。
当执行com.solin.controller.LearnController类的login方法时,LearnController 在包com.solin.controller中,所以首先执行<logger name="com.solin.controller"/>
,将级别为“info”及大于“info”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“console”的appender处理,“console”appender将信息打印到控制台;
打印结果如下:
16:00:17.407 logback [http-nio-8080-exec-8] INFO com.solin.controller.LearnController - 日志输出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN com.solin.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.solin.controller.LearnController - 日志输出 error
第二种:带有多个logger的配置,指定级别,指定appender
<!--logback.LogbackDemo:类的全路径 -->
<logger name="com.solin.controller.LearnController" level="WARN" additivity="false"><appender-ref ref="console"/>
</logger>
控制com.solin.controller.LearnController类的日志打印,打印级别为“WARN”;
additivity属性为false,表示此logger的打印信息不再向上级传递;
指定了名字为“console”的appender;
这时候执行com.solin.controller.LearnController类的login方法时,先执行<logger name="com.solin.controller.LearnController" level="WARN" additivity="false">
,
将级别为“WARN”及大于“WARN”的日志信息交给此logger指定的名为“console”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。
打印结果如下:
16:00:17.408 logback [http-nio-8080-exec-8] WARN com.solin.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.solin.controller.LearnController - 日志输出 error
当然如果你把additivity="false"改成additivity="true"的话,就会打印两次,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。
9、多环境日志输出
据不同环境(prod:生产环境,test:测试环境,dev:开发环境)来定义不同的日志输出,在 logback-spring.xml中使用 springProfile 节点来定义,方法如下:
文件名称不是logback.xml,想使用spring扩展profile支持,要以logback-spring.xml命名
<!-- 测试环境+开发环境. 多个使用逗号隔开. -->
<springProfile name="test,dev"><logger name="com.dudu.controller" level="info" />
</springProfile>
<!-- 生产环境. -->
<springProfile name="prod"><logger name="com.dudu.controller" level="ERROR" />
</springProfile>
application.properties增加环境选择的配置active: dev
# 选择加载不同环境的配置文件 dev pre prod
spring.profiles.active=dev
10、配置文件示例
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true"><!-- 项目名称 --><property name="PROJECT_NAME" value="springBootTemplate" /><!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径--><!--<property name="LOG_HOME" value="${catalina.base}/logs" />--><property name="LOG_HOME" value="D:\\opt\\logs" /><!-- 控制台输出 --><appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><!-- On Windows machines setting withJansi to true enables ANSIcolor code interpretation by the Jansi library. This requiresorg.fusesource.jansi:jansi:1.8 on the class path. Note thatUnix-based operating systems such as Linux and Mac OS Xsupport ANSI color codes by default.http://blog.csdn.net/u013613428/article/details/51499552--><!--<withJansi>true</withJansi>--><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %highlight([%-5level] %logger{50} - %msg%n)</pattern><charset>GBK</charset></encoder></appender><!-- 系统错误日志文件 --><appender name="SYSTEM_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 过滤器,只打印ERROR级别的日志 --><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter><rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"><!--日志文件输出的文件名--><FileNamePattern>${LOG_HOME}/${PROJECT_NAME}.error.%d{yyyy-MM-dd}.%i.log</FileNamePattern><!--日志文件保留天数--><MaxHistory>15</MaxHistory><!--日志文件最大的大小--><MaxFileSize>10MB</MaxFileSize></rollingPolicy><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符--><pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] %logger{50} - %msg%n</pattern><charset>UTF-8</charset></encoder></appender><logger name="system_error" additivity="true"><appender-ref ref="SYSTEM_FILE"/></logger><!--TRACE < DEBUG < INFO < WARN < ERROR < FATAL--><!-- 开发环境下的日志配置 --><springProfile name="dev"><root level="INFO"><appender-ref ref="CONSOLE" /><appender-ref ref="SYSTEM_FILE" /></root></springProfile><!-- 生产环境下的日志配置 --><springProfile name="prod"><root level="INFO"><appender-ref ref="SYSTEM_FILE" /></root></springProfile>
</configuration>
参考:https://juejin.im/post/58f86981b123db0062363203
版权声明:本站所有资料均为网友推荐收集整理而来,仅供学习和研究交流使用。
工作时间:8:00-18:00
客服电话
电子邮件
admin@qq.com
扫码二维码
获取最新动态