JavaにおけるJsonPatchインターフェースの重要性とは？JSONパッチ操作の基本を解説

JavaのJSON Processing APIに含まれるJsonPatchインターフェースは、対象となるJSON構造に適用可能な一連の操作（オペレーション）を格納するためのフォーマットです。

パッチとして保存できる主な操作には、add（追加）、remove（削除）、replace（置換）、copy（コピー）、move（移動）、test（検証）の6種類があります。これらの操作を組み合わせることで、元のJSONドキュメントを直接書き換えることなく、差分だけを効率的に管理し、必要なタイミングで一括して適用することが可能になります。

また、JsonPatchBuilderインターフェースを使用すると、Json.createPatchBuilder()メソッドを通じてJSONパッチを直感的かつ柔軟に構築できます。

JSONファイルの例

以下のような「simple.json」を入力ファイルとして用意します。

サンプルコード

次のコードでは、JsonPatchBuilderを使って「postalCodeフィールドの追加」と「ageフィールドの削除」を行うパッチを作成し、既存のJSON構造へ適用しています。

import java.io.*;
import javax.json.Json;
import javax.json.JsonPatch;
import javax.json.JsonPatchBuilder;
import javax.json.JsonReader;
import javax.json.JsonStructure;

public class JsonPatchTest {
    public static void main(String[] args) throws Exception {
        // パッチビルダーの生成
        JsonPatchBuilder jsonPatchBuilder = Json.createPatchBuilder();

        // postalCodeを追加し、ageを削除するパッチを構築
        JsonPatch jsonPatch = jsonPatchBuilder.add("/postalCode", "500072").remove("/age").build();

        // JSONファイルを読み込み
        JsonReader reader = Json.createReader(new FileReader("simple.json"));
        JsonStructure jsonStructure1 = reader.read();

        // パッチを適用して新しいJSON構造を生成
        JsonStructure jsonStructure2 = jsonPatch.apply(jsonStructure1);

        System.out.println(jsonStructure2);
        reader.close();
    }
}

実行結果

パッチ適用後の出力は以下の通りです。「postalCode」が新たに追加され、「age」が削除されていることが確認できます。

{"firstName":"Raja","lastName":"Ramesh","streetAddress":"Madhapur","city":"Hyderabad","state":"Telangana","phoneNumbers":[{"Mobile":"9959984000"},{"Home":"7702144400"}],"postalCode":"500072"}

このようにJsonPatchを活用することで、JSONデータの変更履歴を明確に保ちながら、安全かつ再現性のあるデータ更新処理を実現できます。APIリクエストの差分送信や設定ファイルの部分更新など、さまざまな場面で役立つ強力な仕組みです。