NestJS——使用TypeORM连接MySQL数据库（Docker拉取镜像、多环境适配）

个人简介

👀个人主页： 前端杂货铺
🙋‍♂️学习方向： 主攻前端方向，正逐渐往全干发展
📃个人状态： 研发工程师，现效力于中国工业软件事业
🚀人生格言： 积跬步至千里，积小流成江海
🥇推荐学习：🍍前端面试宝典 🎨100个小功能 🍉Vue2 🍋Vue3 🍓Vue2/3项目实战 🥝Node.js实战 🍒Three.js

🌕个人推广：每篇文章最下方都有加入方式，旨在交流学习&资源分享，快加入进来吧

ORM

ORM（Object Relational Mapping）：对象关系映射，其主要作用是在编程中，把面向对象的概念跟数据库中的概念对应起来。

数据库

关系型：MySQL、Oracle、SQL Server、Access、SQLite

非关系型：MongoDB、Redis、Hbase、Memcache

连接数据库

安装 @nestjs/typeorm、typeorm、mysql2

pnpm i --save @nestjs/typeorm
pnpm i --save typeorm
pnpm i --save mysql2

创建 docker-compose.yml 文件，添加 mysql 及 Adminer 镜像。

services:
  db:
    image: mysql # 使用官方 MySQL 镜像
    restart: always # 容器崩溃时自动重启
    environment: # 配置 MySQL 环境变量
      MYSQL_ROOT_PASSWORD: example # MySQL root 用户的密码
    ports:
      - 3090: 3060 # 将主机的 3090 端口映射到容器的 3306 端口（MySQL 默认端口）

  adminer:
    image: adminer # 使用官方 Adminer 镜像
    restart: always # 容器崩溃时自动重启
    ports:
      - 8090: 8080 # 将主机的 8090 端口映射到容器的 8080 端口（Adminer 默认端口）

使用如下命令拉取镜像

docker-compose up -d

在 app.module.ts 文件中进行 typeorm 相关配置，连接数据库

import { Module } from "@nestjs/common";
import { UserModule } from "./user/user.module";
import { ConfigModule } from "@nestjs/config";
// 导入 dotenv 库，用于解析 .env 文件
import * as dotenv from "dotenv";
import * as Joi from "joi"; // 用于验证环境变量的库
import { TypeOrmModule } from "@nestjs/typeorm";

/**
 * 动态生成环境变量文件路径：
 * - 如果系统环境变量 `NODE_ENV` 存在（如 production、development、test），则加载对应的 `.env.[NODE_ENV]` 文件
 * - 默认使用 `.env.development` 文件
 */
const envFilePath = `.env.${process.env.NODE_ENV || "development"}`;

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true, // 将配置模块声明为全局模块，所有其他模块均可直接注入 ConfigService
      envFilePath, // 指定环境变量文件路径（根据 NODE_ENV 动态加载）
      /**
       * 自定义配置加载器：
       * - 显式加载默认的 `.env` 文件，作为兜底配置
       * - 如果 `envFilePath` 和 `.env` 文件中存在相同的变量，`envFilePath` 的变量会覆盖 `.env` 中的值
       */
      load: [() => dotenv.config({ path: ".env" })],
      /**
       * 使用 Joi 验证环境变量：
       * - 定义环境变量的结构和默认值
       * - 确保环境变量的值符合预期（如类型、范围等）
       */
      validationSchema: Joi.object({
        NODE_ENV: Joi.string()
          .valid("development", "production", "test") // 限制 NODE_ENV 的合法值
          .default("development"), // 默认值为 "development"
        DB_PORT: Joi.number().default(3306), // 数据库端口，默认值为 3306
        DB_URL: Joi.string().domain(), // 数据库 URL，必须是合法的域名
        DB_HOST: Joi.string().ip(), // 数据库主机地址，必须是合法的 IP 地址
      }),
    }),
    // 新增内容----------------------------------------------------
    TypeOrmModule.forRoot({
      type: "mysql", // 数据库类型
      host: "localhost", // 数据库主机地址
      port: 3090, // 数据库端口
      username: "root", // 数据库用户名
      password: "example", // 数据库密码
      database: "test", // 数据库名称
      entities: [], // 实体类数组
      synchronize: true, // 是否自动同步数据库结构
      logging: ["error", "warn"], // 日志级别
    }),
    // -----------------------------------------------------------
    UserModule, // 导入用户模块
  ],
  controllers: [], // 控制器（当前为空）
  providers: [], // 服务提供者（当前为空）
})
export class AppModule {}

使用 npm start:dev 命令启动项目，若没有任何报错，则说明连接成功。

适配多环境配置

GitHub 提交记录

上面连接数据库的方式是无法适配多环境的。接下来，我们进行多环境的适配。

在 config.const.ts 文件中修改枚举。

