使用TS+Sequelize實現更簡潔的CRUD

JayChen 發布于2019-08-23 11:53 / 2170人閱讀

摘要：哈哈，這又是為什么呢細心的同學可能會發現，的返回值是一個類型的，所以上邊并沒有屬性，的兩個屬性也是如此。我們通過在函數上邊添加一個范型的定義，并且添加限制保證傳入的范型類型一定是繼承自的，在返回值轉換其類型為，就可以實現功能了。

如果是經常使用Node來做服務端開發的童鞋，肯定不可避免的會操作數據庫，做一些增刪改查（CRUD，Create Read Update Delete）的操作，如果是一些簡單的操作，類似定時腳本什么的，可能就直接生寫SQL語句來實現功能了，而如果是在一些大型項目中，數十張、上百張的表，之間還會有一些（一對多，多對多）的映射關系，那么引入一個ORM（Object Relational Mapping）工具來幫助我們與數據庫打交道就可以減輕一部分不必要的工作量，Sequelize就是其中比較受歡迎的一個。

CRUD原始版手動拼接SQL

先來舉例說明一下直接拼接SQL語句這樣比較“底層”的操作方式：

CREATE TABLE animal (
  id INT AUTO_INCREMENT,
  name VARCHAR(14) NOT NULL,
  weight INT NOT NULL, 
  PRIMARY KEY (`id`)
);

創建這樣的一張表，三個字段，自增ID、name以及weight。
如果使用mysql這個包來直接操作數據庫大概是這樣的：

const connection = mysql.createConnection({})
const tableName = "animal"

connection.connect()

// 我們假設已經支持了Promise

// 查詢
const [results] = await connection.query(`
  SELECT 
    id,
    name,
    weight
  FROM ${tableName}
`)

// 新增
const name = "Niko"
const weight = 70
await connection.query(`
  INSERT INTO ${tableName} (name, weight)
  VALUES ("${name}", ${weight})
`)
// 或者通過傳入一個Object的方式也可以做到
await connection.query(`INSERT INTO ${tableName} SET ?`, {
  name,
  weight
})

connection.end()

看起來也還算是比較清晰，但是這樣帶來的問題就是，開發人員需要對表結構足夠的了解。
如果表中有十幾個字段，對于開發人員來說這會是很大的記憶成本，你需要知道某個字段是什么類型，拼接SQL時還要注意插入時的順序及類型，WHERE條件對應的查詢參數類型，如果修改某個字段的類型，還要去處理對應的傳參。
這樣的項目尤其是在進行交接的時候更是一件恐怖的事情，新人又需要從頭學習這些表結構。
以及還有一個問題，如果有哪天需要更換數據庫了，放棄了MySQL，那么所有的SQL語句都要進行修改（因為各個數據庫的方言可能有區別）

CRUD進階版 Sequelize的使用

關于記憶這件事情，機器肯定會比人腦更靠譜兒，所以就有了ORM，這里就用到了在Node中比較流行的Sequelize。

ORM是干嘛的

首先可能需要解釋下ORM是做什么使的，可以簡單地理解為，使用面向對象的方式，通過操作對象來實現與數據庫之前的交流，完成CRUD的動作。
開發者并不需要關心數據庫的類型，也不需要關心實際的表結構，而是根據當前編程語言中對象的結構與數據庫中表、字段進行映射。

就好比針對上邊的animal表進行操作，不再需要在代碼中去拼接SQL語句，而是直接調用類似Animal.create，Animal.find就可以完成對應的動作。

Sequelize的使用方式

首先我們要先下載Sequelize的依賴：

npm i sequelize
npm i mysql2    # 以及對應的我們需要的數據庫驅動

然后在程序中創建一個Sequelize的實例：

const Sequelize = require("Sequelize")
const sequelize = new Sequelize("mysql://root:jarvis@127.0.0.1:3306/ts_test")
//                             dialect://username:password@host:port/db_name

// 針對上述的表，我們需要先建立對應的模型：
const Animal = sequelize.define("animal", {
  id: { type: Sequelize.INTEGER, autoIncrement: true },
  name: { type: Sequelize.STRING, allowNull: false },
  weight: { type: Sequelize.INTEGER, allowNull: false },
}, {
  // 禁止sequelize修改表名，默認會在animal后邊添加一個字母`s`表示負數
  freezeTableName: true,
  // 禁止自動添加時間戳相關屬性
  timestamps: false,
})

// 然后就可以開始使用咯
// 還是假設方法都已經支持了Promise

