วิธีใช้ TypeScript กับ Sequelize

ฉันมีแอปพลิเคชันเซิร์ฟเวอร์ของฉันที่เขียนด้วย Node, PostgreSQL, Sequelize โดยใช้ Fastify อยู่แล้ว

ตอนนี้ฉันต้องการใช้ TypeScript ใครช่วยบอกวิธีเริ่มเขียนแอปพลิเคชันเซิร์ฟเวอร์ของฉันใหม่โดยใช้ TypeScript

การใช้มัณฑนากรเป็นสิ่งที่คุณควรหลีกเลี่ยงให้มากที่สุดไม่ใช่มาตรฐาน ECMAScript พวกเขาถือว่าเป็นมรดกด้วยซ้ำ นี่คือเหตุผลที่ฉันจะแสดงวิธีใช้ sequelize กับ typescript

เราต้องทำตามเอกสาร: https://sequelize.org/v5/manual/typescript.htmlแต่มันไม่ชัดเจนนักหรืออย่างน้อยก็สำหรับฉัน ฉันใช้เวลาสักพักก็เข้าใจ

ที่นั่นบอกว่าคุณต้องติดตั้งต้นไม้นี้

 * @types/node
 * @types/validator // this one is not need it
 * @types/bluebird

npm i -D @types/node @types/bluebird

สมมติว่าโครงการของคุณมีลักษณะดังนี้:

myProject
--src
----models
------index.ts
------user-model.ts
------other-model.ts
----controllers
----index.ts
--package.json

มาสร้างโมเดลผู้ใช้ก่อน

`./src/models/user-model.ts`
import { BuildOptions, DataTypes, Model, Sequelize } from "sequelize";

export interface UserAttributes {
    id: number;
    name: string;
    email: string;
    createdAt?: Date;
    updatedAt?: Date;
}
export interface UserModel extends Model<UserAttributes>, UserAttributes {}
export class User extends Model<UserModel, UserAttributes> {}

export type UserStatic = typeof Model & {
    new (values?: object, options?: BuildOptions): UserModel;
};

export function UserFactory (sequelize: Sequelize): UserStatic {
    return <UserStatic>sequelize.define("users", {
        id: {
            type: DataTypes.INTEGER,
            autoIncrement: true,
            primaryKey: true,
        },
        email: {
            type: DataTypes.STRING,
            allowNull: false,
            unique: true,
        },
        name: {
            type: DataTypes.STRING,
            allowNull: false,
        },
        createdAt: {
            type: DataTypes.DATE,
            allowNull: false,
            defaultValue: DataTypes.NOW,
        },
        updatedAt: {
            type: DataTypes.DATE,
            allowNull: false,
            defaultValue: DataTypes.NOW,
        },
    });
}

ตอนนี้แค่เล่นลูกศรมาสร้างโมเดลอื่นกันเถอะ

`./src/models/another-model.ts`

import { BuildOptions, DataTypes, Model, Sequelize } from "sequelize";

export interface SkillsAttributes {
    id: number;
    skill: string;
    createdAt?: Date;
    updatedAt?: Date;
}
export interface SkillsModel extends Model<SkillsAttributes>, SkillsAttributes {}
export class Skills extends Model<SkillsModel, SkillsAttributes> {}

export type SkillsStatic = typeof Model & {
    new (values?: object, options?: BuildOptions): SkillsModel;
};

export function SkillsFactory (sequelize: Sequelize): SkillsStatic {
    return <SkillsStatic>sequelize.define("skills", {
        id: {
            type: DataTypes.INTEGER,
            autoIncrement: true,
            primaryKey: true,
        },
        skill: {
            type: DataTypes.STRING,
            allowNull: false,
            unique: true,
        },
        createdAt: {
            type: DataTypes.DATE,
            allowNull: false,
            defaultValue: DataTypes.NOW,
        },
        updatedAt: {
            type: DataTypes.DATE,
            allowNull: false,
            defaultValue: DataTypes.NOW,
        },
    });
}

เอนทิตีของเราเสร็จแล้ว ตอนนี้การเชื่อมต่อ db

เปิด./src/models/index.tsตรงนั้นที่เราจะวางอินสแตนซ์ seqelize

`./src/models/index.ts`

import * as sequelize from "sequelize";
import {userFactory} from "./user-model";
import {skillsFactory} from "./other-model";

export const dbConfig = new sequelize.Sequelize(
    (process.env.DB_NAME = "db-name"),
    (process.env.DB_USER = "db-user"),
    (process.env.DB_PASSWORD = "db-password"),
    {
        port: Number(process.env.DB_PORT) || 54320,
        host: process.env.DB_HOST || "localhost",
        dialect: "postgres",
        pool: {
            min: 0,
            max: 5,
            acquire: 30000,
            idle: 10000,
        },
    }
);

// SOMETHING VERY IMPORTANT them Factory functions expect a
// sequelize instance as parameter give them `dbConfig`

export const User = userFactory(dbConfig);
export const Skills = skillsFactory(dbConfig);

// Users have skills then lets create that relationship

User.hasMay(Skills);

// or instead of that, maybe many users have many skills
Skills.belongsToMany(Users, { through: "users_have_skills" });

// the skill is the limit!

ใน index.ts ของเราเพิ่มหากคุณต้องการเปิดการเชื่อมต่อ

  db.sequelize
        .authenticate()
        .then(() => logger.info("connected to db"))
        .catch(() => {
            throw "error";
        });

หรือถ้าคุณต้องการสร้างตาราง

  db.sequelize
        .sync()
        .then(() => logger.info("connected to db"))
        .catch(() => {
            throw "error";
        });

บางอย่างเช่นนี้

 
import * as bodyParser from "body-parser";
import * as express from "express";
import { dbConfig } from "./models";
import { routes } from "./routes";
import { logger } from "./utils/logger";
import { timeMiddleware } from "./utils/middlewares";

export function expressApp () {
    dbConfig
        .authenticate()
        .then(() => logger.info("connected to db"))
        .catch(() => {
            throw "error";
        });

    const app: Application = express();
    if (process.env.NODE_ENV === "production") {
        app.use(require("helmet")());
        app.use(require("compression")());
    } else {
        app.use(require("cors")());
    }

    app.use(bodyParser.json());
    app.use(bodyParser.urlencoded({ extended: true, limit: "5m" }));
    app.use(timeMiddleware);
    app.use("/", routes(db));

    return app;
}

อีกครั้งที่ท้องฟ้ามีขีด จำกัด หากคุณทำเช่นนี้คุณจะมีพลังทั้งหมดของการเติมข้อความอัตโนมัติ นี่คือตัวอย่าง:https://github.com/EnetoJara/resume-app

ใช้ sequelize-typescript แปลงตารางและมุมมองของคุณเป็นคลาสที่ขยาย Model object

ใช้คำอธิบายประกอบในชั้นเรียนเพื่อกำหนดตารางของคุณ

import {Table, Column, Model, HasMany} from 'sequelize-typescript';
 
@Table
class Person extends Model<Person> {
 
  @Column
  name: string;
 
  @Column
  birthday: Date;
 
  @HasMany(() => Hobby)
  hobbies: Hobby[];
}

สร้างการเชื่อมต่อกับ DB โดยการสร้างวัตถุ:

const sequelize = new Sequelize(configuration...). 

จากนั้นลงทะเบียนตารางของคุณกับวัตถุนี้

sequelize.add([Person])

สำหรับการอ้างอิงเพิ่มเติมโปรดตรวจสอบโมดูลนี้ Sequelize-typescript