NestJS TypeORM Paginate 教程

项目介绍

NestJS TypeORM Paginate 是一个用于 NestJS 框架的插件，旨在简化使用 TypeORM 进行分页查询的过程。该插件提供了一组便捷的函数和装饰器，使得在 NestJS 应用中实现分页功能变得非常简单和高效。

项目快速启动

安装依赖

首先，你需要安装必要的依赖包：

npm install nestjs-typeorm-paginate

配置 TypeORM

确保你的 NestJS 项目已经配置了 TypeORM。以下是一个基本的 TypeORM 配置示例：

import { TypeOrmModule } from '@nestjs/typeorm';
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { User } from './user.entity';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: 'password',
      database: 'test',
      entities: [User],
      synchronize: true,
    }),
    TypeOrmModule.forFeature([User]),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

使用分页插件

在你的服务中使用 nestjs-typeorm-paginate 插件进行分页查询：

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';
import { paginate, Pagination } from 'nestjs-typeorm-paginate';

@Injectable()
export class AppService {
  constructor(
    @InjectRepository(User)
    private readonly userRepository: Repository<User>,
  ) {}

  async getUsers(page: number, limit: number): Promise<Pagination<User>> {
    const options = { page, limit };
    return paginate<User>(this.userRepository, options);
  }
}

控制器

在你的控制器中调用服务方法：

import { Controller, Get, Query } from '@nestjs/common';
import { AppService } from './app.service';
import { Pagination } from 'nestjs-typeorm-paginate';
import { User } from './user.entity';

@Controller('users')
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  async getUsers(
    @Query('page') page: number = 1,
    @Query('limit') limit: number = 10,
  ): Promise<Pagination<User>> {
    limit = limit > 100 ? 100 : limit;
    return this.appService.getUsers(page, limit);
  }
}

应用案例和最佳实践

应用案例

假设你正在开发一个博客系统，需要对文章进行分页展示。使用 nestjs-typeorm-paginate 插件可以轻松实现这一功能。以下是一个简单的示例：

1. 实体定义：

import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

@Entity()
export class Article {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  title: string;

  @Column()
  content: string;
}

2. 服务方法：

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { Article } from './article.entity';
import { paginate, Pagination } from 'nestjs-typeorm-paginate';

@Injectable()
export class ArticleService {
  constructor(
    @InjectRepository(Article)
    private readonly articleRepository: Repository<Article>,
  ) {}

  async getArticles(page: number, limit: number): Promise<Pagination<Article>> {
    const options = {