Intellij IDEA中使用Protobuf的正确姿势

逃离我推掉我的手 2022-04-24 09:58 444阅读 0赞

### 1. `.proto`文件语法高亮显示 ###

**需要安装`Protobuf Support`插件：**  
依次点击Intellij中的`“File”-->"Settings"-->"Plugins"-->"Browse repositories"`，如下所示：  
![在这里插入图片描述][380081-20170911152731000-1032816828.png]  
输入Protobuf，如下所示：  
![在这里插入图片描述][380081-20170911152836297-623335650.png]  
安装完后，重启Intellij IDEA，查看`.proto`文件，会发现已经支持语法高亮显示。

### 2. 将.proto文件转成Java类 ###

一般的做法，是执行`protoc`命令，依次将`.proto`文件转成Java类:

protoc.exe -I=d:/tmp --java_out=d:/tmp d:/tmp/monitor_data.proto

不过gRPC官方推荐了一种更优雅的使用姿势，可以通过`maven`轻松搞定

#### 2.1 pom.xml文件配置 ####

<dependencies>
             <dependency>
                <groupId>io.grpc</groupId>
                <artifactId>grpc-netty</artifactId>
                <version>${grpc.version}</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                <groupId>io.grpc</groupId>
                <artifactId>grpc-protobuf</artifactId>
                <version>${grpc.version}</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                <groupId>io.grpc</groupId>
                <artifactId>grpc-stub</artifactId>
                <version>${grpc.version}</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                <groupId>com.google.protobuf</groupId>
                <artifactId>protobuf-java</artifactId>
                <version>${protobuf.version}</version>
            </dependency>
    </dependencies>

<build>
            <extensions>
                <extension>
                    <groupId>kr.motd.maven</groupId>
                    <artifactId>os-maven-plugin</artifactId>
                    <version>1.5.0.Final</version>
                </extension>
            </extensions>
            <plugins>
                <plugin>
                    <groupId>org.xolstice.maven.plugins</groupId>
                    <artifactId>protobuf-maven-plugin</artifactId>
                    <version>0.5.0</version>
                    <configuration>
                        <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
                        <pluginId>grpc-java</pluginId>
                        <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
                    </configuration>
                    <executions>
                        <execution>
                            <goals>
                                <goal>compile</goal>
                                <goal>compile-custom</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>            
            </plugins>
        </build>

### 2.2 编译生成Java类 ###

使用`maven`的编译命令，即可在`target`中看到根据`.proto`文件生成的Java类，如下所示：  
![在这里插入图片描述][380081-20170911161621641-1667317613.png]

--------------------

##### 转自：[https://www.cnblogs.com/liugh/p/7505533.html][https_www.cnblogs.com_liugh_p_7505533.html] #####

[380081-20170911152731000-1032816828.png]: /images/20220216/4ebd9300b0224546a3135d7a8b634c07.png
[380081-20170911152836297-623335650.png]: /images/20220216/00d33ad80c8547138f9b386ddf361a43.png
[380081-20170911161621641-1667317613.png]: /images/20220216/4a7e3d4f1d3241b7937e00a28c087aad.png
[https_www.cnblogs.com_liugh_p_7505533.html]: https://www.cnblogs.com/liugh/p/7505533.html