前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >SpringBoot 日志

SpringBoot 日志

作者头像
jwangkun
发布2021-12-23 17:11:21
2320
发布2021-12-23 17:11:21
举报
文章被收录于专栏:John Wong's BlogJohn Wong's Blog

日志框架

市面上的日志框架: JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j ...

日志门面

日志实现

JUL(Jakarta Commons Logging) SLF4j(Simple Logging Facade for Java) jboss-logging

Log4j JUL(java.util.logging) Log4j2 Logback

划线的是我们开发中不常用的,所以我们首选的日志框架是SLF4j,log4j性能问题,所以其作者开发了新的 logback;log4j2是apache开的的日志框架,性能很好,但是现在市面上用它的还比较少,我们若使用可能会出现兼容问题,所以我们开发中一般的选择是:

日志门面:SLF4j

日志实现:logback

SpringBoot:底层是Spring框架,Spring框架默认是用JCL;SpringBoot对其进行了包装,Srping

Boot选用 SLF4j和logback。

SLF4j

1、如何在系统中使用SLF4j

以后我们开发的时候,日志记录方法的调用,不应该直接掉用日志的实现类,而是调用日志抽象层里的方法。首先要给系统导入slf4j的jar 和 logback的实现jar

代码语言:javascript
复制
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");
	}
}

2、日志框架适配SLF4j的图解

每个日志的实现框架都有自己的配置文件,使用slf4j以后,配置文件还是用日志实现框架自己本身的配置文件

3、统一日志框架

1.问题

实际开发中项目可能是整合了很多框架例如 Spring(commons-logging)、Hibernate(jboss-logging)等等

我们怎么统一使用slf4j进行输出 ?

2.统一日志框架图解

让系统中所有的日志都统一到slf4j:

1、将系统中的其他日志框架先排除出去

2、用中间包来替换原有的日志框架

3、我们导入slf4j其他的实现

4、SpringBoot日志关系

1.pom.xml
代码语言:javascript
复制
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-core</artifactId>
	<exclusions>
		<exclusion>
			<groupId>commons-logging</groupId>
			<artifactId>commons-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>
2.底层依赖关系图
3.总结
  • SpringBoot底层也是使用slf4j+logback的方式进行日志记录
  • SpringBoot把其他的日志替换成了slf4j

日志的使用

1、默认配置

SpringBoot默认帮我配置好了日志.

代码语言:javascript
复制
package com.gf;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootLoggingApplicationTests {

	//日志记录器
	Logger logger = LoggerFactory.getLogger( this.getClass() );

	@Test
	public void contextLoads() {

		//日志级别(由高到底):trace < debug < info < warn < error
		//可以调整输出的日志级别,日志只会在这个级别以后的高级别生效
		logger.trace( "这是trace日志..." );
		logger.warn( "这是warn日志..." );
		logger.debug( "这是error日志..." );
		//SpringBoot默认给我们使用的是info级别,没有指定级别就使用SpringBoot默认的规定
		logger.info( "这是error日志..." );
		logger.warn( "这是error日志..." );
		logger.error( "这是error日志..." );

	}

}
日志输出格式: 
	%d表示日期时间,
	%thread表示线程名,
	%‐5level:级别从左显示5个字符宽度
	%logger{50} 表示logger名字最长50个字符,否则按照句点分割。 %msg:日志消息,
	%n是换行符
	‐‐>
	%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n

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

代码语言:javascript
复制
logging.level.com.gf=trace

#logging.path 和 logging.path 是冲突设置 ,两者都设置时只有 logging.path 起作用
#指定文件名,就在项目下生产springboot.log日志
#logging.file=springboot.log

# 在当前磁盘路径下创建spring文件夹和里面的log文件夹;使用spring.log 作为默认文件
logging.path=/Users/huanchu/Documents/spring/log

# 指定控制台输出的日志格式
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

3、logback.xml指定配置

代码语言:javascript
复制
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="true" scanPeriod="10 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="springboot-logging"></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.gf" 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> 

配置文件命名为logback.xml时,直接被日志框架识别。如果我们把文件名更改成logback-spring.xml,这样就不会被日志框架直接识别,这样配置文件就由SpringBoot加载,就可以使用SpringBoot的一些高级功能:

代码语言:javascript
复制
<!-- 可以指定某段配置只在某个环境下生效 -->
<springProfile name="staging">
<!-- configuration to be enabled when the "staging" profile is active --> 
</springProfile>

例如:

代码语言:javascript
复制
<!-- 设置不同环境下日志的打印格式 -->
<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="test">
   		<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ===== [%thread] ===== %-5level %logger{50} - %msg%n</pattern>
    </springProfile>
    <springProfile name="test">
    	<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
	</springProfile>
</layout>

下一篇: SpringBoot Profile多环境配置→

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2020-11-09,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 日志框架
  • SLF4j
    • 1、如何在系统中使用SLF4j
      • 2、日志框架适配SLF4j的图解
        • 3、统一日志框架
          • 1.问题
          • 2.统一日志框架图解
        • 4、SpringBoot日志关系
          • 1.pom.xml
          • 2.底层依赖关系图
          • 3.总结
      • 日志的使用
        • 1、默认配置
          • 2、修改SpringBoot日志的默认配置
            • 3、logback.xml指定配置
            相关产品与服务
            日志服务
            日志服务(Cloud Log Service,CLS)是腾讯云提供的一站式日志服务平台,提供了从日志采集、日志存储到日志检索,图表分析、监控告警、日志投递等多项服务,协助用户通过日志来解决业务运维、服务监控、日志审计等场景问题。
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档