如何在NestJS中基于Mongoose与mongoose-aggregate-paginate-v2实现服务端分页?
适配NestJS + TS + mongoose-aggregate-paginate-v2的正确实现方案
问题根因
现有代码的两个核心逻辑问题导致TS类型识别失败、方法挂载失效:
- 模型类型定义逻辑颠倒:试图让ContactModel继承
AggregatePaginateResult分页结果类型,本质是搞混了「模型静态方法」和「方法返回值」的边界。 - 缺少全局TS类型扩展:
mongoose-aggregate-paginate-v2是给Mongoose模型挂载静态方法,本身不自带TS类型声明,没有补充全局模块扩展的话,TS永远无法识别aggregatePaginate方法存在。
分步实现步骤
1. 补充全局TS类型声明
项目根目录创建类型声明文件(例如types/mongoose-plugins.d.ts),为Mongoose全局Model扩展插件对应的静态方法类型:
import 'mongoose'; import { Aggregate, PaginateOptions, AggregatePaginateResult } from 'mongoose'; declare module 'mongoose' { interface Model<T> { aggregatePaginate<T = any>( aggregate: Aggregate<T[]>, options: PaginateOptions ): Promise<AggregatePaginateResult<T>>; } }
重点说明:不需要为单个Contact模型单独定义继承分页结果的接口,全局扩展后所有挂了插件的Mongoose模型都会自动获得aggregatePaginate方法的类型识别能力。
2. 修正Schema插件挂载逻辑
插件必须在Schema实例创建完成后立即挂载,不能延迟到Provider工厂中执行,否则会出现方法未绑定的问题:
// contact.schema.ts import { Schema } from 'mongoose'; import aggregatePaginate from 'mongoose-aggregate-paginate-v2'; import { IContact } from './interfaces/contact.interface'; export const ContactSchema = new Schema<IContact>({ // 业务字段定义 }); // Schema实例创建完成后立刻挂载插件 ContactSchema.plugin(aggregatePaginate);
3. 简化Provider的模型实例化逻辑
删掉之前自定义的错误ContactModel类型定义,直接从连接工厂生成带类型的模型实例即可:
// contact.provider.ts import { Connection } from 'mongoose'; import { ContactSchema } from './contact.schema'; import { IContact } from './interfaces/contact.interface'; export const contactProvider = [ { provide: 'CONTACT_MODEL', useFactory: (connection: Connection) => { // 无需额外强转,全局类型扩展会自动匹配方法类型 return connection.model<IContact>('Contact', ContactSchema); }, inject: ['DATABASE_CONNECTION'], }, ];
补充:如果使用NestJS官方@nestjs/mongoose模块,完全不需要手写自定义Provider,直接在模块装饰器中引入Schema即可,框架会自动完成模型实例化:
// contact.module.ts @Module({ imports: [MongooseModule.forFeature([{ name: 'Contact', schema: ContactSchema }])], }) export class ContactModule {}
4. Service层正确调用逻辑
完成上述步骤后,TS不会再报aggregatePaginate方法不存在的错误,调用逻辑如下:
import { Injectable, Inject } from '@nestjs/common'; import { Model } from 'mongoose'; import { IContact } from './interfaces/contact.interface'; @Injectable() export class ContactService { constructor( @Inject('CONTACT_MODEL') private readonly contactModel: Model<IContact> ) {} async getContactList() { // 第一步:构造聚合管道 const contactAggregate = this.contactModel.aggregate([ // 自定义匹配、关联、分组逻辑 { $match: {} } ]); // 第二步:调用分页方法传入管道和分页参数 const pageOptions = { page: 1, limit: 10, // 其他配置:select、sort等 }; const paginatedResult = await this.contactModel.aggregatePaginate( contactAggregate, pageOptions ); return paginatedResult; } }
常见踩坑规避
- 严格控制Schema和插件的挂载顺序:必须先完成
new Schema()实例化,再调用.plugin()方法,若先通过connection.model()生成模型实例、再补挂插件,方法不会绑定到模型上。 - 不要混淆类型边界:
AggregatePaginateResult是分页方法的返回值类型,包含文档列表、总条数、总页数、当前页等结构化字段,不需要让模型继承这个类型。 - 类型声明文件需要被tsconfig.json识别:确保
tsconfig.json的include字段覆盖了存放.d.ts文件的目录,否则全局类型扩展不会生效。
内容的提问来源于stack exchange,提问作者Adam Cox
相关产品推荐
相关产品推荐

