讲师中心 微信公众号
AI工具推荐 视频效率加速

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

千宇姑娘_7588

千宇姑娘_7588

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

|

383人浏览过

|

来源于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<String> CLIENT_ID_KEY 
        = Metadata.Key.of("clientid", Metadata.ASCII_STRING_MARSHALLER);
    private static final Metadata.Key<String> WORKER_ID_KEY 
        = Metadata.Key.of("workerid", Metadata.ASCII_STRING_MARSHALLER);
    private static final Metadata.Key<String> 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 Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

立即学习“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 生成逻辑或引入额外依赖。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

更多
登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

12826

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

1545

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

3477

2023.12.21

token什么意思
token什么意思

token是一种用于表示用户权限、记录交易信息、支付虚拟货币的数字货币。可以用来在特定的网络上进行交易,用来购买或出售特定的虚拟货币,也可以用来支付特定的服务费用。想了解更多token什么意思的相关内容可以访问本专题下面的文章。

5621

2024.03.01

线程和进程的区别
线程和进程的区别

线程和进程的区别:线程是进程的一部分,用于实现并发和并行操作,而线程共享进程的资源,通信更方便快捷,切换开销较小。本专题为大家提供线程和进程区别相关的各种文章、以及下载和课程。

3838

2023.08.10

常见的编码方式
常见的编码方式

常见的编码方式有ASCII编码、Unicode编码、UTF-8编码、UTF-16编码、GBK编码等。想了解更多编码方式相关内容,可以阅读本专题下面的文章。

1408

2023.10.24

a和A对应的ASCII码数值
a和A对应的ASCII码数值

a的ascii码是65,a的ascii码是97;ascii码表中,一个字母的大小写数值相差32,一般知道大写字母的ascii码数值,其对应的小写字母的ascii码数值就算出来了,是大写字母的ascii码数值“+32”。想了解更多相关的内容,可阅读本专题下面的相关文章。

5047

2024.10.24

http500解决方法
http500解决方法

http500解决方法有检查服务器日志、检查代码错误、检查服务器配置、检查文件和目录权限、检查资源不足、更新软件版本、重启服务器或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3183

2023.11.09

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn