ファイル

[C++] jsonパーサーライブラリ(nlohmann-json)の使い方

nlohmann-jsonは、C++でJSONデータを簡単に扱える軽量なライブラリです。

ヘッダオンリーで、追加の依存関係が不要です。

JSONデータをパースするには、nlohmann::json型を使用します。

文字列からJSONオブジェクトを生成したり、オブジェクトを文字列に変換したりできます。

キーを指定して値にアクセスしたり、配列やオブジェクトを動的に構築することも可能です。

目次から探す

nlohmann-jsonとは
- 特徴
- 利用シーン
基本的な使い方
JSONデータの操作
応用的な使い方
- 1. JSONデータのファイル入出力
- 2. JSONデータのマージ
実践例
まとめ

nlohmann-jsonとは

nlohmann-jsonは、C++でJSONデータを簡単に扱うためのライブラリです。

このライブラリは、JSON形式のデータをC++のデータ構造に変換したり、逆にC++のデータ構造をJSON形式に変換したりすることができます。

使いやすさと直感的なインターフェースが特徴で、C++の標準ライブラリに似た感覚でJSONを操作できます。

GitHub – nlohmann/json: JSON for Modern C++

JSON for Modern C++. Contribute to nlohmann/json development by creating an account on GitHub.

GitHub

特徴

シンプルなインターフェース: C++の標準ライブラリに似た使い方ができる。
ヘッダーファイルのみ: インストールが簡単で、ヘッダーファイルをプロジェクトに追加するだけで使用可能。
型安全: C++の型システムを活用して、型安全な操作が可能。
豊富な機能: JSONの読み書きだけでなく、マージや比較などの機能も提供。

利用シーン

設定ファイルの読み込み: アプリケーションの設定をJSON形式で管理。
APIレスポンスの処理: Web APIから取得したJSONデータを簡単に扱う。
データのシリアライズ: C++のオブジェクトをJSON形式に変換して保存。

nlohmann-jsonを使うことで、C++でのJSONデータの操作が格段に楽になります。

次のセクションでは、基本的な使い方について詳しく見ていきます。

基本的な使い方

nlohmann-jsonライブラリを使って、基本的なJSONデータの読み書きを行う方法を紹介します。

まずは、ライブラリをプロジェクトに追加する必要があります。

ヘッダーファイルをインクルードするだけで使用可能です。

以下のサンプルコードでは、JSONデータの作成、読み込み、書き出しの基本的な操作を示します。

#include <iostream>
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
int main() {
    // JSONデータの作成
    json jsonData;
    jsonData["名前"] = "山田太郎"; // 名前を追加
    jsonData["年齢"] = 30; // 年齢を追加
    jsonData["趣味"] = {"読書", "旅行", "プログラミング"}; // 趣味を配列で追加
    // JSONデータの表示
    std::cout << "作成したJSONデータ:\n" << jsonData.dump(4) << std::endl; // 整形して表示
    // JSONデータの読み込み
    std::string jsonString = R"({"名前": "佐藤花子", "年齢": 25, "趣味": ["音楽", "映画"]})"; // JSON文字列
    json loadedData = json::parse(jsonString); // 文字列からJSONデータを読み込む
    // 読み込んだデータの表示
    std::cout << "読み込んだJSONデータ:\n" << loadedData.dump(4) << std::endl; // 整形して表示
    return 0; // プログラムの終了
}

作成したJSONデータ:
{
    "名前": "山田太郎",
    "年齢": 30,
    "趣味": [
        "読書",
        "旅行",
        "プログラミング"
    ]
}
読み込んだJSONデータ:
{
    "名前": "佐藤花子",
    "年齢": 25,
    "趣味": [
        "音楽",
        "映画"
    ]
}

jsonDataオブジェクトを作成し、名前、年齢、趣味を追加しています。
dump(4)メソッドを使うことで、JSONデータを整形して表示できます。
json::parseメソッドを使用して、JSON形式の文字列を読み込み、loadedDataオブジェクトに格納しています。

このように、nlohmann-jsonライブラリを使うことで、JSONデータの作成や読み込みが非常に簡単に行えます。

次のセクションでは、JSONデータの操作について詳しく見ていきます。

JSONデータの操作

nlohmann-jsonライブラリを使用すると、JSONデータの操作が非常に簡単になります。

ここでは、JSONデータの要素の追加、削除、更新、検索などの基本的な操作方法を紹介します。

