安装 password-hash 与测试

用来处理用户密码，不存储用户的明文密码，而是存储加密后的。

  1. npm i password-hash -S

在 src 目录下面创建 db.ts ， 定义模型我们使用define方法， 这些都是有代码提示的。

  1. import * as Sequelize from 'sequelize';
  2. import * as ph from 'password-hash';
  3. import { resolve } from 'path';
  5. const sq = new Sequelize('db', null, null,{
  6.     dialect: 'sqlite',
  7.     storage: resolve(__dirname, '../storage/db.sqlite3')
  8. });
  10. var User = sq.define('user', {
  11.     id:{
  12.         type: Sequelize.INTEGER,
  13.         primaryKey: true,
  14.         autoIncrement: true
  15.     },
  16.     username: {
  17.       type: Sequelize.STRING,
  18.     },
  19.     email: {
  20.      type: Sequelize.STRING
  21.     },
  22.     password: {
  23.      type: Sequelize.STRING
  24.     }
  25. }, {
  26.     timestamps: false,
  27.     freezeTableName: true // Model tableName will be the same as the model name
  28. });
  30. User.create({
  31.     username: 'yugo',
  32.     email: 'belovedyogurt@gmail.com',
  33.     password: ph.generate('123456')
  34. }).then(console.log)

首先编译

  1. tsc

之后再运行

  1. node dist/db.js

这样我们就可以在数据里面看到我们的数据了。

编写 Model 与 ava 测试文件

之前我们是把js文件编译到dist目录下管理，假如我们的test下面的测试文件也跑到dist目录下面的话就感觉很别扭，因为它没有在它该在的位置上，也就是不在其位而谋其政，尽管我们可以通过写2个 tsconfig.json 和 配置 exclude 选项让它们分开编译来解决这个问题，我们还不如就让 js 和 ts 在同一目录下来的简单。

修改我们的 db.ts 我们让他仅仅只提供数据库连接。

  1. import * as Sequelize from 'sequelize';
  2. import { resolve } from 'path';
  4. const sq = new Sequelize('db', null, null,{
  5.     dialect: 'sqlite',
  6.     storage: resolve(__dirname, '../storage/db.sqlite3')
  7. });
  9. export default sq;

修改 tsconfig.json

在根目录下面新建一个 types 文件夹，在这里面你可以写你的代码提示文件，但是并不会被转换成模块。

  1. {
  2.     "compilerOptions": {
  3.         "module": "commonjs",
  4.         "target": "es5",
  5.         "noImplicitAny": false,
  6.         "sourceMap": true,
  7.         "lib": [
  8.             "es6",
  9.             "es7"
  10.         ],
  11.         "typeRoots": [
  12.             "./types"   
  13.         ]
  14.     }
  15. }

在 src 目录下面创建 model 文件夹，新建 todo.ts 、 todoFolder.ts、 user.ts 三个文件。

model 下面都是存放我们的模型，通过 hasMany 定义模型之间的关系。

  • todo.ts
  1. import sq from '../db';
  2. import * as Sequelize from 'sequelize';
  3. import { TodoFolder } from './todoFolder'
  5. const Todo = sq.define<any, any>('todo', {
  6.     id: {
  7.         type: Sequelize.INTEGER,
  8.         primaryKey: true,
  9.         autoIncrement: true
  10.     },
  11.     text: {
  12.         type: Sequelize.TEXT
  13.     },
  14.     completed: {
  15.         type: Sequelize.BOOLEAN
  16.     },
  17.     'todo_folder_id': {
  18.         type: Sequelize.INTEGER,
  19.         references: {
  20.             model: TodoFolder,
  21.             key: 'id'
  22.         }
  23.     }
  24. },{
  25.     freezeTableName: true // 模型名字与表名相同
  26. });
  28. TodoFolder.hasMany(Todo, { as: 'Todos', foreignKey: 'todo_folder_id' })
  30. export { Todo }
  • todoFolder.ts
  1. import sq from '../db';
  2. import * as Sequelize from 'sequelize';
  3. import {User} from './user';
  5. const TodoFolder = sq.define<any, any>('todo_folder', {
  6.     id: {
  7.         type: Sequelize.INTEGER,
  8.         primaryKey: true,
  9.         autoIncrement: true
  10.     },
  11.     title: {
  12.         type: Sequelize.TEXT
  13.     },
  14.    'user_id': {
  15.         type: Sequelize.INTEGER,
  16.         references: {
  17.             model: User,
  18.             key: 'id'
  19.         }
  20.     }
  21. },{
  22.     timestamps: false, // 关闭时间戳
  23.     freezeTableName: true // 模型名字与表名相同
  24. })
  26. User.hasMany(TodoFolder, { constraints: false, as: 'Folders', foreignKey: 'user_id' });
  28. export { TodoFolder }
  • user.ts
  1. import sq from '../db';
  2. import * as Sequelize from 'sequelize';
  3. import * as ph from "password-hash";
  5. const User = sq.define<any, IUser>('user', {
  6.     id:{
  7.         type: Sequelize.INTEGER,
  8.         primaryKey: true,
  9.         autoIncrement: true
  10.     },
  11.     username: {
  12.       type: Sequelize.STRING,
  13.     },
  14.     email: {
  15.      type: Sequelize.STRING
  16.     },
  17.     password: {
  18.      type: Sequelize.STRING
  19.     }
  20. }, {
  21.     timestamps: false, // 关闭时间戳
  22.     freezeTableName: true // 模型名字与表名相同
  23. });
  26. interface IUser {
  27.     username: string,
  28.     email: string,
  29.     password: string
  30. }
  32. export default {
  33.     async createUser(user: IUser) {
  34.         return User.create({
  35.             username: user.username,
  36.             email: user.email,
  37.             password: ph.generate(user.password)
  38.         });
  39.     },
  41.     getOne: User.findById,
  43. }
  45. export { User }

