Javaロギング。 ハローワールド

エントリー

ロガーとは何か、なぜ必要なのかは誰にも秘密ではないと思います。 javaの存在中に、多くのロギングフレームワークが作成されました。 最も有名なものの中には：

• JUL-java.util.logging
• log4j
• JCL-ジャカルタコモンズロギング
• ログバック
• SLF4J-Java用のシンプルなロギングファサード

この記事では、上記の各フレームワークをHello Worldレベルで検証します。 基本的な機能と構成を使用する簡単な例を示します。 この記事は、ロガーを相互に比較し、それらの最良のものを特定するという目標を追求していません。著者は読者にこの機会を残しています。 記事の最後に、各フレームワークの詳細情報を入手できるソースが提供されます。 また、この記事を読む前に、Javaでのロギングシステムの開発の歴史を説明する出版物「Java Logging：A History of a Nightmare」に精通することをお勧めします。

System.err.println

ロギングの最初で最も基本的な方法は、System.err.printlnメソッドでした。 コメントは不要だと思います。以下のコードをご覧ください。

//        System.setErr(new PrintStream(new File("log.txt"))); //   System.err.println(" 1"); System.err.println(" 2"); //     try { throw new Exception("  "); } catch (Exception e) { e.printStackTrace(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Java.util.logging

このフレームワークは標準に含まれており、JDKに付属しているため、他のものをダウンロードしたり接続したりする必要はありません。 JULには、昇順で次のロギングレベルがあります：FINEST、FINER、FINE、CONFIG、INFO、WARNING、SEVERE、およびALLとOFF、すべてのレベルをそれぞれオンとオフにします。

ロガーは、java.util.logging.Loggerクラスの静的メソッドの1つを呼び出すことによって作成されます。

 Logger log = Logger.getLogger(LoggingJul.class.getName());
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ロガーメソッドは、文字列メッセージ、メッセージテンプレート、例外、ローカライズされたメッセージテキストリソース、およびJava 8以降の文字列メッセージプロバイダーを引数として使用できます。

 //   String stringMessage = ""; //     String stringMessageFormat =" {0}"; //  Throwable throwable = new Throwable(); // ResourceBundle   ResourceBundle resourceBundle = ResourceBundle.getBundle("logging.jul.bundle"); //   Supplier<String> stringMessageSupplier = ()->"";
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

メソッドの2つのグループは区別されます。その名前はログレベルに対応し、ログ、loggp、logrbメソッドはログレベルをタイプLevelのパラメーターとして使用します。 最初のグループには、文字列メッセージの受信または文字列メッセージプロバイダーの2種類のメソッドが含まれています。

 log.info(stringMessage); log.info(stringMessageSupplier);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

メソッドの2番目のグループには、次のバリエーションがあります。

 //       log.log(new LogRecord(Level.INFO, stringMessage)); log.log(Level.INFO, stringMessage); log.log(Level.INFO, stringMessageSupplier); log.log(Level.INFO, stringMessageFormat, args); log.log(Level.INFO, stringMessage, throwable ); log.log(Level.INFO, throwable, stringMessageSupplier); //      ,    log.logp(Level.INFO, "ClassName", "MethodName", stringMessage); log.logp(Level.INFO, "ClassName", "MethodName", stringMessageSupplier); log.logp(Level.INFO, "ClassName", "MethodName", stringMessageFormat, args); log.logp(Level.INFO, "ClassName", "MethodName", stringMessage, throwable); log.logp(Level.INFO, "ClassName", "MethodName", throwable, stringMessageSupplier); //      , , //   resourceBundle,   log.logrb(Level.INFO, "ClassName", "MethodName", resourceBundle, "messageId"); log.logrb(Level.INFO, "ClassName", "MethodName", resourceBundle, "messageId", throwable); //     log.throwing("ClassName","MethodName", throwable);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、フレームワークの構成を見てみましょう。 デフォルトでは、JULはコンソールにメッセージを出力しますが、プロパティファイルで設定を指定できます。 メッセージを表示する方法を設定するには、ロガーが使用するハンドラーを指定する必要があります。 次のハンドラクラスが存在します：FileHandler、ConsoleHandler、StreamHandler、SocketHandler、MemoryHandler。 JULの機能は、特定のインスタンスに対してではなく、クラス全体に対してハンドラー設定が全体として設定されることです。これにより、たとえば、異なるロガーからのメッセージを異なるファイルに出力したり、異なるフォーマットで出力したりする必要がある場合、かなりの問題が発生する可能性があります。 構成ファイルの簡単な例を考えてみましょう。

 #    handlers =java.util.logging. FileHandler .level=ALL #    java.util.logging.FileHandler.level =ALL java.util.logging.FileHandler.formatter =java.util.logging.SimpleFormatter java.util.logging.FileHandler.limit = 1000000 java.util.logging.FileHandler.pattern = log.txt #    java.util.logging.ConsoleHandler.level = ALL java.util.logging.ConsoleHandler.pattern = log.log java.util.logging.ConsoleHandler.formatter =java.util.logging.SimpleFormatter
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

