1.記憶體對齊是什麼？ 對結構體和類來說，讓變數不是緊挨著存放，而是通過變數位元組倍數的形式存放 2.為什麼會有記憶體對齊？ 增加cpu的訪問數據的速度 對於cpu來說，數據從記憶體中讀到緩存中去，是通過偏移量(offset)進行讀取，也就是常說的通過塊來讀取，而不是按照位元組讀取。 讀取非記憶體對齊的數據，會 ...
ProtoOptions
簡介
使用protobuf的options，我們可以添加我們自己的option，然後根據option生成代碼添對proto中的參數進行處理，例如添加message的校驗。
extension
能夠對已經存在的消息進行擴展，這種擴展只是動態增加欄位，而沒有增加介面。
例子：擴展protobuf的FieldOptions
message MyFileOptions {
optional bool ok = 1;
}
// 擴展protobuf的MessageOptions
extend google.protobuf.FileOptions {
optional MyFileOptions my_file_option = 51234; // 取一個自定義不重覆值
}
protobuf options
- google.protobuf.FileOptions
- google.protobuf.ServiceOptions
- google.protobuf.MethodOptions
- google.protobuf.MessageOptions
- google.protobuf.FieldOptions
- google.protobuf.EnumOptions
- google.protobuf.EnumValueOptions
- google.protobuf.OneofOptions
- google.protobuf.ExtensionRangeOptions
實現自定義option
擴展實現
mkdir protoc-gen-my-option
cd protoc-gen-my-option
實現一個FileOptions
mkdir proto
# 在proto中實現自己的option,可以將EOF的內容拷貝到proto/my_option.proto中
echo > proto/my_option.proto <<EOF
syntax = "proto3";
package my_option;
option go_package="protoc-gen-my-option/proto";
import "google/protobuf/descriptor.proto";
message MyFileOptions {
optional bool ok = 1;
}
// 擴展protobuf的MessageOptions
extend google.protobuf.FileOptions {
optional MyFileOptions my_file_option = 51234; // 取一個自定義不重覆值
}
EOF
生成後proto/my_option.proto中的內容
syntax = "proto3";
package my_option;
option go_package="protoc-gen-my-option/proto";
import "google/protobuf/descriptor.proto";
message MyFileOptions {
optional bool ok = 1;
}
// 擴展protobuf的MessageOptions
extend google.protobuf.FileOptions {
optional MyFileOptions my_file_option = 51234; // 取一個自定義不重覆值
}
生成擴展的pb文件
protoc --go_out=../ proto/my_option.proto
解析擴展插件
創建工程文件目錄
擴展插件的開頭必須以protoc-gen開頭，在創建的protoc-gen-my-option目錄下編寫插件，並初始化項目。
go mod init protoc-gen-my-option
解析demo
package main
import (
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
"log"
my_proto "protoc-gen-my-option/proto"
)
func getFileOptions(f *protogen.File) *my_proto.MyFileOptions {
log.Println("getFileOptions")
// 解析my_options
if myOptions, ok := proto.GetExtension(f.Proto.Options, my_proto.E_MyFileOption).(*my_proto.MyFileOptions); ok {
log.Println("my_options:", myOptions)
return myOptions
} else {
log.Println("get my_options failed.")
}
return nil
}
func main() {
protogen.Options{}.Run(func(plugin *protogen.Plugin) error {
log.Println("protogen plugin")
// protc時會把proto文件傳入，解析所有文件
for _, f := range plugin.Files {
// 只處理我們處理的文件
if !f.Generate {
continue
}
// 處理getFiledOptions
getFileOptions(f)
}
return nil
})
}
安裝插件
go install .
使用MyFileOptions
mkdir protoc-gen-my-option/test_proto
# 使用my-option
echo > test_proto/test_proto.proto <<EOF
syntax = "proto3";
package my_option;
option go_package="protoc-gen-my-option/test_proto";
import "my_option.proto";
// 使用FiledOptions
option (my_option.my_file_option).ok = true;
EOF
生成的test_proto/test_proto.proto內容如下：
syntax = "proto3";
package my_option;
option go_package="protoc-gen-my-option/test_proto";
import "my_option.proto";
// 使用FiledOptions
option (my_option.my_file_option).ok = true;
驗證插件解析MyFileOptions
protoc -I=./proto --go_out=../ --my-option_out=../ --proto_path=test_proto test_option.proto
成功後會輸出以下內容,能夠看到my_options中的ok被成功解析。
2023/02/18 20:12:16 protogen plugin
2023/02/18 20:12:16 getFileOptions
2023/02/18 20:12:16 my_options: ok:true
解析擴展插件後生成我們自己的代碼
在上面的demo中添加代碼生成邏輯
package main
import (
"fmt"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
"log"
my_proto "protoc-gen-my-option/proto"
)
func getFileOptions(f *protogen.File) *my_proto.MyFileOptions {
log.Println("getFileOptions")
// 解析my_options
if myOptions, ok := proto.GetExtension(f.Proto.Options, my_proto.E_MyFileOption).(*my_proto.MyFileOptions); ok {
log.Println("my_options:", myOptions)
return myOptions
} else {
log.Println("get my_options failed.")
}
return nil
}
func genCode(myOptions *my_proto.MyFileOptions) string {
if myOptions.Ok != nil && myOptions.GetOk() {
return `
func HelloMyOptions() {
fmt.Println("Hello MyOptions, MyOptions is ok!")
}
`
}
return `
func HelloMyOptions() {
fmt.Println("Hello MyOptions, MyOptions is not ok...")
}
`
}
func main() {
protogen.Options{}.Run(func(plugin *protogen.Plugin) error {
log.Println("protogen plugin")
// protc時會把proto文件傳入，解析所有文件
for _, f := range plugin.Files {
// 只處理我們處理的文件
if !f.Generate {
continue
}
// 處理getFiledOptions
myOptions := getFileOptions(f)
head := fmt.Sprintf(`
package %s
import "fmt"
`, f.GoPackageName) // go文件, package名是必須的，import生成後一般IDE會自動import,可以不用寫，除非某些場景需要提前加好import
outFile := plugin.NewGeneratedFile(fmt.Sprintf("%s.my.go", f.GeneratedFilenamePrefix), f.GoImportPath)
outFile.Write([]byte(head))
outFile.Write([]byte(genCode(myOptions)))
}
return nil
})
}
重新安裝插件，並生成我們的代碼
go install .
protoc -I=./proto --go_out=../ --my-option_out=../ --proto_path=test_proto test_option.proto
在test_proto目錄中會生成test_option.my.go,內容如下
package test_proto
import "fmt"
func HelloMyOptions() {
fmt.Println("Hello MyOptions, MyOptions is ok!")
}
