# @bufbuild/protoc-gen-grpc-es 中文文档 规范地址：https://npmcn.com/package/%40bufbuild/protoc-gen-grpc-es/ 版本：0\.0\.1 npm 元数据更新时间：2026-09-16T06:38:46.793Z 中文译文更新时间：2026-11-08T18:37:53.598Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40bufbuild/protoc-gen-grpc-es 原文对照：https://npmcn.com/package/%40bufbuild/protoc-gen-grpc-es/?lang=original 项目主页：https://github.com/bufbuild/protoc-gen-grpc-es 源码仓库：https://github.com/bufbuild/protoc-gen-grpc-es ## 关键信息（来自 npm 元数据） - 包体积（解压后）：40.6 kB，6 个文件 - TypeScript 类型：未声明 - Node.js 要求：\>=20 - 运行依赖：2 个 - peer 依赖：@bufbuild/protobuf 2\.12\.1 - 首次发布：2026-08-03T12:20:11.033Z - 最新版本发布：2026-08-03T12:20:11.484Z - 近 30 天下载量：4833（2026-10-09 至 2026-11-07，npm 官方下载统计） - 已发布版本数：1（近 12 个月 1 个） ## 中文简介 @grpc/grpc-js的Protobuf代码生成器 ## 安装 ```sh npm install @bufbuild/protoc-gen-grpc-es ``` 也可以使用：`pnpm add @bufbuild/protoc-gen-grpc-es`、`yarn add @bufbuild/protoc-gen-grpc-es`、`bun add @bufbuild/protoc-gen-grpc-es` ## README ![The Buf logo](https://npmcn.com/package/%40bufbuild/protoc-gen-grpc-es/.github/buf-logo.svg) # @bufbuilding/protoc-gen-grpc-es (英语) [![NPM Version](https://img.shields.io/npm/v/%40bufbuild%2Fprotoc-gen-grpc-es?style=flat-square)](https://www.npmjs.com/package/@bufbuild/protoc-gen-grpc-es) [![NPM License](https://img.shields.io/npm/l/%40bufbuild%2Fprotoc-gen-grpc-es?style=flat-square)](https://github.com/bufbuild/protoc-gen-grpc-es/blob/main/LICENSE) [![Slack](https://img.shields.io/badge/slack-buf-%23e01e5a?style=flat-square)](https://buf.build/links/slack) `protoc-gen-grpc-es` 生成 **型态好,平庸 [(原始内容存档于2018-10-21) (英语). gRPC](https://grpc.io/) 根节** 页:1 [Protobuf-ES (英语)](https://github.com/bufbuild/protobuf-es) (单位:千美元)`@bufbuild/protobuf`),用于JavaScript和TypeScript的ergoomic和现代Protobuf库. 插入到您已有的 [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) 频道和服务器. 这是已建工程的兼容层 [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js)。生成的客户端和服务器插入您现有的 gRPC 频道和服务器,但直接序列化 Protobuf-ES 消息。 这使得您可以升级到更好的Protobuf软件包,而不触及您的RPC堆栈. > \[TIP\] 用于新项目 [连接-ES](https://github.com/connectrpc/connect-es) 换句话说 Connect除了自身之外还会说出gRPC和gRPC-Web协议,因此现有的gRPC客户端可以称一个Connect服务器不变. 但您也可以获得普通的 HTTP API `curl`,并生成客户端 **每种主要语言**包括你的前端. `protoc-gen-grpc-es` 只存在如此已建基于当前 gRPC 代码库 `@grpc/grpc-js` 可以在今天获得Protobuf-ES的改进而无需完全重写. ## 开始 ### 安装 安装运行时库和 `protoc` 插件, 运行 : ```shell npm install @bufbuild/protobuf @grpc/grpc-js npm install --save-dev @bufbuild/protoc-gen-es @bufbuild/protoc-gen-grpc-es @types/node ``` ### 生成代码 我们建议使用 [`buf`](https://github.com/bufbuild/buf) 生成代码。 添加新内容 `buf.gen.yaml` 配置文件 : ```yaml # Learn more: https://buf.build/docs/configuration/v2/buf-gen-yaml version: v2 inputs: - directory: proto plugins: - local: protoc-gen-es out: src/gen opt: target=ts - local: protoc-gen-grpc-es out: src/gen opt: target=ts ``` 将您的 `.proto` 文档中 `./proto` 目录,然后运行: ```bash npx buf generate ``` ## 使用量 对于每个包含服务的Protobuf文件,插件生成一个 `_grpc.ts` 文件旁边 `_pb.ts` 文件来自 `protoc-gen-es`. 例如,以下服务: ```protobuf syntax = "proto3"; package example; service ElizaService { rpc Say(SayRequest) returns (SayResponse); } message SayRequest { string sentence = 1; } message SayResponse { string sentence = 1; } ``` 生成下列导出 `eliza_grpc.ts`数字 : - `ElizaServiceDefinition`编号: `@grpc/grpc-js` 服务定义. - `ElizaServiceServer`: 服务器执行的接口. - `ElizaServiceClient`:每个RPC都有打入方法的客户端. 要执行服务器 : ```ts import * as grpc from "@grpc/grpc-js"; import { ElizaServiceDefinition, type ElizaServiceServer } from "./gen/eliza_grpc.js"; const implementation: ElizaServiceServer = { say(call, callback) { callback(null, { sentence: `You said: ${call.request.sentence}` }); }, }; const server = new grpc.Server(); server.addService(ElizaServiceDefinition, implementation); server.bindAsync("localhost:50051", grpc.ServerCredentials.createInsecure(), () => {}); ``` 和客户打电话: ```ts import * as grpc from "@grpc/grpc-js"; import { ElizaServiceClient } from "./gen/eliza_grpc.js"; const client = new ElizaServiceClient("localhost:50051", grpc.credentials.createInsecure()); client.say({ sentence: "Hi" }, (error, response) => { if (error) { throw error; } console.log(response?.sentence); }); ``` ## 插件选项 `protoc-gen-grpc-es` 支持与 `protoc-gen-es`数字 : | 选项 | 数值 | 默认 | 说明 | | --- | --- | --- | --- | | [`target`](https://github.com/bufbuild/protobuf-es/tree/main/packages/protoc-gen-es#target) | `js`, (中文(简体) ), `ts`, (中文(简体) ), `dts` (与 `+`(中文(简体) ) | `js+dts` | 要生成的文件 . | | [`import_extension`](https://github.com/bufbuild/protobuf-es/tree/main/packages/protoc-gen-es#import_extension) | `none`, (中文(简体) ), `js`, (中文(简体) ), `ts` | `none` | 在导入路径中使用的文件扩展名 . | | [`js_import_style`](https://github.com/bufbuild/protobuf-es/tree/main/packages/protoc-gen-es#js_import_style) | `module`, (中文(简体) ), `legacy_commonjs` | `module` | 使用ECMAS脚本 `import`编号 :`export` 或 常见JS `require`。 。 。 . | | [`keep_empty_files`](https://github.com/bufbuild/protobuf-es/tree/main/packages/protoc-gen-es#keep_empty_filestrue) | `true`, (中文(简体) ), `false` | `false` | 保留生成的文件, 即使它们没有包含服务 . | | [`ts_nocheck`](https://github.com/bufbuild/protobuf-es/tree/main/packages/protoc-gen-es#ts_nochecktrue) | `true`, (中文(简体) ), `false` | `false` | 生成 a `// @ts-nocheck` 在每个文件的顶部注释. | | [`elide_plugin_version`](https://github.com/bufbuild/protobuf-es/tree/main/packages/protoc-gen-es#elide_plugin_versiontrue) | `true`, (中文(简体) ), `false` | `false` | 从生成的文件头关闭插件版本 . | 确保使用相同的 `target` 财务报告和审定财务报表 `import_extension` 用于两个插件的值,以便生成 `_grpc` 文件可以从生成的文件导入 `_pb` 文档. ## 常见问题 ### @bufbuild/protoc-gen-grpc-es 是什么？ @grpc/grpc-js的Protobuf代码生成器 ### 如何安装 @bufbuild/protoc-gen-grpc-es？ 在项目目录运行 npm install @bufbuild/protoc-gen-grpc-es，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 protoc-gen-grpc-es，可以用 npx protoc-gen-grpc-es 直接运行。 ### @bufbuild/protoc-gen-grpc-es 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bufbuild\_\_protoc-gen-grpc-es 是否存在。 ### @bufbuild/protoc-gen-grpc-es 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @bufbuild/protoc-gen-grpc-es 可以商用吗？ @bufbuild/protoc-gen-grpc-es 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @bufbuild/protoc-gen-grpc-es 的下载量有多少？ 根据 npm 官方下载统计，@bufbuild/protoc-gen-grpc-es 在 2026/10/09 – 2026/11/07 这 30 天内被下载 4,833 次，日均约 161 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @bufbuild/protoc-gen-grpc-es 还在维护吗？ 最新版本 0\.0\.1 发布于 2026/08/03（3 个月前）；至今共发布 1 个版本，其中过去 12 个月发布了 1 个；首次发布于 2026/08/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。