TypeORM - Tạo một dự án đơn giản

Chương này giải thích về cách tạo ứng dụng TypeORM đơn giản. Hãy để chúng tôi tạo một thư mục mới có tên 'TypeORM' và chuyển vào thư mục.

cd /path/to/TypeORM/

Cú pháp

Sử dụng lệnh dưới đây để tạo dự án mới -

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

Thí dụ

typeorm init --name FirstProject --database mysql

Đây,

FirstProject là tên dự án của bạn và sqlite3là tên cơ sở dữ liệu. Sau khi thực hiện lệnh trên, bạn có thể thấy phản hồi sau,

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

Bây giờ, hãy chuyển đến thư mục dự án của chúng tôi và cài đặt các phụ thuộc dự án bằng cách sử dụng npm mô-đun,

$ cd FirstProject 

$ npm install

Cấu trúc dự án

Hãy cho chúng tôi hiểu cấu trúc dự án của dự án mới tạo của chúng tôi, FirstProject.

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

Đây,

  • src - chứa mã nguồn của ứng dụng của bạn trong TypeScriptngôn ngữ. Nó có một tập tinindex.ts và hai thư mục con entitymigration.
  • index.ts - Điểm vào ứng dụng của bạn.
  • entity - Chứa các mô hình cơ sở dữ liệu.
  • migration - chứa mã di chuyển cơ sở dữ liệu.
  • node_modules - các mô-đun npm được lưu cục bộ.
  • ormconfig.json- Tệp cấu hình chính của ứng dụng của bạn. Nó chứa chi tiết cấu hình cơ sở dữ liệu và cấu hình thực thể.
  • package.json - Chứa các phụ thuộc mô-đun nút.
  • package-lock.json - Tệp được tạo tự động và liên quan đến package.json.
  • tsconfig.json - Chứa các tùy chọn trình biên dịch cụ thể của TypeScript.

tệp ormconfig.json

Hãy để chúng tôi kiểm tra tùy chọn cấu hình có sẵn cho ứng dụng của chúng tôi. Mở tệp ormconfig.json và nó trông giống như sau:

{ 
   "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
   }    
 }

Đây,

type, host, username, password, database và các tùy chọn cổng có liên quan đến thiết lập cơ sở dữ liệu. mysql có thể được định cấu hình bằng cách sử dụng cấu hình dưới đây -

{ 
   "type": "mysql", 
   "host": "localhost", 
   "port": 3306, 
   "username": "db_username", "password": "db_password", "database": "db_name" 
}
  • entities - đề cập đến vị trí của các lớp thực thể của bạn.
  • migrations - đề cập đến vị trí của các lớp di chuyển của bạn.
  • subscribers - đề cập đến vị trí của các lớp thuê bao của bạn.
  • cli - đề cập đến tùy chọn được sử dụng bởi TypeORM CLI để tự động tạo mã

Khởi động máy chủ MySql

Trước khi bắt đầu ứng dụng, hãy bắt đầu MySQL máy chủ hoặc bất kỳ máy chủ cơ sở dữ liệu nào do bạn sử dụng và đảm bảo rằng nó đang chạy đúng cách.

Chạy ứng dụng

Sau khi mọi thứ được cấu hình, chúng ta có thể thực thi ứng dụng bằng lệnh dưới đây:

npm start

Bạn có thể thấy phản hồi sau:

> [email protected] 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.

Ứng dụng đã chèn một người dùng mới vào cơ sở dữ liệu và sau đó tải ngược lại từ cơ sở dữ liệu và cuối cùng hiển thị người dùng đã tải trong bảng điều khiển. Chúng tôi đã tạo thành công mộtTypeORM ứng dụng, đã cấu hình nó và chạy ứng dụng.

Chúng ta sẽ thảo luận về cách dữ liệu được thực thi công phu trong các chương sắp tới.