NestJS Objection 项目教程

NestJS Objection 项目教程

nestjs-objectionNestJS module for Objection项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-objection

1. 项目的目录结构及介绍

nestjs-objection/
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   ├── config/
│   │   ├── database.config.ts
│   ├── models/
│   │   ├── user.model.ts
│   ├── repositories/
│   │   ├── user.repository.ts
│   ├── services/
│   │   ├── user.service.ts
│   ├── controllers/
│   │   ├── user.controller.ts
├── test/
├── package.json
├── tsconfig.json
├── README.md
├── LICENSE

目录结构介绍

• src/: 项目的主要源代码目录。
  • app.module.ts: 应用程序的根模块，负责导入和配置其他模块。
  • main.ts: 项目的启动文件，负责启动 NestJS 应用程序。
  • config/: 存放项目的配置文件，如数据库配置。
  • models/: 存放 Objection.js 模型文件，定义数据库表结构。
  • repositories/: 存放数据访问层代码，负责与数据库交互。
  • services/: 存放业务逻辑层代码，负责处理业务逻辑。
  • controllers/: 存放控制器层代码，负责处理 HTTP 请求和响应。
• test/: 存放项目的测试代码。
• package.json: 项目的依赖管理文件，定义了项目的依赖和脚本。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译选项。
• README.md: 项目的说明文档，介绍了项目的功能和使用方法。
• LICENSE: 项目的开源许可证文件。

2. 项目的启动文件介绍

main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

启动文件介绍

• NestFactory.create(AppModule): 创建 NestJS 应用程序实例，传入根模块 AppModule。
• app.listen(3000): 启动应用程序，监听端口 3000。

3. 项目的配置文件介绍

database.config.ts

import { ConfigModule, ConfigService } from '@nestjs/config';
import { KnexModule } from 'nestjs-knex';
import { Module } from '@nestjs/common';

@Module({
  imports: [
    ConfigModule.forRoot(),
    KnexModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => ({
        config: {
          client: 'pg',
          connection: {
            host: configService.get('DB_HOST'),
            port: configService.get('DB_PORT'),
            user: configService.get('DB_USER'),
            password: configService.get('DB_PASSWORD'),
            database: configService.get('DB_NAME'),
          },
        },
      }),
      inject: [ConfigService],
    }),
  ],
})
export class DatabaseModule {}

配置文件介绍

• ConfigModule.forRoot(): 加载环境变量配置。
• KnexModule.forRootAsync(): 异步配置 Knex.js，使用 ConfigService 获取数据库连接信息。
• client: 'pg': 指定数据库客户端为 PostgreSQL。
• connection: 配置数据库连接信息，包括主机、端口、用户、密码和数据库名称。

通过以上模块的介绍，您可以更好地理解和使用 nestjs-objection 项目。

nestjs-objectionNestJS module for Objection项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-objection