增量序列化支持二进制

This commit is contained in:
YHH
2025-10-09 17:14:18 +08:00
parent 959879440d
commit 97a69fed09
6 changed files with 373 additions and 58 deletions

View File

@@ -618,24 +618,28 @@ export class Scene implements IScene {
/**
* 应用增量变更到场景
*
* @param incremental 增量快照数据(JSON字符串或对象
* @param incremental 增量快照数据(IncrementalSnapshot对象、JSON字符串或二进制Buffer
* @param componentRegistry 组件类型注册表(可选,默认使用全局注册表)
*
* @example
* ```typescript
* // 应用增量变更
* // 应用增量变更对象
* scene.applyIncremental(incrementalSnapshot);
*
* // 从JSON字符串应用
* const incremental = IncrementalSerializer.deserializeIncremental(jsonString);
* scene.applyIncremental(incremental);
* // 从JSON字符串应用
* const jsonData = IncrementalSerializer.serializeIncremental(snapshot, { format: 'json' });
* scene.applyIncremental(jsonData);
*
* // 从二进制Buffer应用
* const binaryData = IncrementalSerializer.serializeIncremental(snapshot, { format: 'binary' });
* scene.applyIncremental(binaryData);
* ```
*/
public applyIncremental(
incremental: IncrementalSnapshot | string,
incremental: IncrementalSnapshot | string | Buffer,
componentRegistry?: Map<string, any>
): void {
const snapshot = typeof incremental === 'string'
const snapshot = (typeof incremental === 'string' || Buffer.isBuffer(incremental))
? IncrementalSerializer.deserializeIncremental(incremental)
: incremental;

View File

@@ -11,6 +11,7 @@ import { Component } from '../Component';
import { ComponentSerializer, SerializedComponent } from './ComponentSerializer';
import { SerializedEntity } from './EntitySerializer';
import { ComponentType } from '../Core/ComponentStorage';
import * as msgpack from 'msgpack-lite';
/**
* 变更操作类型
@@ -117,6 +118,11 @@ interface SceneSnapshot {
sceneData: Map<string, string>; // 使用JSON字符串存储场景数据
}
/**
* 增量序列化格式
*/
export type IncrementalSerializationFormat = 'json' | 'binary';
/**
* 增量序列化选项
*/
@@ -138,6 +144,20 @@ export interface IncrementalSerializationOptions {
* 默认false设为true可减少内存占用但增加CPU开销
*/
compressSnapshot?: boolean;
/**
* 序列化格式
* - 'json': JSON格式可读性好方便调试
* - 'binary': MessagePack二进制格式体积小性能高
* 默认 'json'
*/
format?: IncrementalSerializationFormat;
/**
* 是否美化JSON输出仅在format='json'时有效)
* 默认false
*/
pretty?: boolean;
}
/**
@@ -585,40 +605,93 @@ export class IncrementalSerializer {
}
/**
* 序列化增量快照为JSON
* 序列化增量快照
*
* @param incremental 增量快照
* @param pretty 是否美化输出
* @returns JSON字符串
* @param options 序列化选项
* @returns 序列化后的数据JSON字符串或二进制Buffer
*
* @example
* ```typescript
* // JSON格式默认
* const jsonData = IncrementalSerializer.serializeIncremental(snapshot);
*
* // 二进制格式
* const binaryData = IncrementalSerializer.serializeIncremental(snapshot, {
* format: 'binary'
* });
*
* // 美化JSON
* const prettyJson = IncrementalSerializer.serializeIncremental(snapshot, {
* format: 'json',
* pretty: true
* });
* ```
*/
public static serializeIncremental(
incremental: IncrementalSnapshot,
pretty: boolean = false
): string {
return pretty
? JSON.stringify(incremental, null, 2)
: JSON.stringify(incremental);
options?: { format?: IncrementalSerializationFormat; pretty?: boolean }
): string | Buffer {
const opts = {
format: 'json' as IncrementalSerializationFormat,
pretty: false,
...options
};
if (opts.format === 'binary') {
return msgpack.encode(incremental);
} else {
return opts.pretty
? JSON.stringify(incremental, null, 2)
: JSON.stringify(incremental);
}
}
/**
* 从JSON反序列化增量快照
* 反序列化增量快照
*
* @param json JSON字符串
* @param data 序列化的数据JSON字符串或二进制Buffer
* @returns 增量快照
*
* @example
* ```typescript
* // 从JSON反序列化
* const snapshot = IncrementalSerializer.deserializeIncremental(jsonString);
*
* // 从二进制反序列化
* const snapshot = IncrementalSerializer.deserializeIncremental(buffer);
* ```
*/
public static deserializeIncremental(json: string): IncrementalSnapshot {
return JSON.parse(json);
public static deserializeIncremental(data: string | Buffer): IncrementalSnapshot {
if (typeof data === 'string') {
// JSON格式
return JSON.parse(data);
} else {
// 二进制格式MessagePack
return msgpack.decode(data);
}
}
/**
* 计算增量快照的大小(字节)
*
* @param incremental 增量快照
* @param format 序列化格式,默认为 'json'
* @returns 字节数
*/
public static getIncrementalSize(incremental: IncrementalSnapshot): number {
const json = this.serializeIncremental(incremental);
return new Blob([json]).size;
public static getIncrementalSize(
incremental: IncrementalSnapshot,
format: IncrementalSerializationFormat = 'json'
): number {
const data = this.serializeIncremental(incremental, { format });
if (typeof data === 'string') {
// JSON格式计算UTF-8编码后的字节数
return Buffer.byteLength(data, 'utf8');
} else {
// 二进制格式直接返回Buffer长度
return data.length;
}
}
/**

View File

@@ -55,6 +55,7 @@ export { IncrementalSerializer, ChangeOperation } from './IncrementalSerializer'
export type {
IncrementalSnapshot,
IncrementalSerializationOptions,
IncrementalSerializationFormat,
EntityChange,
ComponentChange,
SceneDataChange