JULがこの構成を適用するには、-Djava.util.logging.config.file = <path to file>パラメーターを渡すか、アプリケーションの起動時にコードを実行する必要があります。

 LogManager.getLogManager().readConfiguration(< >.class.getResourceAsStream("logging.properties"));
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Log4j

現在、このフレームワークには2番目のバージョンがありますが、残念ながら最初のバージョンとは互換性がありません。 log4jの最初のバージョンは長い間存在しており、その人気の高さから、インターネットには多くの記事がありますが、今日は2番目のバージョンを検討します。 log4j2を使用するには、 log4j-api-2.xおよびlog4j-core-2.xライブラリを接続する必要があります。 Log4jには、JULとは若干異なるロギングレベルの命名法があります。TRACE、DEBUG、INFO、WARN、ERROR、FATAL、およびALLとOFFで、それぞれすべてのレベルをオンまたはオフにします。

ロガーは、org.apache.logging.log4j.Loggerクラスの静的メソッドを呼び出すことで作成されます。

 Logger log = LogManager.getLogger(LoggingLog4j.class); //  Logger log = LogManager.getLogger(“name”);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

通常のString、Object、Throwableに加えて、ロガーはMapMessageとMarkerの2つの新しいタイプを受け入れることができます。

 //   (  msg1=" 1” msg2=" 2”) MapMessage mapMessage = new MapMessage(); mapMessage.put("msg1", " 1"); mapMessage.put("msg2", " 2"); // ,       Marker marker = MarkerManager.getMarker("fileonly"); //   String stringMessage = ""; //     String stringMessageFormat = " {},  {}"; //  Throwable throwable = new Throwable(); //  Object object = new Object();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ロガーのクラシックスタイルでは、メソッドは2つのタイプに分類されます。名前に一致するログレベルと、ログレベルをパラメーターとして使用するログメソッドです。 最初のものは：

 log.info(mapMessage); log.info(object); log.info(stringMessage); log.info(marker, mapMessage); log.info(marker, object); log.info(marker, stringMessage); log.info(object, throwable); log.info(stringMessage, throwable); log.info(stringMessageFormat, args); log.info(marker, mapMessage, throwable); log.info(marker, object, throwable); log.info(marker, stringMessageFormat, args); log.info(marker, stringMessage, throwable); log.throwing(throwable);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

log4j2のログメソッドは次のようになります。

 log.log(Level.INFO, mapMessage); log.log(Level.INFO, object); log.log(Level.INFO, stringMessage); log.log(Level.INFO, marker, mapMessage); log.log(Level.INFO, marker, object); log.log(Level.INFO, marker, stringMessage); log.log(Level.INFO, object, throwable); log.log(Level.INFO, stringMessageFormat, args); log.log(Level.INFO, stringMessage, throwable); log.log(Level.INFO, marker, mapMessage, throwable); log.log(Level.INFO, marker, object, throwable); log.log(Level.INFO, marker, stringMessageFormat, args); log.log(Level.INFO, marker, stringMessage, throwable); log.throwing(Level.INFO, throwable);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

