1.日志框架
- 日志门面(抽象层)与日志实现
- Spring Boot:
底层是SpringFramework,默认使用JCL,但SpringBoot选用SLF4J和logback
2.使用SLF4J(无关Spring Boot)
2.1 如何在系统中使用?
- 在开发中,需要调用日志记录的方法时, 不应该直接调用日志实现类(logback),而是调用日志抽象层(SLF4J)定义的方法接口
- SLF4J+默认实现logback的简单使用
//导入SLF4J,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("Hello World"); } }
- SLF4J日志接口与其他日志实现的关系图示
每一个日志实现框架都有自己的配置文件。使用SLF4J以后,配置文件还是日志实现框架本身的配置文件。
2.2 遗留问题: 统一日志记录
问题:ProjectA(SLF4j+logback):架设于Spring(commons-loggin)、Hibernate(jboss-logging)等框架,底层的使用的日志框架各不相同。
需求:将底层使用的其他日志框架,统一使用SLF4J抽象层+logback实现层以规范输出 => “偷天换日”三步走,替换jar包后在底层实际调用的是SLF4JLogger,相当于加了一层“搭桥”。
【如何将系统中所有日志都统一到SLF4J】
(1)将系统中其他的日志框架(抽象层+实现层)先行排除掉
(2)使用中间包(这些包保留了原有的调用结构,仅在最底层实际操作中使用了SLF4J,名字如xxx-over-slf4j.jar xxx-to-slf4j.jar)替换原有的日志框架(抽象层+实现层)
(3)导入 SLF4J其他实现(slf4j-xxx.jar)
3. Spring Boot的日志关系
在pom.xml中右击选择Diagrams -> Show Dependencies 查看IDEA提供的依赖图谱
-
最基本依赖 spring-boot-starter,只要是Spring Boot应用就会在底层使用这个依赖。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.0.4.RELEASE</version> <scope>compile</scope> </dependency>
-
spring-boot-starter又依赖了spring-boot-starter-logging来做日志功能(更底层)
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> <version>2.0.4.RELEASE</version> <scope>compile</scope> </dependency>
-
中间替换包 jul-to-slf4j / log4j-over-slf4j / jcl-over-slf4j
与原日志框架完全相同的包组织结构(连包名都不变),但在底层“偷换”逻辑,调用SLF4JLogger。Spring Boot默认已经完成了“偷天换日”的后两步。 -
若引入预置start之外的其他框架集成,则一定要把该框架默认的日志依赖移除掉(exclusion,否则会出现包和类的冲突)!Spring Boot将自动适配所有日志,统一使用SLF4J+logback进行记录!
<!-- SpringFramework底层使用的common-loggins,已经被Spring Boot排除了 --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <exclusions> <exclusion> <groupId>commons-logging</groupId> <artifactId>commons-logging</artifactId> </exclusion> </exclusions> </dependency>
4. Spring Boot的日志使用
4.1 默认配置
Spring Boot默认已配置日志功能
/*
* 这是Spring Boot测试类(标注了@SpringBootTest,由SpringInitializer快速生成,在Maven的test目录下)
*/
@Test
public void contextLoads() {
//得到SLF4J的日志记录器
Logger logger = LoggerFactory.getLogger(getClass());
//日志级别:由低到高为trace, debug, info, warn, error
//可以调整日志级别以增减日志记录,仅该级别及更高级别才会输出
logger.trace("trace格式化日志,过程信息");
logger.debug("debug格式化日志,调试信息");
//SpringBoot默认设置为info级别,没有在全局配置文件中指定级别的那些类就使用SpringBoot默认级别info(即日志框架配置的root级别)
logger.info("info日志,自定义信息");
logger.warn("warn格式化日志,警告信息");
logger.error("error格式化日志,错误信息");
}
4.2 在主配置文件中修改个别日志配置
#日志级别,logging.level.${范围具体到包或者类},不在范围内的类仍然使用SpringBoot默认规定的Info级别
logging.level.me.zj=debug
#日志输出文件
#若没有指定,则只在控制台Console输出
#使用相对路径日志文件或不指定路径将在当前工程下生成;使用完整的绝对路径可以修改其生成位置
#logging.file=springboot.log
#日志输出路径,与logging.file(具有更高优先级)是冲突配置
#一般使用该配置,而不使用logging.file
#默认文件名spring.log,/表示当前工程所在磁盘的根路径
#这里的日志文件的完整路径就是/spring/log/spring.log
logging.path=/spring/log
#在控制台输出的日志格式
#logging.pattern.console=
#向文件输出的日志格式
#logging.pattern.file=
4.3 自定义日志全配置(替换Spring Boot的对日志框架的默认配置文件)
-
Spring Boot对logback的默认配置文件在spring-boot.RELEASE.jar->org->springframework->boot->logging->logback。
-
举例:若使用logback日志框架,则在类路径下创建以 logback.xml或logback-spring.xml 为名的自定义配置文件(即每个日志框架自己的配置文件),Spring Boot就不会使用那些默认配置
<?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"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> </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"> <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都有效 --> <!-- 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>
-
日志框架自定义配置文件的命名
LoggingSystem Customization Logback logback-spring.xml
logback-spring.groovy
logback.xml
logback.groovyLog4j2 log4j2-spring.xml
log4j2.xmlJDK(JUL) logging.properties 【推荐使用xxx-spring.xml (-spring后缀),以开启高级功能springProfile】
logback.xml:直接被logback原生日志框架识别加载,绕过了Spring Boot
logback-spring.xml:原生框架不能识别该配置文件,由Spring Boot解析并开启 “按照环境激活配置” 的高级特性<!-- 现在是logback-spring.xml,如果改回logback.xml,则启动时会直接报错,因为logback no applicable action for [springProfile] --> <springProfile name="staging"> <!-- configuration to be enabled when the "staging" profile is active --> <parttern>...</pattern> </springProfile> <springProfile name="!staging"> <!-- configuration to be enabled when the 非dev profile is active --> <parttern>...</pattern> </springProfile>
4.5 切换日志框架(以log4j/log4j2为例,替换logback)
- 按照SL4J的日志适配图,进行相关移除,导入(适配包+配置文件)
没有什么实际意义,logback本来就是log4j的升级实现,功能架构都更优 - 排除spring-starter-logging,使用spring-starter-log4j
<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>