最近使用js/ts来开发新项目, 而公司现有项目都是以C++开发, 并且直接使用struct来作为序列化/反序列化协议, 所以必须在js/ts中实现struct的解析, 解决新老项目的通信问题.

结构体默认对齐规则

• 规则一: 结构体中元素按照定义顺序依次置于内存中, 但并不是紧密排列. 从结构体首地址开始依次将元素放入内存时, 元素会被放置在其自身对齐大小的整数倍地址上.
• 规则二: 如果结构体大小不是所有元素中最大对齐大小的整数倍, 则结构体对齐到最大元素对齐大小的整数倍,填充空间放置到结构体末尾.
• 规则三: 基本数据类型的对齐大小为其自身的大小, 结构体数据类型的对齐大小为其元素中最大对齐大小元素的对齐大小。

抽象

基于对以上三个规则进行分析, 我们可以得到一个所有类型的抽象基类. 这样, 只要在把基础类型及struct的实现给完成就行了.

interface IType {
    /**
     * 获得类型大小,相当于sizeof
     */
    getTypeSize(): number;
    /**
     * 获得对齐大小
     */
    getAlignSize(): number;
    /**
     * 反序列化
     * @param dataView 存放数据的缓冲区
     * @param offset 偏移多少位置进行读取
     * @return 返回解析得到的值
     */
    decode(dataView: DataView, offset: number): any;
    /**
     * 序列化
     * @param dataView 存放数据的缓冲区
     * @param offset 偏移多少位置进行写入
     * @param value 需要写入的值
     */
    encode(dataView: DataView, offset: number, value: any): void;
}

基本类型的实现

由于类型大小就是c++ 中sizeof得到的结果, 并且对齐大小与类型大小是一致的, 所以基本类型的大小可以轻松得到. 在js/ts的DataView中也提供了对应的整型浮点型的set/get方法, 基本只要调用对应的set/get方法就能完成基本类型的解析.值得注意的是, 在解析结构体时, 会有大小端的问题需要考虑, 不过DataView在对应的方法中提供了参数进行控制.

const littleEndian: boolean = true;

class TYPE_BYTE implements IType {
    getTypeSize(): number {
        return 1;
    }
    getAlignSize(): number {
        return 1;
    }
    decode(dataView: DataView, offset: number): any {
        return dataView.getUint8(offset);
    }
    encode(dataView: DataView, offset: number, value: any): void {
        dataView.setUint8(offset, value);
    }
}

class TYPE_WORD implements IType {
    getTypeSize(): number {
        return 2;
    }
    getAlignSize(): number {
        return 2;
    }
    decode(dataView: DataView, offset: number): any {
        return dataView.getUint16(offset, littleEndian);  // 大小端选择
    }
    encode(dataView: DataView, offset: number, value: any): void {
        dataView.setUint16(offset, value, littleEndian);  // 大小端选择
    }
}

其他基本类型的实现基本类似.

struct实现

结构体类型就是多个IType类型按顺序排列组合到一起, 每个类型的数量可以是0~n个. 然后按照规则一二三实现那四个方法即可.
不过我还在此基础上实现了char数组自动转string, 以及柔性数组(长度为0的数组), 不过柔性数组字段前必须要一个基本数据类型字段来描述大小, 由于柔性数组需要的存储大小是和数据大小相关的, 所以又提供了getRealSize这个通用方法来获取需要的缓冲区大小.

github