## gRPC-JSON转码过滤器
gRPC-JSON转码[配置概述](../../Configurationreference/HTTPfilters/gRPCJSONtranscoderfilter.md)。
### gRPC-JSON转码配置
过滤器配置所需要描述符文件以及要转码的gRPC服务列表。
```
{
"name": "grpc_json_transcoder",
"config": {
"proto_descriptor": "proto.pb",
"services": ["grpc.service.Service"],
"print_options": {
"add_whitespace": false,
"always_print_primitive_fields": false,
"always_print_enums_as_ints": false,
"preserve_proto_field_names": false
}
}
}
```
- **proto_descriptor**<br />
(required, string) 为gRPC服务提供二进制`protobuf`描述符集。描述符集必须包含在服务中使用的所有类型。确保为`protoc`使用`--include_import`选项。
要为gRPC服务生成一个`protobuf`描述符集,在运行`protoc`之前,还需要从Github中克隆`googleapis`仓库,因为在`include`路径中需要`annotations.proto`。
```
git clone https://github.com/googleapis/googleapis
GOOGLEAPIS_DIR=<your-local-googleapis-folder>
```
然后运行`protoc`从`bookstore.proto`生成描述符集:
```
protoc -I$(GOOGLEAPIS_DIR) -I. --include_imports --include_source_info \
--descriptor_set_out=proto.pb test/proto/bookstore.proto
```
如果您有多个原始源文件,您可以在一个命令中传递所有这些文件。
- **services**<br />
(required, array) 提供代码转换器进行转码服务的服务器名称列表。如果服务名称在`proto_descriptor`中不存在,Envoy将启动失败。`proto_descriptor`可能包含比这里指定的服务名称更多的服务,但是它们不会进行转码。
- **print_options**<br />
(optional, object) 响应json的控制选项。这些选项直接传递给[JsonPrintOptions](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.util.json_util#JsonPrintOptions)。有效的选项是:
- **add_whitespace**<br />
(optional, boolean) 是否添加空格,换行符和缩进以使输出的JSON易于阅读。默认为false。
- **always_print_primitive_fields**<br />
(optional, boolean) 是否始终打印原始字段。默认情况下,具有默认值的原始字段将在JSON输出中被省略。例如,设置为0的`int32`字段将被省略。将此标志设置为true,将覆盖默认行为并打印原始字段,而不考虑其值。默认为false。
- **always_print_enums_as_ints**<br />
(optional, boolean) 是否始终打印枚举作为整数。默认情况下,它们呈现为字符串。默认为false。
- **preserve_proto_field_names**<br />
(optional, boolean) 是否保留原始字段名称。默认情况下,`protobuf`将使用`json_name`选项生成JSON字段名称,或者按照下面的顺序生成较低的骆驼大小写。设置此标志将保留原始字段名称。默认为false。
## 返回
- [上一级](../HTTPfilters.md)
- [首页目录](../../README.md)
- 首页
- 简介
- Envoy是什么
- 架构介绍
- 术语
- 线程模型
- 监听器
- L3/L4网络过滤器
- HTTP连接管理
- HTTP过滤器
- HTTP路由
- gRPC
- WebSocket支持
- 集群管理
- 服务发现
- 健康检查
- 连接池
- 负载均衡
- 异常检测
- 熔断
- 全局限速
- TLS
- 统计
- 运行时配置
- 跟踪
- TCP代理
- 访问日志
- MongoDB
- DynamoDB
- Redis
- 热重启
- 动态配置
- 初始化
- 逐出
- 脚本
- 部署
- 业界对比
- 获得帮助
- 历史版本
- 编译安装
- 编译
- 参考配置
- 演示沙箱
- 前端代理
- Zipkin跟踪
- Jaeger跟踪
- gRPC桥接
- 构建Envoy Docker镜像
- 工具
- 配置参考
- V1 API 概述
- V2 API 概述
- 监听器
- 网络过滤器
- TLS客户端身份认证
- Echo
- Mongo代理
- 速率限制
- Redis代理
- TCP代理
- HTTP连接管理器
- 路由匹配
- 流量转移/分流
- HTTP头部操作
- HTTP头部清理
- 统计
- 运行时设置
- 路由发现服务
- HTTP过滤器
- 缓存
- CORS过滤器
- 故障注入
- DynamoDB
- gRPC HTTP/1.1 桥接
- gRPC-JSON 转码过滤器
- gRPC-Web 过滤器
- 健康检查
- 速率限制
- 路由
- Lua
- 集群管理
- 统计
- 运行时设置
- 集群发现服务
- 健康检查
- 熔断
- 访问日志
- 限速服务
- 运行时配置
- 路由表检查工具
- 运维管理
- 命令行选项
- 热重启
- 管理接口
- 统计概述
- 运行时配置
- 文件系统
- 自定义扩展示例
- V1 API参考
- 监听器
- 网络过滤器
- TLS客户端身份认证
- Echo
- HTTP连接管理
- Mongo代理
- 速率限制
- Redis代理
- TCP代理
- HTTP路由配置
- 虚拟主机
- 路由
- 虚拟集群
- 速率限制配置
- 路由发现服务
- HTTP过滤器
- 缓存
- CORS过滤器
- DynamoDB
- 故障注入
- gRPC HTTP/1.1 桥接
- gRPC-JSON 转码过滤器
- gRPC-Web 过滤器
- 健康检查
- Lua
- 速率限制
- 路由
- 集群管理
- 集群
- 健康检查
- 熔断
- TLS上下文
- 异常值检测
- HASH环负载均衡配置
- 异常检测
- 集群发现服务
- 服务发现服务
- 访问日志
- 管理接口
- 限速服务
- 运行时配置
- 跟踪
- V2 API参考
- 启动引导
- 监听&监听发现
- 集群&集群发现
- 服务发现
- 健康检查
- HTTP路由管理&发现
- TLS配置
- 通用的类型
- 网络地址
- 协议选项
- 发现API
- 限速组件
- 过滤器
- 网络过滤器
- TLS客户端身份认证
- HTTP连接管理
- Mongo代理
- 速率限制
- Redis代理
- TCP代理
- HTTP过滤器
- 缓存
- 故障注入
- 健康检查
- Lua
- 速率限制
- 路由
- gRPC-JSON转码器
- 常见访问日志类型
- 常见故障注入类型
- FAQ
- Envoy有多快?
- 我在哪里获得二进制文件?
- 我如何设置SNI?
- 如何设置区域感知路由?
- 我如何设置Zipkin跟踪?