以下のサンプルコードを通じて、具体的な操作方法を見ていきましょう。

#include <iostream>
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
int main() {
    // 初期のJSONデータ
    json jsonData = {
        {"名前", "山田太郎"},
        {"年齢", 30},
        {"趣味", {"読書", "旅行"}}
    };
    // 要素の追加
    jsonData["職業"] = "エンジニア"; // 職業を追加
    // 要素の更新
    jsonData["年齢"] = 31; // 年齢を更新
    // 要素の削除
    jsonData.erase("趣味"); // 趣味を削除
    // 要素の検索
    if (jsonData.contains("名前")) { // 名前が存在するか確認
        std::cout << "名前: " << jsonData["名前"] << std::endl; // 名前を表示
    }
    // JSONデータの表示
    std::cout << "更新後のJSONデータ:\n" << jsonData.dump(4) << std::endl; // 整形して表示
    return 0; // プログラムの終了
}

名前: 山田太郎
更新後のJSONデータ:
{
    "名前": "山田太郎",
    "年齢": 31,
    "職業": "エンジニア"
}

jsonDataオブジェクトに初期データを設定しています。
jsonData["職業"] = "エンジニア";で新しい要素を追加しています。
jsonData["年齢"] = 31;で既存の要素を更新しています。
jsonData.erase("趣味");で要素を削除しています。
jsonData.contains("名前")を使って、特定のキーが存在するかを確認し、存在する場合はその値を表示しています。

このように、nlohmann-jsonライブラリを使うことで、JSONデータの操作が直感的に行えます。

次のセクションでは、応用的な使い方について詳しく見ていきます。

応用的な使い方

nlohmann-jsonライブラリは、基本的な操作だけでなく、より複雑なデータ構造の操作や、ファイルからの読み書き、データのマージなど、さまざまな応用的な使い方が可能です。

ここでは、これらの応用的な機能について具体的なサンプルコードを交えて紹介します。

1. JSONデータのファイル入出力

JSONデータをファイルに保存したり、ファイルから読み込んだりする方法を見ていきます。

#include <iostream>
#include <fstream> // ファイル入出力用
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
int main() {
    // JSONデータの作成
    json jsonData = {
        {"名前", "山田太郎"},
        {"年齢", 30},
        {"趣味", {"読書", "旅行"}}
    };
    // JSONデータをファイルに書き込む
    std::ofstream outFile("data.json");
    outFile << jsonData.dump(4); // 整形して書き込む
    outFile.close(); // ファイルを閉じる
    // ファイルからJSONデータを読み込む
    json loadedData;
    std::ifstream inFile("data.json");
    inFile >> loadedData; // ファイルから読み込む
    inFile.close(); // ファイルを閉じる
    // 読み込んだデータの表示
    std::cout << "読み込んだJSONデータ:\n" << loadedData.dump(4) << std::endl; // 整形して表示
    return 0; // プログラムの終了
}

読み込んだJSONデータ:
{
    "名前": "山田太郎",
    "年齢": 30,
    "趣味": [
        "読書",
        "旅行"
    ]
}

2. JSONデータのマージ

複数のJSONデータをマージする方法を見ていきます。

#include <iostream>
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
int main() {
    // 2つのJSONデータを作成
    json jsonData1 = {
        {"名前", "山田太郎"},
        {"年齢", 30}
    };
    json jsonData2 = {
        {"趣味", {"読書", "旅行"}},
        {"職業", "エンジニア"}
    };
    // JSONデータのマージ
    json mergedData = jsonData1; // 最初のデータをコピー
    mergedData.update(jsonData2); // 2つ目のデータをマージ
    // マージしたデータの表示
    std::cout << "マージしたJSONデータ:\n" << mergedData.dump(4) << std::endl; // 整形して表示
    return 0; // プログラムの終了
}

マージしたJSONデータ:
{
    "名前": "山田太郎",
    "年齢": 30,
    "趣味": [
        "読書",
        "旅行"
    ],
    "職業": "エンジニア"
}

ファイル入出力: std::ofstreamとstd::ifstreamを使用して、JSONデータをファイルに書き込んだり、ファイルから読み込んだりしています。
マージ: updateメソッドを使って、2つのJSONデータをマージしています。

これにより、異なるデータを一つのJSONオブジェクトにまとめることができます。

これらの応用的な使い方を活用することで、nlohmann-jsonライブラリを使ったC++プログラミングがさらに便利になります。

