说明
默认情况下,Spring Boot会用logback来记录日志,并用INFO级别输出到控制台。日志等级从低到高:trace<debug<info<warn<error,这里记录下自己学习logback的笔记。
注意:mybatis中的sql语句打印是debug级别。在dev开发环境可以使用debug级别的日志打印,但是在生产环境中最好使用info级别和error级别的日志打印。
官网:https://logback.qos.ch/documentation.html
中文logback学习:http://www.51gjie.com/javaweb/1109.html
依赖
SpringBoot里面web依赖里面集成了logback日志和slf4j日志,默认是使用logback来打印日志。所以对于SpringBoot项目我们不需要额外再引入logback或者slf4j依赖。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
节点说明
这里只简单说几个常用的子节点。
根节点 configuration 中子节点如下:
property 子节点:设置变量,通过name来指定变量名称,value来设置变量的值。
<property name="LOG_FILE_PATH" value="/log"/>
appender子节点:用来格式化日志输出节点。有两个属性name和class,name用来指定appender的名称,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
logger子节点:用来设置某一个包或者具体的某一个类的日志打印级别、以及指定 。 仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。
name :用来指定受此logger约束的某一个包或者具体的某一个类。
level :用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前logger将会继承上级的级别。也就是root节点设置的日志级别。
addtivity :是否向上级loger传递打印信息。默认是true。
<logger name="com.test.project.controller" level="INFO"/>
root子节点:是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。
默认是DEBUG。
ALL表示打印所有等级的日志。不推荐使用。打印的日志太多了。
OFF表示关闭日志打印。
可以包含零个或多个元素,标识这个appender将会添加到这个logger。
<!--指定最基础的日志输出级别-->
<root level="INFO">
<!--appender将会添加到这个logger,不添加不会打印出日志-->
<appender-ref ref="consoleLog1"/>
<appender-ref ref="consoleLog2"/>
</root>
控制台输出
在你的resource目录下新建一个logback-spring.xml文件。
这里简单说一下logback-spring.xml和logback.xml的区别,logback-spring.xml是只针对spring应用程序,简单说就是只有在spring应用程序启动后,比如:springboot项目通过@SpringBootApplication注解启动,logback-spring.xml日志打印才会生效。logback.xml除了对spring应用程序打印日志外,还会对main方法和使用@Test注解也会执行日志打印。如果你不想打印额外的日志使用logback-spring.xml即可。看情况使用。
**注意:**如果你的日志是配在application.properties或者application.yml文件里面的话,application.properties或者application.yml里面的logger相同配置会覆盖掉logback-spring.xml里面的配置,毕竟application配置加载的优先级较高。
示例1
@RestController
@RequestMapping(value = "/sysUser")
public class SysUserController {
//SpringBoot本身自带slf4j和logback日志,默认是使用logback日志
//依赖是spring-boot-starter-web这个里面下面的spring-boot-starter这个依赖里面有spring-boot-starter-logging这个,这个里面就有logback和slf4j依赖
private static final Logger logger= LoggerFactory.getLogger(SysUserController.class);
@Autowired
private SysUserService sysUserService;
@GetMapping(value = "/test2")
public String test2(){
//日志等级从低到高:trace<debug<info<warn<error
logger.trace("日志输出:trace等级");
logger.debug("日志输出:debug等级");
logger.info("日志输出:info等级");
logger.warn("日志输出:warn等级");
logger.error("日志输出:error等级");
return "hello world";
}
}
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
<!--展示日志打印格式 layout-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d [%thread] %-5level [%logger{36}] -1 %msg%n</pattern>
</layout>
</appender>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d [%thread] %-5level [%logger{36}] -2 %msg%n</pattern>
</encoder>
</appender>
<!--指定最基础的日志输出级别,只打印root根节点指定级别以上的日志(包含指定级别)-->
<root level="INFO">
<!--appender将会添加到这个loger,不添加不会打印出日志-->
<appender-ref ref="consoleLog1"/>
<appender-ref ref="consoleLog2"/>
</root>
</configuration>
浏览器调用接口http://localhost:8080/sysUser/test2打印日志如下:
可以看到 layout 和 encoder ,都可以将事件转换为格式化后的日志记录,但是控制台输出使用 layout ,文件输出使用 encoder 。
打印格式参数解释:
%d:表示当前时间,默认格式为yyyy-MM-dd HH:mm:ss.SSS,如果不想使用该格式可以如下使用:%d{yyyy-MM-dd}这样来指定格式。
%thread:输出当前线程名称。
%logger{36} :输出logger名称,后面的36表示位数,只显示36个字符。
%-5level:输出日志级别,-5表示左对齐并且固定输出5个字符。
%msg:日志内容。
%n:换行。
示例2
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
<!--展示日志打印格式 layout-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d [%thread] %-5level [%logger{36}] -1 %msg%n</pattern>
</layout>
<!--过滤掉WARN等级以下的日志,只显示WARN等级以上的日志,默认是 info 级别的-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>WARN</level>
</filter>
</appender>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d [%thread] %-5level [%logger{36}] -2 %msg%n</pattern>
</encoder>
</appender>
<!--指定最基础的日志输出级别-->
<root level="INFO">
<!--appender将会添加到这个loger-->
<appender-ref ref="consoleLog1"/>
<appender-ref ref="consoleLog2"/>
</root>
</configuration>
ThresholdFilter为系统定义的拦截器,例如我们用ThresholdFilter来过滤掉WARN级别以下(不包含WARN级别)的日志不输出到文件中。
示例3
如果只想显示info级别的日志,那么应该使用LevelFilter。
LevelFilter是级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。
level:设置过滤级别
onMatch:用于配置符合过滤条件的操作,值有ACCEPT允许和DENY禁止
onMismatch:用于配置不符合过滤条件的操作,值有ACCEPT允许和DENY禁止
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
<!--展示日志打印格式 layout-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d [%thread] %-5level [%logger{36}] -1 %msg%n</pattern>
</layout>
<!--只输出Info 级别的日志-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<!--匹配到就允许-->
<onMatch>ACCEPT</onMatch>
<!--没有匹配到就禁止-->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d [%thread] %-5level [%logger{36}] -2 %msg%n</pattern>
</encoder>
</appender>
<!--指定最基础的日志输出级别-->
<root level="INFO">
<!--appender将会添加到这个loger-->
<appender-ref ref="consoleLog1"/>
<appender-ref ref="consoleLog2"/>
</root>
</configuration>
示例4
禁止某个日志等级输出,这里举例ERROR等级禁止输出,那么如下设置就好:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
<!--展示日志打印格式 layout-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d [%thread] %-5level [%logger{36}] -1 %msg%n</pattern>
</layout>
<!--禁止ERROR等级的日志输出-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!--日志等级 ERROR-->
<level>ERROR</level>
<!--匹配到就禁止ERROR等级-->
<onMatch>DENY</onMatch>
<!--没有匹配到就允许其他等级的日志通过-->
<onMismatch>ACCEPT</onMismatch>
</filter>
</appender>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d [%thread] %-5level [%logger{36}] -2 %msg%n</pattern>
</encoder>
</appender>
<!--指定最基础的日志输出级别-->
<root level="INFO">
<!--appender将会添加到这个loger-->
<appender-ref ref="consoleLog1"/>
<appender-ref ref="consoleLog2"/>
</root>
</configuration>
文件输出
通过RollingFileAppender滚动输出到指定文件下面,日志文件会在你的项目根目录下面生成。
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--日志文件保存路径,保存到项目的根目录下面-->
<property name="LOG_FILE_PATH" value="testShopLog"/>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
<!--展示日志打印格式-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d [%thread] %-5level [%logger{36}] - %msg%n</pattern>
</layout>
</appender>
<!--输出INFO级别到指定文件-->
<appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--只输出INFO级别的日志-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<!--指定日志打印格式-->
<pattern>%d [%thread] %-5level [%logger{36}] - %msg%n</pattern>
<!--设置日志编码格式-->
<charset>UTF-8</charset>
</encoder>
<!--滚动策略,按照日志大小和时间滚动SizeAndTimeBasedRollingPolicy-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--设置文件命名格式,%i里面i默认值是0,如果超过了设置日志的大小,会往下生成一个新的日志这时候i为1-->
<!--${LOG_FILE_PATH}表示取property属性里面name为LOG_FILE_PATH的value值-->
<fileNamePattern>${LOG_FILE_PATH}/info/log-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--设置日志文件大小,超过就重新生成一个新文件,默认10MB-->
<maxFileSize>30MB</maxFileSize>
<!--日志文件保留天数,默认30天,假如日志滚动,如果值为7,则只保留最近7天的归档文件,删除之前的文件。-->
<maxHistory>7</maxHistory>
</rollingPolicy>
</appender>
<!--指定最基础的日志输出级别,只输出指定日志等级以上的日志,包含指定等级-->
<root level="INFO">
<!--appender将会添加到这个logger,不添加不会打印出日志-->
<appender-ref ref="consoleLog1"/>
<appender-ref ref="fileInfoLog"/>
</root>
</configuration>
生产环境配置如下:
最后加上我使用的logback-spring.xml配置,将info级别以上的日志在控制台输出(看情况使用,不想要可以在root节点下面注释掉appender-ref ref="consoleLog"这句代码),同时将info级别和error级别分别输出到不同文件,对info和error进行了分级输出。其实简单点说无非就是多配置了一个只显示ERROR日志等级的RollingFileAppender。
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--日志文件保存路径,保存到项目的根目录下面-->
<property name="LOG_FILE_PATH" value="testShopLog"/>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<!--展示日志打印格式-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d [%thread] %-5level [%logger{36}] - %msg%n</pattern>
</layout>
</appender>
<!--输出INFO级别到指定文件-->
<appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--只输出INFO级别的日志-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<!--指定日志打印格式-->
<pattern>%d [%thread] %-5level [%logger{36}] - %msg%n</pattern>
<!--设置日志编码格式-->
<charset>UTF-8</charset>
</encoder>
<!--滚动策略,按照日志大小和时间滚动SizeAndTimeBasedRollingPolicy-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--设置文件命名格式,%i里面i默认值是0,如果超过了设置日志的大小,会往下生成一个新的日志这时候i为1-->
<!--${LOG_FILE_PATH}表示取property属性里面name为LOG_FILE_PATH的value值-->
<fileNamePattern>${LOG_FILE_PATH}/info/log-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--设置日志文件大小,超过就重新生成一个新文件,默认10M-->
<maxFileSize>30MB</maxFileSize>
<!--日志文件保留天数,默认30天,假如日志滚动,如果值为7,则只保留最近7天的归档文件,删除之前的文件。-->
<maxHistory>7</maxHistory>
</rollingPolicy>
</appender>
<!--输出ERROR级别到指定文件-->
<appender name="fileErrorLog" 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>
<encoder>
<!--指定日志打印格式-->
<pattern>%d [%thread] %-5level [%logger{36}] - %msg%n</pattern>
<!--设置日志编码格式-->
<charset>UTF-8</charset>
</encoder>
<!--滚动策略,按照日志大小和时间滚动SizeAndTimeBasedRollingPolicy-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--设置文件命名格式,%i里面i默认值是0,如果超过了设置日志的大小,会往下生成一个新的日志这时候i为1-->
<!--${LOG_FILE_PATH}表示取property属性里面name为LOG_FILE_PATH的value值-->
<fileNamePattern>${LOG_FILE_PATH}/error/log-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--设置日志文件大小,超过就重新生成一个新文件,默认10M-->
<maxFileSize>30MB</maxFileSize>
<!--日志文件保留天数,默认30天,假如日志滚动,如果值为7,则只保留最近7天的归档文件,删除之前的文件。-->
<maxHistory>7</maxHistory>
</rollingPolicy>
</appender>
<!--打印mbg目录下面的mybatis里面的sql语句,因为我的service层和dao层在这个目录里面,只在dev环境使用,生产环境注释掉-->
<logger name="com.test.mbg" level="DEBUG" />
<!--指定最基础的日志输出级别,只输出指定日志等级以上的日志,包含指定等级-->
<root level="INFO">
<!--appender将会添加到这个logger,不添加不会打印出日志-->
<appender-ref ref="consoleLog"/>
<appender-ref ref="fileInfoLog"/>
<appender-ref ref="fileErrorLog"/>
</root>
</configuration>
好了,我的学习笔记就先到这里了。