概要
Java の JSON ライブラリ minimal-json の使い方について説明します。
Java で JSON を扱う
これまで(~JDK 1.8)の Java には標準で JSON ライブラリが提供されていないので、JSON を効率的に扱うには何かしらのライブラリを用いる必要がありました。OSS の有名どころだと下記が挙げられます。
| Library | License | Link |
|---|---|---|
| org.json | JSON | MVNRepository.com |
| Jackson | Apache License 2.0 | GitHub / MVNRepository.com |
| JSONIC | Apache License 2.0 | Official site / MVNRepository.com |
| Gson | Apache License 2.0 | GitHub / MVNRepository.com |
| JsonPath | Apache License 2.0 | GitHub / MVNRepository.com |
それぞれのライブラリの使い方は Qiita やインターネットで検索すれば見つかると思いますので、この記事では取り上げません。
minimal-json？
名前の通り、 JSON の読み書きにフォーカスした小さな Java ライブラリです。MIT ライセンス で公開されています。リポジトリの README.md を見ると、「これ本当なの？」と言いたくなるような高パフォーマンスを示すグラフが出てきます。
クラス数はさほど多くなく、バージョン 0.9.4 では下記の15個だけのようです。jar のファイルサイズは 29.7 KB です。
- Json.java
- JsonArray.java
- JsonHandler.java
- JsonLiteral.java
- JsonNumber.java
- JsonObject.java
- JsonParser.java
- JsonString.java
- JsonValue.java
- JsonWriter.java
- Location.java
- ParseException.java
- PrettyPrint.java
- WriterConfig.java
- WritingBuffer.java
開発状況
GitHub の Release によると、最後のリリースが 2015/07/20 で、最新 commit は半年前の 2016/10/25 でした。開発自体はまだ続いているようです。
なぜ minimal-json か？
単純な JSON の読み書きをしたいだけであれば Gson や Jackson だと機能が多すぎ、シンプルな機能だけを持っている org.json は JSON ライセンス1ということで、意外に選択肢がありませんでした。この minimal-json は JSON のパースにしか使えませんが、前述の通り15のクラスだけで構成されており、 MIT ライセンスであるため、org.json を使いたい場合の代替として選択肢になりうる存在です。
なお、このライブラリには Gson や Jackson で提供されているような、オブジェクトとのマッピングをする機能はありませんので、そういった機能が必要であるなら、マッピングのコードを自分で実装するよりは別のライブラリを使う方がよいでしょう。
導入
build.gradle の dependencies に1行追加するだけです。記事を書いている段階での最新バージョンは 0.9.4 でした。
Gradle
dependencies {
compile 'com.eclipsesource.minimal-json:minimal-json:0.9.4'
Maven
<dependency>
<groupId>com.eclipsesource.minimal-json</groupId>
<artifactId>minimal-json</artifactId>
<version>0.9.4</version>
</dependency>
上記以外はこちら をご覧ください。
使用
JSON の文字列を生成
new で空のオブジェクトを生成し、それに add メソッドで key と値を追加できます。toString() メソッドで JSON 文字列にできます。
final JsonObject json = new JsonObject();
json.add("name", "Bill");
json.add("age", 24);
System.out.println(json.toString());
{"name":"Bill","age":24}
文字列から JsonObject オブジェクトの生成
Json#parse に JSON 文字列を渡し、asObject() で JSON Object を取り出します。
final JsonObject json = Json.parse(jsonStr).asObject();
値の取り出し
String/int/double/float/long/boolean については専用のget～～メソッドがあります。読み込む JSON が完全にアプリケーション開発者の管理下に置かれていて、フォーマットが固定であるなら、これらのメソッドを使ってもよいでしょう。
key を文字列で指定して値を取り出します。第2引数には key がなかった時のデフォルト値を指定します。
json.getString("name", "")
例えば、下記のようなシンプルな JSON があるとします。
{"name": "John", "age": 28}
これをパースして値を取り出し、標準出力に表示するコードは下記の通りです。
final JsonObject json = Json.parse("{\"name\": \"John\", \"age\": 28}").asObject();
System.out.println(json.getString("name", "-"));
System.out.println(json.getInt("age", -1));
なお、 age は int なので、String として取り出そうとすると java.lang.UnsupportedOperationException が出ます。
System.out.println(json.getString("age", "-"));
java.lang.UnsupportedOperationException: Not a string: 28
int の値を String として取り出したい場合は get(key) で取り出した JsonValue オブジェクトを toString() するとよさそうです。
System.out.println(json.get("age").toString());
ただ、その場合は json.get("age") が null を返し得ることに注意してください。
final JsonValue nullable = json.get("age");
if (nullable != null) {
System.out.println(nullable.toString());
}
Optional が使える環境であれば併用するとよいでしょう。
Optional.ofNullable(json.get("age"))
.map(JsonValue::toString)
.ifPresent(System.out::println);
null 対応
例えば、下記のようなシンプルな JSON があるとします。
{"name": "John", "age": 28, "nullable": null}
"nullable" を getString しようとすると、下記のエラーが出ます。 defaultValue を役立ててほしいところですが……
java.lang.UnsupportedOperationException: Not a string: null
at com.eclipsesource.json.JsonValue.asString(JsonValue.java:389)
at com.eclipsesource.json.JsonObject.getString(JsonObject.java:674)
at jp.toastkid.libs.epub.EpubMetaData.readJson(EpubMetaData.java:114)
ちなみに、下記だと例外は回避できますが、標準出力に null と表示されます。
Optional.ofNullable(json.get("nullable"))
.map(JsonValue::toString)
.ifPresent(System.out::println);
「Optional ってそういう仕様だったかな」と思って、下記のコードを実行したら解決しました。この null は Java の null ではなく JSON リテラルの null (com.eclipsesource.json.JsonLiteral)として解釈されていたようです。
Optional.ofNullable(json.get("nullable"))
.map(Object::getClass)
.map(Class::getName)
.ifPresent(System.out::println);
com.eclipsesource.json.JsonLiteral
えー、ここまで見てきてそろそろお気づきかと思います。このライブラリで JSON から取り出した値を扱う場合は get で取り出して JsonValue オブジェクトを介してアクセスした方が安全ですし、 null チェックも容易です。Optional を組み合わせるとよりいい具合になります。
残念な点
JsonArray が Java 8 対応不十分
JsonArray クラスは Iterable の実装 です。stream() がないので Stream API が使えず、イテレーションに使えるメソッドは forEach くらいしか提供されていません。せめて filter / map くらいは欲しいところです。
has 系のメソッドがない
なぜ Optional を持ち出したのかというと、キーの存在を確認するメソッドがないからです。うーん、そう考えると、このライブラリを 1.7 以下で使うのはちょっときついのではないかと……if での null チェックが大量に並ぶコードになります。
まとめ
ごく簡単な JSON の操作ができる Java ライブラリ minimal-json の特徴と導入方法について述べました。値の取り出しには get(key) を使った方が安全で、 Optional と組み合わせて使うと良い感じになります。
-
The Software shall be used for Good, not Evil.の解釈で、保守的なソフトウェアライセンス管理ポリシーを採用している会社だと、JSON ライセンスのライブラリは使用を認められないケースがあります。「JSON ライセンスは org.json のコードには適用されていない」という見解もあるようですが、Java の JSON ライブラリで代替品がある以上は無用のリスクを抱える必要もない、という判断がされる可能性が高いのではないかと思います。ちなみに、Android SDK には org.json のライブラリが含まれている のですが、特にライセンス面で問題があるという話は聞いていません。 ↩