idea 编译protobuf 文件的设置使用

protobuf 是一种数据格式，文件是.proto 格式的，有时需要编译成java 文件，目前流行 idea 工具开发并编译。那么应该怎么准备环境呢？我这有两种方案：下载idea插件编译和通过maven 编译：

二者相同的步骤如下：idea 下载插件

一、下载idea插件编译：

1、安装成功后重启：出现以下按钮说明安装成功。

2、官网下载protobuf 编译工具：protoc-3.11.8-win64.rar,解压打开后显示：

例如： D:\Program Files\protoc-3.11.4-win64\bin\proto.exe

3、点开 Idea上插件 Google ProtobufTool 按钮，点击setting 设置编译相关目录

4、通过有边的Browse 按钮选择相应目录：

protoc_path :就是刚刚下载的工具的目录+命令（=后面是需要编译的.proto 文件的目录），

比如： D:\Program Files\protoc-3.11.4-win64\bin\proto.exe -I=E:\ideaProject\nmp-sdk\nmp-sdk\proto

protofile_path:需要编译的.proto 文件的目录

out_path :编译生成的java文件输出的目录

5、点击成功后进入这个页面：

6、选择一些文件点击Gen 就会编译如图：

7、编译成功图：

二、maven 编译方案下篇详细介绍，这个方案比较简单易用

1、pom.xml 中引用相关jar:

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

<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-core</artifactId>
    <version>1.6.1</version>
</dependency>
<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-protobuf-lite</artifactId>
    <version>1.6.1</version>
</dependency>
<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-protobuf</artifactId>
    <version>${grpc.version}</version>
</dependency>

插件需要的信息

 <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <!--proto编译-->
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.5.1</version>
                <configuration>
                    <!--protobuf 编译成java 文件时用这个目录,二选一-->
<!--                    <protoSourceRoot>${project.basedir}/proto</protoSourceRoot>-->
                    <!--生成后的java 文件 编译成jar包时用这个目录,二选一-->
                    <protoSourceRoot>${project.basedir}/src</protoSourceRoot>
                  
                    <!--<outputDirectory>${project.build.directory}/generated-sources/protobuf/java</outputDirectory>-->
             <!--编译后文件的输出的目录-->
                    <outputDirectory>${project.build.sourceDirectory}</outputDirectory>
             <!--设置是否在生成java文件之前清空outputDirectory的文件，默认值为true-->
                    <clearOutputDirectory>false</clearOutputDirectory>

                    <!--suppress UnresolvedMavenProperty -->
                    <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>

extensions 扩展配置：

<extensions>
    <extension>
        <groupId>kr.motd.maven</groupId>
        <artifactId>os-maven-plugin</artifactId>
        <version>1.5.0.Final</version>
    </extension>
</extensions>

grpc 配置

<!--grpc版本号-->
<grpc.version>1.6.1</grpc.version>
<!--protobuf 版本号-->
<protobuf.version>3.9.0</protobuf.version>

2、引入成功后打开maven插件，点击此处，生成相应的java文件：

（根据个人需求，我这里配置这个：<protoSourceRoot>${project.basedir}/proto</protoSourceRoot>）

3、然后把相关java文件打成单独的jar 包：

（根据个人需求，我这里配置这个：<protoSourceRoot>${project.basedir}/src</protoSourceRoot>）

4、此处编译成功，最后对该项目pom文件里的标签整体解析一下，加深大家的理解：

<?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">
    <parent>
        <artifactId>nmp-sdk</artifactId>
        <groupId>com.navinfo.nmp</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>${parent.groupId}</groupId>
    <artifactId>nmp-sdk-proto</artifactId>
    <packaging>jar</packaging><!--项目产生的构件类型，例如jar、war、ear、pom。插件可以创建他们自己的构件类型，所以前面列的不是全部构件类型 -->
    <version>1.0-SNAPSHOT</version>

 <!--此次jar包引入 -->
    <dependencies>
        <dependency>
            <groupId>com.rabbitmq</groupId>
            <artifactId>amqp-client</artifactId>
            <version>4.1.0</version>
        </dependency>
        <dependency>
            <groupId>commons-httpclient</groupId>
            <artifactId>commons-httpclient</artifactId>
            <version>3.1</version>
        </dependency>
        <!--fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.33</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-nop</artifactId>
            <version>1.7.2</version>
        </dependency>

        <dependency>
            <groupId>org.locationtech.jts</groupId>
            <artifactId> jts-core</artifactId>
            <version>1.15.1</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId> lombok</artifactId>
            <version>1.18.4</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId> protobuf-java</artifactId>
            <version>3.9.0</version>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-core</artifactId>
            <version>1.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-protobuf-lite</artifactId>
            <version>1.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-protobuf</artifactId>
            <version>${grpc.version}</version>
        </dependency>
    </dependencies>
 <!--项目分发信息，在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。 -->
     <distributionManagement>
         <repository>
             <id>lock-releases</id>
             <name>Release Deploy</name>
             <url>http://10.60.145.1:881/repository/maven-releases/</url>
         </repository>
<!--构件的快照部署到哪里？如果没有配置该元素，默认部署到repository元素配置的仓库，参见distributionManagement/repository元素 -->
         <snapshotRepository>
             <id>lock-snapshot</id>
             <name>Snapshot Deploy</name>
             <url>http://10.60.145.241:881/repository/maven-snapshots/</url>
         </snapshotRepository>
     </distributionManagement>
    <build>
        <finalName>nmp-sdk-proto</finalName>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
                <excludes>
                    <exclude>**/*.java</exclude>
                </excludes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>assembly</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
<!--protobuf相关配置 -->
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.5.1</version>
                <configuration>
                    <!--protobuf 编译成java 文件时用这个目录,二选一-->
                    <protoSourceRoot>${project.basedir}/proto</protoSourceRoot>
                    <!--生成后的java 文件 编译成jar包时用这个目录,二选一-->
                   <!-- <protoSourceRoot>${project.basedir}/src</protoSourceRoot>-->
                    <!--默认值-->
                    <outputDirectory>${project.build.sourceDirectory}</outputDirectory>
                    <!--设置是否在生成java文件之前清空outputDirectory的文件，默认值为true-->
                    <clearOutputDirectory>false</clearOutputDirectory>

                    <!--suppress UnresolvedMavenProperty -->
                    <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <!--suppress UnresolvedMavenProperty -->
                    <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>
<!--使用来自该项目的一系列构建扩展 -->
        <extensions>
            <extension>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>1.5.0.Final</version>
            </extension>
        </extensions>
    </build>
<!--项目开发者属性，如即时消息如何处理等 -->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <enduro.version>0.0.1-SNAPSHOT</enduro.version>
        <!--grpc版本号-->
        <grpc.version>1.6.1</grpc.version>
        <!--protobuf 版本号-->
        <protobuf.version>3.9.0</protobuf.version>
    </properties>

</project>

5、到此就结束了，有不明白的地方欢迎留言！

idea 编译protobuf 文件的设置使用

猜你喜欢