TypeORM - 创建一个简单的项目

本章介绍如何创建简单的 TypeORM 应用程序。让我们创建一个名为"TypeORM"的新目录并进入该目录。

cd /path/to/TypeORM/

语法

使用以下命令创建新项目 −

typeorm init --name <project-name> --database <database-name>

示例

typeorm init --name FirstProject --database mysql

这里，

FirstProject 是您的项目名称，sqlite3 是数据库名称。执行上述命令后，你会看到以下响应，

在 /path/to/TypeORM/FirstProject 目录中创建的项目

现在，进入我们的项目目录并使用 npm 模块安装项目依赖项，

$ cd FirstProject

$ npm install

项目结构

让我们了解我们新创建的项目 FirstProject 的项目结构。

FirstProject 
├──> src 
│ ├──> entity 
│ │ └──> User.ts 
│ ├──> migration 
│ └──> index.ts 
├──> node_modules 
├──> ormconfig.json 
├──> package.json 
├──> package-lock.json 
└──> tsconfig.json

此处，

• src − 包含您的应用程序的源代码(采用 TypeScript 语言)。它有一个文件 index.ts 和两个子目录 entity 和 migration。
• index.ts − 应用程序的入口点。
• entity − 包含数据库模型。
• migration − 包含数据库迁移代码。
• node_modules − 本地保存的 npm 模块。
• ormconfig.json − 应用程序的主配置文件。它包含数据库配置详细信息和实体配置。
• package.json −包含节点模块依赖项。
• package-lock.json − 自动生成的文件并与 package.json 相关。
• tsconfig.json − 包含 TypeScript 特定的编译器选项。

ormconfig.json 文件

让我们检查应用程序可用的配置选项。打开 ormconfig.json 文件，它看起来类似于此 −

{ 
   "type": "mysql", 
   "host": "localhost", 
   "port": 3306, 
   "username": "test", 
   "password": "test", 
   "database": "test", 
   "synchronize": true, 
   "logging": false, 
   "entities": [ 
      "src/entity/**/*.ts" ], 
   "migrations": [ "src/migration/**/*.ts" 
   ], 
   "subscribers": [ "src/subscriber/**/*.ts" 
   ], 
   "cli": { 
      "entitiesDir":"src/entity", "migrationsDir":"src/migration", "subscribersDir":"src/subscriber
   }    
 }

此处，

type, host, username, password, database 和 port 选项与数据库设置相关。mysql 可以使用以下配置进行配置 −

{ 
   "type": "mysql", 
   "host": "localhost", 
   "port": 3306, 
   "username": "db_username", "password": "db_password", "database": "db_name" 
}

• entities − 指的是您的实体类的位置。
• migrations − 指的是您的迁移类的位置。
• subscribers − 指的是您的订阅者类的位置。
• cli − 指的是 TypeORM CLI 用于自动生成代码的选项

启动 MySql 服务器

在启动应用程序之前，请启动您的 MySQL 服务器或您使用的任何数据库服务器，并确保它正常运行。

运行应用程序

配置完所有内容后，我们可以使用以下命令执行应用程序 −

npm start

您可以看到以下响应 −

> FirstProject@0.0.1 start /Users/../../TypeORM/FirstProject 

> ts-node src/index.ts 

Inserting a new user into the database... Saved a new user with id: 1 Loading users from the database... Loaded users: [ User { id: 1, firstName: 'Timber', lastName: 'Saw', age: 25 }] 

Here you can setup and run express/koa/any other framework.

应用程序将新用户插入数据库，然后从数据库反向加载，最后在控制台中显示加载的用户。我们已成功创建一个新的 TypeORM 应用程序，对其进行配置并运行该应用程序。

我们将在接下来的章节中详细讨论如何执行数据。