JavaのLoggerを使ってログファイルを出力する方法を現役エンジニアが解説【初心者向け】

初心者向けにJavaのLoggerを使ってログファイルを出力する方法について解説しています。ログファイルの役割とログレベルの基本、Loggerクラスを使った実際のファイル出力の手順について見ていきましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

JavaのLoggerを使ってログファイルを出力する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

そもそもJavaについてよく分からないという方は、Javaとは何なのか解説した記事を読むとさらに理解が深まるでしょう。

 

なお本記事は、TechAcademyのオンラインブートキャンプJava講座の内容をもとに作成しています。

 

田島悠介

今回は、Javaに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Loggerを使ってログファイルを出力する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

ログファイルとは

「ログファイル」とは、PC上の記録(ログ)に対して、ログを保存するために生成されるファイルです。

「ログ」というのは、いつ、何が起こったか、PCに関する記録です。

 

[PR] Javaプログラミングで挫折しない学習方法を動画で公開中

ログファイルの目的

ログファイルが作成される目的としては、なにかエラーが起こったときなどにログファイルを見ることで、以下の点に気付けます。

  • エラーの原因の究明
  • エラーの解決につながる
  • システムが使われている際の状況を把握する

システム開発における参考などといった点が挙げられます。

ログファイルの作成は、プログラムの機能そのものには関係がなくても、非常に重要な機能だといえるでしょう。

 

ログレベルとは

ログファイルには「ログレベル」という情報が付加されています。

これは、ログファイルに保存されている情報がどれほど重要であるのか、どれほど詳細な情報を持っているのかなどといった情報の質を表すものです。

このログレベルを参照することによって、どのログが重要であるかを判断する指標にできます。

 

Loggerクラスとは

Javaにおいては、ログファイルを出力するために「Loggerクラス」と「Handerクラス」というクラスが用意されています。

これらのクラスはjava.util.loggingモジュールに実装されています。

Loggerクラスを用いてログファイルを作成するには、以下の段階を踏みましょう。

①Loggerクラスのインスタンスを生成

Logger Logger名 = Logger.getLogger("ログの名前")

②Handlerクラスのインスタンスを生成

Handler Handler名 = new FileHandler("ログを出力したい場所のパス")

③LoggerインスタンスにHandlerインスタンスを登録

Logger名.addHandler(Handler名)

④ログの出力

Logger名.log(ログレベル, "ログの内容")

 

 

ログファイルを出力してみよう

では、これまでの方法を使用してJavaにおけるログファイルの出力を行ってみましょう。

今回のサンプルプログラムでは、プログラムファイルの存在するディレクトリに”sample.txt”という名前でログファイルを出力する処理を行います。

import java.util.logging.Logger;
import java.util.logging.Level;
import java.util.logging.Handler;
import java.util.logging.FileHandler;
import java.io.File;
import java.io.IOException;

public class LoggerSample{
        public static void main(String[] args){
                 // Loggerインスタンスの生成 
                Logger sample_logger = Logger.getLogger("Sample log");

                // 現在のディレクトリ情報を取得
                String path =  System.getProperty("user.dir"); path = new File(path, "sample_log.txt").getPath();
                System.out.println(path);

                // Handlerクラスのインスタンス生成のときの例外処理のためのtry-catch構文
                try{ 
                        // Handlerインスタンスを生成
                          Handler sample_handler = new FileHandler(path);
                             // LoggerにHandlerを登録
                         sample_logger.addHandler(sample_handler);
                }catch(IOException e){}

                // ログの出力
                sample_logger.log(Level.INFO, "サンプルログです。"); 
        }
}

このプログラムを実行すると、プログラムファイルと同じディレクトリにsample_log.txtという名前のファイルが作られていることを確認できます。

ファイルの中身は、実行環境によって若干中身が変わるものの、今回は以下のようになりました。

<?xml version="1.0" encoding="windows-31j" standalone="no"?>
<!DOCTYPE log SYSTEM "logger.dtd">
<log>
<record>
  <date>xxxx-xx-xxXxx:xx:xx.xxxxxxX</date>
  <millis>xxxxxxxxxxxxx</millis>
  <nanos>xxxxxx</nanos>
  <sequence>0</sequence>
  <logger>Sample log</logger>
  <level>INFO</level>
  <class>LoggerSample</class>
  <method>main</method>
  <thread>1</thread>
  <message>サンプルログです。</message>
</record>
</log>

 

 

執筆してくれたメンター

メンターOS

AIプログラミングを使って開発を行う。

プログラミング歴は約3年でPythonは割と得意。

好きな物理理論は一般相対性理論で動物も好き。

 

大石ゆかり

JavaのLoggerを使ってログファイルを出力する方法がよく分かりやすくて良かったです!

田島悠介

ゆかりちゃん、これからも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもJavaやServletの技術を使ってWebアプリケーション開発を習得できるオンラインブートキャンプJava講座を開催しています。

挫折しない学習方法を知れる説明動画や現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。