Mongoose自定义类型序列化：实现toJSON与toObject的灵活控制

在Mongoose开发中，我们经常需要处理自定义数据类型，但默认的序列化行为可能无法满足特定业务需求。本文将深入探讨如何通过自定义SchemaType实现灵活的JSON和对象转换。

问题背景

当我们在Mongoose中定义自定义数据类型时，经常需要控制该类型在序列化时的输出格式。例如，我们可能希望：

• 在调用toJSON()时输出字符串格式
• 在调用toObject()时输出原始数值
• 避免输出完整的对象结构

核心实现方案

Mongoose 7.6.3版本后，我们可以通过以下方式实现自定义类型的序列化控制：

1. 基础类型定义：

class SchemaCustomType extends mongoose.SchemaType {
  static schemaName = 'CustomType';

  constructor(key, options) {
    super(key, options, 'CustomType');
  }

  cast(value) {
    if (value === null) return null;
    return new CustomType(value);
  }
}

2. 自定义类型实现：

class CustomType {
  constructor(value) {
    this.value = value;
  }

  toObject() {
    return this.value; // 返回原始值
  }

  toJSON() {
    return String(this.value); // 返回字符串格式
  }
}

高级配置方案

Mongoose提供了更灵活的全局配置方式：

// 全局设置转换函数
mongoose.Schema.Types.CustomType.set('transform', v => v == null ? v : v.value);

// 或者在Schema中单独配置
const schema = new mongoose.Schema({
  value: { 
    type: mongoose.Schema.Types.CustomType, 
    transform(v) { 
      return v?.value ?? v; 
    }
  },
});

实际应用场景

这种自定义序列化机制特别适用于：

1. 敏感数据处理：自动过滤或转换敏感字段
2. 国际化支持：根据语言环境输出不同格式
3. 性能优化：减少不必要的数据传输
4. API兼容：保持与旧版API的数据格式一致

最佳实践建议

1. 保持转换函数的纯净性，避免副作用
2. 考虑null和undefined的特殊情况处理
3. 对于复杂类型，确保转换后的数据可以被正确还原
4. 在文档层面和类型层面保持转换逻辑的一致性

通过合理利用Mongoose的自定义类型序列化机制，我们可以构建出更加灵活、高效的数据模型，满足各种复杂的业务场景需求。