coderweij / nodepro

node写的通用API

一、项目的初始化

1. npm初始化

npm init -y

生成package.json文件：

• 记录项目的依赖

2. git初始化

git init

生成.git隐藏文件夹，git的本地仓库

3. 创建README.md文件

二、搭建项目

1. 安装koa框架

npm install koa

2. 创建应用

// src/app.js
const Koa = require('koa');

const app = new Koa();

// 中间件
app.use((ctx, next) => {
  ctx.body = 'Hello API';
});
app.listen(3000, ()=>{
  console.log('服务器启动，监听3000...')
})

3. 启动应用

node ./src/app.js

三、项目的基本优化

1. 自动重启服务

安装nodemon

npm install nodemon

编写package.json脚本

"scripts": {
  "dev": "nodemon ./src/app.js"
},

2. 读取配置文件

安装dotenv,读取根目录中的.env文件，将配置写在process.env中

npm i dotenv

创建.env

APP_PORT = 8000

创建src/config/config.default.js

const dotenv = require('dotenv');
// 读取.env内容
dotenv.config();
module.exports = process.env;

app.js文件使用配置项

const {APP_PORT} = require('./config/config.default.js');

四、添加路由

根据不同的URL，调用对应处理函数

1. 安装koa-router

npm i koa-router

步骤：

1. 导入包
2. 实例化对象
3. 编写路由
4. 注册中间件

const Koa = require('koa');
const Router = require('koa-router');
const {
  APP_PORT
} = require('./config/config.default.js');
// 实例化对象
const app = new Koa();
const router = new Router();

// 路由匹配
// GET请求
router.get('/', (ctx, next) => {
  ctx.body = '首页';
});
router.get('/hello', (ctx, next) => {
  ctx.body = 'hello页面';
});

// 中间件
app
  .use(router.routes())
  .use(router.allowedMethods());
  
app.listen(APP_PORT, () => {
  console.log(`服务器启动，监听${APP_PORT}...`)
})

五、目录结构优化

1. 将http服务和app业务拆分

创建src/app/index.js

const Koa = require('koa');
const userRouter = require('../router/user.route.js');

const app = new Koa();

// 中间件
app
  .use(userRouter.routes())
  .use(userRouter.allowedMethods());

module.exports = app;

改写app.js

const app = require('./app/index.js');
const {
  APP_PORT
} = require('./config/config.default.js');

app.listen(APP_PORT, () => {
  console.log(`服务器启动，监听${APP_PORT}...`)
});

2. 将路由和控制器拆分

路由：解析URL，分发给控制器对应的方法 控制器：处理不同的业务

改写user.route.js

const Router = require('koa-router');
const {
  register, login
} = require('../controller/user.controller.js');

const userRouter = new Router({
  prefix: '/users'
});
// 注册接口
userRouter.post('/register', register);
// 登录接口
userRouter.get('/login', login);

module.exports = userRouter;

创建src/controller/user.controller.js

class UserController {
  async register(ctx, next) {
    ctx.body = "注册接口";
  }

  async login(ctx, next) {
    ctx.body = '登录接口';
  }
}
module.exports = new UserController();

六、解析body

1. 安装koa-body

2. 注册中间件

改写app/index.js

3. 解析请求

改写controller/user.controller.js

const { createUser } = require('../service/user.service.js');
class UserController {
  async register(ctx, next) {
    // 1. 提取数据
    let { user_name, password } = ctx.request.body;
    // 2. 操作数据库
    await createUser(user_name, password);
    // 3. 返回结果
    ctx.body = ctx.request.body;
  }

  async login(ctx, next) {
    ctx.body = '登录接口';
  }
}

module.exports = new UserController();

4. 拆分service层

service层主要做一个数据库处理 创建service/user.service.js

class UserService {
    async createUser(user_name, password) {
        todo: 写入数据库
    }
}

module.exports = new UserService();

七、操作数据库

sequelize ORM数据库工具 ORM: 对象关系映射

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

1. 安装sequelize

npm i --save sequelize mysql2

2. 创建数据库连接对象

创建db/sequelize.js

const { Sequelize } = require('sequelize');
const {
    MYSQL_DB,
    MYSQL_PORT,
    MYSQL_USER,
    MYSQL_PASSWORD,
    MYSQL_HOST
} = require('../config/config.default.js');
// 分别传递参数 (其它数据库)
const sequelize = new Sequelize(MYSQL_DB, MYSQL_USER, MYSQL_PASSWORD, {
    host: MYSQL_HOST,
    port: MYSQL_PORT,
    dialect: 'mysql' /* 选择 'mysql' | 'mariadb' | 'postgres' | 'mssql' 其一 */
});
module.exports = sequelize;
// 测试数据库连接
// sequelize.authenticate().then(res => {
//     console.log('数据表连接成功！');
// }).catch(err => {
//     console.log("数据表连接失败：", err);
// })

八、创建User模型

1. 拆分model层

sequelize主要通过model对应数据表 创建src/model/user.model.js

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

