JavaのPropertiesクラスの使い方完全ガイド！プロパティファイル読み込み方法を初心者向けに徹底解説

1. プロパティファイルとは何か

1. プロパティファイルとは何か

Javaのプロパティファイルとは、アプリケーションの設定情報を保存するためのテキストファイルです。拡張子は一般的にpropertiesを使用します。キーと値をイコールで結びつけて記述する形式で、設定ファイル管理や環境設定の外部化に広く利用されています。

Java開発では、データベース接続情報、APIキー、ログレベル設定、アプリケーションの動作モードなどをプロパティファイルに保存することが一般的です。これによりソースコードを書き換えずに設定変更が可能になります。

JavaのPropertiesクラスは、このプロパティファイルを読み込むための標準クラスです。Java標準ライブラリに含まれているため、特別な外部ライブラリは不要です。

2. プロパティファイルの書き方

2. プロパティファイルの書き方

まずは基本的なプロパティファイルの書き方を理解しましょう。キーと値をイコールでつなぐだけのシンプルな構造です。

db.url=jdbc:mysql://localhost:3306/sampledb
db.user=root
db.password=secret
app.name=SampleApplication

このように設定値を記述します。コメントはシャープを使って記述できます。Javaの設定ファイル管理では、この形式が基本となります。初心者の方でも直感的に理解しやすいのが特徴です。

3. Propertiesクラスでファイルを読み込む方法

3. Propertiesクラスでファイルを読み込む方法

それではJavaでPropertiesクラスを使ってプロパティファイルを読み込む方法を解説します。まずは基本形です。

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

public class PropertiesSample {
    public static void main(String[] args) {
        Properties properties = new Properties();
        try {
            FileInputStream fis = new FileInputStream("config.properties");
            properties.load(fis);

            String url = properties.getProperty("db.url");
            String user = properties.getProperty("db.user");

            System.out.println("URL: " + url);
            System.out.println("User: " + user);

            fis.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

loadメソッドを使うことで、プロパティファイルを読み込みます。getPropertyメソッドでキーに対応する値を取得できます。Javaで設定ファイルを読み込む基本処理として非常に重要です。

URL: jdbc:mysql://localhost:3306/sampledb
User: root

4. デフォルト値を指定する方法

4. デフォルト値を指定する方法

設定値が存在しない場合に備えて、デフォルト値を指定することも可能です。これは実務でもよく使われます。

String timeout = properties.getProperty("app.timeout", "30");
System.out.println("Timeout: " + timeout);

第二引数にデフォルト値を指定することで、安全に値を取得できます。Java初心者の方は、例外回避や安全設計として覚えておきましょう。

5. クラスパスから読み込む方法

5. クラスパスから読み込む方法

WebアプリケーションやSpring環境では、クラスパスからプロパティファイルを読み込む方法がよく使われます。

import java.io.InputStream;
import java.util.Properties;

public class ClassPathPropertiesSample {
    public static void main(String[] args) throws Exception {
        Properties properties = new Properties();

        InputStream is = ClassPathPropertiesSample.class
                .getClassLoader()
                .getResourceAsStream("config.properties");

        properties.load(is);

        System.out.println(properties.getProperty("app.name"));
        is.close();
    }
}

getResourceAsStreamを利用することで、jarファイル内部のプロパティファイルも読み込むことができます。Javaアプリケーション開発では必須知識です。

6. プロパティファイルへ書き込む方法

6. プロパティファイルへ書き込む方法

Propertiesクラスは読み込みだけでなく、書き込みも可能です。設定ファイルを動的に生成する場面で活用できます。

import java.io.FileOutputStream;
import java.util.Properties;

public class PropertiesWriteSample {
    public static void main(String[] args) throws Exception {
        Properties properties = new Properties();

        properties.setProperty("app.version", "1.0");
        properties.setProperty("app.author", "Admin");

        FileOutputStream fos = new FileOutputStream("output.properties");
        properties.store(fos, "Application Settings");
        fos.close();
    }
}

storeメソッドを使うことで、プロパティファイルへ書き込みができます。Javaの設定管理や環境構築に役立つテクニックです。

7. 実務での活用例と注意点

7. 実務での活用例と注意点

JavaのPropertiesクラスは、小規模な設定管理に適しています。ただし機密情報の管理には注意が必要です。パスワードを平文で保存する場合はアクセス制御を行いましょう。

大規模アプリケーションでは、Spring Bootのapplication.propertiesやYAML形式の設定ファイルも使われます。しかし基礎となるのはJava標準のPropertiesクラスです。

Java初心者の方は、まずPropertiesクラスで設定ファイル読み込み方法を理解し、外部設定管理の重要性を学ぶことが大切です。これにより保守性の高いJavaアプリケーション開発が可能になります。

まとめ

まとめ

今回はJavaのPropertiesクラスを使ったプロパティファイルの読み込み方法から書き込み方法までを体系的に学びました。Javaで設定ファイルを外部化することは、アプリケーション開発において非常に重要な考え方です。ソースコードに直接データベース接続情報や環境設定値を記述するのではなく、プロパティファイルに分離することで、保守性、再利用性、拡張性が大きく向上します。

プロパティファイルはキーと値の組み合わせで構成されるシンプルなテキスト形式です。そのためJava初心者でも扱いやすく、設定管理の第一歩として最適です。Propertiesクラスのloadメソッドを使えば簡単にファイルを読み込むことができ、getPropertyメソッドで値を取得できます。さらにデフォルト値を指定することで、安全性を高めた設計も可能です。

また、FileInputStreamを使った通常のファイル読み込みだけでなく、クラスパスからgetResourceAsStreamを利用して読み込む方法も重要です。特にWebアプリケーションやフレームワークを利用する場合は、クラスパスからの読み込みが基本になります。Javaアプリケーション開発ではこの知識は欠かせません。

書き込みについてもstoreメソッドを使えば簡単にプロパティファイルを生成できます。設定情報の保存や更新処理を実装する際に活用できます。ただしパスワードなどの機密情報を扱う場合は、ファイル権限や暗号化などの対策を検討することが大切です。

JavaのPropertiesクラスは標準ライブラリに含まれているため、追加ライブラリは不要です。設定ファイル管理、環境構築、外部設定読み込み、データベース接続情報管理など、多くの場面で利用されます。Java初心者の方はまずPropertiesクラスの基本を確実に理解することで、実務でも通用する基礎力が身につきます。

サンプルプログラムの総復習

ここで、プロパティファイルを読み込み、デフォルト値を指定し、結果を表示するサンプルプログラムをもう一度確認してみましょう。Javaの設定ファイル読み込み処理の流れを復習できます。

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

public class PropertiesReviewSample {
    public static void main(String[] args) {
        Properties properties = new Properties();

        try {
            FileInputStream fis = new FileInputStream("config.properties");
            properties.load(fis);

            String url = properties.getProperty("db.url");
            String user = properties.getProperty("db.user");
            String timeout = properties.getProperty("app.timeout", "30");

            System.out.println("URL: " + url);
            System.out.println("User: " + user);
            System.out.println("Timeout: " + timeout);

            fis.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

URL: jdbc:mysql://localhost:3306/sampledb
User: root
Timeout: 30

このようにJavaのPropertiesクラスを使えば、設定ファイル読み込み処理は非常にシンプルに実装できます。Javaでプロパティファイルを扱う基本的な流れは、インスタンス生成、ファイル読み込み、値取得、クローズ処理の順番です。この流れを理解しておくことが大切です。