export enum ConfigEnum {
  DB_TYPE = "DB_TYPE",
  DB_HOST = "DB_HOST",
  DB_PORT = "DB_PORT",
  DB_DATABASE = "DB_DATABASE",
  DB_USERNAME = "DB_USERNAME",
  DB_PASSWORD = "DB_PASSWORD",
  DB_SYNC = "DB_SYNC",
}

修改 .env 文件

# 公共配置文件
DB_TYPE=mysql
DB_HOST=127.0.0.1
DB_PORT=3090

DB_SYNC=false

修改 .env.development 文件，更改开发环境配置

DB_DATABASE=test
DB_HOST=127.0.0.1
DB_PORT=3090
DB_USERNAME=root
DB_PASSWORD=example

DB_SYNC=true

修改 .env.production 文件，更改生产环境配置（此处为随便写的）

DB_DATABASE=proddb
DB_HOST=zahuopu.com
DB_PORT=3090
DB_USERNAME=root
DB_PASSWORD=long-random-password

DB_SYNC=true

修改 app.module.ts 文件内容如下：

import { Module } from "@nestjs/common";
import { UserModule } from "./user/user.module";
import { ConfigModule, ConfigService } from "@nestjs/config";
// 导入 dotenv 库，用于解析 .env 文件
import * as dotenv from "dotenv";
import * as Joi from "joi"; // 用于验证环境变量的库
import { TypeOrmModule, TypeOrmModuleOptions } from "@nestjs/typeorm";
import { ConfigEnum } from "./enum/config.const"; // 导入配置枚举

/**
 * 动态生成环境变量文件路径：
 * - 如果系统环境变量 `NODE_ENV` 存在（如 production、development、test），则加载对应的 `.env.[NODE_ENV]` 文件
 * - 默认使用 `.env.development` 文件
 */
const envFilePath = `.env.${process.env.NODE_ENV || "development"}`;

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true, // 将配置模块声明为全局模块，所有其他模块均可直接注入 ConfigService
      envFilePath, // 指定环境变量文件路径（根据 NODE_ENV 动态加载）
      /**
       * 自定义配置加载器：
       * - 显式加载默认的 `.env` 文件，作为兜底配置
       * - 如果 `envFilePath` 和 `.env` 文件中存在相同的变量，`envFilePath` 的变量会覆盖 `.env` 中的值
       */
      load: [() => dotenv.config({ path: ".env" })],
      /**
       * 使用 Joi 验证环境变量：
       * - 定义环境变量的结构和默认值
       * - 确保环境变量的值符合预期（如类型、范围等）
       */
      validationSchema: Joi.object({
        NODE_ENV: Joi.string()
          .valid("development", "production", "test") // 限制 NODE_ENV 的合法值
          .default("development"), // 默认值为 "development"
        DB_PORT: Joi.number().default(3306), // 数据库端口，默认值为 3306
        DB_HOST: Joi.string().ip(), // 数据库主机地址，必须是合法的 IP 地址
        DB_TYPE: Joi.string().valid("mysql", "postgres"), // 数据库类型，不能为空
        DB_DATABASE: Joi.string().required(), // 数据库名称，不能为空
        DB_USERNAME: Joi.string().required(), // 数据库用户名，不能为空
        DB_PASSWORD: Joi.string().required(), // 数据库密码，不能为空
        DB_SYNC: Joi.boolean().default(false), // 是否自动同步数据库结构，默认值为 false
      }),
    }),
    TypeOrmModule.forRootAsync({
      imports: [ConfigModule], // 导入 ConfigModule 以获取配置
      inject: [ConfigService], // 注入 ConfigService
      useFactory: (configService: ConfigService) =>
        ({
          type: configService.get(ConfigEnum.DB_TYPE), // 数据库类型
          host: configService.get(ConfigEnum.DB_HOST), // 数据库主机地址
          port: configService.get(ConfigEnum.DB_PORT), // 数据库端口
          username: configService.get(ConfigEnum.DB_USERNAME), // 数据库用户名
          password: configService.get(ConfigEnum.DB_PASSWORD), // 数据库密码
          database: configService.get(ConfigEnum.DB_DATABASE), // 数据库名称
          entities: [], // 实体类数组
          synchronize: configService.get(ConfigEnum.DB_SYNC), // 是否自动同步数据库结构
          logging: ["error", "warn"], // 日志级别
        }) as TypeOrmModuleOptions,
    }),
    UserModule, // 导入用户模块
  ],
  controllers: [], // 控制器（当前为空）
  providers: [], // 服务提供者（当前为空）
})
export class AppModule {}

至此，即完成多环境的配置。

总结

本篇文章，我们学习了学习了 ORM 工具；关系型数据库和非关系型数据库的区别；最后使用 Docker 拉取镜像，实现了 TypeORM 连接 MySQL 数据库。

好啦，本篇文章到这里就要和大家说再见啦，祝你这篇文章阅读愉快，你下篇文章的阅读愉快留着我下篇文章再祝！

参考资料：

1. DeepSeek
2. NestJS 从入门到实战