TypeORM 中文文档

# FAQ

# 如何更新数据库架构？

TypeORM 的主要职责之一是使你的数据库表与实体保持同步。 有两种方法可以帮助你实现这一目标：

  • 在连接选项中设置 synchronize: true：

    import { createConnection } from "typeorm";

createConnection({
  synchronize: true
});
    1
    2
    3
    4
    5

    每次运行时，此选项都会自动将数据库表与给定实体同步。 此选项在开发时非常好用，但在生产环境中最好不要启用此选项。

  • 使用命令行工具进行同步：

    typeorm schema:sync
    1

    此命令将执行架构同步。 注意，要使命令行工具正常工作，必须先创建一个 ormconfig.json 文件。

架构同步非常快。 If you are considering the disable synchronize option during development because of performance issues, first check how fast it is.

# 如何更改数据库中的列名？

默认情况下，列名称是从属性名称生成的。 你也可以通过指定name列选项来简单地更改它：

@Column({ name: "is_active" })
isActive: boolean;
1
2

# 如何将默认值设置为某个函数，例如NOW()？

default列选项支持一个函数。 如果要传递一个返回字符串的函数，它将使用该字符串作为默认值而不去转义它。 例如：

@Column({ default: () => "NOW()" })
date: Date;
1
2

# 怎么做验证？

验证不是 TypeORM 的一部分，因为验证是一个与 TypeORM 无关的独立过程。 如果要使用验证，请使用class-validator (opens new window)，它可以与 TypeORM 完美配合。

# 关系中的"owner side"意味着什么或为什么我们需要使用@JoinColumn和@JoinTable？

让我们从"一对一"关系开始吧。 假设我们有两个实体：User和Photo：

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @OneToOne()
  photo: Photo;
}
1
2
3
4
5
6
7
8
9
10
11
@Entity()
export class Photo {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  url: string;

  @OneToOne()
  user: User;
}
1
2
3
4
5
6
7
8
9
10
11

这个例子没有@JoinColumn，显然这是不对的。 为什么？ 因为要建立真正的关系，我们需要在数据库中创建一个列。 我们需要在user中的photo或photoId中创建一个列userId。 但是应该创建哪一列 ，userId或photoId？ TypeORM 无法为你决定。 要做出决定，你必须在其中一方使用@JoinColumn。 如果你将@JoinColumn放在Photo中，那么将在photo表中创建一个名为userId的列。 如果在User中放置@JoinColumn，那么将在user表中创建一个名为photoId的列。 @JoinColumn的一面将被称为"关系的所有者方"。 没有@JoinColumn的关系的另一面被称为"关系的逆（非所有者）方"。

它在@ManyToMany关系中是相同的。 使用@JoinTable来显示关系的所有者方。

在@ ManyToOne或@OneToMany关系中，@JoinColumn不是必需的，因为两个装饰器都不同，并且放置@ManyToOne装饰器的表将具有关系列。

@JoinColumn和@JoinTable装饰器也可用于指定其他连接列/联结表设置，如连接列名或联结表名。

# 如何在多对多（联结）表中添加额外的列？

无法在由多对多关系创建的表中添加额外的列。 你需要创建一个单独的实体并使用与目标实体的两个多对一关系绑定它（效果与创建多对多表相同），并在其中添加额外的列。

# 如何使用TypeORM与依赖注入工具？

在 TypeORM 中，你可以使用服务容器。 服务容器允许你在某些地方注入自定义服务，例如订阅者或自定义命名策略。 例如，你可以使用服务容器从任何位置访问 ConnectionManager。

以下是如何使用 TypeORM 设置 typedi 服务容器的示例。 注意：你可以使用 TypeORM 设置任何服务容器。

import { useContainer, createConnection } from "typeorm";
import { Container } from "typedi";

// 在开始使用TypeORM之前设置容器很重要
useContainer(Container);
createConnection({
  /* ... */
});
1
2
3
4
5
6
7
8

# 如何处理TypeScript编译器的outDir选项？

当你使用outDir选项时，不要忘记将应用程序使用的 assets 和 resources 复制到输出目录中。 否则，请确保设置这些资源的正确路径。

