SpringBoot + GoogleProtobuf

最新推荐文章于 2024-09-11 07:42:00 发布
最新推荐文章于 2024-09-11 07:42:00 发布
阅读量860 收藏 3
点赞数
分类专栏： SpringBoot 文章标签： java protobuf spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：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        =
最低0.47元/天 解锁文章
Cyansnow
关注
专栏目录
【项目实战】Protocol Buffers系列文章之SpringBoot整合Protobuf，实现基于RestTemplate的模拟客户端与服务端的远程调用
本本本添哥
03-09 2836
项目中使用到了Protobuf，但是因为不知道怎么使用它，所以看起来很高大上，现在写一个简单的Demo来实现基于RestTemplate的模拟客户端与服务端的远程调用！
SpringBoot+gRPC+ProtoBuf实现远程服务调用
郄梦岩的博客
09-15 1028
本文展示SpringBoot+gRPC完整版代码示例（客户端、服务端） 一、客户端 1.编写pom.xml导入对应的jar包 <dependency> <groupId>net.devh</groupId> <artifactId>grpc-spring-boot-starter</artifactId> <version>2.9.0.REL
Springboot集成ProtoBuf
xrq0508的博客
04-30 8274
ProtoBuf是一种序列化和解析速度远高于JSON和XML的数据格式，项目中使用了CouchBase作为缓存服务器，从数据库中拿到数据后通过protobuf序列化后放入CouchBase作为缓存，查询数据的时候解压并反序列化成数据对象，下面是ProtoBuf的具体使用方法 1、pom.xml引入相关依赖 <dependency> <groupId>com....
Protoman使用与安装指南
最新发布
gitblog_01064的博客
09-11 855
Protoman使用与安装指南 Protoman Postman for protobuf APIs 项目地址: https://gitcode.com/gh_mirrors/pr/Protoman ...
springboot+redis(luttuce)+Protobuf
10-18
springboot整合redis选用 `Lettuce` 作为redis框架，选用 `Protobuf` 作为序列化框架
13. Springboot集成Protobuf
有一只柴犬的专栏
03-02 3295
在以往的项目中进行网络通信和数据交换的应用场景中，最经常使用的技术便是json或xml。随着JSON的灵活优势，越来越多的企业选择JSON作为数据交换的格式，目前JSON已经成为了业界的主流。JSON已经足够好用，且能满足相当大部分的场景。但是今天在介绍一个Google的力作protobuf作为数据交换格式。我们来看看。
Spring boot 2.5 集成 Google protocol buffer
Mrqiang9001
08-13 1946
Spring boot 2.5 集成 Google protocol buffer ​ ​ ​ 1 摘要 Portocol Buffers 是一种由 Google 开源的数据序列化格式，简称 protobuf，这是一种支持多语言、无关操作系统平台的、具有拓展性的数据格式。为什么要有 protobuf？或者说 protobuf 的应用场景有哪些？答案是 probuf 的最大优势是体积小，适用于网络状况不佳或者网络带宽有限的设备之间通讯，比如 IoT 之间数据传输。对于网页而言，则完全没有必要。除了网络带宽足够
Springboot集成websocket+protobuf基本Demo，可实现后端与前端数据实时发送与接收.zip
01-04
protobuf是Google推出的一种高效的数据序列化协议，它能将结构化数据序列化为二进制流，相比JSON或XML，protobuf更紧凑、解析速度更快。 在Spring Boot中使用protobuf，首先需要定义.proto文件，该文件描述了数据的...
SpringBoot整合kafka及ProtoBuf实现跨平台跨语言的信息交互
10-28
在现代分布式系统中，数据通信和信息交互是关键部分，SpringBoot、Kafka以及ProtoBuf的结合使用可以构建高效、可扩展的解决方案。本篇文章将深入探讨如何利用这些技术实现跨平台、跨语言的信息交互。 首先，让我们...
springboot集成netty，使用protobuf作为数据交换格式，可以用于智能终端云端服务脚手架
04-08
本项目“springboot-netty-protobuf-master”旨在提供一个基础架构，它利用了Spring Boot的便捷性以及Netty的高效网络通信能力，同时采用Google的Protocol Buffers（protobuf）作为数据交换格式，确保数据传输的高效...
ProtoBuf及整合到SpringBoot
yangzhe19931117的博客
04-16 1979
protobuf是跨语言的，并且自带一个编译器(protoc)，只需要用protoc进行编译，就可以编译成Java、Python、C++、C#、Go等多种语言代码，然后可以直接使用，不需要再写其它代码，自带有解析的代码。Protobuf(Google Protocol Buffer)是Google公司开发的一种跨语言和平台的序列化数据结构的方式，是一个灵活的、高效的用于序列化数据的协议。3、将生成的MessageUser.java放到对应的位置，如com\example\demo\protobuf。
spring boot protobuf demo
07-05
spring boot protobuf demo
【Protobuf】Springboot集成protobuf
No8g攻城狮的博客
04-28 2585
定义两个proto文件，一个用于接收接口请求数据 Student.proto，一个用于响应 Response.proto。Tips：对于新手来说，定义的这个 .proto 文件还不知道放在哪个目录下。注意：此文件是放在静态资源 resources 目录下。// 指定 Protobuf 版本为版本 3（最新版本）// 指定protobuf包名，防止类名重复// 生成的文件存放在哪个包下，对于新手来说，不指定生成到哪个目录下即可，不建议指定包（否则，可能让你怀疑人生）
Springboot+protocolbuffer学习加测试用例
qq_34918776的博客
11-30 730
protobuf使用流程 定义用于文件.proto 使用protobuf的编译器编译消息文件 使用编译好对应语言的类文件进行消息的序列化与反序列化 新增依赖 核心依赖 &lt;dependency&gt; &lt;groupId&gt;com.google.protobuf&lt;/groupId&gt; &lt;artifactId&gt;protobuf-java&lt;/art...
spring boot 引入Protocol Buffer
ityqing的博客
11-02 1649
Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准，目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。 Protocol Buffers 是一种轻便高效的结构化数据存储格式，可以用于结构化数据串行化，或者说序列化。它很适合做数据存储或 R...
springboot 集成 grpc 和 protobuf（二） | 在实际项目中使用 grpc 和 protobuf
慌途L
12-08 5658
springboot 集成 grpc 和 protobuf（二） | 在实际项目中使用 grpc 和 protobuf 一、引入pom依赖
protobuf（二）springboot整合protobuf传输数据
qly的博客
03-11 2320
springboot整合protobuf传输数据具体实践环境准备开发定义传输内容后端开发前端开发测试传输效果 具体实践 环境准备 后端 见博客：protobuf（一）认识protobuf 前端 1）nodejs： 官网下载；PS：本次我仍是利用浏览器作为js解释器 2）protbufjs：https://github.com/protobufjs/protobuf.js 开发 定义传输内容 首先，写一个.proto文件 后端开发 将.proto编译为.java 采用springboot框架，
Spring Boot中关于 HTTP 中请求转发与重定向以及注解
可小辉的博客
03-25 4842
1.控制器 1.Controller 2.RestController 2.HTTP请求参数 1.字符串查询参数 2.协议主体中的负载 3.URL路径 3.注解 1.工程目录 User.java package com.newer.anno; //附加信息 //元数据信息，反射（黑魔法）可以获得这些信息 //源码级...
Springboot接口、入参、出参使用字节流传输数据，使用协议proto序列化
zhou870498的博客
05-25 1524
springboot使用protobuf协议序列化，网上找了半天没找到满意的结果，其实不用设置contentType，入参、出参均使用字节流形式。对于字节流可以自己在入参增加解密算法，出参增加加密算法。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值