1. 说明
grpc基于protobuf来定义接口。分为server端和client端。其中server端提供接口实现，client通过调用server端接口从而获取期望数据。
2. 公共部分
2.1 添加依赖
<dependency> <groupid>net.devh</groupid> <artifactid>grpc-spring-boot-starter</artifactid> <version>2.12.0.RELEASE</version> </dependency> <dependency> <!-- Java 9+ compatibility --> <groupid>javax.annotation</groupid> <artifactid>javax.annotation-api</artifactid> </dependency>
添加插件(注意：如果wagon-provider-api无法自动引入，可以现在依赖中引入，以便于依赖的下载，然后在删除依赖坐标即可)
<plugin>
<!-- protobuf生成插件-->
<groupid>org.xolstice.maven.plugins</groupid>
<artifactid>protobuf-maven-plugin</artifactid>
<version>0.6.1</version>
<configuration>
<protocartifact>com.google.protobuf:protoc:3.17.3:exe:${os.detected.classifier}
</protocartifact>
<pluginid>grpc-java</pluginid>
<pluginartifact>io.grpc:protoc-gen-grpc-java:1.39.0:exe:${os.detected.classifier}
</pluginartifact>
<!--默认值-->
<protosourceroot>${project.basedir}/src/main/proto</protosourceroot>
<outputdirectory>${project.basedir}/src/main/java</outputdirectory>
<clearoutputdirectory>false</clearoutputdirectory>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
<goal>compile-custom</goal>
</goals>
</execution>
</executions>
</plugin>
2.2 添加proto依赖文件
添加目录src/main/proto，并将目录设置为Source Root,然后在目录src/main/proto下添加文件hello.proto，内容如下
syntax = "proto3"; //指定proto版本
package com.server;
// 生成的Java代码的包名
option java_package = "com.grpc.server";
// 请求参数
message HelloReq{
string name = 1;
}
// 返回参数
message HelloResp{
string ret = 1;
}
// rpc service
service HelloService{
// service中需要进行调用的具体方法
rpc hello(HelloReq) returns (HelloResp){}
}
2.3 通过protobuf生成Java代码
插件导入成功后，点击下图选中的protobuf:compile和protbuf:compile-custom 依次生成对应的Java代码（也就是接口依赖代码）
Java Maven Common
下载
Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。
3. server端接口具体实现
service代码如下
import io.grpc.stub.StreamObserver;
import net.devh.boot.grpc.server.service.GrpcService;
@GrpcService
public class HelloService extends HelloServiceGrpc.HelloServiceImplBase {
@Override
public void hello(Hello.HelloReq request, StreamObserver<hello.helloresp> responseObserver) {
Hello.HelloResp resp = Hello.HelloResp.newBuilder().setRet("你好-->"+request.getName()).build();
responseObserver.onNext(resp);
responseObserver.onCompleted();
}
}</hello.helloresp>
4 client端接口具体实现
client端测试调用代码如下
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class GrpcTest {
@Autowired
private HelloSerivce helloSerivce;
@Test
public void test1() throws Exception{
helloSerivce.haha("牛哈哈");
}
}
