TypeORM - 创建一个简单的项目

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

cd /path/to/TypeORM/

句法

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

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

例子

typeorm init --name FirstProject --database mysql

这里，

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

Project created inside /path/to/TypeORM/FirstProject directory

现在，进入我们的项目目录并使用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 - 应用程序的入口点。
实体- 包含数据库模型。
迁移- 包含数据库迁移代码。
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" 
}

实体- 指实体类的位置。
迁移- 指迁移类的位置。
订阅者- 指您的订阅者类别的位置。
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应用程序，对其进行了配置并运行该应用程序。

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