前言

日志系统作为一个应用系统的重要部分之一，它能够有助于我们在系统在线上环境中如果有问题，及时发现问题，并且定位问题，从而解决问题，保证服务的高可用，减少生产事故的发生。所以日志的重要性，不言而喻。

Java开发使用的日志框架有很多，常用的比如有JUL（java.util.logging）、log4j、logback、JCL(Jakarta commons-logging)等等。SpringBoot 提供了一套日志系统，SpringBoot 默认选择的是 SLF4J + Logback 的组合，如果不需要更改为其他日志系统（如 Log4j2 等），则无需多余的配置，LogBack 默认会将日志打印到控制台上。由于新建的 Spring Boot 项目一般都会引用 spring-boot-starter 或者 spring-boot-starter-web，而这两个起步依赖中都已经包含了对于 spring-boot-starter-logging 的依赖，所以，我们无需额外添加依赖。

接下来，本文主要总结一下项目中目前使用的SpringBoot集成slf4j日志配置。

什么是slf4j

slf4j、正式名はSimple Logging Facade for Java**** で、単純なファサードログです。これは、すべてのログフレームワーク向けに策定された仕様、標準、インターフェイスであり、フレームワークの特定の実装ではなく、さまざまなログシステムにのみサービスを提供します。

slf4j はログを記録するための統一インターフェイスを提供し、さまざまなログシステムの特定の実装を抽象化します。提供された方法に従って記録する限り、最終的なログ形式、記録レベル、出力方法などは特定のログシステムにバインドされ、満たす。プロジェクトでログを記録するために slf4j が使用され、log4j がバインドされている場合 (対応する jar パッケージの依存関係が pom で構成されています。jar パッケージ log4j を logback に置き換えるだけで、ログファイルのコードを変更する必要はまったくありません) 。

前述したように、SpringBoot はデフォルトで SLF4J + Logback の組み合わせを選択しますが、他のログシステムに変更する必要がない場合は、冗長構成なしで使用できます。まず、最も単純な使用法を見てみましょう。次のように、スタートアップクラスに Logger ロギングを導入し、出力されるログ結果を確認します。

public class SpringbootdemoApplication {
    private static final Logger logger = LoggerFactory.getLogger(SpringbootdemoApplication.class);
    public static void main(String[] args) {
        logger.info("===============项目启动了===============");
        SpringApplication.run(SpringbootdemoApplication.class, args);
        logger.info("===============启动成功了===============");
    }
}
复制代码

プロジェクトが正常に開始されると、コンソールのログ情報は次のようになります。

ここでのメインメソッドは LoggerFactory の getLogger(xxxxxxx.class) です。このメソッドは、現在のクラスを入力パラメータとして渡し、出力ログには対応する xxx クラス名が表示されます。このようなステートメントの利点は、ログを見つけるのに便利であり、クラス情報を正確に記述することで、効率的にログを迅速に見つけることができることです。

SpringBoot は slf4j を提供しますが、それをより効果的に使用するには、プロジェクトの実際のニーズに応じてロギングを構成する必要があります。

slf4jを使用します

springboot はデフォルトで slf4j を統合するため、通常、新しい Spring Boot プロジェクトでは spring-boot-starter または spring-boot-starter-web が参照され、これら 2 つの開始依存関係にはすでに spring-boot-starter-logging 依存関係が含まれているため、必要はありませんpom ファイルに追加の依存関係をインポートします。sl4j 関連の依存関係を再度インポートすると、同じ依存関係の複数のエラーが表示される場合があります。

次に、application.yml 設定ファイル内の関連する設定を確認してください。ログをカスタマイズするには、設定ファイルで設定できます。

たとえば、ここでの構成の一部は次のとおりです。

logging:
#logging.config是用来指定项目启动的时候，读取哪个配置文件，这里指定的是日志配置文件，即子module项目根路径下的 logback.xml文件，该文件是日志的主要配置信息。
  config: /workspace/java/SpringBootWorkSpace/src/main/resources/locbak.xml
 # level用来配置指定包的路径下应用程序的日志记录，及其日志级别。
  level:
    root: info
    com.springboot.springbootdemo.controller: trace
    com.springboot.springbootdemo.service: debug
    com.springboot.springbootdemo.dao: debug
复制代码

logging.level は、特定のパッケージのアプリケーションログの出力レベルを指定するために使用されます。トレースは、com.springboot.springbootdemo.controller パッケージの下のすべてのログ出力レベルがトレースになることを意味し、データベースを操作する SQL を出力します。問題の特定を容易にするために、開発中にトレースするように設定します。運用環境では、これを設定します。ログレベルからエラーレベルまでは問題ありません。

一般的に使用される 5 つのログレベルは、重大度に応じて低位から高位まで、debug (デバッグ) < info (メッセージ) < warn (警告) < error (エラー) < 致命的 (重大なエラー) です。通常は、実際に必要な粒度の大きさに応じていくつか選択でき、debug、info、warn、error の 4 レベルがよく使われます。

実際の開発では、システム稼働後にカスタマイズされた要件に応じて必要な指定されたログ情報が出力されるように、ログの設定ファイルの内容を策定する必要があります。リソースフォルダーの下に locbak.xml 構成ファイルを追加し、上記のように application.yml 構成ファイルに構成パス (絶対パスである必要があります) を設定できます。logback.xml 構成ファイルの詳細は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="/SpringBootWorkSpace/SpringBootWorkSpace/logs"/>    <!-- 定义日志格式  -->
    <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] [%-30.30logger{30}] %msg%n"/>
    <!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/SpringBootWorkSpace-Slf4j_%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 日志输出级别 -->
    <logger name="org.springframework" level="INFO"/>
    <logger name="root" level="INFO"/>
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>
复制代码

logback.xml では、ログの出力形式、パス、コンソール出力形式、ファイルサイズ、保存時間などを定義できます。実際、これらのファイルは次のように application.yml 構成ファイルでも構成できます。

logging:
# 日志文件最大的大小
  file:
    max-size: 10MB
   # 日志文件保留天数
    max-history: 7
复制代码

上記の構成が完了すると、スタートアッププロジェクトは、次のように、logback.xml 構成ファイルで構成されたログストレージパスの下の構成に従って、対応するログファイルを生成します。

画像.png

要約する

ログシステムの強力な機能は、日々の開発やシステムメンテナンスのトラブルシューティングや問題解決に役立つツールであるため、実際のプロジェクトに応じて合理的なログシステムを構成することで、プロジェクトシステムの開発とメンテナンスをより効果的に行うことができます。

質問や間違いがある場合は、一緒にコミュニケーション、ディスカッション、学習することを歓迎します。

このプロジェクトのソースコードは次の場所にあります。

github.com/JiangXia-10…

ダウンロードへようこそ、スター!

SpringBoot集成slf4j日志系统

前言

什么是slf4j

slf4jを使用します

要約する

おすすめ