3.日志
3.1 日志框架
市面上的日志框架:
- JUL
- JCL
- Jboss-logging
- logback
- log4j
- log4j2
- sfl4j
- …
日志门面(日志的抽象层) | 日志实现 |
---|---|
Log4j JUL(java.util.logging) Log4j2 Logback |
SpringBoot :底层是Spring框架,Spring框架默认是用JCL;
SpringBoot:SLF4J和logback
3.2 SLF4j使用
3.2.1 系统中使用SLF4j SLF4j官网
在开发的过程中,日志记录方法的调用,不应该直接调用日志的实现类,而是调用日志抽象层里面的方法;
给系统里面导入slf4j的jar和logback的实现jar
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("HelloWorld!!!");
}
}
图示:
说明1
- 灰蓝色是 logging-api(门面)
- 深蓝色是默认slf4j实现
- 天蓝色是中间适配
- 灰色是原本的日志框架实现
说明2
- SLF4J绑定logback-classic:slf4j-api.jar+logback-classic.jar+logback-core.jar
- SLF4J绑定log4j:slf4j-api.jar+slf4j-log4j2.jar+log4j.jar
- SLF4J绑定java.util.logging:slf4j-api.jar+slf4j-jdk14.jar+jvm runtime
- SLF4J绑定simple:slf4j-api.jar+slf4j-simple.jar
- SLF4J绑定no-operation:slf4j-api.jar+slf4j-nop.jar
SLF4J绑定其他日志实现=slf4j.api.jar+中间适配.jar+原本日志.jar
每一个日志的实现框架都有自己的配置文件。使用slf4j以后,配置文件还是做成日志实现框架自己本身的配置文件
3.2.1 遗留问题
SpringBoot(slf4j+logback):Spring (commons-logging)、Hibernate(jobss-loggin)、Mybatis
统一日志记录,即使是别人的框架和我一起统一使用slf4j进行输出?
说明1
在一个系统中如果本身要使用slf4j+logback 的日志,但是在引入框架的时候会有框架本身及自带日志框架,如Spinrg自带 commons-logging,其他框架又自带 ** log4j.log** 等情况,可以使用sfl4j官网提供的 “替换包”,即保留原本接口的调用形式,底层的实现还是调用slf4j,如:
- 使用jcl-over-slf4j.jar替换commons-logging.jar
- 使用log4j-over-slf4j.jar替换 log4j.jar
- 使用jul-to-slf4j.jar 替换 java.util.logging
- 导入logback需要的jar,logback-classic.jar+logback-core.jar
如何让系统中所有的日志都统一到slf4j
- 将系统中其他的日志框架先排除出去
- 用中间包替换原有的日志框架
- 导入slf4j其他的实现
3.3 SpringBoot的日志关系
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
SpringBoot使用它来做日志功能
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
底层依赖关系
说明
- SpringBoot的底层也是使用slf4j+logback的方式进行日志记录;
- SpringBoot也把其他的日志都通过"替换包"内部实现都成了slf4j;
- 在替换包中实际上调用的是SLF4J的实现
@SuppressWarnings("rawtypes")
public abstract class LogFactory {
static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J ="http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
static LogFactory logFactory = new SLF4JLogFactory();
}
4. 如果要引入其他框架?一定要把这个框架默认的日志移除?
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的方式记录日志,引入其他的框架的时候,只需要把这个框架依赖的日志框架排除掉即可。
3.4 日志使用
3.4.1 默认配置
SpringBoot默认帮我们配置好了日志;
// 记录器
Logger logger= LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
// 日志的级别
// 由低到高 trance<debug<info<warn<error
// 可以调整输出日志级别,日志只会在这级高级别生效
logger.trace("这是trance日志...");
logger.debug("这是debug日志...");
// springBoot默认是使用info级别,没有指定级别就用SpringBoot默认规定的级别,root级别
logger.info("这是info日志...");
logger.warn("这是warn日志....");
logger.error("这是error日志...");
}
SpringBoot默认配置文件修改
logging.level.com.study=trace
# 不指定路径当前项目下生成springboot.log日志
# 可以指定完整的路径
# logging.file=springboot.log
# 在当前磁盘的根路径下穿件spring文件和李曼的log文件夹,使用spring.log 为默认文件
logging.path=/springboot/log
# 在控制台输出日志的格式
# %d:表示日期时间
# %thread:表示线程名
# %-5level:级别从左显示5个字符宽度
# %logger{50}:表示logger名字最长50个字符,否则按句点分割
# %n:表示换行符
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{51} - %msg%n
# 在日志输出日志的格式
logging.pattern.file=%d{yyyy-MM-dd}=== [%thread] === %-5level === %logger{51} === %msg%n
logging.file | logging.path | Example | Description |
---|---|---|---|
(none) | (none) | 只在控制台输出 | |
指定文件名 | (none) | my.log | 输出日志到my.log文件 |
(none) | 指定录目 | /var/log | 输出到指定录目的spring.log文件中 |
3.4.2 指定配置
给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了
Logging System | Customization |
---|---|
Logback | logback-spring.xml,logbakc-spring.groovy,logback,xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) | loggin.properties |
logback.xml:直接就被日志框架识别了;
logback-spring.xml:SpringBoot推荐使用日志框架就不直接加载日志的配置项,由SpringBoot加载,这样就可以使用SpingBoot的高级Profile功能
<springProfile name="dev">
<!--在指定激活dev的时候生效-->
</springProfile>
如:
<?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="springBoot"/>
<!--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="!dev">
<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的行为,涉及文件的移动和重命名
TimeBaseRollingPolicy:最常用的滚动策略,它根据时间来定制滚动的策略,及负责滚动也负责触发滚动
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动。
且maxHistory是365,则只保存最近的365天的文件,删除之前的旧文件。注意,删除旧文件是,
那些为了归档而创建的目录也会被删除。
-->
<MaxHistory>365</MaxHistory>
<!--
当日志文件超过maxFileSize指定的大小是,根据上面提到的%1进行日志文件滚动
注意此处配置SizeBasedTriggeringPolicy是无法实现文件大小进行滚动的,
必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">>
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
</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都有效
-->
<logger name="com.study" level="debug"/>
<logger name="org.springframework" level="debug" additivity="false"/>
<!--
root与logger是父子关系,没有特别定义规则默认为root,任何一个类只会和一个logger对应,
要么是定义logger,要么是root,判断的关键在于找到这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="stdout"/>
<appender-ref ref="appLogAppender"/>
</root>
</configuration>
如果使用logback.xml作为日志配置文件,还要使用profile功能,会有以下错误
no application action for [springProfile]
3.5 切换日志框架
可以按照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>
切换为spring-boot-starter-log4j2
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring-boot-starter-logging</artifactId>
<groupId>org.springframwork.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependncy>
<groupId>org.springframwork.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactid>
</dependncy>