// 查詢
const results = await Animal.findAll({
  raw: true,
})

// 新增
const name = "Niko"
const weight = 70

await Animal.create({
  name,
  weight,
})

sequelize定義模型相關的各種配置：docs

拋開模型定義的部分，使用Sequelize無疑減輕了很多使用上的成本，因為模型的定義一般不太會去改變，一次定義多次使用，而使用手動拼接SQL的方式可能就需要將一段SQL改來改去的。

而且可以幫助進行字段類型的轉換，避免出現類型強制轉換出錯NaN或者數字被截斷等一些粗心導致的錯誤。

通過定義模型的方式來告訴程序，有哪些模型，模型的字段都是什么，讓程序來幫助我們記憶，而非讓我們自己去記憶。
我們只需要拿到對應的模型進行操作就好了。

這還不夠

But，雖說切換為ORM工具已經幫助我們減少了很大一部分的記憶成本，但是依然還不夠，我們仍然需要知道模型中都有哪些字段，才能在業務邏輯中進行使用，如果新人接手項目，仍然需要去翻看模型的定義才能知道有什么字段，所以就有了今天要說的真正的主角兒：sequelize-typescript

CRUD終極版裝飾器實現模型定義

Sequelize-typescript是基于Sequelize針對TypeScript所實現的一個增強版本，拋棄了之前繁瑣的模型定義，使用裝飾器直接達到我們想到的目的。

Sequelize-typescript的使用方式

首先因為是用到了TS，所以環境依賴上要安裝的東西會多一些：

# 這里采用ts-node來完成舉例
npm i ts-node typescript
npm i sequelize reflect-metadata sequelize-typescript

其次，還需要修改TS項目對應的tsconfig.json文件，用來讓TS支持裝飾器的使用：

{
  "compilerOptions": {
+   "experimentalDecorators": true,
+   "emitDecoratorMetadata": true
  }
}

然后就可以開始編寫腳本來進行開發了，與Sequelize不同之處基本在于模型定義的地方：

// /modles/animal.ts
import { Table, Column, Model } from "sequelize-typescript"

@Table({
  tableName: "animal"
})
export class Animal extends Model {
  @Column({
    primaryKey: true,
    autoIncrement: true,
  })
  id: number

  @Column
  name: string

  @Column
  weight: number
}

// 創建與數據庫的鏈接、初始化模型
// app.ts
import path from "path"
import { Sequelize } from "sequelize-typescript"
import Animal from "./models/animal"

const sequelize = new Sequelize("mysql://root:jarvis@127.0.0.1:3306/ts_test")
sequelize.addModels([path.resolve(__dirname, `./models/`)])

// 查詢
const results = await Animal.findAll({
  raw: true,
})

// 新增
const name = "Niko"
const weight = 70

await Animal.create({
  name,
  weight,
})

與普通的Sequelize不同的有這么幾點：

模型的定義采用裝飾器的方式來定義

實例化Sequelize對象時需要指定對應的model路徑

模型相關的一系列方法都是支持Promise的

如果在使用過程中遇到提示XXX used before model init，可以嘗試在實例化前邊添加一個await操作符，等到與數據庫的連接建立完成以后再進行操作

但是好像看起來這樣寫的代碼相較于Sequelize多了不少呢，而且至少需要兩個文件來配合，那么這么做的意義是什么的？
答案就是OOP中一個重要的理念：__繼承__。

使用Sequelize-typescript實現模型的繼承

因為TypeScript的核心開發人員中包括C#的架構師，所以TypeScript中可以看到很多類似C#的痕跡，在模型的這方面，我們可以嘗試利用繼承減少一些冗余的代碼。

比如說我們基于animal表又有了兩張新表，dog和bird，這兩者之間肯定是有區別的，所以就有了這樣的定義：

CREATE TABLE dog (
  id INT AUTO_INCREMENT,
  name VARCHAR(14) NOT NULL,
  weight INT NOT NULL, 
  leg INT NOT NULL,
  PRIMARY KEY (`id`)
);

CREATE TABLE bird (
  id INT AUTO_INCREMENT,
  name VARCHAR(14) NOT NULL,
  weight INT NOT NULL, 
  wing INT NOT NULL,
  claw INT NOT NULL,
  PRIMARY KEY (`id`)
);

關于dog我們有一個腿leg數量的描述，關于bird我們有了翅膀wing和爪子claw數量的描述。
特意讓兩者的特殊字段數量不同，省的有杠精說可以通過添加type字段區分兩種不同的動物 :p

