Serializing private class members to JSON

By default, the NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE macro that's used to make a type serializable with the nlohmann::json library only works with public members.

To serialize private members, you have a couple of options:

Option 1: Make the private members public (not recommended, as it breaks encapsulation).

Option 2: Use the NLOHMANN_DEFINE_TYPE_INTRUSIVE macro instead and put it in the public section of your class:

1class Character {
2  std::string name;
3  int level;
4
5 public:
6  NLOHMANN_DEFINE_TYPE_INTRUSIVE(
7    Character, name, level)
8
9  const std::string& getName() const {
10    return name;
11  }
12
13  int getLevel() const { return level; }
14};

Now name and level will be serialized even though they're private.

Option 3: Define your own to_json and from_json functions for the type:

1class Character {
2  std::string name;
3  int level;
4
5 public:
6  const std::string& getName() const {
7    return name; }
8  int getLevel() const { return level; }
9
10  friend void to_json(json& j,
11    const Character& c) {
12    j = json{
13      {"name", c.name},
14      {"level", c.level}
15    };
16  }
17
18  friend void from_json(const json& j,
19    Character& c) {
20    j.at("name").get_to(c.name);
21    j.at("level").get_to(c.level);
22  }
23};

By making the to_json and from_json functions friends of the Character class, they can access its private members.

Options 2 and 3 are the recommended ways to serialize private members, as they don't require changing your class's access controls. Which one you choose depends on whether you prefer the convenience of the macro or the flexibility of writing the functions yourself.