Mac 环境下 protobuf-java 快速使用

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接： https://blog.csdn.net/weixin_45505313/article/details/102479891

1. protobuf 简介

Protobuf 是 Google 开发的一种数据交换的序列化协议，常用于 RPC 调用中，性能非常高，大部分 IM 通讯协议都是使用它来传输

2. Mac 环境 protobuf-java 安装

打开终端，使用命令:
brew install protobuf

如未安装 brew，可使用如下命令安装:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/ Homebrew/install/master/install)"

安装完成后可使用如下命令来验证安装结果:
protoc --version

3. protobuf-java 的使用

3.1 生成 protobuf 的 Java 文件

1. 编写 *.proto 文件用以描述一个消息的结构，此处以 proto_basic.proto 为例子，message 可以嵌套使用，类似 JSON ，故可以表达丰富的信息

   syntax = "proto3";  // 指定使用 proto3 语法
   
   option java_package = "com.example.demo.proto"; // 指定包名
   option java_outer_classname = "BasicProto"; // 指定类名
   
   message Person {
      string name = 1;
      int32 id = 2;
      string email = 3;
   
      enum PhoneType {
           MOBILE = 0;
           HOME = 1;
           WORK = 2;
       }
   
       message PhoneNumber {
           string number = 1;
           PhoneType type = 2;
       }
   
       repeated PhoneNumber phone = 4;// 数组结构
   }
   

2. 编写编译脚本 gen_code.sh
   给脚本文件授权 chmod 744 gen_code.sh，之后使用命令 . gen_code.sh运行该脚本，即能将 proto 文件信息转化为指定 Java 类，脚本文件内容如下：
   protoc –java_out=…/…/java *.proto

    #!/usr/bin/env sh
    protoc --java_out=../../java *.proto
   

   文件结构如下：
   

3.2 protobuf-java 文件的使用

1. 生成的 Java 文件作为一个消息的结构定义和普通 Java 类使用方式相同，但是使用前需引入依赖，以支持正常使用

    Gradle 依赖：在 build.gradle 文件中添加配置
    dependencies {
    	compile 'com.google.protobuf:protobuf-java:3.10.0' //版本
    }
   

    Maven 依赖：在 pom.xml 中添加以下配置
    <dependency>
    	<groupId>com.google.protobuf</groupId>
    	<artifactId>protobuf-java</artifactId>
    	<version>3.10.0</version>
    </dependency>
   

2. 引入依赖后的使用示例如下

    @SpringBootApplication
    public class TestApplication {
   
    	public static void main(String[] args) {
        	BasicProto.Person.Builder personBuilder = 
        					BasicProto.Person.newBuilder();
       	 	personBuilder.setId(12);
       		BasicProto.Person person = personBuilder.build();
        	System.out.println("good job "+ person);
        	SpringApplication.run(TestApplication.class, args);
    	}
    }