如何在 Java gRPC 客户端中正确传递自定义元数据（Metadata）_技术教程

本文详解如何通过自定义 `callcredentials` 在 java grpc 客户端中安全、可靠地注入 `clientid`、`workerid` 和 `instance` 等必需元数据，解决 `unauthenticated: invalid credentials` 错误。

在 Java 中使用 gRPC 时，若服务端要求认证型元数据（如 clientid、workerid、instance），不能依赖 stub.withInterceptors() 或手动构造 Metadata 后调用 apply()——这些方式无法被底层传输链路真正识别。唯一符合 gRPC 协议规范、被所有拦截器和传输层一致支持的方式是：实现 CallCredentials 并通过 stub.withCallCredentials() 注入。

✅ 正确做法：继承 CallCredentials 实现元数据注入

以下是一个轻量、线程安全、生产可用的元数据凭证类：

import io.grpc.CallCredentials;
import io.grpc.Metadata;
import io.grpc.Status;
import java.util.concurrent.Executor;

public class ApplyMetadata extends CallCredentials {
    private final String clientid;
    private final String workerid;
    private final String instance;

    // 预声明元数据 Key（复用 ASCII_STRING_MARSHALLER，确保与服务端解析一致）
    private static final Metadata.Key CLIENT_ID_KEY 
        = Metadata.Key.of("clientid", Metadata.ASCII_STRING_MARSHALLER);
    private static final Metadata.Key WORKER_ID_KEY 
        = Metadata.Key.of("workerid", Metadata.ASCII_STRING_MARSHALLER);
    private static final Metadata.Key INSTANCE_KEY 
        = Metadata.Key.of("instance", Metadata.ASCII_STRING_MARSHALLER);

    public ApplyMetadata(String clientid, String workerid, String instance) {
        this.clientid = clientid;
        this.workerid = workerid;
        this.instance = instance;
    }

    @Override
    public void applyRequestMetadata(
            RequestInfo requestInfo,
            Executor executor,
            MetadataApplier metadataApplier) {
        // 必须在 executor 中异步执行（gRPC 要求）
        executor.execute(() -> {
            try {
                Metadata headers = new Metadata();
                headers.put(CLIENT_ID_KEY, clientid);
                headers.put(WORKER_ID_KEY, workerid);
                headers.put(INSTANCE_KEY, instance);
                metadataApplier.apply(headers); // ✅ 正确提交
            } catch (Throwable t) {
                // 发生异常时需显式 fail，避免请求挂起或静默失败
                metadataApplier.fail(Status.UNAUTHENTICATED
                        .withDescription("Failed to apply auth metadata")
                        .withCause(t));
            }
        });
    }

    // 此方法为 gRPC 内部 API 标记，必须实现（空实现即可）
    @Override
    public void thisUsesUnstableApi() {
        // noop —— 不可删除，否则编译/运行时报错
    }
}

? 使用示例（完整客户端调用链）

// 1. 构建通道（注意：若服务端启用 TLS，请勿 usePlaintext()）
ManagedChannel channel = ManagedChannelBuilder.forTarget("localhost:8080")
        .usePlaintext() // ⚠️ 生产环境请改用 .sslContext(...) + 启用 TLS
        .build();

// 2. 创建强类型 Stub（以 yourpackage.YourServiceGrpc.YourServiceBlockingStub 为例）
YourServiceGrpc.YourServiceBlockingStub stub 
    = YourServiceGrpc.newBlockingStub(channel);

// 3. 注入元数据凭证
CallCredentials credentials = new ApplyMetadata("1", "2", "3");
stub = stub.withCallCredentials(credentials);

// 4. 发起调用（元数据将自动随每个 RPC 请求发送）
try {
    YourResponse response = stub.add(Empty.newBuilder().build());
    System.out.println("Success: " + response);
} finally {
    channel.shutdownNow().awaitTermination(5, TimeUnit.SECONDS);
}

⚠️ 关键注意事项

Key 名称严格区分大小写与连字符："clientid" ≠ "clientId"；确保与服务端期望的 header key 完全一致（通常全小写+无下划线）；
Marshaller 必须匹配：服务端若按 ASCII 解析，则客户端必须用 Metadata.ASCII_STRING_MARSHALLER；若含 Unicode 字符，应改用 Metadata.UTF_8_STRING_MARSHALLER；
不要在 applyRequestMetadata 中阻塞：所有逻辑必须包裹在 executor.execute(...) 中，否则会导致 RPC 超时或死锁；
thisUsesUnstableApi() 不可省略：这是 gRPC 强制契约，缺失将导致 NoSuchMethodError；
避免 Mock 替代真实凭证逻辑：你原代码中对 mockExecutor 和 mockRequestInfo 的模拟仅适用于单元测试，无法用于真实 RPC 调用。

✅ 总结

解决 UNAUTHENTICATED: invalid credentials 的本质，不是“怎么塞进 metadata”，而是“如何让 gRPC 框架信任并自动携带它”。CallCredentials 是官方唯一推荐、协议级支持的元数据注入机制。只要正确实现 applyRequestMetadata 并确保 Key/Value/Executor/Exception 处理四要素完备，即可稳定通过服务端鉴权校验。无需额外拦截器、无需修改 stub 生成逻辑，简洁、标准、可维护。