- nodejs： assert 断言 | Node.js API 文档 (nodejs.cn)
- koa：Koa (koajs) -- 基于 Node.js 平台的下一代 web 开发框架 | Koajs 中文文档 (bootcss.com)
- 数据库对象映射：入门 | Sequelize 中文文档 | Sequelize 中文网
- 加密：bcryptjs - npm (npmjs.com)
- 颁发token：jsonwebtoken - npm (npmjs.com)
- 参数校验：koa-parameter - npm (npmjs.com)
在my-node-template/.env配置文件中修改服务运行的端口
#服务端口
APP_PORT = 8001
#mysql的主机
MYSQL_HOST = localhost
#mysql的端口
MYSQL_PORT = 3306
#mysql用户名
MYSQL_USER = root
#mysql用户密码
MYSQL_PWD = 123456
#mysql数据库
MYSQL_DB = test#进入到项目根路径，安装所需包
npm i
#运行项目
npm run dev
#浏览器访问：http://localhost:8001npm run dev
npm run prod
使用vscode，安装的插件列表
-
ESLint: 代码规范与错误提示(必须安装)
-
EditorConfig: 代码格式规范
-
Auto Close Tag: 输入开标签自动输入闭标签
-
Auto Rename Tag: 修改一侧标签时，自动修改另一侧标签
-
Bracket Pair Colorizer: 将括号设置为不同的颜色
-
GitLens -- Git supercharged: git工具，可以看到代码提交记录
-
Path Intellisense: 文件路径智能提示
-
Veter: 格式化vue文件
|-- my-node-template
|-- .env 存放一些环境配置
|-- .gitignore 提交git时使用的文件
|-- directoryList.md 生成的目录文件
|-- package-lock.json
|-- package.json
|-- readme.md
|-- src
|-- main.js 项目的入口文件
|-- app
| |-- index.js 业务入口
|-- config
| |-- config.base.js 读取配置
|-- constant
| |-- errorStatus.js 常量
|-- controller
| |-- user.contrller.js 处理请求
|-- db
| |-- seq.js 连接数据库
|-- disposeRequestMiddle 处理请求过程中的一些函数
| |-- user.middle.js
| |-- utils.middle.js
|-- model
| |-- user.model.js 模式（对应数据库中表）
|-- router 路由配置（根据不同的url进行不同的函数处理）
| |-- hello.route.js
| |-- index.js 将新添加的路由文件自动注册到router对象上
| |-- uploadfile.route.js
| |-- user.route.js
|-- service 操作数据库，供controller层调用
| |-- user.service.js
|-- upload 上传文件后存放的目录
|-- upload_134e4657e3ff4108e1aba69ad2e83c69.png#安装
npm i nodemon -dev--save
#编写packeage.json脚本
"script":{
"dev":"nodemon ./src/main.js"
}
#启动服务
npm run dev使用dotenv，读取根目录下的.env文件，将配置写道process.env中
#安装
npm i dotenv
#创建.env文件
APP_PORT= 8080 #设置服务端口
#创建src/config/config.base.js
const dotenv = require('dotenv')
dotenv.config()
module.exports = process.env
#main.js
const Koa = require('koa')
const {APP_PORT} = require('./config/config.base')
const app = new Koa()
app.listen(APP_PORT,()=>{
console.log(`服务地址：http://localhost:${APP_PORT}`)
})router/index.js文件会自动读取当前目录下的所有文件，然后进行挂载到router对象上
const fs = require('fs')
const Router = require('koa-router')
const router = new Router()
fs.readdirSync(__dirname).forEach(file => {
if (file !== 'index.js') {
// 导入当前目录下的所有路由文件，注册到router对象中
let r = require('./' + file) //每个文件导入后都会得到一个router对象
router.use(r.routes()) //router也可以注册中间件的
}
})
module.exports = router只需要在/src/router中加入一个xxx.router.js配置文件并导出router就可以
#创建src/app/index.js
const Koa = require('koa')
const router = require('../router/index')
const app = new Koa()
app.use(router.routes())
module.exports = app
#main.js
const app = require('./app')
app.listen(APP_PORT,()=>{
console.log(`服务地址：http://localhost:${APP_PORT}`)
})#安装
npm i koa-body
#注册中间件
const KoaBody = require('koa-body')
app.use(KoaBody()) #这里注意，在所有注册中间件之前调用这个
#使用ctx.request.body获取post的提交请求数据
ctx.request.body koa-body可以支持上传文件，通过配置可以打开上传文件
配置如下：
app.use(KoaBody({
multipart: true,
formidable: {
keepExtensions: true,
//这里有一个小注意点，如果写相对路径的话，是相对于cwd()这个目录的
uploadDir: path.join(__dirname, '../upload')
},
// 以下的请求的请求体会放到ctx.request.body 上，默认只有前三个请求方式会，这里添加一个delete的请求
parsedMethods: ['POST', 'PUT', 'PATCH', 'DELETE']
}))请求的处理:通过ctx.request.files就可以获取到文件对象
router.post('/upload', (ctx, next) => {
//files后面的file是定义的key值
//这里拿到了上传文件的路径
//path.basename(ctx.request.files.file.path)可以拿到上传后的文件名（不带路径的）
console.log(ctx.request.files.file.path)
ctx.body = ctx.request
})详细使用参考koa-body使用文档
controller层用来将路由对应的处理函数实现部分拆分出去。
service主要用来操作数据库相关的操作（通过model模型对象进行操作）
案例： 注册用户
user.router.js
const Router = require('koa-router')
const { register } = require('../controller/user.contrller')
const router = new Router()
router.post('/register', register)
module.exports = router controller/user.controller.js
const { createUser } = require('../service/user.service')
class UserController {
async register(ctx, next) {
//获取请求数据体
const { user_name, password } = ctx.request.body
//调用service操作数据库
try {
let res = await createUser(user_name, password)
//返回结果
ctx.body = {
code: 200,
message: 'register success',
result: {
id: res.id,
user_name: res.user_name
}
}
} catch (err) {
console.err(err)
}
}
}
module.exports = new UserControllerservice/user.service.js
const User = require('../model/user.model')
class UserService {
async createUser(user_name, password) {
//通过User对象插入数据，
const res = await User.create({ user_name, password })
return res.dataValues
}
}
module.exports = new UserService()model模型对象（通过这个对象即可以创建表，可以操作增删改查等操作）
src/disposeRequestMiddle/user.middle.js
const {userFormatError} = require('../constant/errorStatus')
const userValidator = (ctx,next)=>{
const {user_name,password} = ctx.request.body
if(!user_name||!password){
console.error('用户名或密码为空',ctx.request.body)
ctx.app.emit('error',userFormatError,ctx)
await next()
}
}
module.exports = {
userValidator,
}const Router = require('koa-router')
const { register } = require('../controller/user.contrller')
const {userValidator} = '../disposeRequestMiddle/user.middle.js'
const router = new Router()
// 为了使代码逻辑更加清晰，这里可以拆分一个中间件层，封装多个中间件函数
// 这些函数如： 参数校验（参数是否合法），是否是登录状态等等
//router.post('/register', register)
//先执行自定义的中间层参数校验函数，然后再去执行register处理请求，可以有多个中间层处理函数。
router.post('/register',userValidator,register)
module.exports = router - 安装sequelize 和数据库驱动mysql2
npm install sequelize
npm install mysql2 - 创建seq对象进行连接数据库
const {Sequelize} = require('sequelize')
const {
MYSQL_HOST,
MYSQL_PORT,
MYSQL_USER,
MYSQL_PWD,
MYSQL_DB
} = require('../config/config.base')
const seq = new Sequelize(MYSQL_DB, MYSQL_USER, MYSQL_PWD, {
host: MYSQL_HOST,
dialect: 'mysql'
})
#const seq = new Sequelize(数据库名称，用户名，用户密码，{
# host: 主机，
# dialect: 'mysql'
#})
#测试数据库是否可以连接
seq.authenticate()
.then(() => {
console.log('connected success!!!')
}).catch((err) => {
console.log('connected failed', err)
})
module.exports = seq- 通过seq对象创建模型
#例如，创建一个用户表
const { DataTypes } = require('sequelize')
const seq = require('../db/seq')
//通过define定义一个模型，定义模型后可以通过这个模型进行增删改查操作
const User = seq.define('test_user', {
user_name: {
type: DataTypes.STRING,
allowNull: false,
unique: true,
comment: '用户名',
},
password: {
type: DataTypes.CHAR(64),
allowNull: false,
comment: '密码',
},
})
//如果表不存在，则创建该表（如果已经存在，则不执行任何操作）
User.sync()
module.exports = User-
通过创建的模型对象User可以进行增删改查
如5.6中service层对数据库的操作
通过ctx.app.emit触发提交错误，app中监听app.on事件.两者传递参数约定好。
constant/errorStatus.js
这个文件的错误码和错误描述是前后端约定好的
module.exports = {
userFormatError:{
code: '错误码',
message: '错误的描述',
result: '',
}
}user.controller.js
console.err('用户名为空',ctx.request.body)
ctx.app.emit('error',userFormatError,ctx)app/index.js
const errHandler = require('./errHandler')
// 统一的错误处理
app.on('error',errHandler)errHandler.js
这个函数的意义是根据规定的code码，返回给前端具体的错误status
module.exports =(err,ctx)=> {
let status = ''//给一个默认的
switch(err.code){
case '':
status = ''
break
default:
status = ''
}
ctx.status = status
ctx.body = err
}ctx.body = {
code: numberValue,
message: '返回的描述信息',
result:{
返回的值
}
}npm install bcryptjs
const bcrypt = require('bcryptjs')
const bcryptPassword = async (ctx,next)=>{
const {password} = ctx.request.body
//hash就是加密后的password
const salt = bcrypt.genSaltSync(10)
const hash = bcrypt.hashSync(password,salt)
await next()
}用户登录后验证密码是否正确
const verityLogin = async(ctx,next)=>{
const {user_name,password} = ctx.request.body
try{
//调用service层中的方法，根据用户名获取用户信息
const res = await getUserInfo({user_name})
if(!res){
console.error('用户名不存在',{user_name})
return
}
//密码是否匹配，不匹配的话就报错了，匹配的话继续往下执行
if(bcrypt.compareSync(password,res.password)){
return
}
}catch(err){
console.log('用户名或密码不正确')
return
}
await next()
}登录之后要进行登录状态的记录，通过token进行登录状态的记录