Vue2+Koa2+Typescript先後端框架教程--05Sequelize（ORM）的使用，實現基礎的班級增刪改查API

時間 2021-01-19

標籤 html node mysql sql typescript 數據庫 npm json 後端 api 欄目 Java 简体版

原文原文鏈接

本篇開始分享Node.js後端服務開發中對於數據結構ORM的實現，主要使用的技術棧是：Sequelize。html

上一篇文章中講到班級管理的數據結構：ID，班級名稱，班級編碼，班主任ID，使用的數據庫是MySQL，經過Sequelize，實現簡單的增刪改查的API。node

1. MySQL中建立數據庫和班級表。mysql

1.1 建立數據庫demo_nodesql

CREATE DATABASE `demo_node` /*!40100 DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci */ /*!80016 DEFAULT ENCRYPTION='N' */;

1.2 建立班級表t_classtypescript

CREATE TABLE `demo_node`.`t_class` (
  `id` VARCHAR(36) NOT NULL,
  `class_name` VARCHAR(45) NULL,
  `class_code` VARCHAR(20) NULL,
  `head_teacher_id` VARCHAR(45) NULL,
  PRIMARY KEY (`id`))
COMMENT = '班級表';

2. 安裝Sequelize。數據庫

npm install sequelize -s

npm install mysql2 -s

注：Sequelize鏈接哪一種數據庫就要安裝對應數據庫的驅動npm

3. src根目錄下添加數據庫配置文件：db_config.tsjson

import { Sequelize } from 'sequelize';


const DbSequelize = new Sequelize({
    host: "localhost",//本地：localhost，其餘服務器使用ip地址
    dialect: "mysql",//鏈接數據庫類型
    database: "demo_node",//數據庫名稱
    username: "root",//數據庫帳戶用戶名
    password: "123456",//數據庫帳戶密碼
    define: {
        timestamps: false,//是否開啓時間戳createAt  deleteAt  updateAt    
        underscored: true,//下劃線 
        freezeTableName: true, //禁止sequelize修改表名，默認會在表後邊添加一個字母`s`表示複數
        paranoid: true //開啓假刪除
    },
    pool: {
        max: 10,
        min: 0,
        acquire: 30000,
        idle: 10000
    },
    timezone: '+08:00',//時區設置，東八區
});

export default DbSequelize;

4. 定義Model：在models文件夾中修改class.ts，定義班級模型。（上一篇使用的是sequelize-typescript，這裏沒有使用，因此模型定義有所區別，可是思路一致）後端

import { Sequelize, DataTypes } from "sequelize";
import DbSequelize from "../db_config";

//班級模型
export default DbSequelize.define('ClassModel', {
    id: {
        type: DataTypes.STRING,
        primaryKey: true//設爲主鍵
    },
    className: {
        type: DataTypes.STRING
    },
    classCode: {
        type: DataTypes.STRING
    },
    headTeacherId: {
        type: DataTypes.STRING
    },
}, {
    tableName: 't_class'//定義對應數據庫表名
});

5. 定義Service，在services中修改class.ts：api

import ClassModel from '../models/class';

//班級管理服務
export default class ClassService {
    //獲取全部班級
    async findClassList() {
        try {
            return ClassModel.findAll({
                attributes: ['id', 'className', 'classCode', 'headTeacherId']
            });
        }
        catch (err) {
            throw (err);
        }
    }

    //獲取單個班級
    async findClassById(classId: string) {
        try {
            return ClassModel.findOne({
                attributes: ['id', 'className', 'classCode', 'headTeacherId'],
                where: { id: classId }
            });
        }
        catch (err) {
            throw (err);
        }
    }

    //刪除班級
    async deleteClass(classId: string) {
        try {
            return await ClassModel.destroy({ where: { id: classId } });
        }
        catch (err) {
            throw (err);
        }
    }


    //修改班級
    async editClass(classObj: any) {
        try {
            return await ClassModel.update(classObj, { where: { id: classObj.id }, individualHooks: true });
        }
        catch (err) {
            throw (err);
        }
    }