次のセクションでは、実践例を通じて、具体的な利用シーンを紹介します。

実践例

nlohmann-jsonライブラリを使った実践的な例をいくつか紹介します。

ここでは、設定ファイルの読み込み、APIレスポンスの処理、データのシリアライズといった具体的なシナリオを通じて、ライブラリの活用方法を示します。

1. 設定ファイルの読み込み

アプリケーションの設定をJSON形式で管理し、プログラム内で利用する方法を見ていきます。

#include <iostream>
#include <fstream> // ファイル入出力用
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
int main() {
    // 設定ファイルを読み込む
    std::ifstream configFile("config.json");
    json configData;
    configFile >> configData; // JSONデータを読み込む
    configFile.close(); // ファイルを閉じる
    // 設定内容の表示
    std::cout << "アプリケーション名: " << configData["アプリ名"] << std::endl;
    std::cout << "バージョン: " << configData["バージョン"] << std::endl;
    std::cout << "デバッグモード: " << (configData["デバッグ"] ? "有効" : "無効") << std::endl;
    return 0; // プログラムの終了
}

アプリケーション名: サンプルアプリ
バージョン: 1.0.0
デバッグモード: 有効

2. APIレスポンスの処理

Web APIから取得したJSONデータを処理する方法を見ていきます。

以下の例では、架空のAPIからのレスポンスを模擬しています。

#include <iostream>
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
int main() {
    // 模擬APIレスポンス
    std::string apiResponse = R"({
        "ユーザー": {
            "名前": "佐藤花子",
            "年齢": 25,
            "趣味": ["音楽", "映画"]
        }
    })";
    // JSONデータの解析
    json responseData = json::parse(apiResponse); // 文字列からJSONデータを解析
    // ユーザー情報の表示
    std::cout << "ユーザー名: " << responseData["ユーザー"]["名前"] << std::endl;
    std::cout << "年齢: " << responseData["ユーザー"]["年齢"] << std::endl;
    std::cout << "趣味: ";
    for (const auto& hobby : responseData["ユーザー"]["趣味"]) {
        std::cout << hobby << " "; // 趣味を表示
    }
    std::cout << std::endl;
    return 0; // プログラムの終了
}

ユーザー名: 佐藤花子
年齢: 25
趣味: 音楽 映画

3. データのシリアライズ

C++のオブジェクトをJSON形式に変換して保存する方法を見ていきます。

以下の例では、ユーザー情報をJSON形式で保存します。

#include <iostream>
#include <fstream> // ファイル入出力用
#include <nlohmann/json.hpp> // nlohmann-jsonライブラリのインクルード
using json = nlohmann::json; // json型のエイリアス
struct User {
    std::string name;
    int age;
    std::vector<std::string> hobbies;
};
void saveUserToJson(const User& user, const std::string& filename) {
    json userData = {
        {"名前", user.name},
        {"年齢", user.age},
        {"趣味", user.hobbies}
    };
    std::ofstream outFile(filename);
    outFile << userData.dump(4); // 整形して書き込む
    outFile.close(); // ファイルを閉じる
}
int main() {
    User user = {"山田太郎", 30, {"読書", "旅行"}}; // ユーザー情報の作成
    saveUserToJson(user, "user.json"); // JSONファイルに保存
    std::cout << "ユーザー情報をuser.jsonに保存しました。" << std::endl;
    return 0; // プログラムの終了
}

ユーザー情報をuser.jsonに保存しました。

設定ファイルの読み込み: JSON形式の設定ファイルを読み込み、アプリケーションの設定を表示しています。
APIレスポンスの処理: 模擬的なAPIレスポンスを解析し、ユーザー情報を表示しています。
データのシリアライズ: C++の構造体をJSON形式に変換し、ファイルに保存する方法を示しています。

これらの実践例を通じて、nlohmann-jsonライブラリの活用方法が具体的に理解できるでしょう。

まとめ

この記事では、nlohmann-jsonライブラリを使ったC++におけるJSONデータの基本的な使い方から応用的な機能までを詳しく解説しました。

具体的には、JSONデータの作成、読み込み、操作、ファイル入出力、APIレスポンスの処理、データのシリアライズなど、多岐にわたる機能を紹介しました。

これを機に、nlohmann-jsonライブラリを活用して、C++プログラミングにおけるJSONデータの取り扱いをさらに進めてみてはいかがでしょうか。