程序日志的保存追踪以及异常捕获是开发人员在日常应用及编程开发中经常会遇到的。正好最近开发需要用到此功能,就记录了下来。
项目环境
- Spring Boot : 2.0.1.RELEASE
- Maven : 3.6.1
- Java : 1.8
- Intellij IDEA : 2019.1.3
项目创建
开发环境为 Intellij IDEA,创建spring boot项目很简单,可参考 spring boot快速入门
项目创建完毕之后就可以进行开发,项目的完整结构如下图所示:
参数配置
项目创建完成之后,需要设置一些必要的参数,打开项目resources
目录下配置文件application.properties
,在其中添加以下参数:
#端口号
server.port=8080
#配置日志
logging.config=classpath:logback-boot.xml
其中logback-boot.xml
是我们要用到的logback配置文件,所以我们需要在resources
下新建logback-boot.xml
,内容如下:
<configuration>
<!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
<!-- appender是configuration的子节点,是负责写日志的组件。 -->
<!-- ConsoleAppender:把日志输出到控制台 -->
<appender name="ConsoleLog" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<!-- 自定义样式-->
<pattern>%white(%d{
yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) - %highlight(%msg%n)</pattern>
<!-- 控制台也要使用UTF-8,不要使用GBK,否则会中文乱码 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
<!-- 以下的大概意思是:1.先按日期存日志,日期变了,将前一天的日志文件名重命名为XXX%日期%索引,新的日志仍然是xxx.log -->
<!-- 2.如果日期没有发生变化,但是当前日志的文件大小超过10MB时,对当前日志进行分割 重命名-->
<!-- 配置异常文件相关-->
<appender name="ErrorLog"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>logs/test1/error/error.log</File>
<!-- rollingPolicy:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。 -->
<!-- TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次 -->
<!-- 文件名:log/test1/error/error.2020-03-30.0.log -->
<fileNamePattern>logs/test1/error/error.%d.%i.log</fileNamePattern>
<!-- 每产生一个日志文件,该日志文件的保存期限为15天 -->
<maxHistory>15</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- maxFileSize:这是活动文件的大小,默认值是10MB -->
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<!-- pattern节点,用来设置日志的输入格式 -->
<pattern>