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 - 應用程式的入口點。
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應用程式，對其進行了配置並運行了該應用程式。

我們將在後續章節中詳細討論資料是如何執行的。

列印頁面