qidao123.com技术社区-IT企服评测·应用市场»论坛 › 安全 › 网络安全 › [Protobuf] 快速上手:安全高效的序列化指南 ...

[Protobuf] 快速上手:安全高效的序列化指南

[复制链接]
发表于 2025-7-19 17:03:59 | 显示全部楼层 |阅读模式
标题：[Protobuf] (1)快速上手
@水墨不写bug



一、什么是protobuf？

Protocol Buffers（简称 protobuf）是由 Google 开发的一种与语言无关、平台无关、可扩展的序列化数据结构的方法。它用于结构化数据的序列化与反序列化，类似于 XML 或 JSON，但更小、更快、更简单。
二、protobuf的特点

protobuf 可以把数据结构（比如对象或消息）编码成紧凑的二进制格式，之后再还原回原始的数据结构。 这阐明protobuf编码是比较安全的，由于二进制无法被直接阅读。
其他重要特点：


  • 跨语言（支持 Java、C++、Python、Go、C#、JavaScript 等多种语言）
  • 二进制格式，高效且体积小
  • 向后兼容和向前兼容性好（得当长期演进的体系）
  • 需要提前定义数据结构（.proto 文件）
减少开发周期和负担
protobuf可以通过protoc编译器来编译proto文件来生成对应的头文件和源文件，内部已经实现了序列化和反序列化的接口。- - - 节省开发时间，制止重复性造轮子
三、使用protobuf的过程？

1、定义消息格式（.proto文件）

(1)指定语法版本

创建**.proto**文件后，首行需要先指定protobuf的语法版本，假如不指定，默认使用proto2。一般我们都使用proto3。 - - - proto3的语法更加简便，支持更多的语言（比如C#）
(2)package 声明符

在proto文件编译之后，假如写了pageage声明，那么cc和h文件内部会被定名空间封装。
假如没有package声明，则cc和h文件的对应类不会被定名空间包裹。
2、使用protoc编译器生成代码

经过1、2两步，后，就可以编写消息的内部数据结构了，假如如下设计(文件名称为 “contact.proto” )：
  1. //首行：语法指定行
  2. syntax = "proto3";
  4. //package 声明符
  5. package contast;
  7. //定义联系人信息
  8. message PersonInfo
  9. {
  10.     string name = 1;
  11.     int32 age = 2;
  12. }
复制代码
下一步就需要编译：
（1）当前目录直接编译：

  1. protoc --cpp_out=. contact.proto
复制代码
这段指令的含义如下：


  • protoc：表示 Protocol Buffers 的编译器程序（Protocol Compiler）。
  • --cpp_out=.：指定生成 C++ 语言的代码文件，并将生成的文件输出到当前目录（. 代表当前目录）。
  • contact.proto：需要被编译的 proto 文件，即你定义了消息结构的协议文件。
综合解释
这条命令的作用是：
使用 Protocol Buffers 的编译器 protoc，将 contact.proto 文件中定义的消息结构，自动生成对应的 C++ 源代码文件（通常为 contact.pb.h 和 contact.pb.cc），并把它们输出到当前目录下。
如许你就可以在 C++ 项目中直接包含和使用这些自动生成的代码了。
（2）指定目录编译

这种情况适用于当前没有处在contact.proto文件所在的目录时：
  1. protoc -I contact_dir/ --cpp_out=contact_dir/ contact.proto
复制代码
这段指令的含义如下：


  • protoc
    Protocol Buffers 的编译器（protocol compiler）。
  • -I contact_dir/
    指定包含 proto 文件的搜索目录（即 import 路径）。表示编译器在 contact_dir/ 目录下查找 proto 文件及其 import 的依赖。
  • --cpp_out=contact_dir/
    指定输出目录为 contact_dir/，并生成 C++ 源代码（通常为 .pb.h 和 .pb.cc 文件）。
  • contact.proto
    要编译的 proto 文件，定义了详细的数据结构。
综合解释：
这条命令会让 protoc 在 contact_dir/ 目录下查找 contact.proto，将其编译为 C++ 源代码，并把生成的 .pb.h 和 .pb.cc 文件输出到同样的 contact_dir/ 目录下。
这种写法常用于项目结构较复杂时，便于管理 proto 文件及生成的代码。
3、在业务中引入并使用生成的类

