Mongoose中lean()与非lean()查询的类型差异处理

在使用Mongoose操作MongoDB时，开发者经常会遇到需要处理Decimal128类型数据的情况。本文将深入探讨如何在使用lean()和非lean()查询时正确处理类型差异，特别是针对Decimal128类型的转换问题。

问题背景

Mongoose提供了两种查询文档的方式：

1. 标准查询：返回完整的Mongoose文档实例
2. lean查询：返回普通的JavaScript对象

当我们需要处理Decimal128类型字段时，这两种方式会带来类型差异。标准查询会应用schema中定义的getter转换，而lean查询则直接返回原始数据。

解决方案一：单独定义lean类型

最直接的解决方案是为lean查询单独定义一个类型：

interface IOrder {
  total: Decimal
}

type IOrderLean = { total?: mongoose.Types.Decimal128 };

const Order = mongoose.model<IOrder>('Order', orderSchema)

// 使用示例
const orderTotal: Decimal = (await Order.findOne().orFail()).total;
const leanOrderTotal = await Order.findOne().orFail().lean<IOrderLean>();

这种方法简单直接，但需要维护两个类型定义。

解决方案二：使用HydratedDocument类型

更符合Mongoose设计理念的做法是：

interface IOrder {
  total?: mongoose.Types.Decimal128
}

type OrderHydratedDocument = mongoose.HydratedDocument<
  IOrder,
  { total?: Decimal }
>;

const Order = mongoose.model<IOrder, OrderModelType>('Order', orderSchema)

// 使用示例
const orderTotal: Decimal | undefined = (await Order.findOne().orFail()).total;
const leanOrderTotal = await Order.findOne().orFail().lean();

这种方案中：

1. 基础接口IOrder表示MongoDB中存储的原始类型
2. HydratedDocument类型表示经过Mongoose处理后的文档类型
3. 通过泛型参数确保类型安全

最佳实践建议

1. 对于简单项目，方案一更易于理解和实现
2. 对于大型项目或需要严格类型安全的场景，推荐使用方案二
3. 无论哪种方案，都应该在schema中明确定义getter函数，确保类型转换的一致性

总结

Mongoose的lean查询和非lean查询在类型处理上存在差异，特别是在使用自定义getter时。通过合理使用TypeScript的泛型和Mongoose提供的HydratedDocument类型，我们可以构建类型安全的应用程序，同时享受lean查询带来的性能优势。开发者应根据项目规模和复杂度选择适合的方案。