浅谈Spring Boot日志框架实践

 更新时间:2018年03月29日 10:40:16   作者:hansonwang  
这篇文章主要介绍了浅谈Spring Boot日志框架实践,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
(福利推荐:【腾讯云】服务器最新限时优惠活动,云服务器1核2G仅99元/年、2核4G仅768元/3年,立即抢购>>>:9i0i.cn/qcloud

(福利推荐:你还在原价购买阿里云服务器?现在阿里云0.8折限时抢购活动来啦!4核8G企业云服务器仅2998元/3年,立即抢购>>>:9i0i.cn/aliyun

Java应用中,日志一般分为以下5个级别:

  1. ERROR 错误信息
  2. WARN 警告信息
  3. INFO 一般信息
  4. DEBUG 调试信息
  5. TRACE 跟踪信息

Spring Boot使用Apache的Commons Logging作为内部的日志框架,其仅仅是一个日志接口,在实际应用中需要为该接口来指定相应的日志实现。

SpringBt默认的日志实现是Java Util Logging,是JDK自带的日志包,此外SpringBt当然也支持Log4J、Logback这类很流行的日志实现。

统一将上面这些 日志实现 统称为 日志框架

下面我们来实践一下!

使用Spring Boot Logging插件

首先application.properties文件中加配置:

logging.level.root=INFO

控制器部分代码如下:

package com.hansonwang99.controller;

import com.hansonwang99.K8sresctrlApplication;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
 private static Logger logger = LoggerFactory.getLogger(K8sresctrlApplication.class);
 @GetMapping("/hello")
 public String hello() {
  logger.info("test logging...");
  return "hello";
 }
}

运行结果

由于将日志等级设置为INFO,因此包含INFO及以上级别的日志信息都会打印出来

这里可以看出,很多大部分的INFO日志均来自于SpringBt框架本身,如果我们想屏蔽它们,可以将日志级别统一先全部设置为ERROR,这样框架自身的INFO信息不会被打印。然后再将应用中特定的包设置为DEBUG级别的日志,这样就可以只看到所关心的包中的DEBUG及以上级别的日志了。

控制特定包的日志级别

application.yml中改配置

logging:
 level:
 root: error
 com.hansonwang99.controller: debug

很明显,将root日志级别设置为ERROR,然后再将 com.hansonwang99.controller 包的日志级别设为DEBUG,此即:即先禁止所有再允许个别的 设置方法

控制器代码

package com.hansonwang99.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
 private Logger logger = LoggerFactory.getLogger(this.getClass());
 @GetMapping("/hello")
 public String hello() {
  logger.info("test logging...");
  return "hello";
 }
}

运行结果

可见框架自身的INFO级别日志全部藏匿,而指定包中的日志按级别顺利地打印出来

将日志输出到某个文件中

logging:
 level:
 root: error
 com.hansonwang99.controller: debug
 file: ${user.home}/logs/hello.log

运行结果

使用Spring Boot Logging,我们发现虽然日志已输出到文件中,但控制台中依然会打印一份,发现用 org.slf4j.Logger 是无法解决这个问题的

 

集成Log4J日志框架

pom.xml中添加依赖

<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>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-log4j2</artifactId>
		</dependency>

在resources目录下添加 log4j2.xml 文件,内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

 <appenders>
  <File name="file" fileName="${sys:user.home}/logs/hello2.log">
   <PatternLayout pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"/>
  </File>
 </appenders>

 <loggers>

  <root level="ERROR">
   <appender-ref ref="file"/>
  </root>
  <logger name="com.hansonwang99.controller" level="DEBUG" />
 </loggers>

</configuration>

其他代码都保持不变

运行程序发现控制台没有日志输出,而hello2.log文件中有内容,这符合我们的预期:

而且日志格式和 pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n" 格式中定义的相匹配

Log4J更进一步实践

pom.xml配置:

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

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

