前端 - 应该如何在已经有内容的项目中初始化使用typeorm？

Question

在使用typeorm的时候，

如果想要对项目初始化使用typeorm，

如果是一个项目目录（没有任何内容），我们可以：

typeorm init

进行初始化。

但是如果我们已经开始写代码了，有内容，应该如何初始化呢？因为这里不能使用typeorm init，会覆盖掉原有我们写的代码。

Answer 1

在已经有内容的项目中初始化使用TypeORM，主要步骤是手动配置TypeORM而不是使用typeorm init命令，因为该命令会覆盖或创建一个新的项目结构。以下是在已有项目中集成TypeORM的步骤：

1. 安装TypeORM

首先，你需要确保你的项目中已经安装了TypeORM。如果还没有安装，可以通过npm或yarn来安装：

npm install --save typeorm
# 或者
yarn add typeorm

如果你打算使用TypeORM与特定的数据库（如PostgreSQL, MySQL, SQLite等）进行交互，你还需要安装相应的数据库驱动：

npm install --save pg # 对于PostgreSQL
# 或者
npm install --save mysql # 对于MySQL
# 以此类推

2. 配置TypeORM

在项目中创建一个TypeORM的配置文件。这个文件可以是一个JSON、YAML、JS或TS文件，通常命名为ormconfig.json、ormconfig.yml、ormconfig.js或ormconfig.ts。这个文件将包含数据库连接信息、实体、迁移等配置。

示例：ormconfig.json

{
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "your_username",
  "password": "your_password",
  "database": "your_database",
  "synchronize": true,
  "logging": false,
  "entities": [
    "dist/entity/**/*.js"
  ],
  "migrations": [
    "dist/migration/**/*.js"
  ],
  "subscribers": [
    "dist/subscriber/**/*.js"
  ]
}

注意：synchronize属性在生产环境中应该设置为false，并使用迁移（migrations）来管理数据库结构的变化。

3. 定义实体

在项目中创建实体（Entity）类，这些类将映射到数据库中的表。实体类使用TypeORM的装饰器来定义字段、关系等。

示例：User.ts

import { Entity, Column, PrimaryGeneratedColumn } from "typeorm";

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

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  // 其他字段和关系
}

4. 使用TypeORM连接数据库

在你的应用程序的启动过程中，使用TypeORM创建数据库连接。这通常在应用的入口文件（如app.ts或server.ts）中完成。

示例：

import "reflect-metadata";
import { createConnection } from "typeorm";

createConnection().then(async connection => {
    // 在这里运行你的应用逻辑
    console.log("Database connection is established!");
}).catch(error => console.error(error));

5. 迁移（可选）

如果你的数据库结构会发生变化，你可以使用TypeORM的迁移功能来管理这些变化。首先，创建一个迁移脚本，然后运行它。

创建迁移：

typeorm migration:create -n CreateUser

运行迁移：

typeorm migration:run

通过以上步骤，你可以在已有内容的项目中初始化并使用TypeORM。记得根据你的具体需求调整配置和代码。