Properties

JavaのPropertiesファイルは KEY=VALUE または KEY:VALUE 形式の設定ファイルで、Javaエコシステムの伝統的な設定形式であり、Unicodeエスケープをサポートする。

目的

Propertiesクラスと併用される、Java標準の設定ファイル形式を提供する。

メカニズム

各行は KEY=VALUE または KEY:VALUE である（どちらの区切り文字も可）。コメントは # または ! である。非ASCII文字は \uXXXX にエスケープされる。ネストはなく、プレフィックスで名前空間を模倣する。java.util.Properties で読み込まれる。

ユースケース

Javaアプリケーションの設定
Spring Bootにおけるapplication.properties
Androidリソース
レガシーJava設定の移行

例

入力

db.url=jdbc:postgres://...

Output

Properties {db.url:...}

A key-value pair

よくあるエラー

Mixing = and : as separators creates ambiguity: Standardize on = as the separator

関連用語

INI は伝統的な設定ファイル形式である。[section] ヘッダーと key=value ペアで設定をグループ化する。シンプルだが標準化されておらず、実装ごとに細部が異なる。

ENV ファイルは KEY=VALUE 形式でアプリケーション設定用の環境変数を定義する。12-Factor アプリの推奨方式である。

YAML（YAML Ain't Markup Language）は、設定向けのデータ直列化形式で、インデントで階層を表し、コメントと参照をサポートし、JSONよりも手書き編集に適する。

関連ツール

Properties から JSON への変換

Properties To Json — 純クライアントサイドツール。プライバシーファースト、サーバー往復なし。

Properties パーサー

Java .properties の KEY=VALUE 行を JSON に解析します。行末バックスラッシュによる行の継続（次の行との結合）はサポートされず、バックスラッシュは値に残り、次の行は新しいエントリとして読み込まれます。「#」または「;」で始まる行はコメントとして扱われます。

Properties 文字列生成

Properties Stringify — 純クライアントサイドツール。プライバシーファースト、サーバー往復なし。

References