Skip to content
ray.zh edited this page Dec 3, 2023 · 15 revisions

1. Magic-Byte 帮我们解决了什么问题?

在平时的项目开发中,特别是涉及到物联网对接或者自定义协议的开发。开发者不免的就陷入到对象与字节流的的序列化/反序列化中。 严重影响开发效率。

一般来说,开发的流程就大致如下:

1. 定义实体类,如下面的一段代码:

public class Student {
    private String name;
    private int length;
    private List<Long> phones;
    private byte age;
    // getter and setter ...
}

2. 约定协议细节以及出具协议文档

3. 开始进行协议对接,对接时需要将字段都按照协议解析和格式化,如下

byte bytes[] = new byte[] {name_bytes, length_bytes, phones_bytes, age};

4. 开始收发数据, 然而在编码/解码的过程中,时常伴随着以下问题:

  • 字节转换处理
  • 大小端处理
  • 空值,默认值处理
  • 数组溢出处理
  • 数组填充对齐处理

以上问题在代码中体现的就是一个又一个的IF/ELSE, 它们到处充斥在代码中,业务代码和解析代码相互穿插,显得复杂且臃肿。

但如果引入 Magic-Byte 一切都会变得很简单。 我们需要在对象定义时同时描述字段使用字节数量,上面代码将会定义如下:

@MagicClass(autoTrim = true)
public class Student {
    // 普通数据, 字符串长度为 10
    @MagicField(order = 1, size = 10)
    private String name;
    // 普通数据, 整数, 此字段决定后续 phones 字段长度
    @MagicField(order = 2)
    private int length;
    // 此List并未直接指定大小, 大小由 length 字段决定
    @MagicField(order = 3, dynamicSizeOf = 2)
    private List<Long> phones;
    @MagicField(order = 4)
    private byte age;
    // getter and setter ...
}

在进行序列化和反序列化时,只需要简单使用以下方法:

void main() {
    Student student1 = new Student();
    byte[] bytes = MagicByte.unpack(student); // 对象转换为字节数组
    Student student2 = MagicByte.pack(bytes, School.class); // 字节数组转换为对象
}

怎么样,是不是很简单!~从此以后,只需要聚焦业务实现啦,为你省下大把时间!!!