要知道的重要事情是，当你移除或移动实体时，旧实体在输出目录中保持不变。 例如，你创建一个Post实体并将其重命名为Blog， 此时你的项目中不再有Post.ts。 但是，Post.js保留在输出目录中。 现在，当 TypeORM 从输出目录中读取实体时，它会看到两个实体 - Post和Blog。 这可能是错误的根源。 这就是为什么当你删除并移动启用了utDir的实体时，强烈建议删除输出目录并重新编译项目。

# 如何将TypeORM和ts-node一起使用？

你可以使用ts-node (opens new window)阻止每次编译文件。 如果你使用的是 ts-node，则可以在连接选项中指定ts实体：

{
    entities: ["src/entity/*.ts"],
    subscribers: ["src/subscriber/*.ts"]
}
1
2
3
4

另外，如果要将 js 文件编译到 typescript 文件所在的同一文件夹中，请确保使用outDir编译器选项来防止此问题 (opens new window)。

此外，如果要使用 ts-node CLI，可以通过以下方式执行 TypeORM：

npx typeorm-ts-node-commonjs schema:sync
1

# 后端如何使用Webpack？

由于缺少 require 语句，Webpack 会产生警告 - 对 TypeORM 支持的所有驱动程序都需要语句。 要禁用未使用的驱动程序的这些警告，你需要编辑 webpack 配置文件。

const FilterWarningsPlugin = require('webpack-filter-warnings-plugin');

module.exports = {
    ...
    plugins: [
        // 忽略你不想要的驱动程序。 这是所有驱动程序的完整列表 - 删除你要使用的驱动程序的suppressions。
        new FilterWarningsPlugin({
            exclude: [/mongodb/, /mssql/, /mysql/, /mysql2/, /oracledb/, /pg/, /pg-native/, /pg-query-stream/, /redis/, /sqlite3/]
        })
    ]
};
1
2
3
4
5
6
7
8
9
10
11

# 打包迁移文件

默认情况下，Webpack 尝试将所有内容捆绑到一个文件中。 当你的项目具有迁移文件时，这可能会出现问题，这些文件是在将捆绑代码部署到生产环境之后执行的。 为了确保所有迁移都可以被 TypeORM 识别和执行，你可能需要使用"Object Syntax"作为迁移文件的entry配置。

const glob = require("glob");
const path = require("path");

module.exports = {
  // ...你的webpack配置在这里...
  // Dynamically generate a `{ [name]: sourceFileName }` map for the `entry` option
  // change `src/db/migrations` to the relative path to your migration folder
  entry: glob.sync(path.resolve("src/db/migrations/*.ts")).reduce((entries, filename) => {
    const migrationName = path.basename(filename, ".ts");
    return Object.assign({}, entries, {
      [migrationName]: filename
    });
  }, {}),
  resolve: {
    // 假设所有迁移文件都是用TypeScript编写的
    extensions: [".ts"]
  },
  output: {
    // 将`path`更改为要放置已转换的迁移文件的位置。
    path: __dirname + "/dist/db/migrations",
    // 这很重要 - 我们希望UMD（通用模块定义）用于迁移文件。
    libraryTarget: "umd",
    filename: "[name].js"
  }
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

此外，自 Webpack 4 之后，当使用mode：'production'时，默认情况下会优化文件，包括修改代码以最小化文件大小。 这会中断迁移，因为 TypeORM 依赖于它们的名称来确定哪些已经执行。 你可以添加以下内容来完全禁用最小化：

module.exports = {
  // ... 其他Webpack配置在这里
  optimization: {
    minimize: false
  }
};
1
2
3
4
5
6

或者，如果您使用的是UglifyJsPlugin，你可以告诉它不要更改类或函数名称，如下所示：

const UglifyJsPlugin = require("uglifyjs-webpack-plugin");

module.exports = {
  // ... 其他Webpack配置在这里
  optimization: {
    minimizer: [
      new UglifyJsPlugin({
        uglifyOptions: {
          keep_classnames: true,
          keep_fnames: true
        }
      })
    ]
  }
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

最后，确保在ormconfig文件中包含已转换的迁移文件：

// TypeORM配置
module.exports = {
  // ...
  migrations: [
    // 这是生产环境中已转换的迁移文件的相对路径
    "db/migrations/**/*.js",
    // 你的源迁移文件，在开发模式下使用
    "src/db/migrations/**/*.ts"
  ]
};
1
2
3
4
5
6
7
8
9
10

← 支持的平台 →