Spring Boot ロギング フレームワークの実践 - hansonwang99 の技術共有

この記事では主に Spring Boot ロギング フレームワークの実践について説明します。コード部分も詳しく説明されています。

---

概要

Javaアプリケーションでは、ログは通常次の5つのレベルに分けられます:

• ERRORエラーメッセージ

• WARN警告メッセージ

• INFO一般情報

• DEBUG デバッグ情報

• TRACE トレース情報

Spring Boot は内部ログ フレームワークとして Apache の Commons Logging を使用します。これは単なるログ インターフェイスであり、実際のアプリケーションでは、このインターフェイスに対応するログ実装を指定する必要があります。

SpringBt のデフォルトのロギング実装は、JDK に付属するロギング パッケージである Java Util Logging です。さらに、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 フレームワーク自体から取得されていることがわかります。それらをブロックしたい場合は、フレームワーク自身の INFO 情報が出力されないように、最初にすべてのログ レベルを ERROR に設定できます。次に、アプリケーション内の特定のパッケージを DEBUG レベルのログに設定すると、対象のパッケージ内の DEBUG 以上のレベルのログのみが表示されるようになります。

• 特定のパッケージのログ レベルを制御します

application.yml の構成を変更します

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

もちろん、ルート ログ レベルを ERROR に設定し、com.hansonwang99.controller code> package ログレベルは DEBUG に設定されます。これは、最初にすべてを禁止し、次に個別の設定メソッドを許可することを意味します<code>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"

---

コントローラーコード

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

実行結果

• 

フレームワーク自体の INFO レベルのログがすべて非表示になっており、ログが指定したパッケージをレベル別にスムーズに出力
ログをファイルに出力

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

実行結果

🎜Spring Boot Logging を使用すると、ログがファイルに出力されても、コピーがコンソールに出力されることがわかりました。org.slf4j.Logger を使用すると、この問題は解決できません🎜🎜🎜🎜🎜🎜🎜Log4J ロギング フレームワークを統合します🎜🎜 🎜🎜pom.xml に依存関係を追加します🎜🎜🎜

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";
    }
}

🎜🎜🎜次の内容を含む log4j2.xml ファイルをリソース ディレクトリに追加します: 🎜🎜🎜rrreee🎜🎜🎜他のコードは変更されません🎜 🎜🎜🎜プログラムを実行すると、コンソールにログが出力されず、hello2.log ファイルに期待どおりの内容が存在することがわかります: 🎜🎜🎜 🎜🎜🎜🎜🎜🎜🎜🎜🎜🎜🎜ログ形式は pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n" 形式で定義されたものと一致します 🎜🎜🎜Log4Jさらに練習 🎜🎜🎜🎜pom.xml 設定: 🎜🎜🎜rrreee🎜🎜🎜log4j2.xml 設定🎜 🎜🎜rrreee🎜🎜🎜コントローラーコード: 🎜🎜🎜rrreee🎜🎜🎜R結果を発表🎜🎜🎜🎜🎜🎜🎜🎜🎜 🎜🎜🎜🎜

ログファイルのサイズが 2M を超える場合、ログは複数のファイルに分割されて圧縮されて保存されます。 20～50MBに調整しました。

---

追記

著者によるその他のオリジナル記事はSFコラムをご覧ください

著者によるその他のSpringBt実践記事はこちら:

• SpringBootでのElasticSearch検索エンジンの実践

• Kotlin+SpringBootの予備探索共同プログラミング

---

関連する推奨事項:

Java プログラマーによって最もよく使用される 8 つの Java ロギング フレームワーク

以上がSpring Boot ロギング フレームワークの実践 - hansonwang99 の技術共有の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。