在Cache-Manager项目中处理对象序列化与反序列化的最佳实践

在JavaScript/TypeScript开发中，对象序列化是一个常见需求，特别是在使用缓存系统时。本文将以Cache-Manager项目为例，深入探讨如何正确处理包含方法和属性的对象序列化问题。

问题背景

当开发者尝试将包含方法的对象实例存入缓存时，经常会遇到一个典型问题：对象被序列化为JSON后，方法会丢失。例如，一个包含messages数组和addMessage方法的History类：

class History {
  messages: string[];

  addMessage(message: string) {
    this.messages.push(message);
  }
}

当这个对象被存入缓存再取出后，虽然数据属性messages被保留，但方法addMessage却丢失了，导致调用时出现TypeError: history.addMessage is not a function错误。

根本原因分析

这种现象的根本原因在于JavaScript的JSON序列化机制：

1. JSON.stringify()默认只序列化对象的可枚举属性
2. 类方法属于原型链上的函数，不会被序列化
3. 反序列化时只是创建了一个普通对象，而不是原类的实例

解决方案

Cache-Manager项目推荐的最佳实践是：只缓存纯数据，不缓存包含方法的对象。具体实现方式有两种：

方案一：通过属性赋值重建对象

// 缓存时只存储数据部分
cache.set('historyMessageKey', history.messages);

// 获取缓存后通过属性赋值
const historyMessages = await cache.get<Array<string>>('historyMessageKey');
history.messages = historyMessages;

方案二：通过构造函数重建对象

class History {
  private _messages: string[] = [];
  
  constructor(messages?: string[]) {
    if(messages) {
      this._messages = messages;
    }
  }

  get messages(): string[] {
    return this._messages;
  }

  set messages(messages: string[]) {
    this._messages = messages;
  }

  addMessage(message: string) {
    this._messages.push(message);
  }
}

// 使用缓存数据创建新实例
const historyMessages = await cache.get<Array<string>>('historyMessageKey');
const history2 = new History(historyMessages);

进阶建议

1. 使用DTO模式：创建专门用于传输的数据传输对象(Data Transfer Object)，只包含需要缓存的数据

2. 添加序列化/反序列化方法：在类中实现专门的序列化方法，明确控制哪些数据需要被缓存

class History {
  // ...其他代码同上...

  serialize(): string {
    return JSON.stringify(this._messages);
  }

  static deserialize(data: string): History {
    return new History(JSON.parse(data));
  }
}

3. 考虑使用专业序列化库：对于复杂场景，可以评估使用专业的序列化库如class-transformer

总结

在Cache-Manager等缓存解决方案中处理对象序列化时，开发者应当：

1. 明确区分数据和行为，缓存只应存储数据
2. 设计类时考虑序列化需求，提供明确的序列化接口
3. 重建对象时使用构造函数或属性赋值恢复完整功能
4. 对于复杂场景采用DTO模式或专业序列化方案

遵循这些原则可以确保缓存功能的正确性，同时保持代码的清晰和可维护性。