設定を決定しないと、log4j2の起動時に、設定が設定されていないことを示す怒ったメッセージが表示され、ERROR以上のレベルでメッセージがコンソールに出力されます。 log4j2の設定は、xml、json、yamlなどのいくつかのオプションによって設定されます。 2番目のバージョン以降、プロパティファイルからの構成サポートがないことに注意してください。 構成ファイルはクラスパスによって自動的に検索され、log4j2という名前を持ち、デフォルトでパッケージ内に配置されている必要があります。

log4j2の構成は、ロガー、アペンダー、およびフィルターの説明で構成されます。 より詳細な調査については、ドキュメントを参照してください。ただし、ここではいくつかの重要な点にのみ注意します。 まず、マーカーを含むフィルター形式のさまざまな利点があります。

• バーストフィルター
• コンポジットコンポジット
• DynamicThresholdFilter
• Mapfilter
• マーカーフィルター
• 正規表現フィルター
• StructuredDataFilter
• ThreadContextMapFilter
• ThresholdFilter
• タイムフィルター

第二に、非同期アペンダーや他のアペンダーのグループをラップするアペンダーなど、幅広いアペンダークラスがあります。

• Asyncappppender
• ConsoleAppender
• Failoverapppp
• Fileappender
• Flumeappender
• JDBCAppender
• JMSAppender
• JPAAppender
• MemoryMappedFileAppender
• NoSQLAppender
• OutputStreamAppender
• RandomAccessFileAppender
• Rewriteappppender
• RollingFileAppender
• RollingRandomAccessFileAppender
• RoutingAppender
• SMTPAppender
• ソケットアペンダー
• Syslogappppender

また、log4jは同じクラスの多くの異なるアペンダー、たとえば異なるファイルに書き込む複数のファイルアペンダーを作成できることにも注意してください。

2つのロガーが宣言された構成の例を考えてみましょう（ルートおよびクラス用）。最初のロガーはlog.logファイルに書き込み、2番目のロガーはマーカーによるフィルタリングを使用してlog2.logに書き込みます。

 <?xml version="1.0" encoding="UTF-8"?> <Configuration> <!--   --> <Appenders> <!--   --> <File name="file" fileName="log.log"> <PatternLayout> <Pattern>%d %p %c{1.} [%t] %m %ex%n</Pattern> </PatternLayout> </File> <!--   --> <File name="file2" fileName="log2.log"> <!--    --> <MarkerFilter marker="fileonly" onMatch="DENY" onMismatch="ACCEPT"/> <PatternLayout> <Pattern>%d %p %c{1.} [%t] %m %ex%n</Pattern> </PatternLayout> </File> </Appenders> <!--   --> <Loggers> <!--   --> <Root level="trace"> <AppenderRef ref="file" level="DEBUG"/> </Root> <!--    --> <Logger name="logging.log4j.LoggingLog4j" level="info" additivity="false"> <AppenderRef ref="file2" level="INFO"/> </Logger> </Loggers> </Configuration>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コモンズロギング

かなり古いプロジェクト。JULとlog4jのラッパーであり、追加の機能はありません。 JCLロギングレベルはlog4jと同じであり、JULと対話する場合、次のマッピングが発生します。

 fatal = Level.SEVERE error = Level.SEVERE warn = Level.WARNING info = Level.INFO debug = Level.FINE trace = Level.FINEST
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

JCLを使用するには、 commons-logging-1.x.jarを接続します。 ファクトリメソッドを呼び出してロガーを作成します。

 Log log = LogFactory.getLog(LoggingCl.class); //  Log log = LogFactory.getLog("name");
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

JCLメソッドは非常にシンプルで、ロギングレベルの名前と一致し、オブジェクトと例外のみを受け入れ、2つのバリエーションがあります。

 Object object = ""; Throwable throwable = new Throwable(); log.info(object); log.info(object, throwable);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

