Javaでプロパティファイルを読み込む方法：PropertiesクラスやResourceBundleの使い方を解説

Javaアプリケーションを開発する際、データベースの接続情報やアプリケーションの動作設定、多言語対応のためのメッセージなどをソースコードに直接記述する（ハードコーディングする）ことは避けるべきです。

設定を外部ファイルに切り出すことで、ソースコードを修正・再コンパイルすることなく設定変更が可能になり、保守性と柔軟性が大幅に向上します。

Javaにおいて最も一般的に利用されるのが「プロパティファイル」です。

本記事では、Javaでプロパティファイルを読み込むための主要な手法である java.util.Properties クラスと java.util.ResourceBundle クラスの使い方を中心に、実践的な実装方法を詳しく解説します。

プロパティファイルの基本構造と役割

プロパティファイルとは、主に設定情報を「キー=値」の形式で保存するテキストファイルのことです。

拡張子には通常 .properties が使用されます。

Java開発において、この形式は標準的な設定ファイルとして定着しています。

プロパティファイルの記述ルール

プロパティファイル内では、1行ごとに1つの設定項目を記述します。

基本的には 「キー=値」 の形式で記述しますが、イコールの代わりにコロン（:）を使用することも可能です。

また、行頭に # や ! を置くことで、その行をコメントとして扱うことができます。

# データベース接続設定
db.url=jdbc:mysql://localhost:3306/mydb
db.user=admin
db.password=password123

# アプリケーションの動作設定
app.version=1.0.0
app.debug=true

文字エンコーディングの注意点

かつてのJava（Java 8以前）では、プロパティファイルは ISO-8859-1（Latin-1） エンコーディングで読み込まれるのが標準でした。

そのため、日本語などの全角文字を含める場合は、native2ascii コマンドを使用してUnicodeエスケープ形式（\uXXXX形式）に変換する必要がありました。

しかし、現代のJava（Java 9以降）では、プロパティファイルをデフォルトでUTF-8として読み込むことが可能になっています。

これにより、特別な変換処理を行わなくても日本語を直接記述できるようになり、開発の利便性が飛躍的に向上しました。

最新のプロジェクトではUTF-8での運用を前提とするのが一般的です。

Propertiesクラスを使用した読み込み方法

Javaの標準ライブラリに含まれる java.util.Properties クラスは、古くから存在する最も基本的なプロパティ読み込み手段です。

このクラスは Hashtable を継承しており、読み込んだデータをキーと値のペアで保持します。

ファイルシステムから読み込む

実行環境の特定のパスにあるファイルを読み込む場合は、FileInputStream を使用します。

この方法は、外部の設定ファイルを読み込む際に適しています。

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

public class PropertiesLoader {
    public static void main(String[] args) {
        Properties properties = new Properties();
        String filePath = "config.properties";

        // try-with-resources文を使用して自動的にストリームを閉じる
        try (InputStream input = new FileInputStream(filePath)) {
            // プロパティファイルを読み込む
            properties.load(input);

            // 値を取得する
            String dbUrl = properties.getProperty("db.url");
            String dbUser = properties.getProperty("db.user");

            System.out.println("DB URL: " + dbUrl);
            System.out.println("DB User: " + dbUser);

        } catch (IOException ex) {
            System.err.println("ファイルの読み込みに失敗しました: " + ex.getMessage());
        }
    }
}

DB URL: jdbc:mysql://localhost:3306/mydb
DB User: admin

クラスパス上のリソースとして読み込む

JARファイルの中に含まれているプロパティファイルや、プロジェクトのソースフォルダ配下にあるファイルを読み込む場合は、ClassLoader を利用するのが適切です。

これにより、実行環境の絶対パスに依存しない設計が可能になります。

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

public class ResourceLoader {
    public static void main(String[] args) {
        Properties properties = new Properties();
        
        // クラスローダーを使用してリソースを取得
        try (InputStream input = ResourceLoader.class.getClassLoader().getResourceAsStream("config.properties")) {
            if (input == null) {
                System.out.println("指定されたファイルが見つかりません。");
                return;
            }

            // プロパティファイルをロード
            properties.load(input);

            // デフォルト値を指定して取得することも可能
            String version = properties.getProperty("app.version", "unknown");
            System.out.println("App Version: " + version);

        } catch (IOException ex) {
            ex.printStackTrace();
        }
    }
}

プロパティ値のデフォルト設定

getProperty(String key, String defaultValue) メソッドを使用すると、指定したキーがファイル内に存在しなかった場合の デフォルト値を指定 できます。

これにより、設定の欠落による意図しないエラー（NullPointerExceptionなど）を防止でき、堅牢なコードになります。

ResourceBundleを使用した読み込み方法

java.util.ResourceBundle は、主に多言語対応（国際化：I18n）を目的としたクラスです。

ユーザーのロケール（地域と言語）に応じて、自動的に適切なファイルを切り替えて読み込む機能を持っています。

多言語対応での利用例

例えば、日本語（ja）と英語（en）に対応したメッセージファイルを以下のように用意します。

• messages.properties（デフォルト）
• messages_ja.properties（日本語用）
• messages_en.properties（英語用）

import java.util.Locale;
import java.util.ResourceBundle;