如果要用Sequelize的方式，我們就要將一些相同的字段定義define三遍才能實現，或者說寫得靈活一些，將define時使用的Object抽出來使用Object.assign的方式來實現類似繼承的效果。

但是在Sequelize-typescript就可以直接使用繼承來實現我們想要的效果：

// 首先還是我們的Animal模型定義
// /models/animal.ts
import { Table, Column, Model } from "sequelize-typescript"

@Table({
  tableName: "animal"
})
export default class Animal extends Model {
  @Column({
    primaryKey: true,
    autoIncrement: true,
  })
  id: number

  @Column
  name: string

  @Column
  weight: number
}

// 接下來就是繼承的使用了
// /models/dog.ts
import { Table, Column, Model } from "sequelize-typescript"
import Animal from "./animal"

@Table({
  tableName: "dog"
})
export default class Dog extends Animal {
  @Column
  leg: number
}

// /models/bird.ts
import { Table, Column, Model } from "sequelize-typescript"
import Animal from "./animal"

@Table({
  tableName: "bird"
})
export default class Bird extends Animal {
  @Column
  wing: number

  @Column
  claw: number
}

有一點需要注意的：每一個模型需要多帶帶占用一個文件，并且采用export default的方式來導出
也就是說目前我們的文件結構是這樣的：

├── models
│?? ├── animal.ts
│?? ├── bird.ts
│?? └── dog.ts
└── app.ts

得益于TypeScript的靜態類型，我們能夠很方便地得知這些模型之間的關系，以及都存在哪些字段。
在結合著VS Code開發時可以得到很多動態提示，類似findAll，create之類的操作都會有提示：

Animal.create({
  abc: 1,
// ^ abc不是Animal已知的屬性  
})

通過繼承來復用一些行為

上述的例子也只是說明了如何復用模型，但是如果是一些封裝好的方法呢？
類似的獲取表中所有的數據，可能一般情況下獲取JSON數據就夠了，也就是findAll({raw: true})
所以我們可以針對類似這樣的操作進行一次簡單的封裝，不需要開發者手動去調用findAll：

// /models/animal.ts
import { Table, Column, Model } from "sequelize-typescript"

@Table({
  tableName: "animal"
})
export default class Animal extends Model {
  @Column({
    primaryKey: true,
    autoIncrement: true,
  })
  id: number

  @Column
  name: string

  @Column
  weight: number

  static async getList () {
    return this.findAll({raw: true})
  }
}

// /app.ts
// 這樣就可以直接調用`getList`來實現類似的效果了
await Animal.getList() // 返回一個JSON數組

同理，因為上邊我們的兩個Dog和Bird繼承自Animal，所以代碼不用改動就可以直接使用getList了。

const results = await Dog.getList()

results[0].leg // TS提示錯誤

但是如果你像上邊那樣使用的話，TS會提示錯誤的：[ts] 類型“Animal”上不存在屬性“leg”。。
哈哈，這又是為什么呢？細心的同學可能會發現，getList的返回值是一個Animal[]類型的，所以上邊并沒有leg屬性，Bird的兩個屬性也是如此。

所以我們需要教TS認識我們的數據結構，這樣就需要針對Animal的定義進行修改了，用到了 __范型__。
我們通過在函數上邊添加一個范型的定義，并且添加限制保證傳入的范型類型一定是繼承自Animal的，在返回值轉換其類型為T，就可以實現功能了。

class Animal {
  static async getList() {
    const results = await this.findAll({
      raw: true,
    })
    return results as T[]
  }
}

const dogList = await Dog.getList()
// 或者不作任何修改，直接在外邊手動as也可以實現類似的效果
// 但是這樣還是不太靈活，因為你要預先知道返回值的具體類型結構，將預期類型傳遞給函數，由函數去組裝返回的類型還是比較推薦的
const dogList = await Dog.getList() as Dog[]

console.log(dogList[0].leg) // success

這時再使用leg屬性就不會出錯了，如果要使用范型，一定要記住添加extends Animal的約束，不然TS會認為這里可以傳入任意類型，那么很難保證可以正確的兼容Animal，但是繼承自Animal的一定是可以兼容的。

當然如果連這里的范型或者as也不想寫的話，還可以在子類中針對父類方法進行重寫。
并不需要完整的實現邏輯，只需要獲取返回值，然后修改為我們想要的類型即可：

class Dog extends Animal {
  static async getList() {
    // 調用父類方法，然后將返回值指定為某個類型
    const results = await super.getList()
    return results as Dog[]
  }
}

