Skip to content

Latest commit

 

History

History
222 lines (178 loc) · 9.65 KB

README_CN.md

File metadata and controls

222 lines (178 loc) · 9.65 KB

简体中文 | English

Ⅰ. 简介

  • 去中心化网络序列化库，安全可靠，自定义私有协议格式，可前后兼容，让每个人都拥有一套独一无二的协议
  • 支持将protobuf的proto文件到生成到pojo协议文件，生成完成的协议不仅可以被转为其它协议也可以被java使用
  • 协议目前原生支持 C++ Rust Java/Kotlin/Scala JavaScript/TypeScript/ES C# Go Php Ruby Lua GDScript Python Dart Swift

Ⅱ. 快速使用

  • 环境要求JDK 17+，支持OpenJDK, Oracle JDK, native GraalVM
// zfoo协议注册，只能初始化一次
ProtocolManager.initProtocol(Set.of(ComplexObject.class, ObjectA.class, ObjectB.class));

// 序列化
ProtocolManager.write(byteBuf, complexObject);

// 反序列化
var packet = ProtocolManager.read(buffer);

Ⅲ. 性能测试

操作系统：win10
cpu： i9900k
内存：64g
  • 单线程测试，横坐标为序列化和反序列化的对象数量，纵坐标为花费的时间（单位毫秒） Image text Image text Image text

Ⅳ. 为什么快

  • 使用Javassist字节码增强动态生成顺序执行的序列化和反序列化函数，顺序化的函数可以轻易的被JIT编译以达到极致的性能
  • 原生集成netty的高性能ByteBuf，支持Zero Copy
  • 使用primitive type collection，没有装箱和拆箱，避免了无效GC，性能也足够快
  • 天生线程安全并且无锁化，多线程环境无任何性能损失
  • 没有反射，没有unsafe操作，支持GraalVM
  • 扁平化了方法栈的调用深度，数据结构嵌套没有任何性能损失，如List<Set<Map<>>>；对比kryo和protobuf数据结构嵌套会出现性能损失
  • 无漏洞注入风险，只有初始化时会进行字节码增强，后期不会再进行任何字节码的操作
  • 充分利用程序局部性原理，序列化器放在short[]数组中，对象序列化和反序列化只会查找一次序列化器
数据压缩体积小，压缩体积比kryo和protobuf都要小；比kryo小是因为kryo需要写入每个对象的注册号
智能语法分析，错误的协议定义将无法启动程序并给出错误警告
提升开发效率，完全支持POJO方式开发，使用非常简单

Ⅴ. 为什么小

  • 轻量级实现，核心序列化和反序列化代码一千行左右
  • 优化了int和long的zigzag和varint编码的算法，避免了一些多余的方法调用和位操作
  • 数据压缩体积小，压缩体积比kryo和protobuf都要小；比kryo小是因为kryo需要写入每个对象的注册号
  • 智能语法分析，错误的协议定义将无法启动程序并给出错误警告
  • 提升开发效率，完全支持POJO方式开发，使用非常简单
目前的序列化过后对象的大小如下：
简单对象，zfoo包体大小8，kryo包体大小5，protobuf包体大小8
常规对象，zfoo包体大小430，kryo包体大小483，protobuf包体大小793
复杂对象，zfoo包体大小2216，kryo包体大小2528，protobuf包体大小5091

Ⅵ. 数据类型

  • 默认的数据格式支持，无需用户手动注册，参考类定义

    • boolean，byte，short，int，long，float，double，String
    • Boolean，Byte，Short，Integer，Long，Float，Double，String 序列化的时候如果null，会给个默认值
    • int[]，Integer[]，如果是null，则解析后的为一个长度为0的数组
      • 原生泛型List，Set，Map，反序列化返回类型为HashSet，ArrayList，HashMap，并且空指针安全（返回大小为0的集合）
      • List，必须指定泛型类，如果发送的是[1,1,null,1]，接收到的是[1,1,0,1]
      • List，如果发送的是[obj,obj,null,obj]，接收到的是[obj,obj,null,obj]，即引用类型序列化之前为null，序列化之后同样为null

  • 不支持的数据格式，因为zfoo会自动识别不支持的类型并且给出错误警告，所以用户不必太关心

    • int[][]，二维以上数组，考虑到不是所有语言都支持多维数组
    • List[]，Map<Integer, Integer>[]，Java语言本身就没有支持泛型类数组
    • List<int[]>，Map<Integer, Integer[]>，泛型里面套数组，这种写法看起来比较奇怪，实际使用的地方很少
    • char和Character类型，考虑到很多其他语言不支持char，可以用string在代码层面做替换
    • 枚举类，考虑到很多其他语言不支持枚举类，可以用int或者string在代码层面做替换
    • 自定义泛型类XXXClass，泛型类在很多框架中都极易出现性能上和解析上的问题，而且并不是所有语言都支持
    • 循环引用，虽然底层支持循环引用，但是考虑到循环引用带来语义上难以理解，容易出现错误，所以就屏蔽了