为了确保这些 model 都已经正确可用了，我们需要编写我们的测试文件。

首先全局安装 ava 测试套件

  1. npm i ava -g

在根目录初始化 ava 套件

  1. ava --init

在根目录下面创建 test 文件夹，在里面新建 user.ts

一定不要把异步函数传给闭包，要不然有一些你意想不到的后果。

  1. import UserUtil, { User } from '../src/model/user';
  2. import { TodoFolder } from '../src/model/todoFolder';
  3. import { Todo } from '../src/model/todo';
  5. import test from 'ava';
  6. import * as ph from 'password-hash';
  8. // 错误的例子，最后一个 User 死活删除不了。
  9. // async function deleteData(data: any[]){
  10. //     if(data.length == 0) return;
  11. //     data.forEach( async (i) => {
  12. //         await i.destroy();
  13. //     })
  14. // }
  16. async function deleteData(data: any[]){
  17.     if(data.length == 0) return;
  18.     const compose = data.map((i) => {
  19.         return i.destroy();
  20.     });
  21.     await Promise.all(compose);
  22. }
  24. async function destroyAll(){
  25.     // 因为外键依赖的原因，我们需要按顺序删除
  26.     let todos = await Todo.findAll();
  28.     let folders = await TodoFolder.findAll();
  30.     let users = await User.findAll();
  32.     await Promise.all([deleteData(todos), deleteData(folders), deleteData(users)])
  34.     console.log('aleady delete all data\n');
  35. }
  37. async function fackerData(){
  38.     const user = await UserUtil.createUser({
  39.         username: 'yugo',
  40.         email: 'belovedyogurt@gmail.com',
  41.         password: '123456'
  42.     });
  44.     const todoFolder = TodoFolder.build({
  45.         'user_id': user.id,
  46.         title: '生活'
  47.     });
  49.     await todoFolder.save();
  51.     const todo_1 = Todo.build({
  52.         text: '吃大餐！',
  53.         completed: true,
  54.         'todo_folder_id': todoFolder.id
  55.     });
  57.     const todo_2 = Todo.build({
  58.         text: '睡大觉！',
  59.         completed: false,
  60.         'todo_folder_id': todoFolder.id
  61.     });
  63.     await todo_1.save();
  64.     await todo_2.save();
  66.     console.log('facker data finished!\n');
  67. }
  69. test('test user create', async (t) => {
  71.     await destroyAll();
  72.     await fackerData();
  74.     const user = await User.find({
  75.         where: {
  76.             email: 'belovedyogurt@gmail.com'
  77.         }
  78.     });
  81.     let folders = await user.getFolders();
  83.     let todos = await folders[0].getTodos();
  85.     t.is(folders[0].title, '生活');
  87.     t.is(todos[0].completed, true);
  88.     t.is(todos[0].text, '吃大餐！');
  90.     t.is(ph.verify('123456', user.password), true)
  92. });

每次运行测试之前必须先运行 tsc 编译好，之后再运行 ava 命令。

我们可以修改一下 package.json 的 scripts

  1.   "scripts": {
  2.     "test": "tsc && ava",
  3.     "tsc": "tsc --watch",
  4.     "start": "pm2 start src/index.js --watch src"
  5.   },

现在我们在根目录下运行

  1. ava

到现在，我们的 Model 已经基本建立完成了，接下来我们进入业务编写环节。