SpringBoot + GoogleProtobuf

最新推荐文章于 2024-07-31 11:30:30 发布

Cyansnow

最新推荐文章于 2024-07-31 11:30:30 发布

阅读量845

点赞数

分类专栏： SpringBoot 文章标签： java protobuf spring boot

本文链接：https://blog.csdn.net/cyansnow/article/details/115508785

版权

本文详细介绍了如何在SpringBoot项目中集成GoogleProtobuf，包括环境配置、项目配置、Proto文件编写、Pojo文件创建、Service接口及实现、配置文件设定、Controller接口编写以及使用Postman和Protoman测试接口的过程。

摘要由CSDN通过智能技术生成

SpringBoot + GoogleProtobuf

项目地址: protobuf-simple ：https://github.com/Cyanss/protobuf-simple

一、环境配置

protobuf-java版本的选择需要对应到C++等其他端的版本以及Maven中protobuf-java版本。这里选择3.4.0版本进行演示及测试。

电脑系统:

Windows 10 x64 bit

protobuf GitHub:

https://github.com/protocolbuffers/protobuf

protobuf 源码下载:

protobuf-java-3.4.0.zip

https://github.com/protocolbuffers/protobuf/releases/download/v3.4.0/protobuf-java-3.4.0.zip

protoc 编译器下载:

protoc-3.4.0-win32.zip

https://github.com/protocolbuffers/protobuf/releases/download/v3.4.0/protoc-3.4.0-win32.zip

注：protoc编译器3.4.0版本只有32位安装包。

protobuf-java 依赖:

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>3.4.0</version>
    <scope>compile</scope>
</dependency>

Json转换工具:

<dependency>  
    <groupId>com.googlecode.protobuf-java-format</groupId>  
    <artifactId>protobuf-java-format</artifactId>  
    <version>1.4</version>  
</dependency>

Protoman测试工具:

Protoman github : https://github.com/haizhibin1989/Protoman

Protoman_Setup_0.4.0.exe: https://github.com/haizhibin1989/Protoman

将相关的工具下载，小伙伴们也可以根据自己的环境以及需求选择其他版本或者环境的。

protobuf安装配置：

D盘新建Protobuf文件夹，我们将下载的protobuf和protoc编译器分别解压到这个文件夹。

├─Protobuf
│  ├─protobuf-3.4.0
│  │  ├─benchmarks
│  │  ├─cmake
│  │  ├─conformance
│  │  ├─editors
│  │  ├─examples
│  │  ├─gmock
│  │  ├─java
│  │  ├─m4
│  │  ├─objectivec
│  │  ├─python
│  │  ├─src
│  │  └─util
│  ├─protoc-3.4.0-win32
│  │  ├─bin
│  │  └─include

右键我的电脑 > 属性 > 高级系统设置 > 环境变量。

在环境变量的系统变量选项新建系统变量：

PROTO_SRC_HOME值为：D:\Protobuf\protobuf-3.4.0
PROTO_HOME值为：D:\Protobuf\protoc-3.4.0-win32

选择Path > 编辑 > 新建，%PROTO_HOME%\bin和%PROTO_SRC_HOME%\src

按快捷键Win+X > Windows PowerShell(I)。

输入protoc --version验证protoc编译器环境配置：

Windows PowerShell
版权所有 (C) 2016 Microsoft Corporation。保留所有权利。

PS C:\Users\Cyan> protoc --version
libprotoc 3.4.0

二、项目配置

