How to integrate maven grpc with springboot demo

1. Description

GRPC defines the interface based on protobuf. Divided into server side and client side. The server side provides interface implementation, and the client obtains the expected data by calling the server side interface.

2. Public part

2.1 Add dependencies

        <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>

Add plug-in (Note: If wagon-provider-api cannot be automatically introduced, you can introduce it now in the dependencies to facilitate dependencies Download, and then delete the dependency coordinates)

<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 Add proto dependency file

Add directorysrc/main/proto, and set the directory to Source Root, and then add the file hello.proto under the directory src/main/proto, with the following content

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 Generate Java code through protobuf

After the plug-in is imported successfully, click on the protobuf:compile and protbuf:compile-custom selected in the figure below to generate the corresponding Java code (that is, the interface dependency code) in sequence

3. The specific implementation of the server-side interface

service code is as follows

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();
    }
}

4 The specific implementation of the client-side interface

client The terminal test calling code is as follows

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("牛哈哈");
    }
}

The above is the detailed content of How to integrate maven grpc with springboot demo. For more information, please follow other related articles on the PHP Chinese website!