gRPC服务接入
接入前,请正确启动 shenyu-admin
,并开启grpc
插件,在网关端和grpc
服务端引入相关依赖。可以参考前面的 gRPC快速开始。
应用客户端接入的相关配置请参考:。
数据同步的相关配置请参考:数据同步配置。
引入网关对gRPC
的代理插件,在网关的 pom.xml
文件中增加如下依赖:
- 重启你的网关服务。
- 在由
gRPC
构建的微服务中,引入如下依赖:
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-client-grpc</artifactId>
<version>${shenyu.version}</version>
<exclusions>
<exclusion>
<artifactId>guava</artifactId>
<groupId>com.google.guava</groupId>
</exclusion>
</exclusions>
</dependency>
在 shenyu-examples-grpc
下执行以下命令生成 java
代码。
mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
在gRPC
服务接口实现类上加上 @ShenyuGrpcClient
注解。启动你的服务提供者,成功注册后,在后台管理系统进入插件列表 -> rpc proxy -> grpc
,会看到自动注册的选择器和规则信息。
示例:
可以通过 http
的方式来请求你的服务。Apache ShenYu
网关需要有一个路由前缀,这个路由前缀就是你接入项目进行配置 contextPath
。
message EchoRequest {
string message = 1;
}
那么请求参数如下所示:
"data": [
{
"message": "hello grpc"
}
]
}
当前是以 json
的格式传递参数,key
的名称默认是data
,你可以在 GrpcConstants.JSON_DESCRIPTOR_PROTO_FIELD_NAME
中进行重置;value
的传入则根据你定义的 proto
文件。
Apache ShenYu
可以支持 gRPC
的流式调用,通过数组的形式传递多个参数。
如果你的proto
文件定义如下:
UNARY
{
"data": [
{
"text": "hello grpc"
}
]
CLIENT_STREAMING
{
"data": [
{
"text": "hello grpc"
},
{
},
{
"text": "hello grpc"
}
]
}
SERVER_STREAMING
BIDI_STREAMING
{
"data": [
{
"text": "hello grpc"
},
{
"text": "hello grpc"
},
{
"text": "hello grpc"
}
]
}