    //添加班級
    async addClass(classObj: any) {
        try {
            return await ClassModel.create(classObj);
        }
        catch (err) {
            throw (err);
        }
    }
}

6. 定義Controller，在controllers文件夾中修改班級控制器class.ts：

import ClassService from '../services/class';

const clsService = new ClassService();

//班級管理控制器
export default class ClassController {
    //查找全部班級
    static async findClassList(ctx: any) {
        try {
            //調用查詢列表服務，獲取結果
            let res = await clsService.findClassList();
            ctx.body = {
                status: 1,//返回碼：1操做成功，0操做錯誤
                data: {
                    classList: res
                }
            }
        }
        catch (err) {
            ctx.throw(err.message);
        }
    }

    //根據班級id獲取班級詳細信息
    static async findClassById(ctx: any) {
        try {
            let id = ctx.request.query.id;
            if (!id) {
                ctx.body = {
                    status: 0
                }
                return;
            }
            //調用查詢詳情服務，獲取結果
            let res = await clsService.findClassById(id);
            ctx.body = {
                status: 1,
                data: {
                    class: res
                }
            }
        }
        catch (err) {
            ctx.throw(err.message);
        }
    }

    //刪除班級
    static async deleteClass(ctx: any) {
        try {
            let id: string = ctx.request.body.id;
            //調用刪除服務，獲取結果
            let res: any = await clsService.deleteClass(id);
            if (res === 1) {
                ctx.body = {
                    status: 1
                }
            }
            else {
                ctx.body = {
                    status: 0
                }
            }
        }
        catch (err) {
            ctx.throw(err.message);
        }
    }

    //修改班級
    static async editClass(ctx: any) {
        try {
            let obj: any = ctx.request.body;
            //調用修改服務，獲取結果
            let res: any = await clsService.editClass(obj);

            if (res[0] !== 1) {
                ctx.body = {
                    status: 0
                }
            }
            else {
                ctx.body = {
                    status: 1,
                    data: {
                        classId: res[1][0].id
                    }
                }
            }
        }
        catch (err) {
            ctx.throw(err.message);
        }
    }

    //添加班級
    static async addClass(ctx: any) {
        try {
            let obj: any = ctx.request.body;
            //調用添加服務，獲取結果
            let res: any = await clsService.addClass(obj);

            if (!res) {
                ctx.body = {
                    status: 0
                }
            }
            else {
                ctx.body = {
                    status: 1,
                    data: {
                        classId: res.id
                    }
                }
            }
        }
        catch (err) {
            ctx.throw(err.message);
        }
    }
}

7. router如上篇一致，以下：

import KoaRouter from 'koa-router';
import ClassController from './controllers/class';

const router = new KoaRouter();
router.post('/api/class/addClass', ClassController.addClass);
router.post('/api/class/editClass', ClassController.editClass);
router.post('/api/class/deleteClass', ClassController.deleteClass);
router.get('/api/class/findClassById', ClassController.findClassById);
router.get('/api/class/findClassList', ClassController.findClassList);

export default router;

8.開始測試：

8.1 安裝koa-body：因爲添加修改刪除定義爲post方法，因此首先要安裝koa-body，才能獲取到post過來的數據（刪除也能夠使用get）

npm install koa-body -s

8.2 修改app.ts，添加koa-body中間件引用

const Koa = require('koa');
import KoaBody from "koa-body";

const app = new Koa();

app.use(KoaBody({
  multipart: true,
  formidable: {
      maxFileSize: 1000 * 1024 * 1024    // 設置上傳文件大小最大限制，默認2M
  },
  formLimit: "10mb",
  jsonLimit: "10mb",
  textLimit: "10mb"
}));

//引入路由
import router from './router';
//添加中間件
app.use(router.routes());
app.use(router.allowedMethods());

app.use(async (ctx: any) => {
  ctx.body = 'Hello World...Hello LaoLv';
});

console.log('app server start on port 3000...')
app.listen(3000);