c++ - 有没有办法使用 Cereal/C++ 为 std::map 指定更简单的 JSON(反)序列化？

Question

我正在从事的项目是一个管理大量自定义硬件设备的 C++ 应用程序。该应用程序具有用于客户端的套接字/端口接口(interface)(如 GUI)。每种设备类型都有自己明确定义的 JSON 模式，我们可以使用 Cereal 很好地序列化它们。

但应用程序还需要解析来自客户端的入站 JSON 请求。请求的一部分指定了设备过滤器参数，大致类似于一个 SQL“WHERE”子句，其中所有表达式都用“与”运算在一起。例如:

"filter": { "type": "sensor", "status": "critical" }

这表明客户端想要在每个具有“关键”状态的“传感器”设备上执行操作。从表面上看，过滤器参数的 C++ 实现似乎是一个 std::map。但是当我们尝试使用 Cereal 反序列化对象时，它失败了。当我们序列化一个硬编码的过滤器映射时，它看起来像这样:

"filter": [
   { "key": "type", "value": "sensor" },
   { "key": "status", "value": "critical" }
]

现在我可以理解为什么 Cereal 支持这种冗长的 map 序列化了。毕竟，映射的键可以是非字符串类型。但在这种情况下，键是一个字符串。

我并不热衷于重写我们的接口(interface)规范并让我们的客户生成明显非惯用的 JSON 来满足 Cereal。我是 Cereal 的新手，我们一直停留在这一点上。有没有办法告诉 Cereal 将此过滤器解析为 std::map？或者也许我问错了方式。我们应该反序列化到其他一些 STL 容器吗？

Answer 1

首先让我解释一下为什么 cereal 输出的样式比您想要的更冗长。 cereal 被编写为与任意序列化文件一起使用，并采用满足所有这些文件的中间方法。想象一下，键类型是比字符串或算术类型更复杂的东西 - 我们如何以简单的 "key": "value" 方式序列化它？

另请注意， Cereal 希望成为它读入的任何数据的祖先。

---

话虽这么说，你想要的东西完全可以用麦片做，但有一些障碍:

要克服的最大障碍是您所需的输入序列化了 JSON 对象而不是 JSON 数组中一些未知数量的名称-值对。 cereal 被设计为在处理可以容纳可变数量元素的容器时使用 JSON 数组，因为考虑到它使用的底层 rapidjson 解析器，这最有意义。

其次，cereal 目前并不期望名称-值对中的名称实际加载到内存中 - 它只是将它们用作组织工具。

---

如此漫无边际，这里有一个完全有效的解决方案(可以做得更优雅)，只需对 Cereal 进行非常小的改动(实际上使用的改动是 slated for cereal 1.1，当前版本是 1.0):

将此函数添加到 JSONInputArchive:

//! Retrieves the current node name
/*! @return nullptr if no name exists */
const char * getNodeName() const
{
  return itsIteratorStack.back().name();
}

然后您可以为一对字符串编写std::map(或无序，无论您喜欢哪个)序列化的特化。确保将它放在 cereal 命名空间中，以便编译器可以找到它。此代码应存在于您自己的文件中的某处:

namespace cereal
{
  //! Saving for std::map<std::string, std::string>
  template <class Archive, class C, class A> inline
  void save( Archive & ar, std::map<std::string, std::string, C, A> const & map )
  {
    for( const auto & i : map )
      ar( cereal::make_nvp( i.first, i.second ) );
  }

  //! Loading for std::map<std::string, std::string>
  template <class Archive, class C, class A> inline
  void load( Archive & ar, std::map<std::string, std::string, C, A> & map )
  {
    map.clear();

    auto hint = map.begin();
    while( true )
    {
      const auto namePtr = ar.getNodeName();

      if( !namePtr )
        break;

      std::string key = namePtr;
      std::string value; ar( value );
      hint = map.emplace_hint( hint, std::move( key ), std::move( value ) );
    }
  }
} // namespace cereal

---

这不是最优雅的解决方案，但效果很好。我将所有内容都保留为通用模板，但鉴于所做的更改，我上面写的内容仅适用于 JSON 存档。将类似的 getNodeName() 添加到 XML 存档可能会让它在那里工作，但显然这对二进制存档没有意义。

为了使它干净，您需要将 enable_if 放在它周围以用于它使用的存档。您还需要修改 cereal 中的 JSON 存档以使用可变大小的 JSON 对象。要了解如何执行此操作，请查看 cereal 在获取要序列化的 SizeTag 时如何在存档中设置状态。基本上你必须让存档不打开一个数组而是打开一个对象，然后创建你自己的 loadSize() 版本来查看对象有多大(这将是一个 Member 用 rapidjson 的说法)。

---

要查看上面的操作，请运行此代码:

int main()
{
  std::stringstream ss;
  {
    cereal::JSONOutputArchive ar(ss);
    std::map<std::string, std::string> filter = {{"type", "sensor"}, {"status", "critical"}};

    ar( CEREAL_NVP(filter) );
  }

  std::cout << ss.str() << std::endl;

  {
    cereal::JSONInputArchive ar(ss);
    cereal::JSONOutputArchive ar2(std::cout);

    std::map<std::string, std::string> filter;

    ar( CEREAL_NVP(filter) );
    ar2( CEREAL_NVP(filter) );
  }

  std::cout << std::endl;
  return 0;
}

你会得到:

{
    "filter": {
        "status": "critical",
        "type": "sensor"
    }
}
{
    "filter": {
        "status": "critical",
        "type": "sensor"
    }
}