SpringBoot学习第三天----日志管理（logback,log4j,log4j2)

最新推荐文章于 2024-10-04 18:41:44 发布

JAVA-新的开始

最新推荐文章于 2024-10-04 18:41:44 发布

阅读量982

点赞数

分类专栏： JAVA SpringBoot 文章标签： SpringBoot 日志

本文链接：https://blog.csdn.net/tianlong1569/article/details/82998371

版权

JAVA 同时被 2 个专栏收录

103 篇文章 3 订阅

订阅专栏

SpringBoot

25 篇文章 1 订阅

订阅专栏

目前学用的日志管理工具有三种，分别是Logback，Log4j，Log4j2。

下面我们一个一个的学习这种种不同的日志是如何实现同SpringBoot集成到一起的。

SpringBoot集成Logback日志工具

在第一天学习SpringBoot系统搭建的时候我们在pom文件中依赖了spring-boot-starter-web包。如下面代码所示：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>

而spring-boot-starter-web包中依赖spring-boot-starter，spring-boot-starter包中依赖了spring-boot-starter-logging。依赖结构如下图所示：

而spring-boot-starter-logging包中默认采用了logback进行日志处理。因此当我们在SpringBoot中进行logback日志记录时，是不需要另外引入包的。只需要在src/main/resources目录下面建立一个logback日志输出的配置文件即可。

我这里建立的配置文件名的logback.xml。代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>    
    <!-- appender是configuration的子节点，是负责写日志的组件。 -->
    <!-- ConsoleAppender：把日志输出到控制台 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">    
        <encoder>
        <!-- %d日期及时间,%t线程名,%p日志输出级别，%c类的全名,%file 类名，%line行号，%m输出的信息，%n换行-->
            <pattern>%d[  %t]---[%p]---%c:%file:%line- %m%n</pattern>  
            <!-- 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 -->
            <charset>UTF-8</charset>   
        </encoder>    
    </appender>    
    <!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <!-- 以下的大概意思是：1.先按日期存日志，日期变了，将前一天的日志文件名重命名为XXX%日期%索引，新的日志仍然是log.log -->
    <!--             2.如果日期没有发生变化，但是当前日志的文件大小超过1MB时，对当前日志进行分割 重命名-->
    <appender name="filelog" class="ch.qos.logback.core.rolling.RollingFileAppender">    
        <File>log/log.log</File>    
        <!-- rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。 -->
        <!-- TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">    
            <!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
            <!-- 文件名：log/log.2017-12-05.0.log  %i索引【从数字0开始递增】-->
            <fileNamePattern>log/log.%d.%i.log</fileNamePattern> 
            <!-- 每产生一个日志文件，该日志文件的保存期限为7天 --> 
            <maxHistory>7</maxHistory>   
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">    
                <!-- maxFileSize:这是活动文件的大小，不设置值时默认值是10MB-->  
                <maxFileSize>1MB</maxFileSize>    
            </timeBasedFileNamingAndTriggeringPolicy>    
        </rollingPolicy>    
        <encoder>    
            <!-- pattern节点，用来设置日志的输入格式 -->
           <pattern>%d[  %t]---[%p]---%c:%file:%line- %m%n</pattern>   
            <!-- 记录日志的编码:此处设置字符集 - -->
            <charset>UTF-8</charset>
        </encoder>    
    </appender>    
    <!-- 默认输出级别为info,通过控制台输出 -->
    <root level="info">    
        <appender-ref ref="STDOUT" />    
    </root>    
    <!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
    <!-- com为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
    <!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
<!--     <logger name="com" level="DEBUG">    
        <appender-ref ref="filelog" />    
    </logger> -->    
</configuration>

关于logback日志输出文件的相关配置参数说明，大概可以查相关的文档，我这里的配置文件就是从别处复制了一份。

日志文件创建好后，就需要将文件进行引入。在application.yml文件中有一个logging.config的配置，这个配置后面只能跟xml文件。因此我们的配置文件必须是xml格式。配置信息如下：


logging:
  config: classpath:logback.xml

到这里logback日志即配置完成。

如果我们要配置mybatis的语句输出，可以在application.yml文件中加入如下配置。前面的com.qlys.dao为数据库操作的包名。下面包括两个包，一个是mapper文件的包，一个是接口类的包。

logging:
  level: 
    com.qlys.dao: debug

SpringBoot集成log4j2

前面已经讲过SpringBoot中集成了logback，因此在加入其他的日志框架前需要将logback的日志给排除，如果不排除不包，配置将不生效。因此需要修改pom文件，将spring-boot-starter-web的引入修改如下：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>

下一步在pom文件中加入对log4j2的依赖。代码如下：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

下一步增加log4j2的配置文件，前面已经讲过，在application.yml文件中logging.config的配置必须是xml文件，因此我们的log4j2的配置文件也是xml文件。定义文件名为log4j2-spring.xml,代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--设置log4j2的自身log级别为warn-->
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，
    当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="warn" monitorInterval="30">
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
        </File>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，
        则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/hpaasvc/info.log"
                     filePattern="${sys:user.home}/logs/hpaasvc/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
 
        <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/hpaasvc/warn.log"
                     filePattern="${sys:user.home}/logs/hpaasvc/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
 
        <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/hpaasvc/error.log"
                     filePattern="${sys:user.home}/logs/hpaasvc/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="ERROR"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
 
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <logger name="com" level="DEBUG"/>
        <root level="error">
            <appender-ref ref="Console"/>
<!--             <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/> -->
        </root>
    </loggers>
 
</configuration>

最后修改application.yml文件，将logging.config配置修改如下：

logging:
  config: classpath:log4j2-spring.xml

到这里log4j2的配置完成

最后我们学习一下SpringBoot集成Log4j

SpringBoot集成log4j和集成Log4j2差不多，都是需要先将spring-boot-starter-logging包给排除。如果不排除此包，配置将不生效。同上面一样，pom文件修改如下：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>

下一步在pom文件中增加log4j的依赖包，如下面代码：

<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-log4j12</artifactId>
</dependency>

然后在src/main/resources文件中加入log4j.properties配置文件。文件名必须为“log4j.properties”。并在文件中加入log4j日志输出的配置信息；如：

log4j.rootLogger=info,stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender   
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout   
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH\:mm\:ss} %-5p [%F\]%L---%m%n

最后将application.yml中的logging.config的信息删除即可。因为，loggin.config必须采用xml进行配置。因此log4j是采用properties文件进行配置的，因此我们需要将以前配置的这个属性删除即可。