// 這樣就可以直接使用方法，而不用擔心返回值類型了
const dogList = await Dog.getList()

console.log(dogList[0].leg) // success

小結

本文只是一個引子，一些簡單的示例，只為體現出三者（SQL、Sequelize和Sequelize-typescript）之間的區別，Sequelize中有更多高階的操作，類似映射關系之類的，這些在Sequelize-typescript中都有對應的體現，而且因為使用了裝飾器，實現這些功能所需的代碼會減少很多，看起來也會更清晰。

當然了，ORM這種東西也不是說要一股腦的上，如果是初學者，從個人層面上我不建議使用，因為這樣會少了一個接觸SQL的機會
如果項目結構也不是很復雜，或者可預期的未來也不會太復雜，那么使用ORM也沒有什么意義，還讓項目結構變得復雜起來
以及，一定程度上來說，通用就意味著妥協，為了保證多個數據庫之間的效果都一致，可能會拋棄一些數據庫獨有的特性，如果明確的需要使用這些特性，那么ORM也不會太適合
選擇最合適的，要知道使用某樣東西的意義

最終的一個示例放在了GitHub上：notebook | typescript/sequelize

參考資料：

mysql | npm

sequelize

sequelize-typescript | npm

waht are the advantages of using an orm

云服務器 GPU云服務器簡潔的javascript 最簡潔的編程語言最小二乘法的簡潔算法簡潔的c語言編譯器

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/97621.html

nodejs如何簡潔優雅的訪問mysql數據庫

摘要：如何簡潔優雅的訪問數據庫一前言誕生以來出現了一大批的框架如等等，前端可以不再依賴后端可以自己控制服務端的邏輯。今天我們就來說說前端在中如何操作數據庫。 nodejs如何簡潔優雅的訪問mysql數據庫一、前言nodejs誕生以來出現了一大批的web框架如express koa2 egg等等，前端可以不再依賴后端可以自己控制服務端的邏輯。今天我們就來說說前端在nodejs中如何操作mysq...

jlanglang 2019-08-26 10:32 評論0 收藏0
sequelize入門

摘要：最近在公司接觸到了的框架，研究了一下官方文檔，做了以下整理其他定義方法字段類型是否允許為字段是否自定義表名是否需要增加字段不需要字段將字段改個名將字段改名同時需要設置為此種模式下，刪除數據時不會進行物理刪除，而是設置為當前時間最近在公司接觸到了sequelize(Nodejs的ORM框架)，研究了一下官方文檔，做了以下整理 Models Definition let DeviceIn...

kidsamong 2019-08-22 10:49 評論0 收藏0

發表評論

登陸后可評論

0條評論

JayChen

男|高級講師

我要關注我要私信

TA的文章

Splunk CEO Douglas Merritt 離職，董事會主席 Graham Smith 將

閱讀 2234·2021-11-17 09:33
C語言實現【掃雷游戲】拓展版

閱讀 2774·2021-11-12 10:36
阿里云免費領取云服務器：企業新用戶最長免費領取12個月

閱讀 3395·2021-09-27 13:47
主機安裝什么管理系統-哪個主機管理系統好用？

閱讀 884·2021-09-22 15:10
Bitwarden免費密碼管理軟件實現跨平臺在線密碼管理（云端密碼存儲）

閱讀 3485·2021-09-09 11:51
AkkoCloud：299元/年/512MB內存/10GB SSD空間/500GB流量/300Mbp

閱讀 1392·2021-08-25 09:38
實現一個平行四邊形

閱讀 2757·2019-08-30 15:55
移動端開發系列——像素與viewport

閱讀 2608·2019-08-30 15:53

国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務器低至59元/年，更有多臺、長期優惠，快來選購！

使用TS+Sequelize實現更簡潔的CRUD

相關文章

nodejs如何簡潔優雅的訪問mysql數據庫

sequelize入門

發表評論

0條評論

JayChen

男|高級講師

TA的文章

Splunk CEO Douglas Merritt 離職，董事會主席 Graham Smith 將

C語言實現【掃雷游戲】拓展版

阿里云免費領取云服務器：企業新用戶最長免費領取12個月

主機安裝什么管理系統-哪個主機管理系統好用？

Bitwarden免費密碼管理軟件實現跨平臺在線密碼管理（云端密碼存儲）

AkkoCloud：299元/年/512MB內存/10GB SSD空間/500GB流量/300Mbp

實現一個平行四邊形

移動端開發系列——像素與viewport

最新活動