spring boot 2-日志

Posted 2021-08-16 之墨_

spring boot 2-日志

• 一、日志框架的选择
• • 1.供选择的部分框架
• 二、SLF4J使用
• • 1.如何在系统中使用SLF4J
  • 2.调用代码示例：
  • 3.图示：
  • 4.如何统一日志记录
• 三、SpringBoot日志关系
• • 1.父类
  • 2.底层实现
  • 3.底层依赖关系
  • 4.小结
  • 5.引入其他框架
  • 6.只需排除现在框架依赖的日志框架
• 四、日志使用
• • 1.SpringBoot默认日志配置
  • 2.SpringBoot修改日志的默认配置
  • 3.日志输出格式：
  • 4.logback-spring.xml示例:
• 五、切换日志框架
• • 1.参照slf4j的日志适配图，进行相关的切换；

一、日志框架的选择

1.供选择的部分框架

JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

日志门面 （日志的抽象层）	日志实现
SLF4j（Simple Logging Facade for Java）	Log4j2 Logback

• SpringBoot：底层是Spring框架；
• Spring框架默认是用JCL（Jakarta Commons Logging））；
• SpringBoot选用 SLF4j和logback；

二、SLF4J使用

1.如何在系统中使用SLF4J

官方文档

日志记录方法的调用，不直接调用日志的实现类，而是调用日志抽象层里面的方法；

2.调用代码示例：

给系统里面导入slf4j的jar和 logback的实现jar

调用抽象层org.slf4j的LoggerFactory：

logger - 记录器
传一个HelloWorld.class类别
获取记录器Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info记录信息_{可打印在控制台，也可输入到文件}

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.图示：

实现层

适配层

4.如何统一日志记录

每一个日志的实现框架都有自己的配置文件。使用SLF4J，配置文件还是做成日志实现框架自己本身的配置文件；

1. 将系统中其他日志框架先排除出去；
2. 用中间包来替换原有的日志框架；
3. 我们导入SLF4J其他的实现

三、SpringBoot日志关系

1.父类

_官方文档

2.底层实现

spring boot底层使用spring-boot-starter-logging做日志功能

3.底层依赖关系

4.小结

1. SpringBoot底层也是使用SLF4J+logback的方式进行日志记录
2. SpringBoot也把其他的日志都替换成了SLF4J；
3. 运用中间替换包

_{例（替换包）：}

@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();

_{中间转换包:}

5.引入其他框架

如果要引入其他框架，一定要把这个框架的默认日志依赖移除掉，Spring框架用的是commons-logging；

我在我的spring-boot-starter-2.5.2.pom中没有找到

<exclusions>
	<exclusion>
		<groupId>commons‐logging</groupId>
		<artifactId>commons‐logging</artifactId>
	</exclusion>
</exclusions>

但是视频中的spring-boot-starter-1.5.10.RELEASE.pom中有_{（可能更新后没了？）}

6.只需排除现在框架依赖的日志框架

SpringBoot能自动适配所有的日志，而且底层使用SLF4J+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

四、日志使用

1.SpringBoot默认日志配置

_{SpringBoot帮我们配置好了日志}

• SpringBoot默认给我们使用的是info级别的
• 没有指定级别的就用SpringBoot默认规定的级别:root级别
  

2.SpringBoot修改日志的默认配置

在配置文件application.properties中修改日志配置

3.日志输出格式：

• %d：表示日期时间，
• %thread:表示线程名，
• %‐5level：级别从左显示5个字符宽度
• %logger{50} :表示logger名字最长50个字符，否则按照句点分割。
• %msg：日志消息，
• %n:是换行符

_{‐‐>例子：}

%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n

logging.file	logging.path	Example	Description
none	none		只在控制台输出
指定文件名	none	my.log	输出日志到my.log文件
none	指定目录	/var/log	输出到指定目录的 spring.log 文件

4.自定义日志配置

Logging System	Customization
Logback	logback-spring.xml , logback-spring.groovy , logback.xml / logback.groovy
Log4j2	log4j2-spring.xml / log4j2.xml
JDK (Java Util
Logging)	logging.properties

logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

<springProfile name="staging">
<!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
可以指定某段配置只在某个环境下生效
</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="!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 的行为，涉及文件移动和重命名
        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> 

五、切换日志框架

1.参照slf4j的日志适配图，进行相关的切换；

<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>