通过protoc编译proto文件之后，会生成下面两个文件：
  1. // Generated by the protocol buffer compiler.  DO NOT EDIT!
  2. // NO CHECKED-IN PROTOBUF GENCODE
  3. // source: contact.proto
  4. // Protobuf C++ Version: 6.31.0
  6. #include "contact.pb.h"
  8. #include <algorithm>
  9. #include <type_traits>
  10. #include "google/protobuf/io/coded_stream.h"
  11. #include "google/protobuf/generated_message_tctable_impl.h"
  12. #include "google/protobuf/extension_set.h"
  13. #include "google/protobuf/generated_message_util.h"
  14. #include "google/protobuf/wire_format_lite.h"
  15. #include "google/protobuf/descriptor.h"
  16. #include "google/protobuf/generated_message_reflection.h"
  17. #include "google/protobuf/reflection_ops.h"
  18. #include "google/protobuf/wire_format.h"
  19. // @@protoc_insertion_point(includes)
  21. // Must be included last.
  22. #include "google/protobuf/port_def.inc"
  23. PROTOBUF_PRAGMA_INIT_SEG
  24. namespace _pb = ::google::protobuf;
  25. namespace _pbi = ::google::protobuf::internal;
  26. namespace _fl = ::google::protobuf::internal::field_layout;
  27. namespace contact {
  29. inline constexpr Info::Impl_::Impl_(
  30.     ::_pbi::ConstantInitialized) noexcept
  31.       : _cached_size_{0},
  32.         name_(
  33.             &::google::protobuf::internal::fixed_address_empty_string,
  34.             ::_pbi::ConstantInitialized()),
  35.         age_{0} {}
  37. template <typename>
  38. PROTOBUF_CONSTEXPR Info::Info(::_pbi::ConstantInitialized)
  39. #if defined(PROTOBUF_CUSTOM_VTABLE)
  40.     : ::google::protobuf::Message(Info_class_data_.base()),
  41. #else   // PROTOBUF_CUSTOM_VTABLE
  42.     : ::google::protobuf::Message(),
  43. #endif  // PROTOBUF_CUSTOM_VTABLE
  44.       _impl_(::_pbi::ConstantInitialized()) {
  45. }
  46. struct InfoDefaultTypeInternal {
  47.   PROTOBUF_CONSTEXPR InfoDefaultTypeInternal() : _instance(::_pbi::ConstantInitialized{}) {}
  48.   ~InfoDefaultTypeInternal() {}
  49.   union {
  50.     Info _instance;
  51.   };
  52. };
  54. PROTOBUF_ATTRIBUTE_NO_DESTROY PROTOBUF_CONSTINIT
  55.     PROTOBUF_ATTRIBUTE_INIT_PRIORITY1 InfoDefaultTypeInternal _Info_default_instance_;
  56. }  // namespace contact
  57. static constexpr const ::_pb::EnumDescriptor *PROTOBUF_NONNULL *PROTOBUF_NULLABLE
  58.     file_level_enum_descriptors_contact_2eproto = nullptr;
  59. static constexpr const ::_pb::ServiceDescriptor *PROTOBUF_NONNULL *PROTOBUF_NULLABLE
  60.     file_level_service_descriptors_contact_2eproto = nullptr;
  61. const ::uint32_t
  62.     TableStruct_contact_2eproto::offsets[] ABSL_ATTRIBUTE_SECTION_VARIABLE(
  63.         protodesc_cold) = {
  64.         0x081, // bitmap
  65.         PROTOBUF_FIELD_OFFSET(::contact::Info, _impl_._has_bits_),
  66.         5, // hasbit index offset
  67.         PROTOBUF_FIELD_OFFSET(::contact::Info, _impl_.name_),
  68.         PROTOBUF_FIELD_OFFSET(::contact::Info, _impl_.age_),
  69.         0,
  70.         1,
  71. };
  73. static const ::_pbi::MigrationSchema
  74.     schemas[] ABSL_ATTRIBUTE_SECTION_VARIABLE(protodesc_cold) = {
  75.         {0, sizeof(::contact::Info)},
  76. };
  77. static const ::_pb::Message* PROTOBUF_NONNULL const file_default_instances[] = {
  78.     &::contact::_Info_default_instance_._instance,
  79. };
  80. const char descriptor_table_protodef_contact_2eproto[] ABSL_ATTRIBUTE_SECTION_VARIABLE(
  81.     protodesc_cold) = {
  82.     "\n\rcontact.proto\022\007contact"!\n\004Info\022\014\n\004name"
  83.     "\030\001 \001(\t\022\013\n\003age\030\002 \001(\005b\006proto3"
  84. };
  85. static ::absl::once_flag descriptor_table_contact_2eproto_once;
  86. PROTOBUF_CONSTINIT const ::_pbi::DescriptorTable descriptor_table_contact_2eproto = {
  87.     false,
  88.     false,
  89.     67,
  90.     descriptor_table_protodef_contact_2eproto,
  91.     "contact.proto",
  92.     &descriptor_table_contact_2eproto_once,
  93.     nullptr,
  94.     0,
  95.     1,
  96.     schemas,
  97.     file_default_instances,
  98.     TableStruct_contact_2eproto::offsets,
  99.     file_level_enum_descriptors_contact_2eproto,
  100.     file_level_service_descriptors_contact_2eproto,
  101. };
  102. namespace contact {
  103. // ===================================================================
  105. class Info::_Internal {
  106. public:
  107.   using HasBits =
  108.       decltype(::std::declval<Info>()._impl_._has_bits_);
  109.   static constexpr ::int32_t kHasBitsOffset =
  110.       8 * PROTOBUF_FIELD_OFFSET(Info, _impl_._has_bits_);
  111. };
  113. Info::Info(::google::protobuf::Arena* PROTOBUF_NULLABLE arena)
  114. #if defined(PROTOBUF_CUSTOM_VTABLE)
  115.     : ::google::protobuf::Message(arena, Info_class_data_.base()) {
  116. #else   // PROTOBUF_CUSTOM_VTABLE
  117.     : ::google::protobuf::Message(arena) {
  118. #endif  // PROTOBUF_CUSTOM_VTABLE
  119.   SharedCtor(arena);
  120.   // @@protoc_insertion_point(arena_constructor:contact.Info)
  121. }
  122. PROTOBUF_NDEBUG_INLINE Info::Impl_::Impl_(
  123.     ::google::protobuf::internal::InternalVisibility visibility,
  124.     ::google::protobuf::Arena* PROTOBUF_NULLABLE arena, const Impl_& from,
  125.     const ::contact::Info& from_msg)
  126.       : _has_bits_{from._has_bits_},
  127.         _cached_size_{0},
  128.         name_(arena, from.name_) {}
  130. Info::Info(
  131.     ::google::protobuf::Arena* PROTOBUF_NULLABLE arena,
  132.     const Info& from)
  133. #if defined(PROTOBUF_CUSTOM_VTABLE)
  134.     : ::google::protobuf::Message(arena, Info_class_data_.base()) {
  135. #else   // PROTOBUF_CUSTOM_VTABLE
  136.     : ::google::protobuf::Message(arena) {
  137. #endif  // PROTOBUF_CUSTOM_VTABLE
  138.   Info* const _this = this;
  139.   (void)_this;
  140.   _internal_metadata_.MergeFrom<::google::protobuf::UnknownFieldSet>(
  141.       from._internal_metadata_);
  142.   new (&_impl_) Impl_(internal_visibility(), arena, from._impl_, from);
  143.   _impl_.age_ = from._impl_.age_;
  145.   // @@protoc_insertion_point(copy_constructor:contact.Info)
  146. }
  147. PROTOBUF_NDEBUG_INLINE Info::Impl_::Impl_(
  148.     ::google::protobuf::internal::InternalVisibility visibility,
  149.     ::google::protobuf::Arena* PROTOBUF_NULLABLE arena)
  150.       : _cached_size_{0},
  151.         name_(arena) {}
  153. inline void Info::SharedCtor(::_pb::Arena* PROTOBUF_NULLABLE arena) {
  154.   new (&_impl_) Impl_(internal_visibility(), arena);
  155.   _impl_.age_ = {};
  156. }
  157. Info::~Info() {
  158.   // @@protoc_insertion_point(destructor:contact.Info)
  159.   SharedDtor(*this);
  160. }
  161. inline void Info::SharedDtor(MessageLite& self) {
  162.   Info& this_ = static_cast<Info&>(self);
  163.   this_._internal_metadata_.Delete<::google::protobuf::UnknownFieldSet>();
  164.   ABSL_DCHECK(this_.GetArena() == nullptr);
  165.   this_._impl_.name_.Destroy();
  166.   this_._impl_.~Impl_();
  167. }
  169. inline void* PROTOBUF_NONNULL Info::PlacementNew_(
  170.     const void* PROTOBUF_NONNULL, void* PROTOBUF_NONNULL mem,
  171.     ::google::protobuf::Arena* PROTOBUF_NULLABLE arena) {
  172.   return ::new (mem) Info(arena);
  173. }
  174. constexpr auto Info::InternalNewImpl_() {
  175.   return ::google::protobuf::internal::MessageCreator::CopyInit(sizeof(Info),
  176.                                             alignof(Info));
  177. }
  178. constexpr auto Info::InternalGenerateClassData_() {
  179.   return ::google::protobuf::internal::ClassDataFull{
  180.       ::google::protobuf::internal::ClassData{
  181.           &_Info_default_instance_._instance,
  182.           &_table_.header,
  183.           nullptr,  // OnDemandRegisterArenaDtor
  184.           nullptr,  // IsInitialized
  185.           &Info::MergeImpl,
  186.           ::google::protobuf::Message::GetNewImpl<Info>(),
  187. #if defined(PROTOBUF_CUSTOM_VTABLE)
  188.           &Info::SharedDtor,
  189.           ::google::protobuf::Message::GetClearImpl<Info>(), &Info::ByteSizeLong,
  190.               &Info::_InternalSerialize,
  191. #endif  // PROTOBUF_CUSTOM_VTABLE
  192.           PROTOBUF_FIELD_OFFSET(Info, _impl_._cached_size_),
  193.           false,
  194.       },
  195.       &Info::kDescriptorMethods,
  196.       &descriptor_table_contact_2eproto,
  197.       nullptr,  // tracker
  198.   };
  199. }
  201. PROTOBUF_CONSTINIT PROTOBUF_ATTRIBUTE_INIT_PRIORITY1 const
  202.     ::google::protobuf::internal::ClassDataFull Info_class_data_ =
  203.         Info::InternalGenerateClassData_();
  205. PROTOBUF_ATTRIBUTE_WEAK const ::google::protobuf::internal::ClassData* PROTOBUF_NONNULL
  206. Info::GetClassData() const {
  207.   ::google::protobuf::internal::PrefetchToLocalCache(&Info_class_data_);
  208.   ::google::protobuf::internal::PrefetchToLocalCache(Info_class_data_.tc_table);
  209.   return Info_class_data_.base();
  210. }
  211. PROTOBUF_CONSTINIT PROTOBUF_ATTRIBUTE_INIT_PRIORITY1
  212. const ::_pbi::TcParseTable<1, 2, 0, 25, 2>
  213. Info::_table_ = {
  214.   {
  215.     PROTOBUF_FIELD_OFFSET(Info, _impl_._has_bits_),
  216.     0, // no _extensions_
  217.     2, 8,  // max_field_number, fast_idx_mask
  218.     offsetof(decltype(_table_), field_lookup_table),
  219.     4294967292,  // skipmap
  220.     offsetof(decltype(_table_), field_entries),
  221.     2,  // num_field_entries
  222.     0,  // num_aux_entries
  223.     offsetof(decltype(_table_), field_names),  // no aux_entries
  224.     Info_class_data_.base(),
  225.     nullptr,  // post_loop_handler
  226.     ::_pbi::TcParser::GenericFallback,  // fallback
  227.     #ifdef PROTOBUF_PREFETCH_PARSE_TABLE
  228.     ::_pbi::TcParser::GetTable<::contact::Info>(),  // to_prefetch
  229.     #endif  // PROTOBUF_PREFETCH_PARSE_TABLE
  230.   }, {{
  231.     // int32 age = 2;
  232.     {::_pbi::TcParser::SingularVarintNoZag1<::uint32_t, offsetof(Info, _impl_.age_), 1>(),
  233.      {16, 1, 0, PROTOBUF_FIELD_OFFSET(Info, _impl_.age_)}},
  234.     // string name = 1;
  235.     {::_pbi::TcParser::FastUS1,
  236.      {10, 0, 0, PROTOBUF_FIELD_OFFSET(Info, _impl_.name_)}},
  237.   }}, {{
  238.     65535, 65535
  239.   }}, {{
  240.     // string name = 1;
  241.     {PROTOBUF_FIELD_OFFSET(Info, _impl_.name_), _Internal::kHasBitsOffset + 0, 0,
  242.     (0 | ::_fl::kFcOptional | ::_fl::kUtf8String | ::_fl::kRepAString)},
  243.     // int32 age = 2;
  244.     {PROTOBUF_FIELD_OFFSET(Info, _impl_.age_), _Internal::kHasBitsOffset + 1, 0,
  245.     (0 | ::_fl::kFcOptional | ::_fl::kInt32)},
  246.   }},
  247.   // no aux_entries
  248.   {{
  249.     "\14\4\0\0\0\0\0\0"
  250.     "contact.Info"
  251.     "name"
  252.   }},
  253. };
  254. PROTOBUF_NOINLINE void Info::Clear() {
  255. // @@protoc_insertion_point(message_clear_start:contact.Info)
  256.   ::google::protobuf::internal::TSanWrite(&_impl_);
  257.   ::uint32_t cached_has_bits = 0;
  258.   // Prevent compiler warnings about cached_has_bits being unused
  259.   (void) cached_has_bits;
  261.   cached_has_bits = _impl_._has_bits_[0];
  262.   if ((cached_has_bits & 0x00000001u) != 0) {
  263.     _impl_.name_.ClearNonDefaultToEmpty();
  264.   }
  265.   _impl_.age_ = 0;
  266.   _impl_._has_bits_.Clear();
  267.   _internal_metadata_.Clear<::google::protobuf::UnknownFieldSet>();
  268. }
  270. #if defined(PROTOBUF_CUSTOM_VTABLE)
  271. ::uint8_t* PROTOBUF_NONNULL Info::_InternalSerialize(
  272.     const ::google::protobuf::MessageLite& base, ::uint8_t* PROTOBUF_NONNULL target,
  273.     ::google::protobuf::io::EpsCopyOutputStream* PROTOBUF_NONNULL stream) {
  274.   const Info& this_ = static_cast<const Info&>(base);
  275. #else   // PROTOBUF_CUSTOM_VTABLE
  276. ::uint8_t* PROTOBUF_NONNULL Info::_InternalSerialize(
  277.     ::uint8_t* PROTOBUF_NONNULL target,
  278.     ::google::protobuf::io::EpsCopyOutputStream* PROTOBUF_NONNULL stream) const {
  279.   const Info& this_ = *this;
  280. #endif  // PROTOBUF_CUSTOM_VTABLE
  281.   // @@protoc_insertion_point(serialize_to_array_start:contact.Info)
  282.   ::uint32_t cached_has_bits = 0;
  283.   (void)cached_has_bits;
  285.   // string name = 1;
  286.   if ((this_._impl_._has_bits_[0] & 0x00000001u) != 0) {
  287.     if (!this_._internal_name().empty()) {
  288.       const ::std::string& _s = this_._internal_name();
  289.       ::google::protobuf::internal::WireFormatLite::VerifyUtf8String(
  290.           _s.data(), static_cast<int>(_s.length()), ::google::protobuf::internal::WireFormatLite::SERIALIZE, "contact.Info.name");
  291.       target = stream->WriteStringMaybeAliased(1, _s, target);
  292.     }
  293.   }
  295.   // int32 age = 2;
  296.   if ((this_._impl_._has_bits_[0] & 0x00000002u) != 0) {
  297.     if (this_._internal_age() != 0) {
  298.       target =
  299.           ::google::protobuf::internal::WireFormatLite::WriteInt32ToArrayWithField<2>(
  300.               stream, this_._internal_age(), target);
  301.     }
  302.   }
  304.   if (ABSL_PREDICT_FALSE(this_._internal_metadata_.have_unknown_fields())) {
  305.     target =
  306.         ::_pbi::WireFormat::InternalSerializeUnknownFieldsToArray(
  307.             this_._internal_metadata_.unknown_fields<::google::protobuf::UnknownFieldSet>(::google::protobuf::UnknownFieldSet::default_instance), target, stream);
  308.   }
  309.   // @@protoc_insertion_point(serialize_to_array_end:contact.Info)
  310.   return target;
  311. }
  313. #if defined(PROTOBUF_CUSTOM_VTABLE)
  314. ::size_t Info::ByteSizeLong(const MessageLite& base) {
  315.   const Info& this_ = static_cast<const Info&>(base);
  316. #else   // PROTOBUF_CUSTOM_VTABLE
  317. ::size_t Info::ByteSizeLong() const {
  318.   const Info& this_ = *this;
  319. #endif  // PROTOBUF_CUSTOM_VTABLE
  320.   // @@protoc_insertion_point(message_byte_size_start:contact.Info)
  321.   ::size_t total_size = 0;
  323.   ::uint32_t cached_has_bits = 0;
  324.   // Prevent compiler warnings about cached_has_bits being unused
  325.   (void)cached_has_bits;
  327.   ::_pbi::Prefetch5LinesFrom7Lines(&this_);
  328.   cached_has_bits = this_._impl_._has_bits_[0];
  329.   if ((cached_has_bits & 0x00000003u) != 0) {
  330.     // string name = 1;
  331.     if ((cached_has_bits & 0x00000001u) != 0) {
  332.       if (!this_._internal_name().empty()) {
  333.         total_size += 1 + ::google::protobuf::internal::WireFormatLite::StringSize(
  334.                                         this_._internal_name());
  335.       }
  336.     }
  337.     // int32 age = 2;
  338.     if ((cached_has_bits & 0x00000002u) != 0) {
  339.       if (this_._internal_age() != 0) {
  340.         total_size += ::_pbi::WireFormatLite::Int32SizePlusOne(
  341.             this_._internal_age());
  342.       }
  343.     }
  344.   }
  345.   return this_.MaybeComputeUnknownFieldsSize(total_size,
  346.                                              &this_._impl_._cached_size_);
  347. }
  349. void Info::MergeImpl(::google::protobuf::MessageLite& to_msg, const ::google::protobuf::MessageLite& from_msg) {
  350.   auto* const _this = static_cast<Info*>(&to_msg);
  351.   auto& from = static_cast<const Info&>(from_msg);
  352.   // @@protoc_insertion_point(class_specific_merge_from_start:contact.Info)
  353.   ABSL_DCHECK_NE(&from, _this);
  354.   ::uint32_t cached_has_bits = 0;
  355.   (void) cached_has_bits;
  357.   cached_has_bits = from._impl_._has_bits_[0];
  358.   if ((cached_has_bits & 0x00000003u) != 0) {
  359.     if ((cached_has_bits & 0x00000001u) != 0) {
  360.       if (!from._internal_name().empty()) {
  361.         _this->_internal_set_name(from._internal_name());
  362.       } else {
  363.         if (_this->_impl_.name_.IsDefault()) {
  364.           _this->_internal_set_name("");
  365.         }
  366.       }
  367.     }
  368.     if ((cached_has_bits & 0x00000002u) != 0) {
  369.       if (from._internal_age() != 0) {
  370.         _this->_impl_.age_ = from._impl_.age_;
  371.       }
  372.     }
  373.   }
  374.   _this->_impl_._has_bits_[0] |= cached_has_bits;
  375.   _this->_internal_metadata_.MergeFrom<::google::protobuf::UnknownFieldSet>(from._internal_metadata_);
  376. }
  378. void Info::CopyFrom(const Info& from) {
  379. // @@protoc_insertion_point(class_specific_copy_from_start:contact.Info)
  380.   if (&from == this) return;
  381.   Clear();
  382.   MergeFrom(from);
  383. }
  386. void Info::InternalSwap(Info* PROTOBUF_RESTRICT PROTOBUF_NONNULL other) {
  387.   using ::std::swap;
  388.   auto* arena = GetArena();
  389.   ABSL_DCHECK_EQ(arena, other->GetArena());
  390.   _internal_metadata_.InternalSwap(&other->_internal_metadata_);
  391.   swap(_impl_._has_bits_[0], other->_impl_._has_bits_[0]);
  392.   ::_pbi::ArenaStringPtr::InternalSwap(&_impl_.name_, &other->_impl_.name_, arena);
  393.   swap(_impl_.age_, other->_impl_.age_);
  394. }
  396. ::google::protobuf::Metadata Info::GetMetadata() const {
  397.   return ::google::protobuf::Message::GetMetadataImpl(GetClassData()->full());
  398. }
  399. // @@protoc_insertion_point(namespace_scope)
  400. }  // namespace contact
  401. namespace google {
  402. namespace protobuf {
  403. }  // namespace protobuf
  404. }  // namespace google
  405. // @@protoc_insertion_point(global_scope)
  406. PROTOBUF_ATTRIBUTE_INIT_PRIORITY2 static ::std::false_type
  407.     _static_init2_ [[maybe_unused]] =
  408.         (::_pbi::AddDescriptors(&descriptor_table_contact_2eproto),
  409.          ::std::false_type{});
  410. #include "google/protobuf/port_undef.inc"
复制代码
  1. // Generated by the protocol buffer compiler.  DO NOT EDIT!
  2. // NO CHECKED-IN PROTOBUF GENCODE
  3. // source: contact.proto
  4. // Protobuf C++ Version: 6.31.0
  6. #ifndef contact_2eproto_2epb_2eh
  7. #define contact_2eproto_2epb_2eh
  9. #include <limits>
  10. #include <string>
  11. #include <type_traits>
  12. #include <utility>
  14. #include "google/protobuf/runtime_version.h"
  15. #if PROTOBUF_VERSION != 6031000
  16. #error "Protobuf C++ gencode is built with an incompatible version of"
  17. #error "Protobuf C++ headers/runtime. See"
  18. #error "https://protobuf.dev/support/cross-version-runtime-guarantee/#cpp"
  19. #endif
  20. #include "google/protobuf/io/coded_stream.h"
  21. #include "google/protobuf/arena.h"
  22. #include "google/protobuf/arenastring.h"
  23. #include "google/protobuf/generated_message_tctable_decl.h"
  24. #include "google/protobuf/generated_message_util.h"
  25. #include "google/protobuf/metadata_lite.h"
  26. #include "google/protobuf/generated_message_reflection.h"
  27. #include "google/protobuf/message.h"
  28. #include "google/protobuf/message_lite.h"
  29. #include "google/protobuf/repeated_field.h"  // IWYU pragma: export
  30. #include "google/protobuf/extension_set.h"  // IWYU pragma: export
  31. #include "google/protobuf/unknown_field_set.h"
  32. // @@protoc_insertion_point(includes)
  34. // Must be included last.
  35. #include "google/protobuf/port_def.inc"
  37. #define PROTOBUF_INTERNAL_EXPORT_contact_2eproto
  39. namespace google {
  40. namespace protobuf {
  41. namespace internal {
  42. template <typename T>
  43. ::absl::string_view GetAnyMessageName();
  44. }  // namespace internal
  45. }  // namespace protobuf
  46. }  // namespace google
  48. // Internal implementation detail -- do not use these members.
  49. struct TableStruct_contact_2eproto {
  50.   static const ::uint32_t offsets[];
  51. };
  52. extern "C" {
  53. extern const ::google::protobuf::internal::DescriptorTable descriptor_table_contact_2eproto;
  54. }  // extern "C"
  55. namespace contact {
  56. class Info;
  57. struct InfoDefaultTypeInternal;
  58. extern InfoDefaultTypeInternal _Info_default_instance_;
  59. extern const ::google::protobuf::internal::ClassDataFull Info_class_data_;
  60. }  // namespace contact
  61. namespace google {
  62. namespace protobuf {
  63. }  // namespace protobuf
  64. }  // namespace google
  66. namespace contact {
  68. // ===================================================================
  71. // -------------------------------------------------------------------
  73. class Info final : public ::google::protobuf::Message
  74. /* @@protoc_insertion_point(class_definition:contact.Info) */ {
  75. public:
  76.   inline Info() : Info(nullptr) {}
  77.   ~Info() PROTOBUF_FINAL;
  79. #if defined(PROTOBUF_CUSTOM_VTABLE)
  80.   void operator delete(Info* PROTOBUF_NONNULL msg, std::destroying_delete_t) {
  81.     SharedDtor(*msg);
  82.     ::google::protobuf::internal::SizedDelete(msg, sizeof(Info));
  83.   }
  84. #endif
  86.   template <typename = void>
  87.   explicit PROTOBUF_CONSTEXPR Info(::google::protobuf::internal::ConstantInitialized);
  89.   inline Info(const Info& from) : Info(nullptr, from) {}
  90.   inline Info(Info&& from) noexcept
  91.       : Info(nullptr, ::std::move(from)) {}
  92.   inline Info& operator=(const Info& from) {
  93.     CopyFrom(from);
  94.     return *this;
  95.   }
  96.   inline Info& operator=(Info&& from) noexcept {
  97.     if (this == &from) return *this;
  98.     if (::google::protobuf::internal::CanMoveWithInternalSwap(GetArena(), from.GetArena())) {
  99.       InternalSwap(&from);
  100.     } else {
  101.       CopyFrom(from);
  102.     }
  103.     return *this;
  104.   }
  106.   inline const ::google::protobuf::UnknownFieldSet& unknown_fields() const
  107.       ABSL_ATTRIBUTE_LIFETIME_BOUND {
  108.     return _internal_metadata_.unknown_fields<::google::protobuf::UnknownFieldSet>(::google::protobuf::UnknownFieldSet::default_instance);
  109.   }
  110.   inline ::google::protobuf::UnknownFieldSet* PROTOBUF_NONNULL mutable_unknown_fields()
  111.       ABSL_ATTRIBUTE_LIFETIME_BOUND {
  112.     return _internal_metadata_.mutable_unknown_fields<::google::protobuf::UnknownFieldSet>();
  113.   }
  115.   static const ::google::protobuf::Descriptor* PROTOBUF_NONNULL descriptor() {
  116.     return GetDescriptor();
  117.   }
  118.   static const ::google::protobuf::Descriptor* PROTOBUF_NONNULL GetDescriptor() {
  119.     return default_instance().GetMetadata().descriptor;
  120.   }
  121.   static const ::google::protobuf::Reflection* PROTOBUF_NONNULL GetReflection() {
  122.     return default_instance().GetMetadata().reflection;
  123.   }
  124.   static const Info& default_instance() {
  125.     return *reinterpret_cast<const Info*>(
  126.         &_Info_default_instance_);
  127.   }
  128.   static constexpr int kIndexInFileMessages = 0;
  129.   friend void swap(Info& a, Info& b) { a.Swap(&b); }
  130.   inline void Swap(Info* PROTOBUF_NONNULL other) {
  131.     if (other == this) return;
  132.     if (::google::protobuf::internal::CanUseInternalSwap(GetArena(), other->GetArena())) {
  133.       InternalSwap(other);
  134.     } else {
  135.       ::google::protobuf::internal::GenericSwap(this, other);
  136.     }
  137.   }
  138.   void UnsafeArenaSwap(Info* PROTOBUF_NONNULL other) {
  139.     if (other == this) return;
  140.     ABSL_DCHECK(GetArena() == other->GetArena());
  141.     InternalSwap(other);
  142.   }
  144.   // implements Message ----------------------------------------------
  146.   Info* PROTOBUF_NONNULL New(::google::protobuf::Arena* PROTOBUF_NULLABLE arena = nullptr) const {
  147.     return ::google::protobuf::Message::DefaultConstruct<Info>(arena);
  148.   }
  149.   using ::google::protobuf::Message::CopyFrom;
  150.   void CopyFrom(const Info& from);
  151.   using ::google::protobuf::Message::MergeFrom;
  152.   void MergeFrom(const Info& from) { Info::MergeImpl(*this, from); }
  154.   private:
  155.   static void MergeImpl(::google::protobuf::MessageLite& to_msg,
  156.                         const ::google::protobuf::MessageLite& from_msg);
  158.   public:
  159.   bool IsInitialized() const {
  160.     return true;
  161.   }
  162.   ABSL_ATTRIBUTE_REINITIALIZES void Clear() PROTOBUF_FINAL;
  163.   #if defined(PROTOBUF_CUSTOM_VTABLE)
  164.   private:
  165.   static ::size_t ByteSizeLong(const ::google::protobuf::MessageLite& msg);
  166.   static ::uint8_t* PROTOBUF_NONNULL _InternalSerialize(
  167.       const ::google::protobuf::MessageLite& msg, ::uint8_t* PROTOBUF_NONNULL target,
  168.       ::google::protobuf::io::EpsCopyOutputStream* PROTOBUF_NONNULL stream);
  170.   public:
  171.   ::size_t ByteSizeLong() const { return ByteSizeLong(*this); }
  172.   ::uint8_t* PROTOBUF_NONNULL _InternalSerialize(
  173.       ::uint8_t* PROTOBUF_NONNULL target,
  174.       ::google::protobuf::io::EpsCopyOutputStream* PROTOBUF_NONNULL stream) const {
  175.     return _InternalSerialize(*this, target, stream);
  176.   }
  177.   #else   // PROTOBUF_CUSTOM_VTABLE
  178.   ::size_t ByteSizeLong() const final;
  179.   ::uint8_t* PROTOBUF_NONNULL _InternalSerialize(
  180.       ::uint8_t* PROTOBUF_NONNULL target,
  181.       ::google::protobuf::io::EpsCopyOutputStream* PROTOBUF_NONNULL stream) const final;
  182.   #endif  // PROTOBUF_CUSTOM_VTABLE
  183.   int GetCachedSize() const { return _impl_._cached_size_.Get(); }
  185.   private:
  186.   void SharedCtor(::google::protobuf::Arena* PROTOBUF_NULLABLE arena);
  187.   static void SharedDtor(MessageLite& self);
  188.   void InternalSwap(Info* PROTOBUF_NONNULL other);
  189. private:
  190.   template <typename T>
  191.   friend ::absl::string_view(::google::protobuf::internal::GetAnyMessageName)();
  192.   static ::absl::string_view FullMessageName() { return "contact.Info"; }
  194. protected:
  195.   explicit Info(::google::protobuf::Arena* PROTOBUF_NULLABLE arena);
  196.   Info(::google::protobuf::Arena* PROTOBUF_NULLABLE arena, const Info& from);
  197.   Info(
  198.       ::google::protobuf::Arena* PROTOBUF_NULLABLE arena, Info&& from) noexcept
  199.       : Info(arena) {
  200.     *this = ::std::move(from);
  201.   }
  202.   const ::google::protobuf::internal::ClassData* PROTOBUF_NONNULL GetClassData() const PROTOBUF_FINAL;
  203.   static void* PROTOBUF_NONNULL PlacementNew_(
  204.       const void* PROTOBUF_NONNULL, void* PROTOBUF_NONNULL mem,
  205.       ::google::protobuf::Arena* PROTOBUF_NULLABLE arena);
  206.   static constexpr auto InternalNewImpl_();
  208. public:
  209.   static constexpr auto InternalGenerateClassData_();
  211.   ::google::protobuf::Metadata GetMetadata() const;
  212.   // nested types ----------------------------------------------------
  214.   // accessors -------------------------------------------------------
  215.   enum : int {
  216.     kNameFieldNumber = 1,
  217.     kAgeFieldNumber = 2,
  218.   };
  219.   // string name = 1;
  220.   void clear_name() ;
  221.   const ::std::string& name() const;
  222.   template <typename Arg_ = const ::std::string&, typename... Args_>
  223.   void set_name(Arg_&& arg, Args_... args);
  224.   ::std::string* PROTOBUF_NONNULL mutable_name();
  225.   [[nodiscard]] ::std::string* PROTOBUF_NULLABLE release_name();
  226.   void set_allocated_name(::std::string* PROTOBUF_NULLABLE value);
  228.   private:
  229.   const ::std::string& _internal_name() const;
  230.   PROTOBUF_ALWAYS_INLINE void _internal_set_name(const ::std::string& value);
  231.   ::std::string* PROTOBUF_NONNULL _internal_mutable_name();
  233.   public:
  234.   // int32 age = 2;
  235.   void clear_age() ;
  236.   ::int32_t age() const;
  237.   void set_age(::int32_t value);
  239.   private:
  240.   ::int32_t _internal_age() const;
  241.   void _internal_set_age(::int32_t value);
  243.   public:
  244.   // @@protoc_insertion_point(class_scope:contact.Info)
  245. private:
  246.   class _Internal;
  247.   friend class ::google::protobuf::internal::TcParser;
  248.   static const ::google::protobuf::internal::TcParseTable<1, 2,
  249.                                    0, 25,
  250.                                    2>
  251.       _table_;
  253.   friend class ::google::protobuf::MessageLite;
  254.   friend class ::google::protobuf::Arena;
  255.   template <typename T>
  256.   friend class ::google::protobuf::Arena::InternalHelper;
  257.   using InternalArenaConstructable_ = void;
  258.   using DestructorSkippable_ = void;
  259.   struct Impl_ {
  260.     inline explicit constexpr Impl_(::google::protobuf::internal::ConstantInitialized) noexcept;
  261.     inline explicit Impl_(
  262.         ::google::protobuf::internal::InternalVisibility visibility,
  263.         ::google::protobuf::Arena* PROTOBUF_NULLABLE arena);
  264.     inline explicit Impl_(
  265.         ::google::protobuf::internal::InternalVisibility visibility,
  266.         ::google::protobuf::Arena* PROTOBUF_NULLABLE arena, const Impl_& from,
  267.         const Info& from_msg);
  268.     ::google::protobuf::internal::HasBits<1> _has_bits_;
  269.     ::google::protobuf::internal::CachedSize _cached_size_;
  270.     ::google::protobuf::internal::ArenaStringPtr name_;
  271.     ::int32_t age_;
  272.     PROTOBUF_TSAN_DECLARE_MEMBER
  273.   };
  274.   union { Impl_ _impl_; };
  275.   friend struct ::TableStruct_contact_2eproto;
  276. };
  278. extern const ::google::protobuf::internal::ClassDataFull Info_class_data_;
  280. // ===================================================================
  285. // ===================================================================
  288. #ifdef __GNUC__
  289. #pragma GCC diagnostic push
  290. #pragma GCC diagnostic ignored "-Wstrict-aliasing"
  291. #endif  // __GNUC__
  292. // -------------------------------------------------------------------
  294. // Info
  296. // string name = 1;
  297. inline void Info::clear_name() {
  298.   ::google::protobuf::internal::TSanWrite(&_impl_);
  299.   _impl_.name_.ClearToEmpty();
  300.   _impl_._has_bits_[0] &= ~0x00000001u;
  301. }
  302. inline const ::std::string& Info::name() const
  303.     ABSL_ATTRIBUTE_LIFETIME_BOUND {
  304.   // @@protoc_insertion_point(field_get:contact.Info.name)
  305.   return _internal_name();
  306. }
  307. template <typename Arg_, typename... Args_>
  308. PROTOBUF_ALWAYS_INLINE void Info::set_name(Arg_&& arg, Args_... args) {
  309.   ::google::protobuf::internal::TSanWrite(&_impl_);
  310.   _impl_._has_bits_[0] |= 0x00000001u;
  311.   _impl_.name_.Set(static_cast<Arg_&&>(arg), args..., GetArena());
  312.   // @@protoc_insertion_point(field_set:contact.Info.name)
  313. }
  314. inline ::std::string* PROTOBUF_NONNULL Info::mutable_name()
  315.     ABSL_ATTRIBUTE_LIFETIME_BOUND {
  316.   ::std::string* _s = _internal_mutable_name();
  317.   // @@protoc_insertion_point(field_mutable:contact.Info.name)
  318.   return _s;
  319. }
  320. inline const ::std::string& Info::_internal_name() const {
  321.   ::google::protobuf::internal::TSanRead(&_impl_);
  322.   return _impl_.name_.Get();
  323. }
  324. inline void Info::_internal_set_name(const ::std::string& value) {
  325.   ::google::protobuf::internal::TSanWrite(&_impl_);
  326.   _impl_._has_bits_[0] |= 0x00000001u;
  327.   _impl_.name_.Set(value, GetArena());
  328. }
  329. inline ::std::string* PROTOBUF_NONNULL Info::_internal_mutable_name() {
  330.   ::google::protobuf::internal::TSanWrite(&_impl_);
  331.   _impl_._has_bits_[0] |= 0x00000001u;
  332.   return _impl_.name_.Mutable( GetArena());
  333. }
  334. inline ::std::string* PROTOBUF_NULLABLE Info::release_name() {
  335.   ::google::protobuf::internal::TSanWrite(&_impl_);
  336.   // @@protoc_insertion_point(field_release:contact.Info.name)
  337.   if ((_impl_._has_bits_[0] & 0x00000001u) == 0) {
  338.     return nullptr;
  339.   }
  340.   _impl_._has_bits_[0] &= ~0x00000001u;
  341.   auto* released = _impl_.name_.Release();
  342.   if (::google::protobuf::internal::DebugHardenForceCopyDefaultString()) {
  343.     _impl_.name_.Set("", GetArena());
  344.   }
  345.   return released;
  346. }
  347. inline void Info::set_allocated_name(::std::string* PROTOBUF_NULLABLE value) {
  348.   ::google::protobuf::internal::TSanWrite(&_impl_);
  349.   if (value != nullptr) {
  350.     _impl_._has_bits_[0] |= 0x00000001u;
  351.   } else {
  352.     _impl_._has_bits_[0] &= ~0x00000001u;
  353.   }
  354.   _impl_.name_.SetAllocated(value, GetArena());
  355.   if (::google::protobuf::internal::DebugHardenForceCopyDefaultString() && _impl_.name_.IsDefault()) {
  356.     _impl_.name_.Set("", GetArena());
  357.   }
  358.   // @@protoc_insertion_point(field_set_allocated:contact.Info.name)
  359. }
  361. // int32 age = 2;
  362. inline void Info::clear_age() {
  363.   ::google::protobuf::internal::TSanWrite(&_impl_);
  364.   _impl_.age_ = 0;
  365.   _impl_._has_bits_[0] &= ~0x00000002u;
  366. }
  367. inline ::int32_t Info::age() const {
  368.   // @@protoc_insertion_point(field_get:contact.Info.age)
  369.   return _internal_age();
  370. }
  371. inline void Info::set_age(::int32_t value) {
  372.   _internal_set_age(value);
  373.   _impl_._has_bits_[0] |= 0x00000002u;
  374.   // @@protoc_insertion_point(field_set:contact.Info.age)
  375. }
  376. inline ::int32_t Info::_internal_age() const {
  377.   ::google::protobuf::internal::TSanRead(&_impl_);
  378.   return _impl_.age_;
  379. }
  380. inline void Info::_internal_set_age(::int32_t value) {
  381.   ::google::protobuf::internal::TSanWrite(&_impl_);
  382.   _impl_.age_ = value;
  383. }
  385. #ifdef __GNUC__
  386. #pragma GCC diagnostic pop
  387. #endif  // __GNUC__
  389. // @@protoc_insertion_point(namespace_scope)
  390. }  // namespace contact
  393. // @@protoc_insertion_point(global_scope)
  395. #include "google/protobuf/port_undef.inc"
  397. #endif  // contact_2eproto_2epb_2eh
复制代码
假如在main函数中需要对PersonInfo类进利用用，需要包含生成的头文件，别的在编译的时候，还需要指定使用-std=c++11选项以及编译连接库 -lprotobuf。
示例：
  1. #include<iostream>
  2. #include"contact.pb.h"
  3. #include<string>
  4. using std::endl;
  5. using std::cout;
  6. using std::cerr;
  7. int main()
  8. {
  9.     std::string people_str;
  10.     {
  11.         contact::PersonInfo info1;
  12.         info1.set_age(21);
  13.         info1.set_name("张三");
  14.         if(!info1.SerializeToString(&people_str))
  15.         {
  16.             cerr<<"序列化失败"<<endl;
  17.             exit(-1);
  18.         }        
  19.         cout<<"序列化成功"<<endl;
  20.         cout<<"people_str:"<<people_str<<endl;
  21.         cout<<"---------------------------------"<<endl;
  22.     }
  23.     {
  24.         contact::PersonInfo info1;
  25.         
  26.         if(!info1.ParseFromString(people_str))
  27.         {
  28.             cerr<<"反序列化失败"<<endl;
  29.             exit(-1);
  30.         }        
  31.         cout<<"反序列化成功"<<endl;
  32.         cout<<"name:"<<info1.name()<<endl;
  33.         cout<<"age:"<<info1.age()<<endl;
  34.     }
  36.     return 0;
  37. }
复制代码
运行结果：

4、在网络通讯或存储中使用protobuf序列化数据

和本地是类似的，这里不再演示，在反面的讲解和实际项目中再详细展示。
四、快速上手写一个小需求来熟悉怎样编写proto文件？

需求： 我们正在开发一个简单的图书管理体系。需要在客户端和服务器之间传输图书信息。每本图书包含以下内容：


  • 图书ID（整数）
  • 书名（字符串）
  • 作者（字符串）
  • 出书年份（整数，可选）
  • 是否借出（布尔值）
  • 借阅人（字符串，可选，仅在借出时填写）
请根据这个需求，设计一个合适的proto文件。
比较美满的答案如下：
  1. //声明语法版本
  2. syntax = "proto3";
  4. package books;
  6. // 单本图书信息
  7. message Book {
  8.     int64 id = 1;                  // 图书ID
  9.     string title = 2;              // 书名
  10.     string author = 3;             // 作者
  11.     int32 year = 4;                // 出版年份（可选，未知为0）
  12.     bool is_borrowed = 5;          // 是否借出
  13.     string borrower = 6;           // 借阅人（仅借出时填写，否则为空字符串）
  14. }
复制代码
完~

未经作者同意克制转载

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
继续阅读请点击广告

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

×
回复

使用道具 举报

返回列表

灌篮少年
+ 我要发帖
×
登录参与点评抽奖，加入IT实名职场社区
去登录
快速回复 返回顶部 返回列表