準備:
在http://code.google.com/p/protobuf/下載protobuf-2.5版本
預備知識: 已經使用過protobuf, 熟練應用protobuf序列化在各語言間交互信息
目標: 獲取proto內容而無需手動解析proto文件
為proto文件添加更多的meta信息, 并在運行期獲取.
protoc編譯器準備
通過protobuf-2.5的源碼或者從官網下載, 可以獲得protoc的protobuf編譯器, 這個編譯器由C++編寫, 官方支持完整的protobuf特性. 編譯器默認支持C++, python和java 三種語言的代碼生成. 如需生成更多的語言, 可以通過官網的第三方頁面獲取.
protoc插件原理
但我們在日常使用中, 可能需要提取proto信息, 例如: 所有的枚舉,消息等信息, 字段名稱和導出號. 自己編寫詞法解析器來做是費力不討好的. 官方推薦的方法是使用protoc外掛插件來實現.
protoc的插件設計比較獨特, 不使用動態鏈接庫或者java的jar包導入方式, 而是直接使用了命令行來交換數據.查看protobuf源碼我們可以發現這樣一個文件:
protobuf-2.5.0\src\google\protobuf\descriptor.proto
這個文件描述了一個proto文件的格式, 消息組成及枚舉等完整信息. 這是一種自我描述的方法.
在找到這樣一個文件
protobuf-2.5.0\src\google\protobuf\compiler\plugin.proto
這樣一個文件描述: 插件如何與protoc進行交互的協議
protoc編譯器在給定指定proto文件及搜索路徑后, 將各種信息填充為descriptor.proto描述的結構后通過CodeGeneratorRequest消息系列化為二進制流后輸出到命令行. 插件只用捕獲protoc命令行輸出的二進制流, 序列化化回CodeGeneratorRequest即可獲得解析后的proto文件內容
這里需要注意的是: 插件可執行文件很有講究, 必須為protoc-gen-$NAME, 而且輸出文件名參數必須為--${NAME}_out
看一個栗子:
protoc.exe foo.proto --plugin=protoc-gen-go=..\tools\protoc-gen-go.exe --go_out foo.go --proto_path "."
這個栗子里: $NAME=go
protoc將foo.proto文件(搜索路徑為當前路徑)的內容通過命令行輸出給位于..\tools\的插件protoc-gen-go.exe, 輸出文件名字為 foo.go
descriptor.proto信息挖掘
我們注意到在descriptor.proto文件中包含有這樣的一個message: SourceCodeInfo, 這個消息體里有如下字段
optional string leading_comments = 3;
optional string trailing_comments = 4;
這兩個字段對于我們獲取proto文件的meta信息尤為重要, 所謂的meta信息, 理解理解為C#語言中的attribute
這個attribute功能可以為一個字段, 一個消息擴充一些描述. 比如: 當一個字段通過反射顯示在gui上時, gui需要獲取這個字段的中文描述
那么只需要如下編寫
optional int32 somevalue = 1 //@ desc=”中文描述”
位于字段尾部的描述, 會被填充到SourceCodeInfo的 trailing_comments中, 而位于字段上方的字段, 會被填充到leading_comments中
SourceCodeInfo 并沒有直接掛載在message或者字段的附近, 而是通過其下的path字段來描述與字段的關系, 這是個極為麻煩的設計.
其原理如下:
假設我有如下一個message
message foo
{
optional int32 v = 1; // comments
}
要獲取v后的注釋, 對應的path為 4, 0, 2, 0
4 表示descriptor中message_type所在的序號,由于message_type對應的類型DescriptorProto是一個數組, 所以0表示foo是在FileDescriptorProto的message_type數組類型的索引為0;
如此類推: 2, 0 表示 v在DescriptorProto結構體的field成員序號為2的數組元素的索引為0
如果需要更多的參考, 可以獲取https://github.com/golang/protobuf
github.com\golang\protobuf\protoc-gen-go工程內有詳細代碼解析