打开IDEA新建protobuf-simple项目，删除暂时用不到的.mvn、HELP.md、mvnw、mvnw.cmd和resources目录下的static、templates、test文件，引入我们需要的Mave依赖，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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>cyan.simple</groupId>
    <artifactId>protobuf-simple</artifactId>
    <version>0.1.0-SNAPSHOT</version>
    <name>protobuf-simple</name>
    <description>protobuf simple project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <repositories>
        <repository>
            <id>aliyun-central</id>
            <name>aliyun maven centrals</name>
            <url>https://maven.aliyun.com/repository/central</url>
        </repository>
        <repository>
            <id>aliyun-google</id>
            <name>aliyun maven google</name>
            <url>https://maven.aliyun.com/repository/google</url>
        </repository>
        <repository>
            <id>aliyun-spring</id>
            <name>aliyun maven spring</name>
            <url>https://maven.aliyun.com/repository/spring</url>
        </repository>
        <repository>
            <id>aliyun-spring-plugin</id>
            <name>aliyun maven spring-plugin</name>
            <url>https://maven.aliyun.com/repository/spring-plugin</url>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.18</version>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>3.4.0</version>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>com.googlecode.protobuf-java-format</groupId>
            <artifactId>protobuf-java-format</artifactId>
            <version>1.4</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

Ctrl+Alt+S打开设置，找到Plugins安装proto相关插件，在Marketplace中搜索proto,选择GenProtobuf、Protobuf Support、Protobuf Highlight插件。

安装完成重启IDEA后，Ctrl+Alt+S打开设置,在Settings中搜索proto,找到Tools下的ProtoBuf Compiler配置protoc的路径: D:\Protobuf\protoc-3.4.0-win32\bin\protoc.exe。

关闭设置界面，选择Tools目录下的Configure GenProtobuf,选择protoc的路径：D:\Protobuf\protoc-3.4.0-win32\bin\protoc.exe。语言配置选择Java,勾选下方文件生成路径中的Java选项，选择生成路径为当前项目下的…\java。

protoc path: D:\Protobuf\protoc-3.4.0-win32\bin\protoc.exe

Quick Gen  : Java

            Paths to save output, absolute or relative to proto file

Python     :

C++        :

......

Java       : ..\java

......

注：如果protoc的环境变量配置没问题，这里的protoc的路径配置也可以是protoc:
protoc path: protoc

Quick Gen  : Java

......

三、Proto文件编写

选择main包下新建proto包用来存放.proto文件。我们使用学生、老师以及班级的数据模型来模拟protobuf接口的访问。分别新建编写如下proto文件：

学生protobuf文件 StudentProto.proto


syntax = "proto3";
package proto;
option java_package = "cyan.simple.protobuf.model.proto";
option java_outer_classname = "StudentProto";

message StudentsMessage{
    repeated StudentMessage students = 1;
}

message StudentMessage{
    // 姓名
    string name = 1;
    // 年龄
    int32 age = 2;
    // 性别
    string sex = 3;
}

教师protobuf文件 TeacherProto.proto

syntax = "proto3";
package proto;
option java_package = "cyan.simple.protobuf.model.proto";
option java_outer_classname = "TeacherProto";


message TeachersMessage{
    repeated TeacherMessage teachers = 1;
}

message TeacherMessage{
    // 姓名
    string name = 1;
    // 年龄
    int32 age = 2;
    // 性别
    string sex = 3;
    // 学科
    string subject = 4;
}

班级protobuf文件 ClassProto.proto

syntax = "proto3";
package proto;
import "TeacherProto.proto";
import "StudentProto.proto";
option java_package = "cyan.simple.protobuf.model.proto";
option java_outer_classname = "ClassProto";

message ClassesMessage {
    repeated ClassMessage classes = 1;
}

message ClassMessage{
    // 班级名称
    string name = 1;
    // 班级人数
    int32 size = 2;
    // 教师列表
    repeated TeacherMessage teachers = 3;
    // 学生列表
    repeated StudentMessage students = 4;
}

响应结果protobuf文件 ResultProto.proto

syntax = "proto3";
package proto;
import "ClassProto.proto";
import "TeacherProto.proto";
import "StudentProto.proto";
option java_package = "cyan.simple.protobuf.model.proto";
option java_outer_classname = "ResultProto";

message ResultMessage {
    // 状态码
    int32 status        =