JCL構成には、log4j、JUL、および独自の実装用の個別のブロックが含まれています。 構成を指定しない場合、コンソールにメッセージを表示するSimpleLogと呼ばれる独自の実装を使用します。 構成ファイルの例を考えてみましょう。

 #Log4j org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger log4j.configuration=log4j.properties #JUL org.apache.commons.logging.Log=org.apache.commons.logging.impl.Jdk14Logger handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler .level=INFO java.util.logging.FileHandler.pattern=jul.log java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter java.util.logging.FileHandler.limit=50000 java.util.logging.FileHandler.count=1 #SimpleLog org.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog org.apache.commons.logging.simplelog.defaultlog=fatal org.apache.commons.logging.simplelog.showlogname=true org.apache.commons.logging.simplelog.showShortLogname=true org.apache.commons.logging.simplelog.showdatetime=true
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次のようにJCL構成ファイルを指定できます。

 java -Djava.util.logging.config.file=/absolute/path/to/your/config/file/commons-logging.properties -jar /absolute/path/to/your/jar/file/MyClass.jar
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ログバック

このフレームワークは、後で説明するSLF4Jラッパーと組み合わせてのみ使用されます。 開始するには、 logback-core-1.x.jarとlogback-classic-1.xxjar 、およびslf4j-api-1.xxjarが必要です。

SLF4Jラッパーが提供するAPIを介してロガーと対話します。 ロギングレベルはlog4jと同じです。 この場合のロガーの作成は次のようになります。

 org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LoggingLogback.class); //  org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger("name");
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

APIを使用すると、文字列メッセージ、文字列メッセージパターン、例外を表示したり、マーカーを使用したりできます。

 //   String stringMessage = ""; //   String stringMessageFormat = " {} {}"; //  Throwable throwable = new Throwable(); //  Marker marker = MarkerFactory.getMarker("marker");
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

メソッドの名前はロギングのレベルと一致し、形式は次のとおりです。

 log.info(stringMessage); log.info(stringMessageFormat, args); log.info(stringMessage, throwable); log.info(marker, stringMessage); log.info(marker, stringMessage, throwable); log.info(marker,stringMessageFormat, args);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、ログバック機能を直接見てみましょう。 構成は、次の順序でクラスパスで検索されます。

1. logback.groovyを見つけようとしています
2. それ以外の場合、logback-test.xmlを見つけようとします
3. それ以外の場合、logback.xmlを見つけようとします
4. それ以外の場合、基本構成を使用します-コンソールにメッセージを表示します

主な構成アイテムは、ロガー、アペンダー、ライトアウト、フィルターです。

次のフィルターを使用できます。

• 通常のフィルター
• レベルフィルター
• ThresholdFilter
• EvaluatorFilter
• マッチャー
• ターボフィルター
• カウントフィルター

以下のアペンダーが利用可能です：

• OutputStreamAppender
• ConsoleAppender
• Fileappender
• RollingFileAppender
• SocketAppenderおよびSSLSocketAppender
• ServerSocketAppenderおよびSSLServerSocketAppender
• SMTPAppender
• Syslogappppender
• ふるい
• Asyncappppender

私は、logbackのレイアウトとエンコーダーがドキュメントにあることについて読むことを提案し、今度はlogback.xmlファイルの簡単な例を示します。

 <?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- --> <!--  --> <appender name="file" class="ch.qos.logback.core.FileAppender"> <file>log.log</file> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</Pattern> </layout> </appender> <!--  --> <appender name="sout" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern> </layout> </appender> <!--  --> <!--    --> <turboFilter class="ch.qos.logback.classic.turbo.MarkerFilter"> <Marker>marker</Marker> <OnMatch>DENY</OnMatch> </turboFilter> <!--  --> <!--   --> <root level="info"> <appender-ref ref="file" /> </root> <!--    --> <logger name="logging.logback.LoggingLogback" level="info" > <appender-ref ref="sout" /> </logger> </configuration>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

SLF4J