const User = sequelize.define('zd_user', {
    // 在这里定义模型属性
    user_name: {
        // id不用自己创建，sequelize会自动创建并管理
        type: DataTypes.STRING,
        allowNull: false,
        unique: true,
        comment: '用户名，唯一'
    },
    password: {
        type: DataTypes.CHAR(64),
        allowNull: false,
        // allowNull 默认为 true
        comment: '密码',
    },
    is_admin: {
        type: DataTypes.BOOLEAN, // 相当于 TINYINT(1)
        allowNull: false,
        defaultValue: 0,
        comment: '0 普通用户; 1 管理员'
    }
}, {
    // 这是其他模型参数
    // tableName: 'zd_user', // 直接给出表名
    freezeTableName: true, // 表明推断，将模型名称强制推断为表名：zd_user -> zd_user；不加就是zd_user -> zd_users  
});
User.sync({ force: true }) // 强制同步数据库(将创建表,如果表已经存在,则将其首先删除)
module.exports = User;
// `sequelize.define` 会返回模型
// console.log(User === sequelize.models.User); // true

九、添加用户入库

1. 修改service层

实现service/user.service.js具体功能

const User = require('../model/user.model.js')
class UserService {
    async createUser(user_name, password) {
        // 添加user表的记录
        const res = await User.create({
            user_name,
            password
        });
        return res;
    }

    async getUserInfo({ id, user_name, password, is_admin }) {
        const whereObj = {};
        // 查询条件
        id && Object.assign(whereObj, { id });
        user_name && Object.assign(whereObj, { user_name });
        password && Object.assign(whereObj, { password });
        is_admin && Object.assign(whereObj, { is_admin });

        // 查询
        const res = await User.findOne({
            attributes: ['id', 'user_name', 'password', 'is_admin'], // 查询字段名
            where: whereObj, // 查询条件
        });
        console.log("select结果：", res);
        return res ? res.dataValues : null;
    }
}

module.exports = new UserService();

2. 修改model层

修改model/user.model.js的register方法

  async register(ctx, next) {
    // 1. 提取数据
    let { user_name, password } = ctx.request.body;
    // 2. 操作数据库
    // 返回信息
    if (!user_name || !password) { // 用户名或密码为空的情况
      console.error('用户名或密码为空', ctx.request.body);
      ctx.status = 400; // 返回400状态码
      ctx.body = {
        code: '10001',
        message: '用户名或密码为空',
        result: ''
      }
      return; // 直接返回
    } else if (await getUserInfo({ user_name })) { // 数据库查询，用户名已被注册
      console.log('打印这里：', getUserInfo({ user_name }));
      ctx.status = 409; // 资源冲突
      ctx.body = {
        code: '10002',
        message: '用户名已存在',
        result: ''
      }
      return;
    } else {
      let res = await createUser(user_name, password);
      ctx.body = {
        code: '10000',
        message: '注册成功！',
        result: res
      }
    }
  }

十，错误处理

写在九里面了

十一、拆分中间件

十二、密码加密

1. 下载bcryptjs

npm i bcryptjs

2. 注册中间件

修改middleware/user.middleware.js

async function bcryptPassword(ctx, next) {
    const { password } = ctx.request.body;
    const salt = bcrypt.genSaltSync(10); // 加密
    // hash为密文
    const hash = bcrypt.hashSync(password, salt);
    ctx.request.body.password = hash;
    await next();
}

十三、登录验证

1. 添加中间件

async function verifyLogin(ctx, next) {
    const { user_name, password } = ctx.request.body;
    try {
        console.log(user_name);
        const res = await getUserInfo({ user_name });

        console.log('匹配结果', res);
        // 1. 查询用户名是否存在数据库
        if (!res) {
            console.error('用户名不存在！', { user_name });
            ctx.app.emit('error', userNotExist, ctx);
            return;
        }
        // 2. 密码匹配
        if (!bcrypt.compareSync(password, res.password)) {
            console.error('密码错误');
            ctx.app.emit('error', invaildPassword, ctx);
            return;
        }
        await next();
    } catch (err) {
        console.error('用户登录失败！', err);
        ctx.app.emit('error', userLoginError, ctx);
    }
}

十四、颁发token

登录成功后，给用户颁发一个令牌token，用户在以后的每一次请求中携带这个令牌。 jwt: jsonwebtoken

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

1. 安装jsonwebtoken

npm i jsonwebtoken

十五、用户认证

1. token验证

新增middleware/auth.middleware.js

const jwt = require('jsonwebtoken');
const {
  JWT_SECRET
} = require('../config/config.default.js');
const {
  TokenExpiredError,
  invaildToken
} = require('../constant/err.type.js');
// token验证
async function auth(ctx, next) {
  const {
    authorization
  } = ctx.request.header;
  const token = authorization.replace('Bearer ', ''); // 获取token
  console.log('解析出的token: ', token);
  try {
    //user中包含了payload的信息(id, user_name, is_admin)
    const user = jwt.verify(token, JWT_SECRET);
    console.log("user: ", user);
    ctx.state.user = user;
  } catch (err) {
    switch (err.name) {
      case 'TokenExpiredError':
        console.error('token已过期', err);
        return ctx.app.emit('error', TokenExpiredError, ctx);

      case 'JsonWebTokenError':
        console.error('无效的token', err);
        return ctx.app.emit('error', invaildToken, ctx);
    }
  }
  await next();
}

