Cách sử dụng TypeScript với Sequelize

Tôi đã có ứng dụng máy chủ của mình được viết bằng Node, PostgreSQL, Sequelize bằng Fastify.

Bây giờ tôi muốn sử dụng TypeScript. Bất cứ ai có thể cho tôi biết cách bắt đầu viết lại ứng dụng Máy chủ của tôi bằng TypeScript.

Sử dụng Decorator là điều bạn nên tránh càng nhiều càng tốt, chúng không phải là tiêu chuẩn ECMAScript. Họ thậm chí còn được coi là di sản. Đó là lý do tại sao tôi sẽ chỉ cho bạn cách sử dụng phần tiếp theo với kiểu chữ.

chúng ta chỉ cần làm theo các tài liệu: https://sequelize.org/v5/manual/typescript.htmlnhưng vì nó không rõ ràng lắm, hoặc ít nhất là đối với tôi. Tôi đã mất một lúc để hiểu nó.

Ở đó nó nói rằng bạn cần cài đặt cái cây này.

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

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

thì hãy giả sử dự án của bạn trông giống như vậy:

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

Trước tiên hãy tạo mô hình người dùng

`./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,
        },
    });
}

Bây giờ chỉ để chơi arrow, hãy tạo một model.ts khác

`./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,
        },
    });
}

Thực thể của chúng tôi đã xong. bây giờ là kết nối db.

mở ./src/models/index.tsở đó là nơi chúng tôi sẽ đặt phiên bản 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!

trên index.ts của chúng tôi thêm, nếu bạn chỉ muốn mở kết nối

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

hoặc nếu bạn muốn tạo chúng bảng

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

Một số như thế này

 
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;
}

Một lần nữa bầu trời là giới hạn. Nếu bạn làm điều này, bạn sẽ có tất cả sức mạnh của tính năng tự động hoàn thành. đây là một ví dụ:https://github.com/EnetoJara/resume-app

Sử dụng kiểu chữ tiếp theo. Chuyển đổi các bảng và dạng xem của bạn thành một lớp mở rộng đối tượng Model.

Sử dụng chú thích trong các lớp để xác định bảng của bạn.

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

Tạo kết nối đến DB bằng cách tạo đối tượng:

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

Sau đó đăng ký các bảng của bạn vào đối tượng này.

sequelize.add([Person])

Để tham khảo thêm, hãy kiểm tra mô-đun này. Sequelize-Typescript