# Node通用商城接口 **Repository Path**: zjp_giteeHome/node-general-mall-interface ## Basic Information - **Project Name**: Node通用商城接口 - **Description**: 第一次用Node写的通用商城API - **Primary Language**: JavaScript - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2022-04-28 - **Last Updated**: 2022-10-29 ## Categories & Tags **Categories**: Uncategorized **Tags**: Nodejs, JavaScript, ES6, npm ## README # npm 初始化 npm init -y 生成package.json文件 # git 初始化 git init .git隐藏文件夹 git 本地仓库 git add . 将当前目录全部添加到仓库 # 提交项目 git commit -m '1-项目初始化' # 显示项目版本 git log --pretty=oneline # 推送至git仓库 git remote add origin git@github.com:michaelliao/learngit.git git push -f origin # 安装koa框架 npm install koa # 编写最基本的app // 项目入口文件 const Koa = require('koa') // 创建app实例 const app = new Koa() // 创建中间件 app.use((context, next) => { context.body = 'hello api' }) app.listen(3000, () => { console.log("server is running in http://localhost:3000"); }) node main.js 启动应用 # 安装Nodemon 自动重启服务 npm i nodemon "scripts": { "dev": "nodemon ./src/main.js", "test": "echo \"Error: no test specified\" && exit 1" }, # 读取配置文件 安装dotenv 在主目录创建.env 设置APP_PORT=8000 在src文件下设置config文件下的config_default.js文件 设置端口配置 # 添加路由 安装koa-router npm install koa-router 步骤: 1.导入包 2.编写路由 创建src/router文件夹 编写user.route.js 3.写入中间件 app.use(UserRouter) # 优化路由 创建controller文件夹在user.controller.js下编写用户业务 在user.route.js中注册用户登录和用户注册接口 # 解析body 1.安装koa-body 导入模块 const 2.使用中间件 app.use(KoaBody) 3.在user.controller.js中解析数据 # 拆分service 创建service/user.service.js 编写用户操作数据库逻辑 # 安装sequenlize npm i mysql2 sequenlize 创建db/seq.js 操作数据库 在.env文件下编写配置文件 # 创建User模型 新建model/user.model.js文件 1.导入模块,创建数据模型 2.指定模型同步,导出User数据模型 # 添加用户 使用User.create方法使用户数据持久化 所有数据库的操作都在 Service 层完成, Service 调用 Model 完成数据库操作 改写src/service/user.service.js将用户模型的数据添加至数据库 改写user.controller.js文件将数据成功的结果返回 # 错误处理 在控制器中, 对不同的错误进行处理, 返回不同的提示错误提示, 提高代码质量 校验用户已存在和用户密码不存在的情况,通过中间件流程控制后校验 # 拆分中间件 将错误返回请求作为常量存至consitant/err_type.js文件中 将错误处理函数存至app/errhandler.js文件中通过校验码code获得状态码 # 统一错误处理 在出错的地方使用ctx.app.emit提交错误 在app中通过app.on监听 # 使用trycatch优化错误处理 调用service层的时候会返回一个Promise对象,需要用async和await表达式对Promise对象进行解析,使用trycatch流程控制 在service层数据未被接收到时可以及时响应错误 在user_controller.js中创建数据字段时添加错误处理 在user_validate.js中添加错误处理 # 用户加密 npm i bcryptjs 安装bcryptjs 构建密码加密中间件 cryptPassword # 密码验证 创建verifylogin中间件进行密码校验 使用getUserInfo方法通过user_name查询数据库判断用户是否存在,如果错误就发送错误请求到错误处理函数 通过bcrypt.compareSync(password, res.password)判断密码是否匹配,如果错误就发送错误请求到错误处理函数 # 颁发token 安装jsonwebtoken npm i jsonwebtoken 在用户登录请求函数中通过请求的user_name向数据库发起请求获得除了密码的信息 将得到的信息作为校验信息并在.env下创建密钥,设置过期时间通过jwt.sign的结果作为token返回给用户 # 用户认证 创建auth中间件 使用auth函数处理请求获得的token,将token使用verify方法解码后添加到ctx.state.user中 添加错误处理,将token过期和token无效的错误处理信息添加到error_type中 在user.router.js文件中添加router.patch方法添加修改密码接口 在postman中添加token全局变量 在用户登录测试接口的Tests中 pm.test("Successful POST request", function () { // 响应结果转换格式 const res=pm.response.json() // 设置token变量 pm.collectionVariables.set('token',res.result.token); }); 使用户登录接口的token自动变为全局变量 # 修改密码接口 在修改密码接口中增加密码加密中间件cryptPassword,在user.controller.js文件中添加changePassword回调函数 在changePassword中通过service层的updateById方法操作数据库中的字段 通过更新数据库操作返回的值判断是否成功更改密码,返回成功或返回的值到ctx.body中 # 创建上传商品接口 新建router/goods.route.js文件并以post请求创建上传商品接口 新建controller/goods.controller.js文件创建upload回调函数 # 路由自动加载 在router中新建index.js文件通过fs.readdirSync同步读取当前路径下的所有文件实现自动加载 # 管理员权限校验 对上传图片接口使用auth中间件进行Token校验和管理员校验 创建hasNoAdminExist中间件校验数据库中is_admin字段是否为1发起错误处理函数 # 完成上传图片接口 在app/index.js中完成对上传图片的配置 使用path模块指定上传的路径 安装koa-static并应用到app中 在controller/goods.controoler中通过判断ctx.request.files.file是否存在返回成功结果失败则触发错误处理函数 判断文件类型,如果错误则触发错误函数 # 发布商品接口 创建发布商品接口并进行token用户登录和管理员权限校验 安装koa-parameter并在app中引用 创建参数校验中间件并设置方法 设置指定校验参数,使用trycatch进行错误处理,如果校验失败则触发错误函数 创建发布商品回调函数PubGoods,创建商品Service层并创建createGoods发布商品方法 创建数据库模型并指定字段和字段类型 如果数据库创建失败或商品信息获取失败则触发错误函数 成功则返回正确信息和商品信息 # 修改商品接口 创建修改商品接口,在url路径传入id,进行token用户登录校验和管理员权限校验 创建修改商品回调UpdateGoods,等待Service层更新数据库 Service层更新数据库方法updategoods接受id和商品信息参数,使用数据库模型的update方法更新数据库,返回更改结果 根据更改数据库返回结果判断是否成功更改数据库，返回成功结果或失败的错误回调 # 硬删除商品接口 创建put删除商品接口,url路径传入id,根据id在service层使用destoy方法删除商品 成功则返回正确结果，商品id不存在则返回失败结果 # 修改商品硬删除接口为下架商品接口,商品上架接口 将put请求改为post请求,在Goods数据模型中添加字段paranoid: true,实现数据软删除(数据库中添加字段DeleteAt) 若destory方法成功则deleteAt字段设置为删除时间,失败则返回失败回调 创建restore接口并在回调中等待数据模型发送restore上架请求，清除deleteAt字段 # 获取商品列表接口 创建商品列表路由并创建回调,在回调中等待service层操作数据库成功后返回成功信息 在Service层设置offset偏移量和limit字段并使用count和findAll方法或findAndCountAll方法根据offset和limit字段获得商品信息并返回 # 添加购物车列表接口 创建路由、控制器、参数校验中间件 参数校验商品id是否为number 创建购物车数据模型指定字段goods_id,user_id,num,selected并指定类型,与数据库进行同步 在控制器中查询数据库的goods_id和user_id字段是否存在，若存在则将Num值自增加1并重新载入数据库 否则创建一条字段返回 # 获取购物车列表接口 在购物车数据模型中与商品模型使用belongsTo制造关联，外键为goods_id, 创建路由并用auth中间件确认Token,在service层使用findAndCountAll获得购物车的总数、购物车商品信息 将成功和商品信息返回 # 更新购物车接口 改写购物车参数校验中间件validator,使用闭包传入一个rule使外部调用时可自定义校验参数 在控制器判断num和selected参数是否均未传，否则触发数据格式错误 在service层使用findByPk方法找到购物车数据表指定字段,如果找不到则返回空值 如果num未传或selected未传则只更新一个字段并存至数据库 # 删除购物车接口 在koabody中间件中设置参数 parsedMethods: ['POST', 'PUT', 'PATCH', 'DELETE', 'GET']指定请求类型使ctx.request.body可以解析delete请求 创建Delete请求类型的接口并设置登录校验和参数校验,在控制器中等待Service层完成后发送成功信息 在Service层根据传来的数组使用[Op.in]使商品ID符合数组内任何数字的字段删除 # 购物车全选和全不选接口 创建两个post请求分别使用auth中间件Token校验,在控制器中解析出用户id并传入service层 service层操作数据库根据用户id将符合的字段中selected全部为true或false # 添加地址接口完成 创建post请求并进行登录校验和指定参数校验 在控制器解析出请求的参数传入service层 创建address数据模型并同步数据库 在service层向数据模型发起create请求将数据添加到数据库并将结果返回 控制器返回成功信息 # 修改地址接口完成 创建put请求并进行登录校验和指定参数校验 在控制器解析请求并把地址id和更改的地址信息传入service层 在sevice层调用update方法根据地址id更改地址信息并将结果返回 # 修改默认地址接口和删除地址接口完成 沿用MVC思想使用user_id和地址id对数据表进行更新 # 创建订单接口完成 沿用MVC思想创建数据模型、Service和控制器controller传入address_id、goods_info和total三个参数并解析到user_id 在数据模型指定参数并数据同步 service层使用create方法创建数据字段 # 获取订单列表接口完成 由于和前面相似，不予笔记 # 更新订单接口完成