Ⅶ. 协议规范

  • 协议类必须是简单的javabean，不能继承任何其它的类，但是可以继承接口

  • 协议号定义为short类型是为了减少包体积和内存大小，一个包可以减少2个byte，每个协议的在应用内存也可以降低6byte（protocols + IProtocolRegistration + protocolIdMap）

一个项目的协议体类很难超过3w，会有工具自动把你的协议号打包的紧凑一点，这样你的协议号就不会超过3w了

  • 协议类必须标注协议号，有四种方式

    • 第一种使用注解：@Protocol(id = protocolId)

      @Protocol(id = 104)
public class SimpleObject {

    public int c;
    public boolean g;

}

    • 第二种使用：通过ProtocolManager.initProtocolAuto()去注册协议就可以不写协议号

      public class SimpleObject {

    public int c;

    public boolean g;

}

    • 第三种使用：通过ProtocolManagerinitProtocol(xmlProtocols)去注册协议，把协议号写在protocol.xml文件

      <protocols>
    <!-- 使用类路径 -->
    <module id="1" name="common">
        <protocol id="100" location="com.zfoo.protocol.packet.ComplexObject"/>
        <protocol id="101" location="com.zfoo.protocol.packet.NormalObject"/>
        <protocol id="102" location="com.zfoo.protocol.packet.ObjectA"/>
        <protocol id="103" location="com.zfoo.protocol.packet.ObjectB"/>
        <protocol id="104" location="com.zfoo.protocol.packet.SimpleObject"/>
        <protocol id="105" location="com.zfoo.protocol.packet.VeryBigObject"/>
        <protocol id="106" location="com.zfoo.protocol.packet.EmptyObject"/>
    </module>
    <!-- 使用包名会扫描该包路径下的所有协议类 -->
    <module id="2" name="native">
        <protocol location="com.zfoo.net.packet.common"/>
        <protocol location="com.zfoo.tank.common.protocol.common"/>
    </module>
</protocols>

    • 第四种使用：通过定义proto文件去生成带协议号的协议，这样就能轻松注册协议

      syntax = "proto3";
package test.message;

message SimpleObject {
    int64 aa = 1;
}

// 如果字段的tag超过1000，则视这个字段为需要兼容的协议字段
message OneMessage {
    // 这是属性的注释
    int64 id = 1;
    // 等于给这个字段加上了 @Compatible 注解
    string name = 1001;
}

  • 如果为了版本兼容，增加字段，需要加上Compatible注解，order需要自然增大，这样就可以保证新老协议可以互相兼容，协议嵌套也依然能够兼容

  • 正式环境为了版本兼容，避免修改字段名称，内部默认使用字段的名称按照字符串的自然顺序来依次读写的（也可以自定义），所以会导致序列化出现异常

  • 正式环境为了版本兼容，避免减少字段，没必要一定要删除一个不需要的字段，所以不考虑支持这种减少字段兼容协议的情况

  • 设计模式六大原则中的开闭原则是对扩展开放，对修改关闭。协议的设计涉及到功能应该也要遵守这个原则，优先增加新的协议而不是修改现有协议

Ⅷ. zfoo和Protobuf的区别

  • protobuf可以删除字段，zfoo不支持删除字段，以此为代价提升1倍的性能和减小1倍的体积
实际正式上线的项目几乎没遇到谁会去删字段，删除了这个字段，服务器要改代码不去引用这个删除字段，客户端要改代码不去引用这个删除字段，双倍工作量。
如果其中任何一端忘了修改代码就会直接报错，所以实际项目中给这个字段加一个废弃字段 @Deprecated 注释就能避免很多不必要的麻烦。

  • zfoo取所有语言的类型声明的交集，而不是protobuf取并集，简化protobuf的类型实现

    • protobuf 
      double
float
int32
int64
uint32
uint64
sint32
sint64
fixed32
fixed64
sfixed32
sfixed64
bool
string
bytes
bytes
    • zfoo 
      float
double
byte
int16
int32
int64
bool
string

  • zfoo取所有语言的语法的交集，而不是protobuf的并集，增加protobuf的语法实现

    • protobuf 
      不支持集合嵌套语法
    • zfoo 
      支持集合嵌套语法

  • 简化protobuf的语法，没有枚举，没有oneof，没有optional