Spring Boot 集成 Protobuf 快速入门 Demo

1、什么是 Protobuf？

Protobuf（Protocol Buffers）是由 Google 开发的一种轻量级、高效的数据交换格式，它被用于结构化数据的序列化、反序列化和传输。相比于 XML 和 JSON 等文本格式，Protobuf 具有更小的数据体积、更快的解析速度和更强的可扩展性。Protobuf 的核心思想是使用协议（Protocol）来定义数据的结构和编码方式。使用 Protobuf，可以先定义数据的结构和各字段的类型、字段等信息，然后使用 Protobuf 提供的编译器生成对应的代码，用于序列化和反序列化数据。

Protobuf 有以下几个优势：

1、 更小的数据量：Protobuf 的二进制编码通常只有 XML 和 JSON 的 1/3 到 1/10 左右，因此在网络传输和存储数据时可以节省带宽和存储空间。
2、 更快的序列化和反序列化速度：由于 Protobuf 使用二进制格式，所以序列化和反序列化速度比 XML 和 JSON 快得多。
3、 跨语言：Protobuf 支持多种编程语言，可以使用不同的编程语言来编写客户端和服务端。这种跨语言的特性使得 Protobuf 受到很多开发者的欢迎（JSON 也是如此）。
4、 易于维护可扩展：Protobuf 使用 .proto 文件定义数据模型和数据格式，这种文件比 XML 和 JSON 更容易阅读和维护，且可以在不破坏原有协议的基础上，轻松添加或删除字段，实现版本升级和兼容性。

2、代码工程

实验目标

本实验的目标是实现基于 Protobuf 协议的 REST API 通信。

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">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.2.1</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>protobuf</artifactId>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>3.19.2</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.6.1</version>
                <configuration>
                    <protoSourceRoot>${basedir}/src/main/resources</protoSourceRoot>
                    <protocArtifact>com.google.protobuf:protoc:3.19.1:exe:${os.detected.classifier}</protocArtifact>
                    <outputDirectory>src/main/java</outputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build></project>

定义 Protobuf 文件

在 src/main/resources 目录下创建 mxsm.proto 文件：

syntax = "proto3";
package mxsm;
option java_package = "com.et.protobuf";
option java_outer_classname = "ProtobufMessage";

message Student {
    int32 id = 1;
    string first_name = 2;
    string last_name = 3;
    string email = 4;
    repeated PhoneNumber phone = 5;

    message PhoneNumber {
        string number = 1;
        PhoneType type = 2;
    }

    enum PhoneType {
        MOBILE = 0;
        LANDLINE = 1;
    }
}

配置类

在 com.et.protobuf.config 包下创建 Config 类：

package com.et.protobuf.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter;
import org.springframework.web.client.RestTemplate;

import java.util.Arrays;

@Configurationpublic class Config {
    @Bean
    public RestTemplate restTemplate(ProtobufHttpMessageConverter hmc) {
        return new RestTemplate(Arrays.asList(hmc));
    }

    @Bean
    public ProtobufHttpMessageConverter protobufHttpMessageConverter() {
        return new ProtobufHttpMessageConverter();
    }
}

控制器类

在 com.et.protobuf.controller 包下创建 HelloWorldController 类：

package com.et.protobuf.controller;

import com.et.protobuf.ProtobufMessage;
import com.et.protobuf.StudentJson;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestControllerpublic class HelloWorldController {
    @RequestMapping("/json/{id}")
    public StudentJson showHelloWorld(@PathVariable Integer id) {
        StudentJson studentJson = new StudentJson();
        studentJson.setId(id);
        studentJson.setFirstName("张三");
        studentJson.setLastName("李四");
        studentJson.setEmail("zhangsan@example.com");

        // 创建电话对象
        StudentJson.PhoneNumber phoneNum = new StudentJson.PhoneNumber();
        phoneNum.setNumber("123456789");
        phoneNum.setType(1);

        List<StudentJson.PhoneNumber> list = new ArrayList<>();
        list.add(phoneNum);

        studentJson.setPhone(list);
        return studentJson;
    }

    @RequestMapping("/protobuf/{id}")
    public ProtobufMessage.Student protobuf(@PathVariable Integer id) {
        return ProtobufMessage.Student.newBuilder()
                .setId(id)
                .setFirstName("张三")
                .setLastName("李四")
                .setEmail("zhangsan@example.com")
                .addPhone(ProtobufMessage.Student.PhoneNumber.newBuilder()
                        .setNumber("123456789")
                        .setType(ProtobufMessage.Student.PhoneType.MOBILE).build())
                .build();
    }
}

