Spring Boot利用Logback输出日志到指定位置的简单配置及使用方式
Spring Boot工程一般都是通过打包为jar或者war格式,这个时候你一定希望日志输出到指定的位置,这样方便后期的系统日志分析。
我们还希望日志能够按照我们自己设定的规则进行生成,如希望生成的日志以天为单位,同时还希望当日志大于指定大小时自动进行分割(话说,几十、几百兆的日志文件打开时也是很烦人的)。
我们如何做?
利用Logback+lombok就能满足要求!配置强大,使用简单!
1、在pom.xml中配置lombok的依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
2、安装lombok插件(IDEA中)
3、增加logback的配置
在Spring Boot中增加一个配置文件logback-spring.xml(位置和yml在一个地方就行,方便管理),如下:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
<!-- appender是configuration的子节点,是负责写日志的组件。 -->
<!-- ConsoleAppender:把日志输出到控制台 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %p (%file:%line\)- %m%n</pattern>
<!-- 控制台也要使用UTF-8,不要使用GBK,否则会中文乱码 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
<!-- 以下的大概意思是:1.先按日期存日志,日期变了,将前一天的日志文件名重命名为XXX%日期%索引,新的日志仍然是sys.log -->
<!-- 2.如果日期没有发生变化,但是当前日志的文件大小超过1KB时,对当前日志进行分割 重命名-->
<appender name="syslog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>D:systemlog\sys.log</File>
<!-- rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。 -->
<!-- TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次 -->
<!-- 文件名:sys.2017-12-05.0.log -->
<fileNamePattern>D:\systemlog\sys.%d.%i.log</fileNamePattern>
<!-- 每产生一个日志文件,该日志文件的保存期限为30天 -->
<maxHistory>30</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- maxFileSize:这是活动文件的大小,默认值是10MB,本篇设置为2MB-->
<maxFileSize>2MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<!-- pattern节点,用来设置日志的输入格式 -->
<pattern>
%d %p (%file:%line\)- %m%n
</pattern>
<!-- 记录日志的编码 -->
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
</appender>
<!-- 控制台输出日志级别,并且存入日志文件 -->
<root level="info">
<appender-ref ref="STDOUT" />
<appender-ref ref="syslog" />
</root>
<!-- 指定项目中某个包,当有日志操作行为时的日志记录级别 -->
<!-- com.appley为根包,也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
<!-- 级别依次为【从高到低】:FATAL > ERROR > WARN > INFO > DEBUG > TRACE
<logger name="org.springframework" level="warn">
<appender-ref ref="syslog" />
</logger>-->
</configuration>
上面注释已经写得很到位,大家可以直接拷贝使用,重点只选关注下图所示的两个地方就行了,如下:
4、在Spring Boot中的yml配置文件中引入logback-spring.xml
5、日志的应用
在要输出日志的类上添加注解@Slf4j,然后利用log.info、log.error、log.warn就可以输出日志啦。