草庐IT

c++ - 如何减少当前序列化所需的样板

coder 2023-05-03 原文

我们的软件正在抽象出硬件,并且我们有代表该硬件状态的类,并为该外部硬件的所有属性提供大量数据成员。我们需要定期更新有关该状态的其他组件,为此我们通过 MQTT 和其他消息传递协议(protocol)发送 protobuf 编码的消息。有不同的消息描述硬件的不同方面,因此我们需要发送这些类数据的不同 View 。这是一个草图:

struct some_data {
  Foo foo;
  Bar bar;
  Baz baz;
  Fbr fbr;
  // ...
};

假设我们需要发送一条包含 foobar 的消息,以及一条包含 barbaz 的消息.我们目前的做法是很多样板:

struct foobar {
  Foo foo;
  Bar bar;
  foobar(const Foo& foo, const Bar& bar) : foo(foo), bar(bar) {}
  bool operator==(const foobar& rhs) const {return foo == rhs.foo && bar == rhs.bar;}
  bool operator!=(const foobar& rhs) const {return !operator==(*this,rhs);}
};

struct barbaz {
  Bar bar;
  Baz baz;
  foobar(const Bar& bar, const Baz& baz) : bar(bar), baz(baz) {}
  bool operator==(const barbaz& rhs) const {return bar == rhs.bar && baz == rhs.baz;}
  bool operator!=(const barbaz& rhs) const {return !operator==(*this,rhs);}
};

template<> struct serialization_traits<foobar> {
  static SerializedFooBar encode(const foobar& fb) {
    SerializedFooBar sfb;
    sfb.set_foo(fb.foo);
    sfb.set_bar(fb.bar);
    return sfb;
  }
};

template<> struct serialization_traits<barbaz> {
  static SerializedBarBaz encode(const barbaz& bb) {
    SerializedBarBaz sbb;
    sfb.set_bar(bb.bar);
    sfb.set_baz(bb.baz);
    return sbb;
  }
};

然后可以发送:

void send(const some_data& data) {
  send_msg( serialization_traits<foobar>::encode(foobar(data.foo, data.bar)) );
  send_msg( serialization_traits<barbaz>::encode(barbaz(data.foo, data.bar)) );
}

鉴于要发送的数据集通常比两个项目大得多,我们也需要对这些数据进行解码,并且我们有大量此类消息,因此涉及的样板文件比此草图中的要多得多.所以我一直在寻找减少这种情况的方法。这是第一个想法:

typedef std::tuple< Foo /* 0 foo */
                  , Bar /* 1 bar */
                  > foobar;
typedef std::tuple< Bar /* 0 bar */
                  , Baz /* 1 baz */
                  > barbaz;
// yay, we get comparison for free!

template<>
struct serialization_traits<foobar> {
  static SerializedFooBar encode(const foobar& fb) {
    SerializedFooBar sfb;
    sfb.set_foo(std::get<0>(fb));
    sfb.set_bar(std::get<1>(fb));
    return sfb;
  }
};

template<>
struct serialization_traits<barbaz> {
  static SerializedBarBaz encode(const barbaz& bb) {
    SerializedBarBaz sbb;
    sfb.set_bar(std::get<0>(bb));
    sfb.set_baz(std::get<1>(bb));
    return sbb;
  }
};

void send(const some_data& data) {
  send_msg( serialization_traits<foobar>::encode(std::tie(data.foo, data.bar)) );
  send_msg( serialization_traits<barbaz>::encode(std::tie(data.bar, data.baz)) );
}

我得到了这个工作,它大大减少了样板。 (不是在这个小例子中,但如果你想象有十几个数据点被编码和解码,很多重复的数据成员列表消失会产生很大的不同)。但是,这有两个缺点:

  1. 这依赖于 FooBarBaz 是不同的类型。如果它们都是int,我们需要在元组中添加一个虚拟标签类型。

    这是可以做到的,但它确实使整个想法的吸引力大大降低。

  2. 旧代码中的变量名变成了新代码中的注释和数字。这很糟糕,并且考虑到混淆两个成员的错误很可能出现在编码和解码中,它不能在简单的单元测试中捕获,但需要通过其他技术创建的测试组件(所以集成测试)用于捕获此类错误。

    我不知道如何解决这个问题。

