Java のプロパティファイルは UTF-8 エンコーディングで記述したい

「えーマジ native2ascii!?」「プロパティエディタプラグインが許されるのは J2SE 5.0 までだよねー」

ジャバエンジニアはそろそろ、プロパティファイルを扱う場合に native2ascii やら各種プロパティエディタプラグインやらの呪縛から解放されてもいいと思うのです…

概要

Java でアプリケーションの各種設定を記述したプロパティファイル (.properties) を取り扱う場合、 Properties クラスもしくは ResourceBundle クラスのお世話になるかと思います。

一昔前までは、プロパティファイル内で日本語などいわゆるマルチバイト文字を含む場合に、 native2ascii コマンドを利用して ASCII コードの文字のみで表現できる ユニコードエスケープ (!= UTF-xx エンコーディング) 表現に変換することが必要とされていました。

しかし、Java は 7 or 8 がメインストリームになり、また UTF-8 エンコーディングされたテキストを取り扱うことがわりと当たり前になりつつある昨今、いまだに Eclispe にわざわざプロパティエディタプラグインを導入してプロパティファイルをしこしこ編集したり、プロダクション環境でユニコードエスケープされたプロパティファイルを四苦八苦しながらパラメータ調整したりする現場があったりなかったりするようなので、ここで native2ascii とかプロパティエディタプラグインを必要と せずに UTF-8 エンコーディングされたプロパティファイルを扱う方法についてメモしておきます。

UTF-8 エンコーディングされたプロパティファイルを取り扱う方法

Properties クラスと ResourceBundle クラスそれぞれについて説明します。

その 1 : Properties クラスを使う場合

Properties#load(Reader) メソッドを呼び出す際の Reader オブジェクトを、UTF-8 エンコーディング指定した InputStreamReader オブジェクトにすれば OK です。

すなわち、以下のような実装になるでしょう。

	import java.io.*;
	import java.util.Properties;
	/**
	* UTF-8 エンコーディングされたプロパティファイルを {@link Properties} クラスで取り扱う。
	*/
	public class PropertiesWithUtf8 {
	static Properties loadUtf8Properties(String resourceName) throws IOException {
	try (InputStream is = PropertiesWithUtf8.class.getResourceAsStream(resourceName);
	InputStreamReader isr = new InputStreamReader(is, "UTF-8");
	BufferedReader reader = new BufferedReader(isr)) {
	Properties result = new Properties();
	// Properties#load() で渡す Reader オブジェクトを UTF-8 エンコーディング指定して生成した
	// InputStreamReader オブジェクトにする
	result.load(reader);
	return result;
	}
	}
	public static void main(String[] args) throws IOException {
	Properties prop = loadUtf8Properties("/utf8.properties");
	System.out.println(prop.getProperty("いろはにほへと"));
	}
	}

view raw PropertiesWithUtf8.java hosted with ❤ by GitHub

その 2 : ResourceBundle クラスを使う場合

こちらは若干複雑になりますが、 ResourceBundle.Control クラスのサブクラスを用意して対処する方法をとります。

同クラスの newBundle() メソッドのオーバーライド実装にて、 Properties のときと同様に UTF-8 エンコーディング指定した InputStreamReader オブジェクトを用意し、 PropertyResourceBundle クラスのコンストラクタ引数にそのオブジェクトを指定します。

そして実際に ResourceBundle クラスのオブジェクトを取得する際に、その ResourceBundle.Control サブクラスのオブジェクトを ResourceBundle.getBundle(String, ResourceBundle.Control) メソッドの二つ目の引数に指定してやることで、UTF-8 エンコーディングなプロパティファイルを取り扱うことができるようになります。

実装は以下のとおり。

	import java.io.BufferedReader;
	import java.io.IOException;
	import java.io.InputStream;
	import java.io.InputStreamReader;
	import java.util.Locale;
	import java.util.PropertyResourceBundle;
	import java.util.ResourceBundle;
	/**
	* UTF-8 エンコーディングされたプロパティファイルを {@link ResourceBundle} クラスで取り扱う。
	*/
	public class ResourceBundleWithUtf8 {
	private static ResourceBundle.Control UTF8_ENCODING_CONTROL = new ResourceBundle.Control() {
	/**
	* UTF-8 エンコーディングのプロパティファイルから ResourceBundle オブジェクトを生成します。
	* <p>
	* 参考 :
	* <a href="http://jgloss.sourceforge.net/jgloss-core/jacoco/jgloss.util/UTF8ResourceBundleControl.java.html">
	* http://jgloss.sourceforge.net/jgloss-core/jacoco/jgloss.util/UTF8ResourceBundleControl.java.html
	* </a>
	* </p>
	*
	* @throws IllegalAccessException
	* @throws InstantiationException
	* @throws IOException
	*/
	@Override
	public ResourceBundle newBundle(String baseName, Locale locale, String format, ClassLoader loader, boolean reload)
	throws IllegalAccessException, InstantiationException, IOException {
	String bundleName = toBundleName(baseName, locale);
	String resourceName = toResourceName(bundleName, "properties");
	try (InputStream is = loader.getResourceAsStream(resourceName);
	InputStreamReader isr = new InputStreamReader(is, "UTF-8");
	BufferedReader reader = new BufferedReader(isr)) {
	return new PropertyResourceBundle(reader);
	}
	}
	};
	public static void main(String[] args) {
	ResourceBundle bundle = ResourceBundle.getBundle("utf8", UTF8_ENCODING_CONTROL);
	System.out.println(bundle.getString("いろはにほへと"));
	}
	}

view raw ResourceBundleWithUtf8.java hosted with ❤ by GitHub

まとめ

• Properties も ResourceBundle もどちらも、文字エンコーディング指定した InputStreamReader オブジェクトを扱うようにすれば、 native2ascii 的な呪縛から逃れることができるよ
• UTF-8 エンコーディングなどにしておけば、プロダクション環境上でプロパティファイルをどうしても確認しなきゃいけなくなった場合でも、プロパティファイルに記述した日本語コメントを頼りにスムーズな確認ができるようになるよね
• プロパティエディタプラグインはもうオワコン扱いでいいよね