在Mongoose中同时使用分页和聚合分页插件的TypeScript解决方案

在Mongoose中同时使用分页和聚合分页插件的TypeScript解决方案

在使用Mongoose进行数据库操作时，mongoose-paginate-v2和mongoose-aggregate-paginate-v2是两个非常实用的分页插件。然而，当我们需要在TypeScript项目中同时使用这两个插件时，类型定义会变得有些复杂。本文将介绍如何优雅地解决这个问题。

问题背景

在TypeScript环境下，当我们同时使用这两个分页插件时，模型类型定义会变得复杂。直接的类型组合方式如mongoose.PaginateModel<ModelInterface> & mongoose.AggregatePaginateModel<ModelInterface>并不能很好地工作，因为TypeScript的类型系统需要更明确的定义。

解决方案

我们可以创建一个工具函数和配套的类型定义来简化这一过程。以下是完整的解决方案：

import mongoose, {
  AggregatePaginateModel,
  Document,
  Model,
  PaginateModel,
  Schema,
} from "mongoose";

// 定义分页查询辅助方法接口
export interface PaginatedQueryHelpers<T> {
  paginate: PaginateModel<T>["paginate"];
  aggregatePaginate: AggregatePaginateModel<T>["aggregatePaginate"];
}

// 定义支持分页的文档接口
export interface IPaginatedDocument<T>
  extends Document,
    PaginatedQueryHelpers<T> {}

// 定义支持分页的模型接口
export interface IPaginatedModel<T extends Document>
  extends Model<T, PaginatedQueryHelpers<T>>,
    PaginatedQueryHelpers<T> {}

// 创建模型的工厂函数
export function createModel<T extends Document>(
  modelName: string,
  schema: Schema<T>,
  collectionName: string
): IPaginatedModel<T> {
  // 自动应用两个分页插件
  schema.plugin(require("mongoose-paginate-v2"));
  schema.plugin(require("mongoose-aggregate-paginate-v2"));

  return mongoose.model<T, IPaginatedModel<T>>(
    modelName,
    schema,
    collectionName
  );
}

使用方法

在实际项目中，我们可以这样使用上述工具：

import { createModel } from './util';

// 定义你的模型接口
interface IModel extends Document {
  name: string;
  age: number;
  // 其他字段...
}

// 定义模型Schema
const ModelSchema = new Schema<IModel>({
  name: { type: String, required: true },
  age: { type: Number, required: true },
  // 其他字段定义...
});

// 创建并导出模型
export const UserModel = createModel<IModel>(
  "User",
  ModelSchema,
  "users"
);

方案优势

1. 类型安全：完整的TypeScript支持，包括IntelliSense自动补全
2. 代码复用：避免在每个模型文件中重复应用插件
3. 一致性：确保所有模型都统一应用了相同的分页功能
4. 可维护性：如果需要修改分页配置，只需在一个地方修改

实际应用

创建后的模型可以这样使用：

// 使用普通分页
const paginatedResult = await UserModel.paginate({ age: { $gt: 18 } }, { page: 1, limit: 10 });

// 使用聚合分页
const aggregatedResult = await UserModel.aggregatePaginate(
  UserModel.aggregate([{ $match: { age: { $gt: 18 } } }]),
  { page: 1, limit: 10 }
);

总结

通过创建自定义类型和工厂函数，我们成功地在TypeScript项目中同时集成了mongoose-paginate-v2和mongoose-aggregate-paginate-v2两个分页插件。这种方法不仅解决了类型定义的问题，还提高了代码的可维护性和一致性。对于需要在Mongoose中使用高级分页功能的TypeScript项目，这是一个非常实用的解决方案。