写给Java程序员的GRPC入门系列（1）

点击上方GRPC专栏看系列

Abstract

网上有很多GRPC的例子，但是却没有能够写给普通Java开发人员手把手入门少走弯路的教程。
本教程保证按照步骤一步步来你就可以完成GRPC从0到1的构建。
源码地址：grpc-helloworld-for-java

前置依赖

装有maven和JDK。并且保证javac命令可用。

本文

本文是系列的第一篇，将从0构建MAVEN项目引入相关依赖。 代码在分支：step1-import-mvn。

初始状态

git clone https://github.com/gaoxingliang/grpc-helloworld-for-java.git
git checkout step-0-empty

可以看到没有任何代码，下面我们将一步步引入相关依赖构建。

创建MAVEN module

修改依赖

修改pom.xml 加入如下内容：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>grpcExample</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>

        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>3.16.3</version>
        </dependency>

        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-netty-shaded</artifactId>
            <version>1.15.1</version>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-protobuf</artifactId>
            <version>1.15.1</version>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-stub</artifactId>
            <version>1.15.1</version>
        </dependency>
        <dependency> <!-- necessary for Java 9+ -->
            <groupId>org.apache.tomcat</groupId>
            <artifactId>annotations-api</artifactId>
            <version>6.0.53</version>
            <scope>provided</scope>
        </dependency>

    </dependencies>


    <build>
        <defaultGoal>clean generate-sources compile install</defaultGoal>

        <plugins>
            <!-- compile proto file into java files. -->
            <plugin>
                <groupId>com.github.os72</groupId>
                <artifactId>protoc-jar-maven-plugin</artifactId>
                <version>3.11.4</version>
                <executions>
                    <execution>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                        <configuration>
                            <includeMavenTypes>direct</includeMavenTypes>

                            <inputDirectories>
                                <include>src/main/resources</include>
                            </inputDirectories>

                            <!-- 用这个来指定不同的package依赖。 -->
                            <includeDirectories>
                                <include>src/main/resources</include>
                            </includeDirectories>

                            <outputTargets>
                                <outputTarget>
                                    <type>java</type>
                                    <outputDirectory>src/main/java</outputDirectory>
                                </outputTarget>
                                <outputTarget>
                                    <type>grpc-java</type>
                                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.15.0</pluginArtifact>
                                    <outputDirectory>src/main/java</outputDirectory>
                                </outputTarget>
                            </outputTargets>
                        </configuration>
                    </execution>
                </executions>
            </plugin>


            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

这里面主要有2部分，

• dependencies 指定grpc相关依赖。
• build指定了默认的目标和引入了protoc相关插件。inputDirectories指定去扫描哪些proto文件。includeDirectories指定了哪些依赖包。 后面我们会构建一个带有多个proto文件包引用的例子来模拟更真实的调用。

测试

cd grpcExample
mvn

会看到如下结果： 代表第一步maven依赖已经完成。
我们第一部分代码完成，代码分支：step1-import-mvn

下一步

下一篇中，我们会编写测试proto文件。