SpringBoot日志使用非常简单,所以小白也可以放心的看下去,加油!
官网的学习地址:https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-logging-format
默认日志LogBack
SpringBoot默认使用LogBack作为日志,并且在 spring-boot-starter-web
下面我们启动一个纯净的springboot项目:
可以看到控制台上输出的这些都是日志
如何将日志输出到文件
如果想要将日志输出到文件中,需要在application.properties或application.yml中配置相关属性
下面我给出一些配置文件及其解释帮助大家理解相关含义
#配置日志文件名,默认文件名为spring.log
logging.file=“日志文件名”
#配置日志文件的路径(相对路径或者绝对路径)
logging.path=./
如何设置日志级别
#配置root级别(项目所有日志)的日志级别 logging.level.<logger-name>=<level>
logging.level.root=info
日志级别总共有TARCE < DEBUG < INFO < WARN < ERROR < FATAL ,且级别是逐渐提供,如果日志级别设置为INFO,则意味TRACE和DEBUG级别的日志都看不到。
如何定制自己的日志格式
#配置日志控制台输出格式
logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
#配置日志文件输出格式
logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n
logging.pattern.console 该属性用于定制日志输出格式。
上述配置的编码中,对应符号的含义如下:
%d{HH:mm:ss.SSS}——日志输出时间
%thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
%-5level——日志级别,并且使用5个字符靠左对齐
%logger- ——日志输出者的名字
%msg——日志消息
%n——平台的换行符
使用Log4j2日志
如何使用Log4j2日志
在pom.xml文件中排除SpringBoot默认log日志jar包,引入log4j2日志jar包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<!--移除springboot自带log包-->
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--log4j2日志-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
然后在,resources目录下新建一个关于log4j2的配置文件
需要注意:在springboot的官网中有这么一段信息:
例如:使用Log4j2日志,那么resources下的log4j2-spring.xml和log4j2.xml配置文件是SpringBoot自动识别的,不需要额外的配置,如果用其他的文件名就需要在
application.properties中指定日志配置文件的路径
logging.config=<你的配置文件路径>
好了啰嗦了这么多,直接给出log4j2.xml的配置文件,然后告诉大家这些配置文件的含义
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<properties>
<property name="LOG_HOME">./logs</property>
<property name="FILE_NAME">springboot-log4j2</property>
<property name="log.sql.level">info</property>
</properties>
<Appenders>
<!--控制台输出-->
<Console name="CONSOLE" target="SYSTEM_OUT">
<PatternLayout charset="UTF-8" pattern="(%d{HH:mm:ss.SSS}) [%t] %-5level %l - %msg%n" />
</Console>
<!--文件输出-->
<!--<File name="File" fileName="./springboot-log4j2.log">-->
<!--<PatternLayout charset="UTF-8" pattern="%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n" />-->
<!--</File>-->
<!--更强大的文件输出:根据文件大小或时间生成多个配置文件,避免单个配置文件过大情况-->
<RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
<PatternLayout charset="UTF-8" pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10 MB"/>
</Policies>
<!--指定最多保存的文件个数-->
<DefaultRolloverStrategy max="20"/>
</RollingRandomAccessFile>
</Appenders>
<Loggers>
<root level="info">
<AppenderRef ref="CONSOLE" />
<AppenderRef ref="RollingRandomAccessFile" />
</root>
</Loggers>
</configuration>
log4j2.xml文件的配置大致如下:
• Configuration
• properties
• Appenders
• Console
• PatternLayout
• File
• RollingRandomAccessFile
• Async
• Loggers
• Logger
• Root
• AppenderRef
- Configuration:为根节点,有status和monitorInterval等多个属性
- status的值有 “trace”, “debug”, “info”, “warn”, “error” and “fatal”,用于控制log4j2日志框架本身的日志级别,如果将stratus设置为较低的级别就会看到很多关于log4j2本身的日志,如加载log4j2配置文件的路径等信息
- monitorInterval,含义是每隔多少秒重新读取配置文件,可以不重启应用的情况下修改配置
- Appenders:输出源,用于定义日志输出的地方
log4j2支持的输出源有很多,有控制台Console、文件File、RollingRandomAccessFile\MongoDB、Flume 等
- Console:控制台输出源是将日志打印到控制台上,开发的时候一般都会配置,以便调试
- File:文件输出源,用于将日志写入到指定的文件,需要配置输入到哪个位置
- RollingRandomAccessFile: 该输出源也是写入到文件,不同的是比File更加强大,可以指定当文件达到一定大小(如20MB)时,另起一个文件继续写入日志,另起一个文件就涉及到新文件的名字命名规则,因此需要配置文件命名规则
这种方式更加实用,因为你不可能一直往一个文件中写,如果一直写,文件过大,打开就会卡死,也不便于查找日志。
- fileName 指定当前日志文件的位置和文件名称
- filePattern 指定当发生Rolling时,文件的转移和重命名规则
- SizeBasedTriggeringPolicy 指定当文件体积大于size指定的值时,触发Rolling
- DefaultRolloverStrategy 指定最多保存的文件个数
- TimeBasedTriggeringPolicy 这个配置需要和filePattern结合使用,注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i,最小的时间粒度是mm,即分钟
- TimeBasedTriggeringPolicy指定的size是1,结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH},最小粒度为小时,则每一个小时生成一个文件
- NoSql:MongoDb, 输出到MongDb数据库中
- Flume:输出到Apache Flume(Flume是Cloudera提供的一个高可用的,高可靠的,分布式的海量日志采集、聚合和传输的系统,Flume支持在日志系统中定制各类数据发送方,用于收集数据;同时,Flume提供对数据进行简单处理,并写到各种数据接受方(可定制)的能力。)
- Async:异步,需要通过AppenderRef来指定要对哪种输出源进行异步(一般用于配置RollingRandomAccessFile)
- PatternLayout:控制台或文件输出源(Console、File、RollingRandomAccessFile)都必须包含一个PatternLayout节点,用于指定输出文件的格式(如 日志输出的时间 文件 方法 行数 等格式),例如 pattern=”%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n”
%d{HH:mm:ss.SSS} 表示输出到毫秒的时间
%t 输出当前线程名称
%-5level 输出日志级别,-5表示左对齐并且固定输出5个字符,如果不足在右边补0
%logger 输出logger名称,因为Root Logger没有名称,所以没有输出
%msg 日志文本
%n 换行
其他常用的占位符有:
%F 输出所在的类文件名,如Log4j2Test.java
%L 输出行号
%M 输出所在方法名
%l 输出语句所在的行数, 包括类名、方法名、文件名、行数
- Loggers:日志器
日志器分根日志器Root和自定义日志器,当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器,自定义时需要指定每个Logger的名称name(对于命名可以以包名作为日志的名字,不同的包配置不同的级别等),日志级别level,相加性additivity(是否继承下面配置的日志器), 对于一般的日志器(如Console、File、RollingRandomAccessFile)一般需要配置一个或多个输出源AppenderRef;
每个logger可以指定一个level(TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF),不指定时level默认为ERROR
additivity指定是否同时输出log到父类的appender,缺省为true。 - properties: 属性
使用来定义常量,以便在其他配置的时候引用,该配置是可选的,例如定义日志的存放位置
D:/logs