TypeORM

TypeORM 是一个适用于 TypeScript 和 JavaScript 的 ORM（对象关系映射）框架，支持多种数据库（如 MySQL、PostgreSQL、SQLite、MariaDB 等）。它通过定义实体类来与数据库交互，能够帮助你轻松进行数据库操作，包括增删改查（CRUD）。

下面是 TypeORM 的基本使用指南：

1. 安装 TypeORM 和数据库驱动

首先，你需要安装 TypeORM 和数据库的驱动程序。以 MySQL 为例：

bash
1npm install typeorm mysql2

如果你使用的是 PostgreSQL，可以安装 pg 驱动：

bash
1npm install typeorm pg

2. 创建 TypeORM 配置文件

在项目根目录下创建一个 ormconfig.json 或 data-source.ts 配置文件，来配置 TypeORM 连接数据库。

方式一：使用 `ormconfig.json` 文件

这是一个典型的 JSON 配置文件：

json
1{
2  "type": "mysql", // 或 "postgres" 等
3  "host": "localhost",
4  "port": 3306, // MySQL 默认端口
5  "username": "root",
6  "password": "password",
7  "database": "test",
8  "synchronize": true, // 如果你希望每次运行应用时自动同步数据库结构
9  "logging": true,
10  "entities": [
11    "src/entity/**/*.ts" // 指定实体类文件的位置
12  ],
13  "migrations": [
14    "src/migration/**/*.ts"
15  ],
16  "subscribers": [
17    "src/subscriber/**/*.ts"
18  ]
19}

方式二：使用 TypeScript 配置 (`data-source.ts`)

ts
1import { DataSource } from "typeorm";
2import { User } from "./entity/User";
3
4export const AppDataSource = new DataSource({
5  type: "mysql", // 或 "postgres" 等
6  host: "localhost",
7  port: 3306, 
8  username: "root",
9  password: "password",
10  database: "test",
11  synchronize: true,
12  logging: true,
13  entities: [
14    User
15  ],
16  migrations: [],
17  subscribers: []
18});

3. 定义实体类

在 TypeORM 中，你需要定义一个实体类来表示数据库中的表。每个实体类通常对应数据库中的一个表。

示例：定义一个 `User` 实体类

ts
1import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";
2
3@Entity() // 定义数据库表
4export class User {
5  @PrimaryGeneratedColumn() // 主键，自动递增
6  id: number;
7
8  @Column() // 普通列
9  name: string;
10
11  @Column() // 普通列
12  email: string;
13}

@Entity() 装饰器标记了该类是一个实体类。
@PrimaryGeneratedColumn() 装饰器表示这是主键，并且是自动生成的。
@Column() 装饰器表示该字段对应数据库中的一个列。

4. 连接数据库

在项目启动时，你需要连接到数据库，通常会在 index.ts 或 app.ts 中进行：

ts
1import { AppDataSource } from "./data-source";
2import { User } from "./entity/User";
3
4async function start() {
5  // 建立数据库连接
6  await AppDataSource.initialize();
7
8  // 创建一个新的 User 实体
9  const userRepository = AppDataSource.getRepository(User);
10  const user = new User();
11  user.name = "John Doe";
12  user.email = "[email protected]";
13
14  // 保存到数据库
15  await userRepository.save(user);
16  console.log("User has been saved");
17
18  // 关闭连接
19  await AppDataSource.destroy();
20}
21
22start().catch((error) => console.log(error));

AppDataSource.initialize() 用于初始化数据库连接。
AppDataSource.getRepository(User) 获取 User 实体的 repository（仓库）来进行数据库操作。
userRepository.save(user) 保存实体到数据库。

5. 基本的 CRUD 操作

创建（Create）

ts
1const user = new User();
2user.name = "Jane Doe";
3user.email = "[email protected]";
4await userRepository.save(user);
5```### 查询（Read）#### 查询单个记录
6```ts
7const user = await userRepository.findOneBy({ id: 1 });
8console.log(user);

查询多个记录

ts
1const users = await userRepository.find();
2console.log(users);

使用条件查询

ts
1const users = await userRepository.find({
2  where: { name: "John Doe" },
3});
4console.log(users);

更新（Update）

ts
1const user = await userRepository.findOneBy({ id: 1 });
2if (user) {
3  user.name = "Updated Name";
4  await userRepository.save(user); // save 会执行更新操作
5}

删除（Delete）

ts
1const user = await userRepository.findOneBy({ id: 1 });
2if (user) {
3  await userRepository.remove(user); // 删除操作
4}

6. 同步数据库

如果你将 synchronize 配置为 true，每次启动应用时，TypeORM 会自动根据实体类生成数据库表结构，进行同步操作。

注意： 在生产环境中，通常不建议将 synchronize 设置为 true，因为它会自动修改数据库结构，可能会导致数据丢失。建议在开发环境中使用，并通过迁移（Migration）管理生产环境中的数据库结构。

7. 迁移（Migration）

如果你不想直接同步数据库结构，可以使用 TypeORM 的迁移工具来手动控制数据库结构的变更。

生成迁移文件

bash
1npx typeorm migration:generate -n MigrationName
2```### 运行迁移
3```bash
4npx typeorm migration:run
5```### 撤销迁移
6```bash
7npx typeorm migration:revert
8```## 总结
9
10TypeORM 是一个强大的 ORM 框架，可以帮助你高效地与数据库交互。它提供了许多便利的功能，如自动同步数据库、自动生成迁移文件、强类型支持等，适用于 TypeScript 和 JavaScript 项目。通过配置数据库连接、定义实体类和使用 repository，你可以轻松实现常见的 CRUD 操作。

加载中...

目录