前述のように、SLF4Jは、JUL、log4j、JCL、およびそのインターフェースを実装するロガーと同様に、ログバックのラッパーです。 SLF4Jを使用するには、slf4j-api-1.xxjarライブラリと、ロガーの1つまたはスタブの実装が必要です。 原則として、すべてのロガー（logbackを除く）の実装はSLF4Jで提供され、slf4j-jcl-1.x.jar、slf4j-log4j12-1.x.jar、slf4j-nop-1.x.jarなどに類似した名前を持っています。 n。 ロガーの実装（またはnopスタブ）がクラスパスに見つからない場合、SLF4Jは怒って呪いをかけ、動作を拒否します。 クラスパスに設定された実装に応じて、構成がそれに応じて検索されます。

前の段落でSLF4J APIについて説明しましたので、別のラッパーオプションを見てみましょう。 理想的な世界では、ラッパーインターフェイスを介してメッセージを出力する必要がありますが、その後はすべて問題ありませんが、実際の残酷な世界では、他のロガーを使用し、SLF4Jを知らないサードパーティのライブラリまたはコードとやり取りする必要があることを示唆しています。 各ロガーに適応するのではなく、SLF4Jインターフェースの1つの実装を通じてすべてのメッセージを許可するために、ブリッジングを使用できます。 ラッパーサプライには、jcl-over-slf4j.jar、log4j-over-slf4j.jar、およびjul-to-slf4j.jarライブラリが含まれています。これらのライブラリは、対応するロガーの動作をオーバーライドし、メッセージをラッパーにリダイレクトします。

上記の内容を明確にするため、例を考えてみましょう。 次のロガーがあるとします。

 java.util.logging.Logger julLog = java.util.logging.Logger.getLogger("julLog"); java.util.logging.Logger log4jLog = java.util.logging.Logger.getLogger("log4jLog"); org.slf4j.Logger slf4jLog = org.slf4j.LoggerFactory.getLogger(LoggingSlf4j.class); julLog.info("  jul"); log4jLog.info("  log4j"); slf4jLog.info("  slf4j");
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

JULからのメッセージを1つのファイルに、log4jから別のファイルに、slf4jからコンソールに書き込むようにします。 ラッパーの実装として、logbackを使用します。この不名誉の構成は次のようになります。

 <?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- --> <!--   JUL --> <appender name="jul" class="ch.qos.logback.core.FileAppender"> <file>log_jul.log</file> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</Pattern> </layout> </appender> <!--   log4j --> <appender name="log4j" class="ch.qos.logback.core.FileAppender"> <file>log_log4j.log</file> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</Pattern> </layout> </appender> <!--  --> <appender name="sout" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.classic.PatternLayout"> <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern> </layout> </appender> <!--  --> <!--   --> <root level="info" > <appender-ref ref="sout" /> </root> <!--   jul --> <logger name="julLog" additivity="false" > <level value="trace" /> <appender-ref ref="jul" /> </logger> <!--   log4j --> <logger name="log4jLog" additivity="false" > <level value="trace" /> <appender-ref ref="log4j" /> </logger> </configuration>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ブリッジが機能するには、次のコードを実行する必要があります。

 SLF4JBridgeHandler.removeHandlersForRootLogger(); SLF4JBridgeHandler.install();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

もっと知りたい

• JUL- Java Logging：LoggerおよびJava Logging：Configurationをお読みください
• Log4j2- Log4j 2へようこそ
• JCL- Commons Loggingの使用方法を読む
• Logback- read logbackマニュアル
• SLF4J- SLF4JのドキュメントとレガシーAPIのブリッジを読む

おわりに

結論として、ロギングフレームワークの最終的な選択は常にあなた次第ですが、賢明にこれにアプローチする必要があることを伝えたいと思います。 選択は、高性能、便利なAPI、ログに記録されたデータを保存するために必要な方法の可用性、およびプロジェクトの詳細など、多くの基準の満足度に基づいている必要があります。たとえば、製品が他のプロジェクトで使用される場合、ユーザーが使用するロガーを決定するべきではありません。この代わりに、ラッパーを優先します。