gRPC中的Metadata是什么？有什么作用？

作者：路多辛 2023-03-28 07:03:15

開發前端

gRPC的Metadata是一種用于在gRPC客戶端和服務器之間傳遞元數據信息的機制，可以提供有關RPC調用的信息以及控制gRPC消息的格式。

gRPC中的metadata是什么？

gRPC中的Metadata類似于HTTP Header的概念，用于描述數據和消息的數據信息，可以理解為一個鍵值對集合，用于在gRPC客戶端和服務端之間傳遞元數據信息，提供一種在消息中傳遞數據和追加關鍵信息的機制。

Metadata主要有兩個作用：

提供RPC調用的元數據信息，例如用于鏈路追蹤的traceId、調用時間、應用版本等等。
控制gRPC消息的格式，例如是否壓縮或是否加密。

在gRPC中，元數據可以在客戶端和服務器之間進行交換。客戶端可以在發送請求時，通過添加元數據，向服務器傳遞特定的信息，例如授權令牌、用戶標識、鏈路追蹤ID等。服務器可以使用這些元數據來進行身份驗證、授權、跟蹤請求等操作。

使用gRPC的元數據可以通過gRPC API提供的Metadata對象來實現。在客戶端，可以在調用服務方法時使用Metadata對象，并將元數據添加到對象中，服務端可以在接收請求時從RPC上下文中提取Metadata。

使用場景示例

下面舉一個例子，使用 Golang 代碼來演示。在 Golang 中使用的Metadata是一個類型為map[string]string的數據結構，其中的鍵值對表示元數據的key和value。

import (
    "golang.org/x/net/context"
    "google.golang.org/grpc/metadata"
)

// SendRequestWithContext 發送請求的方法，需要傳入一個context對象和metadata
func SendRequestWithContext(ctx context.Context, data []byte, md metadata.MD) {
      // client實例
    client := pb.NewExampleClient(conn)
    // 通過ctx傳入metadata
    resp, err := client.ExampleMethod(ctx, &pb.ExampleRequest{Data: data}, grpc.Header(md))
    if err != nil {
        log.Fatalf("Send request failed: %v", err)
    }
    log.Printf("Response: %v", resp.GetData())
}

在上述示例中，使用了metadata.MD作為第三個參數，將元數據發送給服務端。下面是發送請求時創建metadata的示例：

ctx := context.Background()
md := metadata.New(map[string]string{"authorization": "Bearer <user-token>"})
ctx = metadata.NewOutgoingContext(ctx, md)

data := []byte("example request data")
SendRequestWithContext(ctx, data, md)

在上述示例中，使用metadata.New創建Metadata對象，用于包裝元數據。然后使用metadata.NewOutgoingContext創建一個新的context，將Metadata對象附加到其中。最后，將新的context和元數據傳遞給SendRequestWithContext方法，以便將元數據發送到服務端。

在服務端接收元數據時，可以通過context對象的Value方法獲取到metadata.MD，然后從中獲取保存的鍵值對。以下是服務端代碼中獲取元數據的示例：

func (s *server) ExampleMethod(ctx context.Context, req *pb.ExampleRequest) (*pb.ExampleResponse, error) {
    // 從context中獲取metadata
    md, ok := metadata.FromIncomingContext(ctx)
    if ok {
        // 獲取key對應的value
        token := md.Get("authorization")
        // 處理元數據
        ...
    }
    // 處理請求
    ...
}

通過在服務端的方法中獲取metadata.MD類型的值，就可以獲取到客戶端請求的元數據，并使用這些元數據進行后續操作。

小結

總之，gRPC的Metadata是一種用于在gRPC客戶端和服務器之間傳遞元數據信息的機制，可以提供有關RPC調用的信息以及控制gRPC消息的格式。

責任編輯：姜華來源：今日頭條

gRPC Metadata