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

Question

我正在开发的项目是一个管理大量自定义硬件设备的C++应用程序.该应用程序具有客户端的套接字/端口接口(如GUI).每种设备类型都有自己定义良好的JSON模式,我们可以使用Cereal对这些模式进行序列化.

但该应用程序还需要解析来自客户端的入站JSON请求.请求的一部分指定设备过滤器参数,大致类似于SQL'WHERE'子句,其中所有表达式都是AND.例如:

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

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

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

现在我可以理解为什么Cereal支持这种详细的地图序列化.毕竟,地图的关键字可以是非字符串类型.但在这种情况下,键是一个字符串.

我并不十分热衷于重写我们的界面规范,并让我们的客户生成明显非惯用的JSON,以满足Cereal.我是谷歌的新手,我们坚持这一点.有没有办法告诉Cereal将此过滤器解析为std :: map？或者我可能是错误的方式.是否还有其他一些我们应该反序列化的stl容器？

Answer 1

让我首先解释为什么谷物输出的风格比你想要的更加冗长.谷物被写成与任意序列化档案一起工作,采取中间立场的方法来满足所有这些.想象一下,键类型比字符串或算术类型更复杂 - 我们怎样才能以简单的"key" : "value"方式序列化它？

另请注意,谷物预计将成为其读入的任何数据的祖先.

话虽这么说,你想要的东西完全可以用谷物,但有一些障碍:

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

其次,谷物目前不希望名称 - 值对中的名称实际上被加载到内存中 - 它只是将它们用作组织工具.

如此漫无边际,这是一个完全有效的解决方案(可以更优雅),对谷物的改变非常小(这实际上使用的是谷物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它使用的档案放置它.您还需要修改Grain中的JSON存档以使用可变大小的JSON对象.要了解如何执行此操作,请查看在获取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"
    }
}