前言
在平时开发的过程中我们经常有部分传参的问题,比如有一个 People 对象,我们只需要更新里面的 name 字段,这个时候我们只需要传递 People.name 就行了,其它 age,sex 等字段就不用传递了,当我们使用 grpc 协议的时候我们往往使用 FieldMask 解决这个问题。
案例
我们先定义一个 proto 文件
syntax = "proto3";
option go_package = "pb";
package pb;
import "google/protobuf/field_mask.proto";
// 定义服务
service Greeter {
// SayHello 方法
rpc SayHello (HelloRequest) returns (HelloResponse) {}
}
message People {
int32 age = 1;
string name = 2;
string sex = 3;
}
// 请求消息
message HelloRequest {
People pe = 1;
// 要更新的字段
google.protobuf.FieldMask update_mask = 3;
}
// 响应消息
message HelloResponse {
string reply = 1;
}
在这个 pb 文件里面我们定义了一个 google.protobuf.FieldMask 类型的字段。
客户端
创建一个 client.go 文件
package main
import (
"context"
"flag"
"log"
"time"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/protobuf/types/known/fieldmaskpb"
"pb"
)
// hello_client
const (
defaultName = "world"
)
var (
addr = flag.String("addr", "127.0.0.1:8972", "the address to connect to")
name = flag.String("name", defaultName, "Name to greet")
)
func main() {
flag.Parse()
conn, err := grpc.Dial(*addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()
c := pb.NewGreeterClient(conn)
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
paths := []string{"name"}
req := pb.HelloRequest{
Pe: &pb.People{
Age: 1,
},
UpdateMask: &fieldmaskpb.FieldMask{Paths: paths},
}
r, err := c.SayHello(ctx, &req)
if err != nil {
log.Fatalf("could not greet: %v", err)
}
log.Printf("Greeting: %s", r.GetReply())
}
在进行传参的时候我们定义了一个 paths 指定要更新的字段,然后把这个字段传递到 UpdateMask 字段里面
服务端接收
创建一个 server.go 文件
import "github.com/mennanov/fieldmask-utils"
func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloResponse, error) {
mask, _ := fieldmask_utils.MaskFromProtoFieldMask(in.UpdateMask, strcase.ToCamel)
var peDst = make(map[string]interface{})
fieldmask_utils.StructToMap(mask, in.Pe, peDst)
fmt.Printf("bookDst:%#v\n", peDst)
}
服务端使用 fieldmask-utils 对入参字段进行转化,转换成 map 类型进行使用
Reference
- https://developers.google.com/slides/api/guides/field-masks