实体类

在 com.et.protobuf 包下创建 StudentJson 类：

package com.et.protobuf;

import java.util.List;

public class StudentJson {
    private int id;
    private String firstName;
    private String lastName;
    private String email;
    private List<PhoneNumber> phone;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public List<PhoneNumber> getPhone() {
        return phone;
    }

    public void setPhone(List<PhoneNumber> phone) {
        this.phone = phone;
    }

    public static class PhoneNumber {
        private int type;
        private String number;

        public int getType() {
            return type;
        }

        public void setType(int type) {
            this.type = type;
        }

        public String getNumber() {
            return number;
        }

        public void setNumber(String number) {
            this.number = number;
        }
    }
}

3、测试

启动 Spring Boot 应用，并编写测试类。

测试类

在 com.et.protobuf 包下创建 ApplicationTest 类：

package com.et.protobuf;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

@SpringBootTest(classes = DemoApplication.class)
public class ApplicationTest {
    private static final String STUDENT_URL = "http://localhost:8080/protobuf/1";

    @Autowired
    private RestTemplate

 restTemplate;

    @Test
    public void whenUsingRestTemplate_thenSucceed() {
        ResponseEntity<ProtobufMessage.Student> student = restTemplate.getForEntity(STUDENT_URL, ProtobufMessage.Student.class);
        System.out.println("学生信息: " + student.toString());
    }
}

4、引用

参考资料：Protobuf 官方文档

以上就是一个简单的 Spring Boot 集成 Protobuf 的示例，通过这个示例，你可以了解如何在 Spring Boot 项目中使用 Protobuf 进行数据传输和处理。希望对你有所帮助！

推荐一个springboot的入门教程，有需要的可以学起来：

一起来学 SpringBoot 2.x | 第一篇：构建第一个 SpringBoot 工程
一起来学 SpringBoot 2.x | 第二篇：SpringBoot配置详解
一起来学 SpringBoot 2.x | 第三篇：SpringBoot日志配置
一起来学 SpringBoot 2.x | 第五篇：使用 JdbcTemplate 访问数据库
一起来学 SpringBoot 2.x | 第四篇：整合Thymeleaf模板
一起来学 SpringBoot 2.x | 第六篇：整合SpringDataJpa
一起来学 SpringBoot 2.x | 第七篇：整合Mybatis
一起来学 SpringBoot 2.x | 第八篇：通用Mapper与分页插件的集成
一起来学 SpringBoot 2.x | 第十篇：使用Spring Cache集成Redis
一起来学 SpringBoot 2.x | 第九篇：整合Lettuce Redis
一起来学 SpringBoot 2.x | 第十一篇：集成Swagger在线调试
一起来学 SpringBoot 2.x | 第十二篇：初探RabbitMQ消息队列
一起来学 SpringBoot 2.x | 第十三篇：RabbitMQ延迟队列
一起来学 SpringBoot 2.x | 第十四篇：强大的 actuator 服务监控与管理
一起来学 SpringBoot 2.x | 第十六篇：定时任务详解
一起来学 SpringBoot 2.x | 第十五篇：actuator与Spring-boot-admin 可以说的秘密
一起来学 SpringBoot 2.x | 第十七篇：轻松搞定文件上传
一起来学 SpringBoot 2.x | 第十八篇：轻松搞定全局异常
一起来学 SpringBoot 2.x | 第十九篇：轻松搞定数据验证（一）
一起来学 SpringBoot 2.x | 第二十篇：轻松搞定数据验证（二）
一起来学 SpringBoot 2.x | 第二十一篇：轻松搞定数据验证（三）
一起来学 SpringBoot 2.x | 第二十二篇：轻松搞定重复提交（本地锁）
一起来学 SpringBoot 2.x | 第二十三篇：轻松搞定重复提交（分布式锁）
一起来学 SpringBoot 2.x | 第二十五篇：打造属于你的聊天室（WebSocket）
一起来学 SpringBoot 2.x | 第二十四篇：数据库管理与迁移（Liquibase）
一起来学 SpringBoot 2.x | 第二十六篇：轻松搞定安全框架（Shiro）
一起来学 SpringBoot 2.x | 第二十七篇：优雅解决分布式限流