0

0

gRPC Java 客户端如何正确传递自定义元数据(Metadata)实现认证

聖光之護

聖光之護

发布时间:2026-01-18 11:30:20

|

363人浏览过

|

来源于php中文网

原创

gRPC Java 客户端如何正确传递自定义元数据(Metadata)实现认证

本文详解在 grpc java 客户端中通过 `callcredentials` 注入 `clientid`、`workerid` 和 `instance` 等 ascii 元数据的完整实践方案,避免 `unauthenticated: invalid credentials` 错误。

在 gRPC Java 中,若服务端要求通过请求头(即 Metadata)校验身份(如 clientid=1, workerid=2, instance=3),不能将元数据直接写入 stub 或手动构造 Metadata 后调用 apply() —— 这些操作不会被底层传输链路自动携带。正确方式是实现 CallCredentials,让 gRPC 在每次 RPC 调用前异步注入元数据

核心要点如下:

  • ✅ 必须继承 io.grpc.CallCredentials 并重写 applyRequestMetadata();
  • ✅ 元数据键必须使用 Metadata.Key.of("key", Metadata.ASCII_STRING_MARSHALLER) 声明(区分大小写,且需 ASCII 编码);
  • ✅ applyRequestMetadata 中需在传入的 Executor 上异步执行元数据构造与 metadataApplier.apply(),不可阻塞主线程
  • ✅ 必须实现空方法 thisUsesUnstableApi()(gRPC 1.50+ 强制要求,用于标识 API 兼容性);
  • ❌ 不要尝试 mock RequestInfo 或 Executor 来“预填充”元数据——这仅适用于单元测试,无法影响真实 RPC 流程。

以下是推荐的生产级实现:

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;

    // 使用 ASCII string marshaller 构建标准元数据键(注意:key 名会自动转为小写 HTTP 格式)
    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.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.withCause(t));
            }
        });
    }

    @Override
    public void thisUsesUnstableApi() {
        // 必须实现,无实际逻辑;gRPC 框架据此判断兼容性策略
    }
}

在业务代码中使用时,只需一行注入:

企奶奶
企奶奶

一款专注于企业信息查询的智能大模型,企奶奶查企业,像聊天一样简单。

下载

立即学习Java免费学习笔记(深入)”;

// 构造凭证实例(值可动态传入)
CallCredentials credentials = new ApplyMetadata("1", "2", "3");

// 绑定到 stub(支持 unary / streaming 所有调用)
YourServiceGrpc.YourServiceBlockingStub stub = YourServiceGrpc
    .newBlockingStub(channel)
    .withCallCredentials(credentials);

// 后续所有 RPC 自动携带元数据
stub.add(Empty.newBuilder().build());

⚠️ 注意事项:

  • 元数据键名(如 "clientid")不区分大小写,但建议全小写以符合 HTTP/2 header 规范;
  • 若服务端期望二进制元数据(如带 -bin 后缀),请改用 Metadata.BINARY_STRING_MARSHALLER;
  • CallCredentials 是线程安全的,可复用;若需动态值(如 token 刷新),应在 applyRequestMetadata 内实时获取;
  • 如遇 UNAUTHENTICATED 仍存在,请用 Wireshark 或 gRPC 的 NettyChannelBuilder 启用 usePlaintext(true).intercept(new LoggingClientInterceptor()) 查看实际发出的 headers。

该方案简洁、稳定、符合 gRPC 最佳实践,无需修改 stub 生成逻辑或引入额外依赖。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

835

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

741

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

736

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

399

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.6万人学习

C# 教程
C# 教程

共94课时 | 7万人学习

Java 教程
Java 教程

共578课时 | 47.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号