public class BundleExample {
    public static void main(String[] args) {
        // ロケールを明示的に指定（日本語）
        Locale localeJa = new Locale("ja", "JP");
        ResourceBundle bundleJa = ResourceBundle.getBundle("messages", localeJa);
        System.out.println("日本語設定: " + bundleJa.getString("welcome.message"));

        // ロケールを英語に切り替え
        Locale localeEn = new Locale("en", "US");
        ResourceBundle bundleEn = ResourceBundle.getBundle("messages", localeEn);
        System.out.println("英語設定: " + bundleEn.getString("welcome.message"));
    }
}

日本語設定: こんにちは、ようこそ！
英語設定: Hello, Welcome!

ResourceBundleの特徴とメリット

ResourceBundle を使用する最大のメリットは、「ロケールに基づいたファイルの自動選択」です。

OSの言語設定やアプリケーションのユーザー設定に合わせて、プログラム側で複雑な分岐を書くことなく最適なメッセージを表示できます。

また、Properties クラスとは異なり、InputStream を手動で開いたり閉じたりする必要がありません。

getBundle メソッドを呼び出すだけでキャッシュ機能も働くため、パフォーマンス面でも有利な場合があります。

PropertiesとResourceBundleの使い分け

どちらのクラスを使用すべきかは、用途によって明確に分かれます。

以下の表は、それぞれの主な違いをまとめたものです。

「設定情報の管理」であれば Properties クラス、「ユーザー向けメッセージの多言語化」であれば ResourceBundle クラスを選択するのがベストプラクティスです。

XML形式のプロパティファイル

Javaのプロパティファイルは、プレーンテキスト形式だけでなく、XML形式 で記述することも可能です。

XML形式にすることで、より構造的な記述や、より確実な文字コードの指定が可能になります。

XML形式の記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
    <comment>XML形式の設定ファイル</comment>
    <entry key="server.port">8080</entry>
    <entry key="server.name">ProductionServer</entry>
</properties>

XMLの読み込みコード

XMLファイルを読み込む際は、loadFromXML メソッドを使用します。

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

public class XmlPropertiesLoader {
    public static void main(String[] args) {
        Properties props = new Properties();
        try (FileInputStream fis = new FileInputStream("config.xml")) {
            // XML形式として読み込む
            props.loadFromXML(fis);
            System.out.println("Server Port: " + props.getProperty("server.port"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

モダンなJava開発におけるプロパティ管理

近年、Spring Bootなどのフレームワークを使用する開発現場では、プロパティファイルを直接Java標準クラスで読み込む機会は減っています。

しかし、その背後ではJava標準の仕組みが活用されています。

Spring Frameworkでのアプローチ

Spring Bootでは、application.properties または application.yml というファイル名を使用するのが標準です。

• @Valueアノテーション: 特定のキーの値をフィールドに注入します。
• @ConfigurationProperties: プレフィックスを指定して、プロパティ群を一つのJava Bean（POJO）にマッピングします。

これらのアノテーションを使用することで、開発者はファイルの読み込み処理を意識することなく、型安全に設定値を利用できるようになっています。

環境変数との組み合わせ

クラウドネイティブな開発では、機密情報（パスワードやAPIキーなど）をプロパティファイルに直接記述せず、環境変数から読み込むことが推奨されます。

Javaの System.getenv() やSpringのプロパティオーバーライド機能を組み合わせることで、セキュリティを高めることができます。

プロパティファイル読み込み時のベストプラクティス

効率的でエラーの少ない開発を行うために、以下のポイントを意識してください。

1. キーの命名規則を統一する

階層構造を意識し、ドット（.）区切りで命名するのが一般的です（例: mail.smtp.host）。

これにより、設定項目が増えても整理された状態を保てます。

2. 定数クラスとの連携

プログラム内でキー名を文字列として直接記述すると、タイポ（打ち間違い）の原因になります。

public class AppConfig {
    public static final String DB_URL = "db.url";
}
// 呼び出し側
String url = properties.getProperty(AppConfig.DB_URL);

このように定数として定義しておくことで、IDEの補完機能が効くようになり、メンテナンス性が向上します。

3. 機密情報の取り扱いに注意

パスワードなどの機密情報は、プロパティファイルに平文で保存してGitなどのバージョン管理システムにコミットしてはいけません。

環境変数を利用するか、設定ファイルを暗号化する仕組み（Jasyptなど）の導入を検討してください。

4. ファイルの存在チェックを行う

ファイルが見つからない場合にアプリケーションが突然終了することを避けるため、例外処理を適切に行い、可能であればデフォルト値を使用して動作を継続できるように設計しましょう。

まとめ

Javaにおけるプロパティファイルの読み込みは、アプリケーションの外部設定管理において欠かせない技術です。

Propertiesクラス

システム設定や汎用的な設定の読み書きに適している。

ResourceBundleクラス

多言語対応やロケール依存のメッセージ管理に特化している。

UTF-8の利用

Java 9以降であれば、日本語も直接記述可能。

モダンな開発

Springなどのフレームワークを活用し、アノテーションベースでの管理が主流。

それぞれの特徴を正しく理解し、プロジェクトの規模や要件に合わせて最適な手法を選択することで、変更に強くメンテナンスしやすいJavaアプリケーションを構築することができます。

まずは基本的な Properties クラスの扱いに慣れ、そこから徐々にフレームワークや多言語対応へとステップアップしていきましょう。