log4j2.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="warn">
 <properties>

  <Property name="app_name">springboot-web</Property>
  <Property name="log_path">logs/${app_name}</Property>

 </properties>
 <appenders>
  <console name="Console" target="SYSTEM_OUT">
   <PatternLayout pattern="[%d][%t][%p][%l] %m%n" />
  </console>

  <RollingFile name="RollingFileInfo" fileName="${log_path}/info.log"
      filePattern="${log_path}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz">
   <Filters>
    <ThresholdFilter level="INFO" />
    <ThresholdFilter level="WARN" onMatch="DENY"
         onMismatch="NEUTRAL" />
   </Filters>
   <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" />
   <Policies>
    <!-- 归档每天的文件 -->
    <TimeBasedTriggeringPolicy interval="1" modulate="true" />
    <!-- 限制单个文件大小 -->
    <SizeBasedTriggeringPolicy size="2 MB" />
   </Policies>
   <!-- 限制每天文件个数 -->
   <DefaultRolloverStrategy compressionLevel="0" max="10"/>
  </RollingFile>

  <RollingFile name="RollingFileWarn" fileName="${log_path}/warn.log"
      filePattern="${log_path}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz">
   <Filters>
    <ThresholdFilter level="WARN" />
    <ThresholdFilter level="ERROR" onMatch="DENY"
         onMismatch="NEUTRAL" />
   </Filters>
   <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" />
   <Policies>
    <!-- 归档每天的文件 -->
    <TimeBasedTriggeringPolicy interval="1" modulate="true" />
    <!-- 限制单个文件大小 -->
    <SizeBasedTriggeringPolicy size="2 MB" />
   </Policies>
   <!-- 限制每天文件个数 -->
   <DefaultRolloverStrategy compressionLevel="0" max="10"/>
  </RollingFile>

  <RollingFile name="RollingFileError" fileName="${log_path}/error.log"
      filePattern="${log_path}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
   <ThresholdFilter level="ERROR" />
   <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" />
   <Policies>
    <!-- 归档每天的文件 -->
    <TimeBasedTriggeringPolicy interval="1" modulate="true" />
    <!-- 限制单个文件大小 -->
    <SizeBasedTriggeringPolicy size="2 MB" />
   </Policies>
   <!-- 限制每天文件个数 -->
   <DefaultRolloverStrategy compressionLevel="0" max="10"/>
  </RollingFile>

 </appenders>

 <loggers>


  <root level="info">
   <appender-ref ref="Console" />
   <appender-ref ref="RollingFileInfo" />
   <appender-ref ref="RollingFileWarn" />
   <appender-ref ref="RollingFileError" />
  </root>

 </loggers>

</configuration>

控制器代码:

package com.hansonwang99.controller;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
 private final Logger logger = LogManager.getLogger(this.getClass());
 @GetMapping("/hello")
 public String hello() {
  for(int i=0;i<10_0000;i++){
   logger.info("info execute index method");
   logger.warn("warn execute index method");
   logger.error("error execute index method");
  }
  return "My First SpringBoot Application";
 }
}

运行结果

日志会根据不同的级别存储在不同的文件,当日志文件大小超过2M以后会分多个文件压缩存储,生产环境的日志文件大小建议调整为20-50MB。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。

相关文章

  • SpringBoot中项目如何读取外置logback配置文件

    SpringBoot中项目如何读取外置logback配置文件

    这篇文章主要介绍了SpringBoot中项目如何读取外置logback配置文件问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • Kafka 网络中断和网络分区4种场景分析

    Kafka 网络中断和网络分区4种场景分析

    这篇文章主要介绍了Kafka 网络中断和网络分区4种场景分析
    2007-02-02
  • Java?RabbitMQ的持久化和发布确认详解

    Java?RabbitMQ的持久化和发布确认详解

    这篇文章主要为大家详细介绍了RabbitMQ的持久化和发布确认,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • SpringBoot 枚举类型的自动转换的实现

    SpringBoot 枚举类型的自动转换的实现

    一般我们在数据库都会定义数值型的枚举常量,不管是序列化还是反序列化都是需要我们手动去转换成枚举类型的,本文主要介绍了Spring Boot 枚举类型的自动转换,感兴趣的可以了解一下
    2022-03-03
  • Java并发教程之Callable和Future接口详解

    Java并发教程之Callable和Future接口详解

    Java从发布的第一个版本开始就可以很方便地编写多线程的应用程序,并在设计中引入异步处理,这篇文章主要给大家介绍了关于Java并发教程之Callable和Future接口的相关资料,需要的朋友可以参考下
    2021-07-07
  • Java的ConcurrentHashMap原理深入分析

    Java的ConcurrentHashMap原理深入分析

    这篇文章主要介绍了Java的ConcurrentHashMap原理深入分析,集合是编程中最常用的数据结构,而谈到并发,几乎总是离不开集合这类高级数据结构的支持,需要的朋友可以参考下
    2023-07-07
  • Java工具类实现高效编写报表

    Java工具类实现高效编写报表

    对于报表数据大部分情况下使用写sql的方式为大屏/报表提供数据来源,但是对于某些复杂情况下仅仅使用sql无法实现,这篇文章主要介绍了Java工具类实现高效编写报表
    2022-11-11
  • 全面了解JAVA_BaseDAO数据处理类

    全面了解JAVA_BaseDAO数据处理类

    下面小编就为大家带来一篇全面了解JAVA_BaseDAO数据处理类。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-07-07
  • Java基础之让你彻底搞懂代理模式

    Java基础之让你彻底搞懂代理模式

    这篇文章主要介绍了Java基础之让你彻底搞懂代理模式,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • 解决Javaweb 提交表单到servlet时出现空白页面,但网站不报错问题

    解决Javaweb 提交表单到servlet时出现空白页面,但网站不报错问题

    这篇文章主要介绍了解决Javaweb 提交表单到servlet时出现空白页面,但网站不报错的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08

最新评论

?


http://www.vxiaotou.com