有人知道如何为我们减少样板吗?

注意:

  • 目前,我们还停留在 C++03 上。是的,你没有看错。对我们来说,它是 std::tr1::tuple。没有 lambda 。也没有 auto
  • 我们有大量使用这些序列化特征的代码。我们不能抛弃整个计划,做一些完全不同的事情。我正在寻找一种解决方案来简化 future 代码以适应现有框架。任何需要我们重写整个内容的想法很可能会被驳回。

最佳答案

在我看来,最好的全方位解决方案是使用脚本语言的外部 C++ 代码生成器。它具有以下优点:

  • 灵 active :它允许您随时更改生成的代码。这有几个子原因非常好:

    • 随时修复所有受支持的旧版本中的错误。
    • 如果您将来迁移到 C++11 或更高版本,请使用新的 C++ 功能。
    • 为不同的语言生成代码。这非常非常有用(特别是如果您的组织很大和/或您有很多用户)。例如,您可以输出一个小型脚本库(例如 Python 模块),它可以用作 CLI 工具来与硬件交互。根据我的经验,这很受硬件工程师的欢迎。
    • 生成 GUI 代码(或 GUI 描述,例如 XML/JSON;甚至是 Web 界面)——对使用最终硬件和测试人员的人很有用。
    • 生成其他类型的数据。例如,图表、统计数据等。甚至是 protobuf 描述本身。
  • 维护:它会比 C++ 更容易维护。即使它是用不同的语言编写的,学习该语言通常也比让新的 C++ 开发人员深入研究 C++ 模板元编程(特别是在 C++03 中)更容易。

  • 性能:它可以轻松减少 C++ 端的编译时间(因为您可以输出非常简单的 C++ -- 甚至是纯 C)。当然,生成器可能会抵消这一优势。在您的情况下,这可能不适用,因为您似乎无法更改客户端代码。

我在几个项目/系统中使用了这种方法,结果非常好。特别是使用硬件的不同替代方案(C++ 库、Python 库、CLI、GUI...)非常 非常感谢。


旁注:如果生成的一部分需要解析已经存在的 C++ 代码(例如,具有要序列化的数据类型的 header ,例如在 OP 的情况下使用 Serialized 类型) ;那么一个非常好的解决方案是使用 LLVM/clang's tooling这样做。

在我从事的一个特定项目中,我们必须自动序列化数十种 C++ 类型(用户随时可能更改这些类型)。我们设法通过使用 clang Python 绑定(bind)自动为其生成代码并将其集成到构建过程中。虽然 Python 绑定(bind)没有公开所有 AST 细节(至少在当时),但它们足以为我们的所有类型(包括模板类、容器等)生成所需的序列化代码。

关于c++ - 如何减少当前序列化所需的样板,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/50338443/

有关c++ - 如何减少当前序列化所需的样板的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  7. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  8. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件? - 2

    在选择我想要运行操作的频率时,唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案,但您可以安排它每天运行,并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/8692687/

  9. ruby-on-rails - 如何从 format.xml 中删除 <hash></hash> - 2

    我有一个对象has_many应呈现为xml的子对象。这不是问题。我的问题是我创建了一个Hash包含此数据,就像解析器需要它一样。但是rails自动将整个文件包含在.........我需要摆脱type="array"和我该如何处理?我没有在文档中找到任何内容。 最佳答案 我遇到了同样的问题;这是我的XML:我在用这个:entries.to_xml将散列数据转换为XML,但这会将条目的数据包装到中所以我修改了:entries.to_xml(root:"Contacts")但这仍然将转换后的XML包装在“联系人”中,将我的XML代码修改为

  10. ruby - 如何使用文字标量样式在 YAML 中转储字符串? - 2

    我有一大串格式化数据(例如JSON),我想使用Psychinruby​​同时保留格式转储到YAML。基本上,我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是,当我使用YAML.dump时,它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量?解

随机推荐