日志框架分类和选择
日志门面与日志实现的关系有点像、JDBC和数据库驱动的关系
日志门面 (日志的抽象层) | 日志实现 |
---|---|
JCL(Jakarta Commons Logging) SLF4j(Simple Logging Facade for Java) jboss-logging |
Log4j JUL(java.util.logging) Log4j2 Logback |
SpringBoot选用 SLF4j
和logback
SpringBoot使用它来做日志功能
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
<version>2.0.5.RELEASE</version>
<scope>compile</scope>
</dependency>
SLF4j使用
开发的时候日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法
SLF4J用户手册
首先给系统里面导入slf4j的jar和 logback的实现jar
Hello World:
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");
}
}
图示:
每一个日志的实现框架都有自己的配置文件。使用slf4j以后,配置文件还是做成日志实现框架自己本身的配置文件
统一日志记录
在实际开发中情况会更复杂一些
例子:
在开发a系统的时候用的是(slf4j+logback),系统中需要用到Spring(commons-logging),hibernate((jboss-logging),mybatis等等,这些框架底层中又自带了日志记录,现在想统一使用slf4j日志
图示
如何让系统中所有的日志都统一到slf4j:
- 将系统中其他日志框架先排除出去
- 用中间包来替换原有的日志框架
- 我们导入slf4j其他的实现
这些SpringBoot都已经帮我们最好了
在pom.xml
中右键
会跳转到一个流程图,从中我们可以看到
总结:
- SpringBoot底层也是使用slf4j+logback的方式进行日志记录
- SpringBoot也把其他的日志都替换成了slf4j
- 中间替换包
如果我们要引入其他框架?一定要把这个框架的默认日志依赖移除掉
Spring框架用的是commons-logging
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring‐core</artifactId>
<exclusions>
<exclusion>
<groupId>commons‐logging</groupId>
<artifactId>commons‐logging</artifactId>
</exclusion>
</exclusions>
</dependency>
SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可
我所使用的的springboot
版本是2.0.5.RELEASE
,里面的spring
版本是5.0.9.RELEASE
,没有commons‐logging
,所以不用排除
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.0.9.RELEASE</version>
<scope>compile</scope>
</dependency>
日志使用
默认配置
SpringBoot默认帮我们配置好了日志
我们可以在测试类中看一下
//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//System.out.println();
//日志的级别;
//由低到高 trace<debug<info<warn<error
//可以调整输出的日志级别;日志就只会在这个级别以后的高级别生效
logger.trace("这是trace日志...");//框架运行中如果你想跟踪信息时用
logger.debug("这是debug日志...");//调试信息
//SpringBoot默认给我们使用的是info级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别
logger.info("这是info日志...");//自己定义的想要输出的信息
logger.warn("这是warn日志...");//警告
logger.error("这是error日志...");//错误
}
修改日志的级别:
#表示把com.nyh里面的所有的类的日志都调为`trace`级别
logging.level.com.nyh=trace
运行结果:
日志的格式
日志输出格式:
%d
表示日期时间,
%thread
表示线程名,
%‐5level
:级别从左显示5个字符宽度
%logger{50}
表示logger名字最长50个字符,否则按照句点分割。
%msg
:日志消息,
%n
是换行符
输出:
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n
在properties或yml配置文件中配置
# 在控制台输出的日志的格式
logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %‐5level === %logger{50} ==== %msg%n
logging.file | logging.path | Example | Description |
---|---|---|---|
(none) | (none) | 只在控制台输出 | |
指定文件名 | (none) | my.log | 输出日志到my.log文件 |
(none) | 指定目录 | /var/log | 输出到指定目录的 spring.log 文件中 |
这种方法只能修改一些默认配置,想要知道更多的默认配置可以到Maven: org.springframework.boot:spring-boot:2.0.5.RELEASE2
jar包下的logging
下查看配置文件
例如logback的日志配置文件:
自定义日志配置
如果我们想要用springboot的日志高级功能,比如异步日志,自动归档等,我们需要自己写配置文件
在官方文档中有专门的介绍
给类路径(resources文件夹)下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了
名字有两种:
logback.xml
:会直接就被日志框架识别,相当于绕过了springboot;
logback-spring.xml
:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot的高级Profile功能
logback-spring.xml
这种写法的好处是可以使用springProfile标签
<springProfile name="dev">
<!‐‐ configuration to be enabled when the "staging" profile is active
指定这段配置只在dev环境下生效-->
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level
%logger{50} ‐ %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level
%logger{50} ‐ %msg%n</pattern>
</springProfile>
切换日志框架
按照slf4j的日志适配图,导入相关的依赖和排除相应的依赖就可以了
例如切换为slf4j+log4j的方式;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>logback‐classic</artifactId>
<groupId>ch.qos.logback</groupId>
</exclusion>
<exclusion>
<artifactId>log4j‐over‐slf4j</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j‐log4j12</artifactId>
</dependency>
切换为切换为log4j2:
<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>