nestjs knex mysql 连接数据库

### 三级标题：在 NestJS 中使用 Knex 连接 MySQL 数据库 在 NestJS 应用中集成 Knex 并连接 MySQL 数据库，可以通过模块化的方式实现灵活的数据库访问层。Knex 是一个功能强大的 SQL 查询构建器，支持多种数据库系统，并且可以与 NestJS 的依赖注入机制无缝集成。以下是一个完整的实现方案。 #### 安装依赖 在开始之前，需要安装必要的依赖包，包括 `knex` 和 `mysql2`： ```bash npm install knex mysql2 ``` 此外，为了支持 TypeScript，还需要安装类型定义文件： ```bash npm install @types/knex --save-dev ``` #### 创建数据库连接配置 在 NestJS 项目中，推荐将数据库连接配置集中管理。可以在 `src/config/database.ts` 文件中创建一个用于初始化 Knex 实例的函数： ```ts import knex from 'knex'; export default knex({ client: 'mysql2', connection: { host: '127.0.0.1', port: 3306, user: 'root', password: 'your_password', database: 'your_database', }, }); ``` 此配置定义了一个基于 `mysql2` 的数据库连接，并设置了连接参数。通过这种方式，可以确保整个应用中使用统一的数据库连接实例。 #### 将 Knex 实例注入到服务中 NestJS 支持依赖注入机制，可以将 Knex 实例作为提供者注入到服务中。首先，在 `src/providers/knex.provider.ts` 中定义一个提供者： ```ts import { Injectable } from '@nestjs/common'; import knex from 'knex'; import config from '../config/database'; @Injectable() export class KnexService { private readonly knexInstance: knex; constructor() { this.knexInstance = config; } get knex(): knex { return this.knexInstance; } } ``` 然后，在模块中注册该服务： ```ts import { Module } from '@nestjs/common'; import { KnexService } from '../providers/knex.provider'; @Module({ providers: [KnexService], exports: [KnexService], }) export class DatabaseModule {} ``` #### 在服务中执行数据库操作 在业务逻辑中，可以通过依赖注入获取 Knex 实例并执行查询。例如，在 `src/modules/user/user.service.ts` 中实现用户查询逻辑： ```ts import { Injectable } from '@nestjs/common'; import { KnexService } from '../../providers/knex.provider'; @Injectable() export class UserService { constructor(private readonly knexService: KnexService) {} async findAll() { return await this.knexService.knex('users').select('*'); } async findById(id: number) { return await this.knexService.knex('users').where('id', id).first(); } } ``` 上述代码展示了如何使用 Knex 构建 SQL 查询，并返回数据库结果。通过这种方式，可以将数据库操作封装在服务中，实现良好的模块化设计。 #### 控制器中调用服务 最后，在控制器中调用服务以处理 HTTP 请求。例如，在 `src/modules/user/user.controller.ts` 中定义 REST 接口： ```ts import { Controller, Get, Param } from '@nestjs/common'; import { UserService } from './user.service'; @Controller('users') export class UserController { constructor(private readonly userService: UserService) {} @Get() async findAll() { return await this.userService.findAll(); } @Get(':id') async findById(@Param('id') id: string) { return await this.userService.findById(Number(id)); } } ``` 通过这种方式，可以实现从 HTTP 请求到数据库查询的完整流程，并保持代码的清晰与可维护性。 #### 项目结构示例 一个典型的 NestJS + Knex + MySQL 项目结构如下： ``` src/ ├── modules/ │ └── user/ │ ├── user.controller.ts │ ├── user.service.ts │ └── user.module.ts ├── config/ │ └── database.ts ├── providers/ │ └── knex.provider.ts ├── main.ts └── index.ts ``` 该结构将数据库连接、服务、控制器和模块分离，便于维护和扩展。 --- ###