JavaでJSONバイト配列をBase64エンコード・デコードする方法

JSONでバイナリデータを送信する際の一般的な手法は、Base64エンコードを使用することです。Javaには、byte[]（バイト配列）をBase64でエンコード・デコードするための方法がいくつか用意されており、その一つがDatatypeConverterクラスです。

ここでは、以下のようなJSONデータを例に説明します。

{
    "menu": {
        "id": "file",
        "value": "File",
        "popup": {
            "menuitem": [
                {"value": "New", "onclick": "CreateNewDoc()"},
                {"value": "Open", "onclick": "OpenDoc()"},
                {"value": "Close", "onclick": "CloseDoc()"}
            ]
        }
    }
}

JSONをBase64にエンコードする

上記のJSONをBase64エンコードするには、次のコードを使用します。

String base64Encoded = DatatypeConverter.printBase64Binary(jsonBytes);

関連記事：

• JavaでJSONをパースする方法
• JavaのMapをJSONに変換する方法
• JavaオブジェクトをJSONに変換する方法

Base64エンコードされたJSONをデコードする

Base64エンコードされたJSONを元の形式に戻すには、次のコードを使用します。

byte[] base64Decoded = DatatypeConverter.parseBase64Binary(base64Encoded);

サンプルコード

エンコードからデコードまでの一連の流れを確認できるサンプルコード全体は以下の通りです。

import javax.xml.bind.DatatypeConverter;

public class JsonEncodeDecode {

    public static void main(String[] args) {
        String json = "{\"menu\": {\n" +
                "  \"id\": \"file\",\n" +
                "  \"value\": \"File\",\n" +
                "  \"popup\": {\n" +
                "    \"menuitem\": [\n" +
                "      {\"value\": \"New\", \"onclick\": \"CreateNewDoc()\"},\n" +
                "      {\"value\": \"Open\", \"onclick\": \"OpenDoc()\"},\n" +
                "      {\"value\": \"Close\", \"onclick\": \"CloseDoc()\"}\n" +
                "    ]\n" +
                "  }\n" +
                "}}";

        byte[] bytes = json.getBytes();

        String base64Encoded = DatatypeConverter.printBase64Binary(bytes);
        System.out.println("Encoded Json:\n");
        System.out.println(base64Encoded + "\n");

        byte[] base64Decoded = DatatypeConverter.parseBase64Binary(base64Encoded);
        System.out.println("Decoded Json:\n");
        System.out.println(new String(base64Decoded));
    }
}

実行結果

エンコードされたJSONの出力：

eyJtZW51IjogewogICJpZCI6ICJmaWxlIiwKICAidmFsdW

注： 出力結果は見やすさのために途中で省略しています。実際には非常に長い文字列が出力されます。

デコードされたJSONの出力：

{
    "menu": {
        "id": "file",
        "value": "File",
        "popup": {
            "menuitem": [
                {"value": "New", "onclick": "CreateNewDoc()"},
                {"value": "Open", "onclick": "OpenDoc()"},
                {"value": "Close", "onclick": "CloseDoc()"}
            ]
        }
    }
}

補足：java.util.Base64の利用について

javax.xml.bind.DatatypeConverterはJava 11以降の標準ライブラリから削除されているため、現在の開発ではjava.util.Base64クラスの使用が推奨されています。同じ処理は以下のように書き換えられます。

import java.util.Base64;

// エンコード
String base64Encoded = Base64.getEncoder().encodeToString(bytes);

// デコード
byte[] base64Decoded = Base64.getDecoder().decode(base64Encoded);