介绍

特性

• 🚀 支持 Google Protocol Buffers
• 🚀 无外部依赖

软件架构

架构

软件目前主要分为 protobuf, protoc 两个部分

• protobuf 提供 Protocol Buffers 编解码能力

• protoc 提供 protoc-gen-cj, 一个 google protoc 的 plugin, 用于使用protoc命令将.proto文件编译为仓颉代码

 protobuf:
 - abstract class MessageLite <: ToString: 定义了messages的通用操作, proto中定义的message均继承MessageLite.
 - interface Enum<E>: 定义了仓颉 enum 和 C 风格 enum 之间"映射"关系的接口, protobuf enum 实现这些接口, 从而在语言之交换 enum 信息

 protoc(protoc-gen-cj):
 - 从 stdin 读取二进制数据解析为 CodeGeneratorRequest, 根据该请求组织生成仓颉代码, 写入CodeGeneratorResponse, 打包并输出到 stdout

源码目录

.
├── README.md
├── doc
│   ├── design.md
│   ├── feature_api.md
├── src
│   ├── protobuf # protobuf核心功能
│   ├── google   # protoc依赖项
│   ├── protoc   # protoc-gen-cj插件
└── test

• . cjpm工作空间 用于管理子项目
• doc 存放库的设计文档、提案、库的使用文档、LLT 用例覆盖报告
• src 是库源码目录
• test 存放测试用例，包括 HLT 用例、LLT 用例和 UT 用例

接口说明

主要是核心类和成员函数说明见 API

编译执行

编译

cjpm build

示例

example.proto 文件内容

syntax = "proto3";
package foo;

message Person {
    string name = 1;
    int32 id = 2;
    string email = 3;
}

示例

import collection.*
import io.*
import foo.* // The foo package is generated by the protobuf-gen-cj plugin.

main() {
    var p = Person()
    // parameter assignment
    p.name = "test"
    p.id = 1
    p.email = "test@huawei.com"
    // print
    println("Serialize to string: ${p}")
    // encode
    var b = p.pack()
    println("Serialize result: ${b}")
    // decode
    var p1 = Person.fromBytes(b)
    println("Deserialization result: ${p1}")
    return
}

使用说明

• src/protoc模块会生成一个二进制protoc 此exe实际名称应为protoc-gen-cj 但protoc-gen-cj不能作为输出名称
• protoc-gen-cj是google protobuf compiler的插件
• google protobuf compiler提供了一个命令行工具protoc 用以将proto文件转换为各种语言的源码
• 只需将protoc-gen-cj放置在任何PATH路径 protoc即可调用cj能力

1. 安装google protobuf compiler
2. 安装protoc-gen-cj插件
   • 由于各种环境下对编译输出路径的重定向 此处只说明手动安装方式
   • 将编译生成的protoc手动重命名为protoc-gen-cj (windows保留exe后缀名)
   • 将protoc-gen-cj放置到任何PATH路径下
3. 使用protoc命令将proto文件编译为*.pb.cj文件: protoc --cj_out . xxx.proto (其他选项参考protoc帮助)
4. 在你的项目中导入*.pb.cj文件 并引用protobuf库
5. 如需其他格式的序列化操作 参考protobuf-format-cj

适配deveco工程

deveco的cangjie插件当前不适配workspace模式的cangjie工程

开发者需要将src/protobuf作为源码依赖加入到deveco模块中

在模块的cjpm.toml中通过dependencies管理protobuf依赖

约束与限制

1.支持的标量数值类型double、float、int32、int64、uint32、uint64、sint32、sint64、fixed32、fixed64、sfixed32、sfixed64、bool、string、bytes。

2.当前版本基于 Google Protocol Buffers V21.5 版本开发，需要符合对应版本协议的proto书写规范

开源协议

本项目基于 Copyright 2008 Google Inc ，请自由的享受和参与开源。

参与贡献

主要写参与贡献的人以及个人主页链接

@chinesebear@tutudo@hardwork001