[Java知识库]IDEA使用maven插件生成protobuf实体类

1.下载对应操作系统的 protoc 可执行文件

官方地址：https://github.com/protocolbuffers/protobuf/releases/tag/v3.20.0

上面2个分别对应windows和mac操作系统，下载好后解压，下面会用到

2.maven项目中引入protobuf依赖（含jar和插件）

下载好pom.xml中引入的依赖和插件，引入protobuf-java依赖是生成好的java实体类中有用

<dependencies>
    <dependency>
        <groupId>com.google.protobuf</groupId>
        <artifactId>protobuf-java</artifactId>
        <version>3.19.4</version>
    </dependency>
    <dependency>
        <groupId>com.google.protobuf</groupId>
        <artifactId>protobuf-java-util</artifactId>
        <version>3.19.4</version>
        <scope>runtime</scope>
    </dependency>
</dependencies>
<build>
        <!--添加编译proto文件的编译程序和对应的编译插件-->
        <plugin>
            <groupId>org.xolstice.maven.plugins</groupId>
            <artifactId>protobuf-maven-plugin</artifactId>
            <version>0.6.1</version>
            <configuration>
                <pluginId>grpc-java</pluginId>
                <!-- proto文件路径 -->
                <protoSourceRoot>${project.basedir}/src/main/proto</protoSourceRoot>
                <!-- 生成后的文件存放根路径 -->
                <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
                <!-- 是否在生成Java文件前清空outputDirectory的文件 -->
                <clearOutputDirectory>false</clearOutputDirectory>
                <!-- 在github下载的 protoc 可执行文件路径 -->
<!-- 在windows上的位置：<protocExecutable>${project.basedir}/src/main/proto/protoc.exe</protocExecutable>-->
                <!-- 下面是mac下的protoc可执行文件全路径 -->
                <protocExecutable>/Users/zhuyu/zy/protobuf/protoc-3.19.4-osx-x86_64/bin/protoc</protocExecutable>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3.新增proto文件，目录：/src/main/proto/Msg.proto

syntax = "proto3";

//package com.zynetty.protobuf;

//[开始 Java选项配置]
option java_package = "com.zynetty.protobuf";
option java_outer_classname = "MsgProtos";
//[结束 Java选项配置]

//[开始消息定义]
message Msg {
  uint32 id=1;      //消息ID
  string content=2; //消息内容
}
//[结束消息定义]

4.idea -> Maven -> Plugins -> protobuf -> 点击 protobuf:compile 就可以生成portobuf java实体类

5.会根据配置好的路径和package，在目录下生成Java实体类

6.补充

看到一些网友还给idea安装了Protobuf Support插件，我没发现用到