如何在Dart gRPC客户端中设置字符串列表到Metadata

gRPC的Metadata底层基于HTTP/2 Header机制，HTTP/2允许同一个Header Key对应多个Value。Go端的map[string][]string正是为了承载这种多值场景设计的，而Dart的gRPC Metadata虽然对外展示为Map<String, String>，但可以通过重复添加同一个Key的方式传递多值，服务端最终会将这些值收集为字符串列表。

Dart客户端实现 #

不要直接用普通Map初始化Metadata（会覆盖重复Key的值），而是使用Metadata类的add方法多次添加同一个Key：

import 'package:grpc/grpc.dart';

void sendRequestWithListMetadata() {
  // 初始化Metadata实例
  final metadata = Metadata();
  
  // 为同一个Key添加多个值，对应Go端的字符串列表
  metadata.add('user-roles', 'admin');
  metadata.add('user-roles', 'editor');
  metadata.add('user-roles', 'viewer');

  // 发起gRPC请求时携带该Metadata
  final callOptions = CallOptions(metadata: metadata);
  // client.yourRpcMethod(yourRequest, options: callOptions);
}

Go服务端接收 #

在Go服务方法中，通过metadata.FromIncomingContext获取Metadata后，直接用Get方法就能拿到对应Key的字符串列表：

import (
    "context"
    "google.golang.org/grpc/metadata"
    "google.golang.org/grpc/codes"
    "google.golang.org/grpc/status"
    pb "your/proto/package/path"
)

func (s *yourServer) YourRpcMethod(ctx context.Context, req *pb.YourRequest) (*pb.YourResponse, error) {
    md, ok := metadata.FromIncomingContext(ctx)
    if !ok {
        return nil, status.Errorf(codes.InvalidArgument, "metadata not found")
    }

    // 获取对应Key的字符串列表
    roles := md.Get("user-roles")
    // roles 此时为 []string{"admin", "editor", "viewer"}
    
    // 业务逻辑处理...
    return &pb.YourResponse{}, nil
}

注意事项 #

• 必须使用Metadata.add()方法添加重复Key，直接用Map赋值（如metadata['user-roles'] = 'admin'）会覆盖之前的值，无法传递列表。
• Metadata的Key命名要符合HTTP/2规范，建议使用小写字母，避免特殊字符（如空格、下划线以外的符号），避免跨语言解析出现问题。

内容的提问来源于stack exchange，提问作者Antiphy Initializator