每个系统中都会有个日志,不管你是自己实现的单纯写文件,还是利用多功能的日志框架,大的系统会有相应的日志系统。什么是日志门面?什么是日志框架?SpringBoot 中如何使用日志。
目录
1.日志门面与日志框架
2.引入方式
3. Slf4j 两种使用方式
4.Logback 的两种配置方式
1
日志门面与日志框架
日志门面:是门面模式的一个典型的应用。门面模式(Facade Pattern),也称之为外观模式,其核心为:外部与一个子系统的通信必须通过一个统一的外观对象进行,使得子系统更易于使用,主要用来隔离解耦。
Java中常见日志门面如 JCL,slf4j等。就好像抽象出来的接口,只是用来发指令,不管底层实现。大概像微服务的注册中心,负载均衡服务器,代理服务器。又像PHP里面的PDO 一样,无论操作的是mysql 还是sql server ,实现起来都一样,只不过加载的驱动一个是 pdo_mysql ,一个是 pdo_sqlsrv。
日志框架:Java中有 jul,Log4j,Log4j2,Logback 几种日志框架一样,每一种日志框架都有自己单独的API,要使用对应的框架就要使用其对应的API,这就大大的增加应用程序代码对于日志框架的耦合性。《阿里巴巴Java开发手册》 中强制要求使用日志门面+日志框架 ,禁止直接调用框架的API。
主要是为了在应用中屏蔽掉底层日志框架的具体实现,即使有一天要更换代码的日志框架,只需要修改jar包,最多再改改日志输出相关的配置文件就可以了,无需修改代码中的日志代码。
2
引入方式
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
</dependency>
3
Slf4j 两种使用方式
第一种 不使用注解
package com.qustdjx.product.respository;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import static org.junit.jupiter.api.Assertions.*;
@SpringBootTest
class ProductInfoRepositoryTest {
private final Logger logger = LoggerFactory.getLogger(ProductInfoRepositoryTest.class);
@Test
void findByProductStatus() {
String var = "World";
logger.info("Hello {}",var);
logger.error("error");
}
}
第二种使用@Slf4j注解,更方便
package com.qustdjx.product.respository;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import static org.junit.jupiter.api.Assertions.*;
@SpringBootTest
@Slf4j
class ProductInfoRepositoryTest {
//private final Logger logger = LoggerFactory.getLogger(ProductInfoRepositoryTest.class);
@Test
void findByProductStatus() {
String var = "World";
log.info("Hello {}",var);
log.error("error");
}
}
4
Logback 的两种配置方式
第一种 使用application.yml 简单配置
spring:
profiles:
active: dev
logging:
pattern:
console: "%d -%msg%n"
file:
name: springboot.log
path: ./
level:
com.qustdjx.product.respository.ProductInfoRepositoryTest: debug
第二种,使用自定义规则的xml,可以实现每天生成一个日志文件,日志文件按等级分文件保存,保存日期等 复杂规则日志
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<contextName>study</contextName>
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_HOME" value="./logs" />
<property name="appName" value="onlineStudy" />
<!--layout 为日志展示的形式-->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>
%d-%msg%n
</pattern>
</layout>
</appender>
<!--控制台日志, 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!--RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件-->
<!--文件日志, 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true -->
<append>true</append>
<!--当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<!--logType:日志类型,如 stats/monitor/access-->
<FileNamePattern>${LOG_HOME}/${appName}_monitor_debug_%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 按日志级别打印 INFO -->
<appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。-->
<file>${LOG_HOME}/info/info.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 文件名称 -->
<fileNamePattern>${LOG_HOME}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern>
<!-- 文件最大保存历史数量 -->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--filter 过滤输出-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
<logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
<logger name="org.hibernate.SQL" level="DEBUG" />
<logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
<logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />
<!--myibatis log configure-->
<logger name="com.apache.ibatis" level="TRACE"/>
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/>
<logger name="java.sql.PreparedStatement" level="DEBUG"/>
<!-- 日志输出级别设置,ref 属性为 appender 的name-->
<root level="DEBUG">
<appender-ref ref="consoleLog" />
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE"/>
<appender-ref ref="infoAppender"/>
</root>
</configuration>
END