由消息生成类

protobuf与编程语言独立，仅仅定义了消息，是无法使用它们的。在proto文件定义消息后，要将消息转成特定编程语言中的类型，来应用消息。以下以C++为例。

protoc编译A.proto文件生成A.pb.h和A.pb.cc文件。

"protoc -I=${SRC_DIR} --cpp_out=${DST_DIR} ${SRC_DIR}/A.proto "

A.pb.*里面有proto文件中定义的消息对应的C++类。

包

包转换成C++中的命名空间。

package foo.bar;
foo::bar

消息

消息转换成C++的类。

message Foo {}

生成一个类Foo，继承自google::protobuf::Message。

class Foo final : public ::google::protobuf::Message {
public:
 Foo(); 
 virtual ~Foo();
 Foo(const Foo& from);
 ...其它成员不列举
};

内嵌消息

message Foo { 
 message Bar {} 
}

生成类Foo和Foo_Bar。但是在Foo内部，定义Bar类型。因此有Foo::Bar类型。

class Foo_Bar final : public ::google::protobuf::Message {
public:
 Foo_Bar();
 ....
};
class Foo final : public ::google::protobuf::Message {
public: 
typedef Foo_Bar Bar;
 Foo();
 ....
};

由字段生成类的数据成员

数字类型字段

数字字段会对应到类的数值成员。并且有对应的操作函数。

以int32型字段为例。

proto2

message ABC{
 optional int32 foo = 1;
}

字段foo操作函数。

• bool has_foo() const: 字段foo是否设置过
• ::google::protobuf::int32 foo() const: 返回字段foo的值。如果没有设置过，返回默认值
• void set_foo(::google::protobuf::int32 value): 设置字段foo的值
• void clear_foo(): 清除字段foo，之后foo()返回默认值

proto3

相对与proto2少了个has_foo函数，其它与proto2一致。

message ABC{
 int32 foo = 1;
}

字段foo操作函数。

• ::google::protobuf::int32 foo() const: 返回字段foo的值。如果没有设置过，返回0
• void set_foo(::google::protobuf::int32 value): 设置字段foo的值
• void clear_foo(): 清除字段foo，之后foo()返回0

字符串字段

proto2

在protobuf内部，bytes类型等同于string类型。两者的接口函数一致。

message ABC{
 optional string foo = 1;
}
message ABC{
 optional bytes foo = 1;
}

成员函数。

bool has_foo() const; 是否设置过foo
void clear_foo(); 清理foo的内容，不释放内存
const ::std::string& foo() const; foo const引用
void set_foo(const ::std::string& value); 以下几种set函数
void set_foo(::std::string&& value);
void set_foo(const char* value);
void set_foo(const char* value, size_t size);
::std::string* mutable_foo(); foo的指针，可修改
::std::string* release_foo(); 释放字段的所有权并返回字符串对象的指针。调用它之后，调用者获取分配的字符串对象的所有权，has_foo（）将返回false，并且foo（）将返回默认值
void set_allocated_foo(::std::string* foo); 对象内部原先的foo指针被释放，用别处分配的foo，替换原先的指针。

proto3

message ABC{ 
string foo = 1;
}
message ABC{
 bytes foo = 1;
}

成员函数少了个has_foo函数，其它函数与proto2一致。

枚举类型字段

proto2

enum Bar {
 BAR_A = 0;
 BAR_B = 1;
}
message ABC{
 optional Bar foo=1
}

对应的C++枚举类型

enum Bar {
 BAR_A = 0,
 BAR_B = 1,
};

类ABC中关于foo的成员函数。

void clear_foo();
::use::Bar foo() const;
void set_foo(::use::Bar value);

proto3 中少了个has_foo函数其它一致。

消息类型字段

字段类型是另一种定义的消息。

message Bar {}
//proto2
message ABC{
 optional Bar foo = 1;
}

ABC类会产生函数，这些函数操作的意义与string字段操作函数的意义一致：

bool has_foo() const; 
void clear_foo();
const ::use::Bar& foo() const; 
::use::Bar* release_foo(); 
::use::Bar* mutable_foo();
void set_allocated_foo(::use::Bar* foo);

数值数组类型字段

数组类型的字段操作函数是重点，也是容易出错的类型。

message ABC{
repeated int32 foo = 1;
}

RepeatedField相关的函数是重点。可以与STL的vector容器的操作函数类比。

• int foo_size() const: 返回字段中当前元素的数量。
• int32 foo(int index) const: 返回给定索引处的元素。使用索引超出[0，foo_size（））调用此方法会产生未定义的行为。
• void set_foo(int index, int32 value): 设置给定索引处元素的值。
• void add_foo(int32 value): 向字段追加新元素。
• void clear_foo(): 从字段中删除所有元素。调用它之后，foo_size（）将返回零。
• const RepeatedField<int32> & foo() const: 返回存储字段元素的基础RepeatedField引用。此容器类提供类似STL的迭代器和其他方法。
• RepeatedField<int32>* mutable_foo(): 返回指向存储字段元素的基础可变RepeatedField的指针。此容器类提供类似STL的迭代器和其他方法。

字符串数组类型字段

字符串类型的数组。

message ABC{
repeated string foo = 1;
或
repeated bytes foo = 1;
}

RepeatedPtrField相关的函数是重点。可以与STL的vector容器的操作函数类比。

int foo_size() const;
void clear_foo();
const ::std::string& foo(int index) const;
::std::string* mutable_foo(int index); 返回index处，可修改的指针
void set_foo(int index, const ::std::string& value); 以下几个类似的set函数
#if LANG_CXX11
void set_foo(int index, ::std::string&& value);
#endif
void set_foo(int index, const char* value);
void set_foo(int index, const char* value, size_t size);
::std::string* add_foo(); 向尾部添加空串，并返回指针
void add_foo(const ::std::string& value); 以下几个类似的向尾部添加串
#if LANG_CXX11
void add_foo(::std::string&& value);
#endif
void add_foo(const char* value);
void add_foo(const char* value, size_t size);
const ::google::protobuf::RepeatedPtrField<::std::string>& foo() const;
::google::protobuf::RepeatedPtrField<::std::string>* mutable_foo();

枚举数组类型字段

与int数组类型字段类似。操作函数也类似。

enum Bar {
 BAR_A = 0;
 BAR_B = 1;
}
message ABC{
repeated Bar foo = 1;
}

消息数组类型字段

与string数组类型字段的函数类似。

message Bar {}
message ABC{
repeated Bar foo = 1;
}

ABC类中Bar类型的操作函数。

int foo_size() const;
void clear_foo();
::use::Bar* mutable_foo(int index);
::google::protobuf::RepeatedPtrField< ::use::Bar >* mutable_foo();
const ::use::Bar& foo(int index) const;
::use::Bar* add_foo();
const ::google::protobuf::RepeatedPtrField< ::use::Bar >& foo() const;

Map类型字段

message ABC{
map<int32, int32> foo = 1;
}

foo操作函数。

int foo_size() const;
void clear_foo();
const ::google::protobuf::Map< ::google::protobuf::int32, ::google::protobuf::int32 >& foo() const;
::google::protobuf::Map< ::google::protobuf::int32, ::google::protobuf::int32 >*
 mutable_foo();

google::protobuf::Map的定义，与std::map的接口类似。与std::map可相互转化。

std::map<int32, int32> standard_map(message.foo().begin(),
 message.foo().end());
google::protobuf::Map<int32, int32> foo(standard_map.begin(), standard_map.end());