网站导航
> 文章列表 > nodejs微服务：关于Protobuf的使用

nodejs微服务：关于Protobuf的使用

网友: 文章列表 2024-03-21 18:11:43

nodejs微服务：关于Protobuf的使用

Protobuf

  • Protobuf是Protocol Buffers的简称，它是Google公司开发的一种数据描述语言
  • 是一种轻便高效的结构化数据存储格式，可以用于结构化数据，或者说序列化
  • 它很适合做数据存储或 RPC 数据交换格式
  • 可用于通讯协议、数据存储等地方的语言无关、平台无关、可扩展的序列化结构数据格式
  • 它是一种灵活，高效，自动化的机制，用于序列化结构化数据，对比于 XML和JSON，他更小，更快、更简单
  • 总之它是微服务中需要使用的东西，Protobuf刚开源时的定位类似于XML、JSON等数据描述语言
  • 通过附带工具生成代码并实现将结构化数据序列化的功能
  • 这里我们更关注的是Protobuf作为接口规范的描述语言，可以作为设计安全的跨语言RPC接口的基础工具
  • 总结
    • protobuf是类似与json一样的数据描述语言（数据格式）
    • protobuf非常适合于RPC数据交换格式

1 ) 优点

  • 序列化后体积相比Json和XML很小，适合网络传输
  • 支持跨平台多语言
  • 消息格式升级和兼容性很好
  • 序列化反序列化速度很快，快于Json的处理速度

2 ) 缺点

  • 应用不够广(相比xml和json)
  • 二进制格式导致可读性差
  • 缺乏自描述

Protobuf 基本语法

1 ) 文档

  • 文档: https://developers.google.com/protocol-buffers/docs/proto3

2 ) 示例

syntax = "proto3"; // 版本package greeter; // 包名 nodejs中理解为命名空间// 对外暴露的服务
service Greeter { rpc sayHello (HelloRequest) returns (HelloReply) {} // 对外暴露的函数名，参数和返回值
}// 请求参数对象
message HelloRequest {  // 名字string name = 1;// 年龄int32 age = 2 ;// 爱好repeated string hobby = 3; // string类型的数组 
}// 返回参数对象
message HelloReply {string message = 1;repeated string hobby = 2;
}

3 ) 说明

  • protobuf消息的定义（或者称为描述）通常都写在一个以 .proto 结尾的文件中
  • 该文件的第一行指定正在使用 proto3 语法：如果不这样做，协议缓冲区编译器将假定正在使用proto2
  • 这也必须是文件的第一个非空的非注释行
  • 第二行 package 命名空间包名称
  • 最后message关键字定义一个HelloRequest的消息体，类似于Nodejs语言中的对象，是包含一系列类型数据的集合
  • 许多标准的简单数据类型都可以作为字段类型，包括 bool，int，float，double，和 string
  • 也可以使用其他 message 类型作为字段类型
  • 在message中有一个字符串类型的value成员，该成员编码时用1代替名字
  • 我们知道，在json中是通过成员的名字来绑定对应的数据，但是Protobuf编码却是通过成员的唯一编号来绑定对应的数据
  • 因此Protobuf编码后数据的体积会比较小，能够快速传输，缺点是不利于阅读

4 ) message的格式说明

  • 消息由至少一个字段组合而成，类似于Nodejs中的Json对象，每个字段都有一定的格式
    • // 注释格式 注释尽量也写在内容上方
    • （字段修饰符）数据类型 字段名称 = 唯一的编号标签值
  • 唯一的编号标签：代表每个字段的一个唯一的编号标签，在同一个消息里不可以重复
    • 这些编号标签用与在消息二进制格式中标识你的字段，并且消息一旦定义就不能更改
    • 需要说明的是标签在1到15范围的采用一个字节进行编码，所以通常将标签1到15用于频繁发生的消息字段
    • 编号标签大小的范围是1到2的29次，其中 19000-19999是官方预留的值，不能使用
  • 注释格式：向.proto文件添加注释
    • 可以使用C/C++/java/Go风格的双斜杠（//） 语法格式
    • 或者 /* … */

5 ) proto类型对比

  • 由于js是一种弱类型语言，所以这里没有详细的类型展示，可以把proto中的类型和typescript中的类型对应
  • 其中proto中的数字类型对应ts的 number 类型
  • proto的字符串类型对应ts的 string 类型
  • proto的 boolean 对应ts的 boolean 类型

Protobuf 高级语法

1 ) message嵌套

  • messsage除了能放简单数据类型外，还能存放另外的message类型，如下：
syntax = "proto3"; // 指定版本信息，不指定会报错 
package helloworld; // 包名 nodejs中理解为命名空间 
//message为关键字，作用为定义一种消息类型 
message Person {// 名字string name = 1;// 年龄int32 age = 2;// 定义一个messagemessage PhoneNumber {string number = 1;int64 type = 2;}PhoneNumber phone = 3;
}

2 ) repeated关键字

  • repeadted关键字类似与js中的数组，编译之后对应的也是js的数组，用法如下：
syntax = "proto3"; //指定版本信息，不指定会报错
package helloworld; 
// message为关键字，作用为定义一种消息类型
message Person {// 名字string name = 1;// 年龄int32 age = 2;// 定义一个messagemessage PhoneNumber {string number = 1;int64 type = 2;}repeated PhoneNumber phone = 3;
}

3 ) 默认值

  • 解析数据时，如果编码的消息不包含特定的单数元素，则解析对象对象中的相应字段将设置为该字段的默认值
  • 不同类型的默认值不同，具体如下：
    • 对于字符串，默认值为空字符串
    • 对于字节，默认值为空字节
    • 对于bools，默认值为false
    • 对于数字类型，默认值为零
    • 对于枚举，默认值是第一个定义的枚举值，该值必须为0
    • repeated字段默认值是空列表
    • message字段的默认值为空对象

4 ) 定义RPC服务

  • 如果需要将message与RPC一起使用，则可以在 .proto 文件中定义RPC服务接口

  • protobuf编译器将根据你选择的语言生成RPC接口代码，官方示例如下：

    syntax = "proto3";package greeter;// The greeting service definition.
service Greeter {// Sends a greetingrpc SayHello (HelloRequest) returns (HelloReply) {}
}// The request message containing the user's name.
message HelloRequest {string name = 1;
}// The response message containing the greetings
message HelloReply {string message = 1;
}

100搞笑动画网

网络标签：

相关问题