Spring Boot 日志
一、Spring Boot使用的日志框架是SLF4J+LogBack,下面我们就介绍一下SLF4J
1.SLF4J官网:https://www.slf4j.org/
2.调用方式如下:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}
3.SLF4J使用原理
注:SLF4J为抽象层所以使用它时需要调用实现类,如果使用的日志框架没有实现SLF4J,那么就要要调用适配层实现,如下图:
4.统一项目中的日志框架(slf4j+logback)
如果项目中的日志框架比较杂(spring使用commons-logging,hibernate使用jboss-logging,等),想要要统一日志框架流程如下:
第一步:将系统中其它日志框架先排除出去
第二步:用中间包来替换原有的日志框架
第三步:导入slf4j实现
二、Spring Boot日志使用
配置属性说明:
Spring Environment | System Property | Comments |
---|---|---|
|
| The conversion word used when logging exceptions. |
|
| If defined, it is used in the default log configuration. |
|
| Maximum log file size (if LOG_FILE enabled). (Only supported with the default Logback setup.) |
|
| Maximum number of archive log files to keep (if LOG_FILE enabled). (Only supported with the default Logback setup.) |
|
| If defined, it is used in the default log configuration. |
|
| The log pattern to use on the console (stdout). (Only supported with the default Logback setup.) |
|
| Appender pattern for log date format. (Only supported with the default Logback setup.) |
|
| The log pattern to use in a file (if |
|
| The format to use when rendering the log level (default |
|
| The current process ID (discovered if possible and when not already defined as an OS environment variable). |
JAVA代码:
package cn.luoruiyuan.login;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class LoginApplicationTests {
//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//日志级别由低到高trace<debug<info<warn<error
logger.trace("===============跟踪轨迹=============");
logger.debug("===============调试信息============");
//SpringBoot默认info级别
logger.info("===========定义信息============");
logger.warn("===========警告信息================");
logger.error("=============错误信息================");
}
}
appplication.properties配置
#级别控制
logging.level.cn.luoruiyuan=trace
#不指定完整的路径保存在项目目录下
#logging.file=d:/springboot.log
#logging.file=springboot.log
#项目根盘符下创建日志(path和file都指定目录了,file生效)
#logging.path=/spring/log
#控制台输出格式(-5=左对齐)
#%d 表示日期
#%thread 表示线程
#%-5level 表示级别并左对齐
#%msg 表示日志消息
#%n 表示换行
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} ****%msg%n
#文件日志格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} *****%msg%n
输出结果:
三、日志Profile功能
1.如果想直接配置日志就直接新建一相xml文件,文件名要按日志框架规定的建网址:https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-logging
2.如果要使用profile功能,就要使用-spring的文件名。如logback-spring.xml
3.profile使用(使用springProfile标签)
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} --------- [%thread] %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="prod">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} +++++++++ [%thread] %-5level %logger{50} - %msg%n</pattern>
</springProfile>
4.使用步骤
新建:logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!-- 定义日志的根目录 -->
<property name="LOG_HOME" value="/app/log" />
<!-- 定义日志文件名称 -->
<property name="appName" value="atguigu-springboot"></property>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} --------- [%thread] %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="prod">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} +++++++++ [%thread] %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>
<!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_HOME}/${appName}.log</file>
<!--
当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动
%i:当文件大小超过maxFileSize时,按照i进行文件滚动
-->
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是,
那些为了归档而创建的目录也会被删除。
-->
<MaxHistory>365</MaxHistory>
<!--
当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} --------- [%thread] %-5level %logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="prod">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} +++++++++ [%thread] %-5level %logger{50} - %msg%n</pattern>
</springProfile>
</layout>
</appender>
<!--
logger主要用于存放日志对象,也可以定义日志类型、级别
name:表示匹配的logger类型前缀,也就是包的前半部分
level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出,
false:表示只用当前logger的appender-ref,true:
表示当前logger的appender-ref和rootLogger的appender-ref都有效
-->
<!-- hibernate logger -->
<logger name="com.atguigu" level="debug" />
<!-- Spring framework logger -->
<logger name="org.springframework" level="debug" additivity="false"></logger>
<!--
root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="stdout" />
<appender-ref ref="appLogAppender" />
</root>
</configuration>
application.properties配置文件中指定环境:
spring.profiles.active=prod
运行结果:
四、切换日志框架(slf4j+log4j2)
1.POM.XML修改
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
注:移除logback添加log4j2