プロパティファイル(.properties)は、キー=値 の形で設定を書くテキストファイルです。Javaでは java.util.Properties で読み込みます。最小のコードは次のとおりです(src/main/resources/config.properties がある前提です)。
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Properties;
public class Main {
public static void main(String[] args) throws Exception {
Properties prop = new Properties();
try (InputStream in = Main.class.getResourceAsStream("/config.properties");
InputStreamReader reader = new InputStreamReader(in, StandardCharsets.UTF_8)) {
prop.load(reader);
}
System.out.println(prop.getProperty("app.name"));
}
}
日本語が文字化けするのは、load(InputStream) が ISO 8859-1 として読むためです。上のようにReaderにしてUTF-8を指定すれば読めます。ファイルが見つからず NullPointerException になるときは、パスの先頭の / を疑ってください(原因は下の表にまとめました)。
PARTS LIST /目次
プロパティファイルとは何か?
プロパティファイルの用途と役割
プロパティファイルとは、アプリケーションの設定情報をキーと値のペアで保存するためのテキストファイルです。
拡張子は.propertiesで、Javaではjava.util.Propertiesクラスやjava.util.ResourceBundleクラスで読み込みます。
設定値をプログラムのコード内に直接書き込まず、外部ファイルとして管理すると、以下のようなメリットがあります。
メリット
- 設定の変更が容易: プログラムを再コンパイルすることなく、設定値を変更できます。例えば、テスト環境から本番環境へ移行する際に、データベースの接続情報を変更する場合などに便利
- 可読性の向上: 設定情報が一箇所にまとまるため、どのような設定がされているのか把握しやすくなる
- セキュリティの向上: パスワードなどの機密情報をコードから分離し、プロパティファイルに記述することで、ソースコードのセキュリティを高められます。ただし、プロパティファイル自体のアクセス管理も重要
主な用途としては、データベース接続情報(URL、ユーザー名、パスワード)、外部APIのキー、アプリケーションの動作モード(開発モード、本番モードなど)、ログレベルの設定など、多岐にわたります。
拡張子 .properties の基本構造
プロパティファイルの拡張子は.properties です。その構造はシンプルです。
ポイント
- キーと値のペア:
キー=値またはキー:値の形式で記述します。=を使うのが標準的です。キーにスペースを含めるにはバックスラッシュ(\)でエスケープが必要ですが、値には含めることができる - コメント: 行頭に
#または!を付けると、その行はコメントとして扱われる - エンコーディング:
Properties#load(InputStream)はISO 8859-1として読むので、UTF-8の日本語は化けます。対処は下の「文字化けするとき」にまとめました
# データベース接続設定
database.url=jdbc:mysql://localhost:3306/mydb
database.username=dbuser
database.password=dbpassword
# アプリケーション設定
application.name=My Awesome App
application.version=1.0.2
Javaでプロパティファイルはどう読み込む?基本手順を解説
Java標準ライブラリの java.util.Properties クラスを使うのが基本的なアプローチです。
Propertiesクラスとload()メソッドの使い方
Propertiesクラスは、プロパティファイルを扱うためにJavaが提供している便利なクラスです。
このクラスは Hashtableを継承しており、キーと値を文字列として格納できます。
主なメソッドとしては、以下のものがあります。
ポイント
load(InputStream inStream): 入力ストリームからプロパティファイルを読み込むgetProperty(String key): 指定されたキーに対応する値を取得するgetProperty(String key, String defaultValue): 指定されたキーに対応する値を取得するが、キーが存在しない場合はデフォルト値を返すsetProperty(String key, String value): 新しいプロパティを設定したり、既存のプロパティを更新するstore(OutputStream out, String comments): プロパティリストを指定された出力ストリームに書き出す
プロパティファイルへの書き込み方法(store メソッド)
プロパティファイルへの書き込みは、setProperty()で値を設定してからstore()でファイルに出力する流れになります。
以下は、設定値を新規のプロパティファイルとして書き出すサンプルコードです。
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Properties;
public class PropertyWriter {
public static void main(String[] args) {
Properties prop = new Properties();
prop.setProperty("app.name", "MyApplication");
prop.setProperty("app.version", "1.0");
try (OutputStream output = new FileOutputStream("config.properties")) {
// 第2引数のコメントはファイル先頭に書き出される
prop.store(output, "アプリケーション設定");
} catch (IOException ex) {
ex.printStackTrace();
}
}
}
store()の第2引数に渡した文字列は、出力されるプロパティファイルの先頭にコメント(#始まりの行)として書き込まれます。ただし、日本語などASCII範囲外の文字は\uXXXX形式にエスケープされて出力されます。
書き込み先はクラスパス内ではなく通常のファイルシステムパスになるため、実行環境の書き込み権限に注意してください。
ファイルの配置場所に注意(resources ディレクトリ)
Javaプロジェクトでは、プロパティファイルのようなリソースファイルを配置する標準的な場所があります。
MavenやGradleといったビルドツールを利用している場合、src/main/resources ディレクトリがそれにあたります。
resources ディレクトリに配置されたファイルは、ビルド時にクラスパスの通った場所(通常は WEB-INF/classes やJARファイルのルートなど)にコピーされます。
例えば、src/main/resources/config.properties というファイルを作成した場合、プログラムからは "config.properties" という名前でアクセスできるようになります。
ファイル読み込みのサンプルコード(InputStream 使用)
Properties クラスと InputStream を使ってプロパティファイルを読み込むサンプルコードは次のとおりです。
ここでは、src/main/resources ディレクトリに config.properties というファイルが存在することを前提とします。
config.properties:
app.name=MyApplication
app.version=1.0
Javaコード:
import java.io.InputStream;
import java.io.IOException;
import java.util.Properties;
public class PropertyReader {
public static void main(String[] args) {
Properties prop = new Properties();
// クラスローダー経由でリソースファイルを取得する
try (InputStream input = PropertyReader.class.getClassLoader().getResourceAsStream("config.properties")) {
if (input == null) {
System.out.println("申し訳ありません、指定されたファイルが見つかりません。");
return;
}
// プロパティファイルを読み込む
prop.load(input);
// プロパティ値を取得して表示
System.out.println("アプリケーション名: " + prop.getProperty("app.name"));
System.out.println("バージョン: " + prop.getProperty("app.version"));
// 存在しないキーを指定した場合 (デフォルト値なし)
System.out.println("作者: " + prop.getProperty("app.author"));
// 存在しないキーを指定した場合 (デフォルト値あり)
System.out.println("作者 (デフォルト値あり): " + prop.getProperty("app.author", "不明"));
} catch (IOException ex) {
// IOExceptionが発生した場合の処理
ex.printStackTrace();
}
}
}
このコードは、config.properties ファイルをクラスパスから読み込み、その中に定義されている app.name と app.version の値を取得して表示します。
getResourceAsStream("config.properties")クラスパスから config.properties を探し、InputStream を得るprop.load(input)中身のキーと値を Properties に格納する(app.name → MyApplication、app.version → 1.0)prop.getProperty(key)キーを指定して値を取り出すgetProperty("app.name")キーがあるgetProperty("app.version")キーがあるgetProperty("app.author")キーが無いgetProperty("app.author", "不明")キーが無い・第2引数ありResourceBundleクラスを使った読み込み方法
Propertiesクラスのほかに、java.util.ResourceBundleクラスを使ってプロパティファイルを読み込む方法もあります。
ResourceBundleはPropertiesと異なり、ロケール(言語・地域)に応じたファイルの自動切り替えに対応している点が特徴です。
例えば config_ja.properties と config_en.properties を用意しておくと、実行環境のロケールに応じて自動的に適切なファイルが読み込まれます。
import java.util.ResourceBundle;
public class ResourceBundleReader {
public static void main(String[] args) {
// src/main/resources/config.properties を読み込む(拡張子は不要)
ResourceBundle bundle = ResourceBundle.getBundle("config");
System.out.println("アプリケーション名: " + bundle.getString("app.name"));
System.out.println("バージョン: " + bundle.getString("app.version"));
}
}
Properties#getProperty()はキーが存在しない場合にnullを返すのに対し、ResourceBundle#getString()はキーが存在しないとMissingResourceExceptionをスローする点が大きな違いです。
設定漏れに気付きやすいという利点がある一方、デフォルト値を指定できないため用途に応じた使い分けが必要です。
使い分けの指針
- Propertiesクラス: 多言語対応が不要な単純な設定読み込み、デフォルト値を使いたい場合に適する
- ResourceBundleクラス: ロケール別にファイルを切り替えたい多言語対応アプリケーションに適する
プロパティファイルの読み込み方法にはどんな種類がある?
クラスパスからの読み込み方法
クラスパスからの読み込みが最も推奨される方法です。
前のセクションのサンプルコードで示した ClassLoader.getResourceAsStream() を使う方法がこれに該当します。
利点
- 環境依存性が低い: アプリケーションがJARファイルやWARファイルとしてパッケージングされても、ファイルへのパスが変わらないため、安定して動作する
- 配置が標準的:
src/main/resourcesに配置するという規約に従うことで、プロジェクト構造が分かりやすくなる
getResourceAsStream が null を返す原因
getResourceAsStream() は、ファイルが見つからないと例外ではなく null を返します。そのまま load() に渡すと NullPointerException になります。config.properties がクラスパスの直下にある状態で、JDK 23 で実際に試した結果は次のとおりです。
| 書き方 | 結果 | 理由 |
|---|---|---|
Main.class.getResourceAsStream("/config.properties") | 読める | 先頭の / はクラスパスのルートを表す |
Main.class.getResourceAsStream("config.properties") | null | / が無いと、そのクラスのパッケージ(app なら app/)が基準になる |
Main.class.getClassLoader().getResourceAsStream("config.properties") | 読める | ClassLoader は常にルートから探す |
Main.class.getClassLoader().getResourceAsStream("/config.properties") | null | ClassLoader では先頭の / を付けてはいけない |
ここまでが書き方の原因です。書き方が合っていても null になるときは、次の2つを見ます。
- MavenやGradleのビルド出力(
target/classes・build/resources)にファイルがコピーされていない(ビルドキャッシュが古い) src/main/resourcesではなくsrc/test/resourcesなど別のディレクトリに置いている
Class#getResourceAsStream は先頭に / を付けるとルート基準になり、ClassLoader#getResourceAsStream は / を付けると見つかりません。どちらを呼んでいるかを見て書き分けてください。迷ったら、Class で先頭に / を付ける書き方に揃えると間違えにくいです。
文字化けするとき
UTF-8で保存した日本語を load(InputStream) で読むと文字化けします。Java 18以降(JEP 400)は既定の文字セットがUTF-8になりましたが、load(InputStream) の仕様はISO 8859-1のままです。JDK 23で app.title=日本語タイトル を読むと、既定の文字セットがUTF-8でも æ¥æ¬èªã¿ã¤ãã« のように化けました。
対処は2つです。
- Readerで読む(推奨):
new InputStreamReader(in, StandardCharsets.UTF_8)を作ってload(Reader)に渡します。この記事の最小コードがこの形です \uXXXXでエスケープして書く: ファイル側をapp.title=\u65e5\u672c\u8a9eのように書けば、load(InputStream)でも読めます。手で書くのは大変なので、store()が出力する形式と思えばよいです
なお、ResourceBundle が読むプロパティファイルは、Java 9以降UTF-8として読まれます。上のコードで ResourceBundle.getBundle("config") を使うと、同じファイルが化けずに読めました。
外部ファイルとして読み込む場合(設定の切り替え用途)
アプリケーションの外部にプロパティファイルを配置し、それを読み込む方法もあります。
この方法は特に、アプリケーションを再デプロイせずに設定を頻繁に変更したい場合や、運用担当者が設定ファイルを直接編集するようなシナリオで有効です。
読み込み方法: ファイルシステムのパス(絶対パス、または実行したディレクトリからの相対パス)を指定して読み込みます。UTF-8の日本語を含むなら、ここでもReaderを使います。
try (Reader reader = Files.newBufferedReader(Path.of("config.properties"), StandardCharsets.UTF_8)) {
prop.load(reader);
}
ファイルが無いときは null ではなく FileNotFoundException(NoSuchFileException)になります。クラスパスから読む場合と違い、JARに入れた後はそのファイルを別途置く必要があります。
| クラスパスから読む | ファイルパスから読む | |
|---|---|---|
| 置き場所 | src/main/resources(JARに同梱される) | JARの外 |
| 見つからないとき | null を返す | FileNotFoundException |
| 向く用途 | 初期値・変えない設定 | 環境ごとに変える設定・運用で編集する設定 |
利点
- 柔軟な設定変更: アプリケーションを停止・再起動することなく、ファイルの変更を監視し再読み込みする仕組みを実装すれば、設定変更を無停止で反映できます
- 運用との分離: 開発物と設定ファイルを分離して管理できる
考慮事項
- ファイルパスの管理: 外部ファイルのパスをどのようにアプリケーションに伝えるか(環境変数、起動時引数など)を考慮する必要がある
- セキュリティ: 外部ファイルのアクセス権限管理が重要になる
別の例として、Dockerコンテナでアプリケーションを動かす際に、ホストOS上の設定ファイルをコンテナ内にマウントし、それを読み込むといった使い方が考えられます。
コンテナイメージを再ビルドせずに設定を変更できます。
XML形式のプロパティファイル(loadFromXML)
.properties ではなくXML形式でも保存・読み込みができます。loadFromXML(InputStream) を使い、読み込み後は入力ストリームが閉じられます(load は開いたままです)。XMLは既定でUTF-8なので、日本語で化ける心配は小さくなります。ただし、DTD宣言を持つ専用の形式で書く必要があり、現場では通常の .properties が使われることがほとんどです。
Spring Bootではプロパティファイルの扱いがどう変わる?
Spring Bootのアプリなら、これまでのような読み込みコードは書かなくて済みます(src/main/resources/application.properties を自動で読み、@Value や @ConfigurationProperties で受け取れます)。これまで見てきたのは、主にJava SE環境での標準的なプロパティファイルの扱い方でした。しかし、現代のJava開発で広く使われているフレームワークであるSpring Boot(最新はSpring Boot 4.1系、Spring Boot 3.5系の無償サポートは2026年6月末で終了)を利用する場合、プロパティファイルの扱いはさらに簡単かつ高機能になります。
Spring Bootは「設定より規約」の原則に基づき、多くの設定を自動で行ってくれます。プロパティファイルの読み込みもその一つです。
application.properties / application.yml の役割
Spring Bootプロジェクトでは、src/main/resourcesディレクトリに application.properties または application.yml という名前のファイルを配置しておくと、Spring Bootが起動時に自動的にその内容を読み込み、アプリケーションの設定として利用可能にします。
application.properties
伝統的なキー=値の形式です。
server.port=8081spring.application.name=my-spring-app
application.yml ( application.yaml)
YAML形式で、より階層的で人間が読みやすい形式で記述できます。
server:
port: 8081
spring:
application:
name: my-spring-app
どちらの形式を使うかはプロジェクトの好みや規約によりますが、YAMLは複雑な設定を記述する際に可読性が高いという利点があります。
同じ場所に.propertiesとYAMLの両方がある場合は.propertiesが優先されるため、どちらか一方の形式に統一するのがおすすめです。なお、プロファイル固有のファイル(application-{profile}.propertiesなど)は、基本のapplication.propertiesより優先されます。
これらのファイルに記述された設定は、特別な読み込み処理をコードに書かなくても、Spring環境内で利用できるようになります。
@Value アノテーションによる読み込み方法
Spring Bootでは、application.properties や application.yml に定義された値を、コンポーネント(@Component, @Service, @Controller などでマークされたクラス)のフィールドに直接インジェクション(注入)できます。
その際に使うのが @Value アノテーションです。
application.properties:
myapp.title=素晴らしいアプリケーション
myapp.version=2.1
Javaコード:
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class AppConfig {
@Value("${myapp.title}")
private String title;
@Value("${myapp.version}")
private String version;
// デフォルト値も指定可能
@Value("${myapp.author:Default Author}")
private String author;
public void printConfig() {
System.out.println("タイトル: " + title);
System.out.println("バージョン: " + version);
System.out.println("作者: " + author);
}
}
${...} のプレースホルダー内にプロパティのキーを指定します。
キーが存在しない場合に備えて、コロン : の後にデフォルト値を記述することも可能です。
これにより、従来の Properties.getProperty() を呼び出すコードが不要になり、より宣言的に設定値を扱えます。
@ConfigurationProperties を使ったプロパティ管理
多数の設定値をまとめてクラスのフィールドとして扱いたい場合、@Value を一つ一つフィールドに付けるのは冗長になることがあります。
そのような場合に便利なのが @ConfigurationProperties アノテーションです。
このアノテーションを使うと、指定したプレフィックスを持つプロパティ群を、POJO(Plain Old Java Object)にまとめてマッピングできます。
application.properties:
myapp.server.host=localhost
myapp.server.port=9000
myapp.client.timeout=5000
myapp.client.retries=3
Javaコード (POJO):
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component; // もしくは @EnableConfigurationProperties と共に利用
// @Component を付けて自動登録するか、@ConfigurationPropertiesScan(パッケージ一括スキャン)または @EnableConfigurationProperties(個別クラス指定)のいずれかで登録する
@ConfigurationProperties(prefix = "myapp") // "myapp" プレフィックスを持つプロパティをマッピング
public class MyAppProperties {
private Server server = new Server(); // ネストしたプロパティも可能
private Client client = new Client();
public static class Server {
private String host;
private int port;
// getters and setters
public String getHost() { return host; }
public void setHost(String host) { this.host = host; }
public int getPort() { return port; }
public void setPort(int port) { this.port = port; }
}
public static class Client {
private int timeout;
private int retries;
// getters and setters
public int getTimeout() { return timeout; }
public void setTimeout(int timeout) { this.timeout = timeout; }
public int getRetries() { return retries; }
public void setRetries(int retries) { this.retries = retries; }
}
// getters and setters for server and client
public Server getServer() { return server; }
public void setServer(Server server) { this.server = server; }
public Client getClient() { return client; }
public void setClient(Client client) { this.client = client; }
@Override
public String toString() {
return "MyAppProperties{" +
"serverHost=" + server.getHost() +
", serverPort=" + server.getPort() +
", clientTimeout=" + client.getTimeout() +
", clientRetries=" + client.getRetries() +
'}';
}
}
この MyAppProperties クラスをSpringのコンポーネントとして登録するか、メインのコンフィギュレーションクラスで @EnableConfigurationProperties(MyAppProperties.class) を指定することで、Springが自動的にプロパティ値をこのクラスのフィールドにバインドしてくれます。
型安全であり、IDEの補完も効きやすくなるため、効率的なプロパティ管理が実現できます。
Spring Bootにおけるこれらの機能は、プロパティファイルの読み込みの作業を大幅に簡略化し、開発者がビジネスロジックに集中できるよう支援してくれます。
よくある質問
Q1. プロパティファイル(.properties)とは何ですか?
A1. Javaにおけるプロパティファイルとは、アプリケーションの設定情報をキーと値のペアで保存するテキストファイルです。拡張子は.propertiesで、コードを再コンパイルせずに設定値を変更できます。
Q2. Javaでプロパティファイルを読み込むにはどうすればいいですか?
A2. java.util.Propertiesクラスのload()メソッドを使います。ClassLoader.getResourceAsStream()でファイルを取得し、prop.load(input)で読み込んだ後、getProperty(key)で値を取得します。
Q3. PropertiesクラスとResourceBundleクラスはどう使い分ければいいですか?
A3. 多言語対応が不要な単純な設定読み込みにはPropertiesクラス、ロケール別にファイルを切り替えたい多言語対応アプリケーションにはResourceBundleクラスが適しています。
Q4. プロパティファイルはどこに配置すればいいですか?
A4. MavenやGradleを使う場合、src/main/resourcesディレクトリに配置します。ビルド時にクラスパスの通った場所へ自動的にコピーされます。
Q5. Spring Bootでプロパティファイルはどう扱われますか?
A5. src/main/resourcesにapplication.propertiesまたはapplication.ymlを配置すると、Spring Bootが起動時に自動的に読み込みます。@Valueや@ConfigurationPropertiesアノテーションで値を注入することも可能です。
Q6. getResourceAsStream()がnullを返すのはなぜですか?
A6. 主な原因は3つです。ClassLoaderに先頭が/のパスを渡している、ビルド出力にファイルがコピーされていない、src/test/resourcesなど誤ったディレクトリに配置している、のいずれかです。
Q7. プロパティファイルの日本語が文字化けするのはなぜですか?
A7. load(InputStream)はファイルをISO 8859-1として読むためです。InputStreamReaderにUTF-8を指定してload(Reader)で読み込むか、日本語を\uXXXX形式でエスケープしてください。
Q8. プロパティファイルに機密情報を含めても安全ですか?
A8. 機密情報は.gitignoreでリポジトリから除外し、環境変数や専用のシークレット管理サービス(AWS Secrets Manager等)経由で管理するのが安全です。
結局どう使い分ければいい?まとめとベストプラクティス
いまでも、Javaアプリケーションにおけるプロパティファイルの扱いは設定管理の基本であり、アプリケーションの柔軟性や保守性を大きく左右します。
設定ファイルを使い分ける戦略
一つのプロパティファイルにすべての設定を詰め込まず、設定の性質に応じてファイルを分割することを検討してください。
application.properties(またはapplication.yml): Spring Bootの場合、基本的なアプリケーション設定、サーバー設定など、汎用的な設定を記述- 機能特化型プロパティファイル: 例えば、
database.properties、aws.properties、external-api.propertiesのように、特定の機能や連携サービスに関する設定を分離します。これにより、関連する設定が一箇所にまとまり、管理がしやすくなります。これらのファイルは、必要に応じてプログラムから明示的に読み込むか、Springであれば@PropertySourceアノテーションなどを使って追加の読み込み対象として指定できる - ロギング設定ファイル: Logback (logback.xml) や Log4j2 (log4j2.xml) のようなロギングフレームワークの設定は、専用のXMLやプロパティファイルで管理するのが一般的
設定ファイルを適切に分割することで、関心事が分離され、設定の見通しが良くなります。結果として、変更時の影響範囲も特定しやすくなります。
環境ごとのプロパティ管理の考え方
開発(dev)、ステージング(stg)、本番(prod)など、アプリケーションを実行する環境ごとに設定値が異なるのは一般的です。
これらの環境差異を効率的に管理する方法を確立しておきます。
- Spring Profiles (Spring Boot): Spring Bootでは、
application-{profile}.properties(例:application-dev.properties,application-prod.properties) という命名規則でプロファイル固有の設定ファイルを作成できます。起動時にアクティブなプロファイル(例:spring.profiles.active=dev)を指定することで、対応する設定が自動的に読み込まれる - 環境変数: データベースのパスワードやAPIキーなど、特に機密性の高い情報や、実行環境に強く依存する値は、環境変数経由で設定するのが良いプラクティスです。プログラムやプロパティファイル内で環境変数を参照するようにします(例:
${DB_PASSWORD})。 - 外部設定ファイル: 前述の通り、設定ファイルをJAR/WARの外に配置し、起動時引数や環境変数でそのパスを指定する方法もあります。これにより、デプロイ成果物を変更せずに設定を切り替えられる
- 設定サーバー (Config Server): Microservicesアーキテクチャなど、多数のサービスが存在する複雑な環境では、Spring Cloud Config Server のような中央集権型の設定サーバーを利用して、各サービスの設定を一元管理する方法も有効
これらの方法を組み合わせることで、安全かつ効率的に環境ごとの設定を管理できます。
ただし、Spring Profilesと環境変数を併用する際は設定の優先順位に注意が必要です。
Spring Bootのプロパティ解決順序は「コマンドライン引数 > JVMシステムプロパティ(-Dオプション) > 環境変数 > application-{profile}.properties > application.properties」の順です。
環境変数はapplication-prod.propertiesより優先されるため、環境変数で値を上書きできます。ただし、コマンドライン引数や-Dオプションはさらに優先されるので、同じキーを複数の場所で指定すると「環境変数を設定したのに別の指定の値が使われる」という混乱が起きやすい点は覚えておいてください。
Git管理する際のセキュリティ的注意点
プロパティファイル、特にデータベースの認証情報やAPIキーなどの機密情報を含むファイルをGitリポジトリで管理する際には、細心の注意が必要です。
- 機密情報はコミットしない:最も基本的な原則は、パスワードやプライベートキーなどの機密情報をリポジトリに直接コミットしないこと
.gitignoreの活用: 機密情報を含む設定ファイル(例:local.properties,secret.properties)は.gitignoreに追加し、リポジトリに含まれないようにします。- テンプレートファイルの提供: 代わりに、設定の雛形となるテンプレートファイル(例:
config.properties.template)をリポジトリに含め、実際の値は各開発者や運用担当者がローカルで設定するようにします。
- 環境変数や外部のシークレット管理システムを利用する:機密情報は、実行環境の環境変数から読み込むか、HashiCorp Vault、AWS Secrets Manager、Google Cloud Secret Manager のような専用のシークレット管理サービスを利用して安全に管理・取得することを強く推奨
- 暗号化の検討:どうしても設定ファイルに機密情報を含める必要がある場合は、Jasypt Spring Boot Starter のようなライブラリを使ってプロパティファイル内の値を暗号化し、アプリケーション起動時に復号する仕組みを導入する方法もあります。ただし、暗号化キーの管理という別の課題が発生する
- Pull Request のレビュー:コードレビューの際には、意図せず機密情報がコミットされていないかを確認するプロセスを設けることも重要
これらのセキュリティ対策を講じることで、プロパティファイルの読み込みの利便性を享受しつつ、情報漏洩のリスクを低減できます。
| REV. | DATE | 内容 |
|---|---|---|
| 5 | 2026-11-19 | 冒頭に最小コードを追加し、文字化け・nullになる原因・クラスパスとファイルパスの違い・XML形式を加筆 |
| 4 | 2026-10-15 | 図解を描き直し(図面のデザインにそろえた) |
| 3 | 2026-10-14 | 雰囲気だけの挿絵を外した |
| 2 | 2026-07-23 | 内容を全体的に見直し(古い記述を4件更新) |
| 1 | 2025-06-07 | 初版 |

