node常用依赖

1. koa

npm install koa

2. nodemon

自动重启

npm install nodemon

配置 package.json

  "scripts": {
    "dev": "nodemon ./src/main.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  }

3. dotenv

读取变量

npm install dotenv

创建 根目录/.env 文件写入

PORT = 9999

DB_HOST = localhost
DB_PORT = 3306
DB_DATABASE = quinhua
DB_USERNAME = root
DB_PASSWORD = 1234

访问

const dotenv = require("dotenv");

dotenv.config();

// console.log(process.env.PORT);

module.exports = process.env;

4. koa-router

路由

npm install koa-router

使用

const Router = require('koa-router')

const router = new Router({ prefix: '/users' })

// GET /users/
router.get('/', (ctx, next) => {
  ctx.body = 'hello users'
})

module.exports = router

5. module-alias

为路径设置别名

npm install module-alias

[注意]根目录下一级目录可以使用别名,二级可能访问不了,我遇到了

配置 package.json,与 scripts 同级

  "_moduleAliases": {
    //别名:文件夹
    "@": "src",
    "@config":"src/config"
  }

项目中使用

require('module-alias/register')//放置于主文件中所有代码前
const app = require("@/app");//使用别名y

6. koa-body

解析 http 中 body 部分,包括 json、表单、文本、文件,支持上传

npm install koa-body

[注意]将 koa-body 注册在所有路由注册之前，例如

const Koa = require("Koa")
const { koaBody } = require("koa-body")

const userRouter = require("@/router/user.route")
const app = new Koa()

app.use(koaBody())

app.use(userRouter.routes())

koa-body 返回的是一个promise对象,需要用 await 接受

7.sequlize

[sequlize官网](Sequelize 简介 | Sequelize 中文文档 | Sequelize 中文网)

sequelize ORM 数据库工具

ORM： 对象关系映射

• 数据表映射(对应)一个类
• 数据表中的数据行(记录)对应一个对象
• 数据表字段对应对象的属性
• 数据表的操作对应对象的方法

安装 sequlize以及 mysql2

npm install sequelize mysql2

连接数据库

//seq.js
const { Sequelize } = require('sequelize')

const seq = new Sequelize("database_name", "username", "password", {
    host: "localhost",
    dialect: "mysql",
    timezone: '+08:00'
});

//测试连接node seq.js
// seq.authenticate().then(() => {
//     console.log('数据库连接成功')
// }).catch((err) => {
//     console.log('数据库连接失败', err)
// })

module.exports = seq

//model.js
const { DataTypes } = require('sequelize')
const seq = require("../db/seq");

const User = seq.define('User', {
    uuid: {
        type: DataTypes.UUID,
        defaultValue: DataTypes.UUIDV4
    },
    username: {
        type: DataTypes.STRING,
        allowNull: false,
        unique: true,
        comment: "用户名,唯一"
    },
    password: {
        type: DataTypes.CHAR(64),
        allowNull: false,
        comment: "密码"
    },
    is_admin: {
        type: DataTypes.BOOLEAN,
        allowNull: false,
        defaultValue: 0,
        comment: "是否为管理员,默认值不是管理员,1是0不是"
    }
});

//取消注释并执行node model.js创建数据库
// User.sync({ force: true })

module.exports = User

8.bcryptjs

数据加密：在将密码保存到数据库之前, 要对密码进行加密处理

加盐加密

npm install bcryptjs

//bcrypt.js
const bcrypt = require('bcryptjs')

const hashSync = (data) => {
    const salt=bcrypt.genSaltSync(10)
    const result=bcrypt.hashSync(data, salt);
    return result
};

const compare = (data, hashdata) => {
    const result = bcrypt.compareSync(data, hashdata)
    return result
}

module.exports = {
    hashSync,
    compare
}

使用

const { hashSync } = require("./bcrypt")

const userVerifyHashSync = async (ctx, next) => {
    const { password } = ctx.request.body
    ctx.request.body.password = hashSync(password)
    await next()
}

9.jsonwebtoken

颁发token令牌 , 在后续请求中携带令牌

jwt：jsonwebtoken

• header: 头部
• payload: 载荷
• signature: 签名

npm install jsonwebtoken

创建 src/utils/util/jwt.js

const jwt = require('jsonwebtoken');

const tokenCarry = (data) => {
    const result = jwt.sign(data, "secret",{ expiresIn: "1d" })
    return result
}

module.exports = {
    tokenCarry
}

src/controller/user.controller.js 使用

//z   
async login(ctx, next) {
        const { username, password } = ctx.request.body
        try {
            // 从返回结果对象中剔除password属性
            const { password, ...res } = await getUserInfo({ username })

            ctx.body = {
                code: 0,
                message: '用户登录成功',
                result: {
                    token: tokenCarry(res),
                },
            }
        } catch (err) {
            console.error('用户登录失败', err)
        }
    }

9.koa-static

提供静态资源访问

npm install koa-static

const KoaStatic = require("koa-static")
app.use(KoaStatic(path.join(__dirname, '../upload')))
const fs = require("fs")

const { file } = ctx.request.files
const reader = fs.createReadStream(file.filepath);
const upStream = fs.createWriteStream(`src/upload/${file.newFilename}`);
reader.pipe(upStream);

 const basename = path.basename(file.filepath)
        ctx.body = {
            code: 200,
            message: "上传成功",
            result: {
                oldFilename: file.originalFilename,
                newFilename: file.newFilename,
                visiturl: `${ctx.origin}/${basename}`
            }
        }

10.@koa/cors和cors

解决跨域

npm install @koa/cors
npm install cors

const cors = require('@koa/cors');
app.use(cors())

11.uuid

唯一识别码

npm install uuid

const { v4: uuidv4 } = require('uuid');
uuidv4(); // ⇨ '1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed'