Nodejs Nestjs ORM插件nestjs-objection的使用

Nodejs Nestjs ORM插件nestjs-objection的使用
nestjs-objection 是一个用于 NestJS 的 ORM 插件，它基于 Objection.js。Objection.js 是一个强大的 Node.js SQL 对象关系映射器（ORM），它支持 Knex.js 查询构建器。下面是一个简单的指南，帮助你开始使用 nestjs-objection。

1. 安装依赖

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

npm install @nestjs/objection objection knex

2. 配置数据库连接

在你的 NestJS 应用中配置数据库连接。假设你使用的是 PostgreSQL 数据库：

// src/database/database.providers.ts
import { Provider } from '@nestjs/common';
import { Knex } from 'knex';
import { ObjectionModule, ObjectionModuleOptions } from '@nestjs/objection';

export const databaseProviders: Provider[] = [
  {
    provide: 'DATABASE_CONNECTION',
    useFactory: (): Knex => {
      return require('knex')({
        client: 'pg', // 使用 PostgreSQL 客户端
        connection: {
          host: 'localhost',
          user: 'your_db_user',
          password: 'your_db_password',
          database: 'your_db_name',
        },
      });
    },
  },
];

3. 配置 ObjectionModule

接下来，在你的模块中导入 ObjectionModule 并提供配置：

// src/app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { databaseProviders } from './database/database.providers';
import { ObjectionModule } from '@nestjs/objection';

@Module({
  imports: [
    ObjectionModule.forRootAsync({
      useFactory: () => ({
        modelsPaths: ['path/to/your/models'], // 指定模型文件路径
      }),
    }),
  ],
  controllers: [AppController],
  providers: [AppService, ...databaseProviders],
})
export class AppModule {}

4. 创建模型

创建你的模型文件，继承自 Model 类：

// path/to/your/models/user.model.ts
import { Model, BaseModel } from 'objection';

export class User extends BaseModel {
  id!: number;
  name!: string;

  static get tableName() {
    return 'users'; // 指定表名
  }
}

5. 使用模型

现在你可以在服务中注入 User 模型并执行 CRUD 操作：

// src/app.service.ts
import { Injectable } from '@nestjs/common';
import { InjectModel } from '@nestjs/objection';
import { User } from './models/user.model';

@Injectable()
export class AppService {
  constructor(@InjectModel(User) private readonly userModel: typeof User) {}

  async createUser(name: string): Promise<User> {
    return this.userModel.query().insert({ name });
  }

  async getUsers(): Promise<User[]> {
    return this.userModel.query();
  }
}

6. 控制器

最后，创建控制器来处理 HTTP 请求：

// src/app.controller.ts
import { Controller, Get, Post, Body } from '@nestjs/common';
import { AppService } from './app.service';

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

  @Post('users')
  async createUser(@Body() body: { name: string }) {
    return this.appService.createUser(body.name);
  }

  @Get('users')
  async getUsers() {
    return this.appService.getUsers();
  }
}

通过以上步骤，你已经成功地在 NestJS 应用中集成了 nestjs-objection，并实现了基本的 CRUD 操作。你可以根据需要进一步扩展和优化这些示例。