module.exports = {
  auth
};

十六、修改密码

1. 添加路由

router/user.route.js

userRouter.patch('/', auth, bcryptPassword, changePassword);

十七、路由动态加载

1. 新增index.js

新建router/index.js，管理所有路由，对外暴露一个路由

const fs = require('fs');
const Router = require('koa-router');

const router = new Router();

fs.readdirSync(__dirname).forEach(file => {
  if (file !== 'index.js') {
    let r = require('./' + file);
    router.use(r.routes())
  }
});
module.exports = router;

2. 修改src/app/index.js

const router = require('../router/index.js');

十八、管理员权限验证

1. 添加中间件

auth.middleware.js新增验证功能

// 判断用户是否有管理员权限
async function hadAdminPermission(ctx, next) {
  const {
    is_admin
  } = ctx.state.user;

  if (!is_admin) {
    console.error('该用户没有管理员权限', ctx.state.user);
    return ctx.app.emit('error', hasNotAdminPermission, ctx);
  }
  await next();
}

2. 修改`goods.route.js``

router.post('/upload', auth, hadAdminPermission, upload);

十九、图片上传(类型判断)

1. 添加koa-body参数

修改app/index.js

KoaBody({
    multipart: true, // 支持多文件上传
    formidable: {
      // 在配置选项里，不推荐使用相对路径
      // 在Options里的相对路径，不是相对当前文件的路径，而是相对process.cwd() => 执行脚本的路径
      uploadDir: path.join(__dirname, '../uploads'), // 上传路径
      keepExtensions: true, // 保留扩展名
    }
  })

2. 文件类型判断

src/controller/goods.controller.js

async upload(ctx, next) {
    // 上传的文件会保留在 ctx.request.files
    const {
      file
    } = ctx.request.files
    if (file) {
      const fileTypes = ['image/png', 'image/jpeg'];
      if (!fileTypes.includes(file.type)) {
        ctx.body = unSupportedFileType;
        return ctx.app.emit('error', unSupportedFileType, ctx);
      }
      // console.log('file类型：', file.type);
      ctx.body = {
        code: '0',
        message: '图片上传成功！',
        result: {
          goods_img: path.basename(file.path)
        }
      };
    } else {
      ctx.body = fileUploadError;
      return ctx.app.emit('error', fileUploadError, ctx);
    }
  }

3. 待完善功能

尽管增加了类型判断，但即使返回文件上传失败的信息，文件还是会被上传到服务器 后面可以加个中间件，提示：formidable。但是formidable是在koa-body参数里，目前不知道怎么做

二十、商品参数校验

二十一、商品入库功能

二十二、商品信息修改功能

二十三、商品删除功能

二十四、商品下架功能

二十五、获取商品列表

二十六、加入购物车模块

1. 新增model/cart.model.js

2. 新增controller/cart.controller.js

3. 新增router/car.route.js

4. 接口细节

• 验证user_id
  • 验证goods_id，如果不存在，则创建一条记录；如果存在，则购物车表的记录，更新数量+1
• 判断用户和商品是否存在

二十七、获取购物车列表数据

1. 新增Cart表和Good表的关联

2. 新增查询方法

修改service/cart.service.js

// 获取购物车列表数据 分页查询
    async findCarts(pageNum, pageSize) {
        const offset = (pageNum - 1) * pageSize;
        const { count, rows } = await Cart.findAndCountAll({
            attributes: ['id', 'number', 'selected'],
            offset,
            limit: pageSize * 1,
            include: {
                attributes: ['id', 'goods_name', 'goods_price', 'goods_img'],
                model: Goods,
                as: 'goods_info'
            }
        });
        return {
            pageNum,
            pageSize,
            total: count,
            list: rows
        }
    }

二十八、更新购物车

1. 更改`/middlerware/cart.middlerware.js``

// 使用闭包
function validator(rules) { // ctx, next
    return async function (ctx, next) {
        try {
            ctx.verifyParams(rules);
        } catch (err) {
            console.error(err);
            cartFormatError.result = err;
            return ctx.app.emit('error', cartFormatError, ctx);
        }
        await next();
    }
}

2. router/cart.router.js新增更新购物车方法

// 更新购物车
router.patch('/:id', auth, validator({
    number: { type: 'number', required: false },
    selected: { type: 'bool', required: false }
}), update);

二十九、删除购物车

三十、全选与取消全选

三十一、统计购物车数量

三十二、添加地址

三十三、 获取地址列表

三十四、更新地址

三十五、删除地址和设置默认地址

三十七、获取订单列表

三十八、更新订单状态