Headline
大事件后台 API 项目,API 接口文档请参考 https://www.showdoc.cc/escook?page_id=3707158761215217
1. 初始化
1.1 创建项目
- 新建
api_server
文件夹作为项目根目录,并在项目根目录中运行如下的命令,初始化包管理配置文件:
npm init -y //安装了package.json文件
- 运行如下的命令,安装特定版本的
express
:
npm i express@4.17.1 //安装了node_modules文件夹和package-lock.json文件
- 在项目根目录中新建
app.js
作为整个项目的入口文件,并初始化如下的代码:
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// write your code here...
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(3007, function () {
console.log('api server running at http://127.0.0.1:3007')
})
1.2 配置 cors 跨域
- 运行如下的命令,安装
cors
中间件:
npm i cors@2.8.5
- 在
app.js
中导入并配置cors
中间件:
// 导入 cors 中间件
const cors = require('cors')
// 将 cors 注册为全局中间件
app.use(cors())
1.3 配置解析表单数据的中间件
- 通过如下的代码,配置解析
application/x-www-form-urlencoded
格式的表单数据的中间件:
app.use(express.urlencoded({ extended: false }))
1.4 初始化路由相关的文件夹
-
在项目根目录中,新建
router
文件夹,用来存放所有的路由
模块路由模块中,只存放客户端的请求与处理函数之间的映射关系
-
在项目根目录中,新建
router_handler
文件夹,用来存放所有的路由处理函数模块
路由处理函数模块中,专门负责存放每个路由对应的处理函数
1.5 初始化用户路由模块
- 在
router
文件夹中,新建user.js
文件,作为用户的路由模块,并初始化代码如下:打开API接口文档中【登录注册】里的登录、注册,查看里面的请求URL地址
const express = require('express')
// 创建路由对象
const router = express.Router()
// 注册新用户
router.post('/reguser', (req, res) => {
res.send('reguser OK')
})
// 登录
router.post('/login', (req, res) => {
res.send('login OK')
})
// 将路由对象共享出去
module.exports = router
- 在
app.js
中,导入并使用用户路由模块
:加上统一访问前缀/api
// 导入并注册用户路由模块
const userRouter = require('./router/user')
app.use('/api', userRouter) //意思是:在访问userRouter这个路由模块时都要加上/api前缀
3.打开postman测试注册和登录这两个模块:post http://127.0.0.1/api/reguster
和post http://127.0.0.1/api/login
,服务器返回文本为:reguser OK
或login OK
就代表已经正常创建了路由模块
1.6 抽离用户路由模块中的处理函数
目的:为了保证
路由模块
的纯粹性,所有的路由处理函数
,必须抽离到对应的路由处理函数模块
中
- 在
/router_handler/user.js
中,使用exports
对象,分别向外共享如下两个路由处理函数
:
/**
* 在这里定义和用户相关的路由处理函数,供 /router/user.js 模块进行调用
*/
// 注册用户的处理函数
exports.regUser = (req, res) => {
res.send('reguser OK')
}
// 登录的处理函数
exports.login = (req, res) => {
res.send('login OK')
}
- 将
/router/user.js
中的代码修改为如下结构:
const express = require('express')
const router = express.Router()
// 导入用户路由处理函数模块
const userHandler = require('../router_handler/user')
// 注册新用户
router.post('/reguser', userHandler.regUser)
// 登录
router.post('/login', userHandler.login)
module.exports = router
2. 登录注册
2.1 新建 ev_users 表
-
在
my_db_01
数据库中,新建ev_users
表如下:a. 进入my_db_01数据库中的
tables
表中,右键create tables
b. [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7fKaUoQV-1622724424546)(C:\Users\HP\AppData\Roaming\Typora\typora-user-images\image-20210401212745424.png)]
2.2 安装并配置 mysql 模块
在 API 接口项目中,需要安装并配置
mysql
这个第三方模块,来连接和操作 MySQL 数据库
- 运行如下命令,安装
mysql
模块:
npm i mysql@2.18.1
- 在项目根目录中新建
/db/index.js
文件,在此自定义模块中创建数据库的连接对象:
// 导入 mysql 模块
const mysql = require('mysql')
// 创建数据库连接对象
const db = mysql.createPool({
host: '127.0.0.1',
user: 'root',
password: 'admin123',
database: 'my_db_01',
})
// 向外共享 db 数据库连接对象
module.exports = db
2.3 注册
2.3.0 实现步骤
- 检测表单数据是否合法
- 检测用户名是否被占用
- 对密码进行加密处理
- 插入新用户
2.3.1 检测表单数据是否合法
- 判断用户名和密码是否为空:打开
router_handler
中的user.js
文件中的注册用户的处理函数中
// 向外暴露:注册用户的处理函数
exports.regUser = (req, res) => {
// 1. 接收表单数据:获取客户端提交到服务器的用户信息 使用req.body这个属性拿到从客户端提交到服务器的数据,再用userinfo常量进行接收
const userinfo = req.body
// console.log(userinfo);
//使用postman测试:post:http://127.0.0.1:3007/api/reguser,再使用body向服务器传入两个属性(username:zs;password:1111)send后,VSCode终端就输出了用户信息
// 2. 判断数据是否合法:对表单中的数据进行合法性的校验
if (!userinfo.username || !userinfo.password) {
return res.send({ status: 1, message: '用户名或密码不能为空!' })
}
res.send('regyser OK')
}
2.3.2 检测用户名是否被占用
- 导入数据库操作模块:打开
router_handler
中的user.js
文件,在最上面导入
const db = require('../db/index')
- 定义 SQL 语句:
const sql = `select * from ev_users where username=?`
-
执行 SQL 语句并根据结果判断用户名是否被占用:
db.query(sql, [userinfo.username], function (err, results) { // 执行 SQL 语句失败 if (err) { return res.send({ status: 1, message: err.message }) } // 用户名被占用 if (results.length > 0) { return res.send({ status: 1, message: '用户名被占用,请更换其他用户名!' }) } // TODO: 用户名可用,继续后续流程... })
-
(1)在VSCode终端运行
PS C:\Users\HP\Desktop\项目\阶段四-大事件项目\api_server> nodemon .\app.js
(2)在数据库中新建数据[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-16cG2CM6-1622724424551)(C:\Users\HP\AppData\Roaming\Typora\typora-user-images\image-20210406101220153.png)],
(3)再在postman中进行测试
(4)用postman测试检测用户名是否重复时,总是弹出
Error: connect ECONNREFUSED 127.0.0.1:3007
或者返回regyser OK
;而VSCode总是报错Error [ERR_HTTP_HEADERS_SENT]: Cannot set headers after they are sent to the client
原因是:这个错误是res.send() 中包含res.end() 方法,调用一次之后,数据正常返回,但同时执行了res.end(),再一次调用此接口,就会报Error [ERR_HTTP_HEADERS_SENT]: Cannot set headers after they are sent to the client
解决方法:将【检测表单数据是否合法】中的
res.send('regyser OK');
注释掉试一下
2.3.3 对密码进行加密处理
为了保证密码的安全性,不建议在数据库以
明文
的形式保存用户密码,推荐对密码进行加密存储
,防止数据库被盗后,用户们的密码被窃取
在当前项目中,使用 bcryptjs
对用户密码进行加密,优点:
- 加密之后的密码,无法被逆向破解,提高了加密密码的安全性
- 同一明文密码多次加密,得到的加密结果各不相同,保证了安全性。比如张三和李四的密码相同,但是两者密码在经过
bcryptjs
加密之后的结果是不一样的,提高了加密密码的安全性
- 运行如下命令,安装指定版本的
bcryptjs
:
npm i bcryptjs@2.4.3
- 在
/router_handler/user.js
中,导入bcryptjs
:
const bcrypt = require('bcryptjs')
- 在注册用户的处理函数中,确认用户名可用之后,调用
bcrypt.hashSync(明文密码, 随机盐的长度)
方法,对用户的密码进行加密处理:第二个参数可以提高密码的安全性
// 对用户的密码,进行 bcrype 加密,返回值是加密之后的密码字符串
userinfo.password = bcrypt.hashSync(userinfo.password, 10)
2.3.4 插入新用户
- 定义插入用户的 SQL 语句:
const sql = 'insert into ev_users set ?'
- 调用
db.query()
执行 SQL 语句,插入新用户:
db.query(sql, { username: userinfo.username, password: userinfo.password }, function (err, results) {
// 执行 SQL 语句失败
if (err) return res.send({ status: 1, message: err.message })
// SQL 语句执行成功,但影响行数不为 1
if (results.affectedRows !== 1) {
return res.send({ status: 1, message: '注册用户失败,请稍后再试!' })
}
// 注册成功
res.send({ status: 0, message: '注册成功!' })
})
2.4 优化 res.send() 代码
在处理函数中,需要多次调用
res.send()
向客户端响应处理失败
的结果,为了简化代码,可以手动封装一个 res.cc() 函数**总结:**先在全局定义一个中间件,再在中间件中拿到
res
对象,去给他挂载一个cc()
函数,在cc()
函数中去接收一个错误消息err
和状态的表述ststus
(默认的是为1,表示处理失败的情况,如果要处理成功的情况,需要手动传递状态值status=0
),而这个err
的值可能是一个错误的对象,也可能是个错误的描述字符串,所以在调用res.send
期间给message
的值做一个三元表达式的判断(如果err
是一个err
构造函数实例的话,就返回err.massage
,否则就返回err
这个字符串),最终在每个路由里都可以去使用res.cc()
函数来处理失败的这个情况,能够极大的简化代码的书写方式。
-
在
app.js
中,所有路由之前,声明一个全局中间件,为 res 对象挂载一个res.cc()
函数 :// 响应数据的中间件app.use(function (req, res, next) { // status = 0 为成功; status = 1 为失败; 默认将 status 的值设置为 1,方便处理失败的情况 res.cc = function (err, status = 1) { res.send({ // 状态 status, // 状态描述,判断 err 是 错误对象 还是 字符串 message: err instanceof Error ? err.message : err, }) } next()})
-
打开
router_handler/user.js
文件,将里面的res.send
语句替换成res.cc()
语句:错误消息可以省略第二个参数(status状态值),但是成功的话就必须指定状态值=0// 二、检测用户名是否被占用if (err) { // return res.send({ status: 1, message: err.message }) return res.cc(err)}// 用户名被占用if (results.length > 0) { // return res.send({ status: 1, message: '用户名被占用,请更换其他用户名!' }) return res.cc('用户名被占用,请更换其他用户名!')}// 四、插入新用户 // 执行 SQL 语句失败 // if (err) return res.send({ status: 1, message: err.message }) if (err) return res.cc(err) // SQL 语句执行成功,但影响行数不为 1 // if (results.affectedRows !== 1) { return res.send({ status: 1, message: '注册用户失败,请稍后再试!' }) } if (results.affectedRows !== 1) { return res.send('注册用户失败,请稍后再试!') } // 注册成功 // res.send({ status: 0, message: '注册成功!' }) res.cc('注册成功!', 0) //成功的话就必须指定状态值=0
使用postman进行测试:
1.注册失败返回:{ “status”: 1, “message”: “用户名被占用,请更换其他用户名!” }
2.注册成功返回:{ “status”: 0, “message”: “注册成功!” }
2.5 优化表单数据验证
表单验证的原则:前端验证为辅,后端验证为主,后端永远不要相信前端提交过来的任何内容(意思是:前端提交过来的数据都要进行合法性的验证,只有验证通过后,才会进行后续的业务逻辑处理)
在实际开发中,前后端都需要对表单的数据进行合法性的验证,而且,后端做为数据合法性验证的最后一个关口,在拦截非法数据方面,起到了至关重要的作用。
单纯的使用 if...else...
的形式对数据合法性进行验证,效率低下、出错率高、维护性差。因此,推荐使用第三方数据验证模块,来降低出错率、提高验证的效率与可维护性,让后端程序员把更多的精力放在核心业务逻辑的处理上。
打开npm网页,搜索 @escook/express-joi
包,查看使用步骤:
a.导入@hapi/joi
和 @escook/express-joi
这两个包
b.定义一个验证规则对象:这个对象中最多包含3个属性(body/query/params)而这三个属性都是按需的,需要对那个数据进行验证就填哪些属性(比如想验证req.body中的数据就选body这个属性)
c.在每一个属性对象的对象中去填写对应的验证规则(比如通过body向服务器提交了3个数据:用户名、密码、确认密码)
- 安装
@hapi/joi
包,为表单中携带的每个数据项,定义验证规则:
npm install @hapi/joi@17.1.0
- 安装
@escook/express-joi
中间件,来实现自动对表单数据进行验证的功能:
npm i @escook/express-joi
- 新建
/schema/user.js
用户信息验证规则模块,并初始化代码如下:
//导入 Joi 来定义验证规则const joi = require('@hapi/joi')/** * string() 值必须是字符串 * alphanum() 值只能是包含 a-zA-Z0-9 的字符串 * min(length) 最小长度 * max(length) 最大长度 * required() 值是必填项,不能为 undefined * pattern(正则表达式) 值必须符合正则表达式的规则 */// 用户名的验证规则(必须是字符串,数字字母组合(只能包含a-z/A-Z/0-9),长度1-10,username是必传的参数(如果客户端没有提交username就会报错)const username = joi.string().alphanum().min(1).max(10).required()// 密码的验证规则(必须是字符串,满足正则表达式(必须是6-12位之间不包含空格,password是必传的参数(如果客户端没有提交password就会报错)//确认密码的验证规则:Joi.ref('password')意思是:通过Joi.ref这个方法去指定一个验证规则的名字(当前规则的值必须和上面的值保持一致)const password = joi .string() .pattern(/^[\S]{6,12}$/) .required()// 定义注册和登录表单的验证规则对象exports.reg_login_schema = { // 表示需要对 req.body 中的数据进行验证 body: { username, password, },}
-
注销
/router_handler/user.js
中的if判断代码:不在用传统的方式去做表单验证// 1.2.判断数据是否合法:对表单中的数据进行合法性的校验// 注销这个是因为后期有表单验证模块,不再需要判断语句// if (!userinfo.username || !userinfo.password) {// return res.send({ status: 1, message: '用户名或密码不能为空!' })// }// 注销这个是因为使用postman测试时,总会弹出// res.send('regyser OK')
-
修改
/router/user.js
中的代码如下:a. 导入验证表单数据的中间件和需要的验证规则对象
b.哪个路由里需要数据的验证,就在这个路由规则里去添加中间件的调用
expressJoi(reg_login_schema)
c.可能会验证失败,所以要去全局去进行错误的捕获:如果err是joi.ValidationError的一个实例,那么就证明验证失败导致的错误,把这个错误消息响应给客户端,否则就可能是个未知的错误
const express = require('express')const router = express.Router()// 导入用户路由处理函数模块const userHandler = require('../router_handler/user')// 1. 导入验证表单数据的中间件const expressJoi = require('@escook/express-joi')// 2. 导入需要的验证规则对象const { reg_login_schema } = require('../schema/user')// 注册新用户// 3. 在注册新用户的路由中,声明局部中间件,对当前请求中携带的数据进行验证// 3.1 数据验证通过后,会把这次请求流转给后面的路由处理函数// 3.2 数据验证失败后,终止后续代码的执行,并抛出一个全局的 Error 错误,进入全局错误级别中间件中进行处理router.post('/reguser', expressJoi(reg_login_schema), userHandler.regUser)// 登录router.post('/login', userHandler.login)module.exports = router
- 在
app.js
的全局错误级别中间件中,捕获验证失败的错误,并把验证失败的结果响应给客户端:
const joi = require('@hapi/joi')// 错误中间件app.use(function (err, req, res, next) { // 数据验证失败(判断err是否是错误构造函数的一个实例,因为用到Joi了,所以要在头部先导入这个包,如果成立了,就代表是验证失败导致的错误,调用res.cc去向服务器响应这个错误) if (err instanceof joi.ValidationError) return res.cc(err) // 未知错误 res.cc(err)})
运行终端后,打开postman进行测试:
**(1)将username属性的对勾去掉,点击send:**返回{ “status”: 1, “message”: ““username” is required” } ; 提示:username是个必填项。
**(2)将username的值写的长一些,点击send:**返回{ “status”: 1, “message”: ““username” length must be less than or equal to 10 characters long” }; 提示:用户名必须小于或等于10个字符。
2.6 登录
2.6.0 实现步骤
- 检测表单数据是否合法
- 根据用户名查询用户的数据
- 判断用户输入的密码是否正确
- 生成 JWT 的 Token 字符串
2.6.1 检测登录表单的数据是否合法
- 将
/router/user.js
中登录
的路由代码修改如下:
// 登录的路由router.post('/login', expressJoi(reg_login_schema), userHandler.login)
2.6.2 根据用户名查询用户的数据
- 接收表单数据:
const userinfo = req.body
- 定义 SQL 语句:
const sql = `select * from ev_users where username=?`
- 执行 SQL 语句,查询用户的数据:
db.query(sql, userinfo.username, function (err, results) { // 执行 SQL 语句失败 if (err) return res.cc(err) // 执行 SQL 语句成功,但是查询到数据条数不等于 1 if (results.length !== 1) return res.cc('登录失败!') // TODO:判断用户输入的登录密码是否和数据库中的密码一致})
2.6.3 判断用户输入的密码是否正确
核心实现思路:调用
bcrypt.compareSync(用户提交的密码, 数据库中的密码)
方法比较密码是否一致
为什么需要用
bcrypt.compareSync()
方法,而不直接用!==
来判断呢?客户端向服务器提交的密码是未加密之前的密码,因为用户在注册的时候填写的可能就是aaaaaa或000000,而在服务器进行存储时是进行加密的,所以如果直接拿着
!==
来判断的话,肯定是登录失败的,因此需要使用bcrypt.compareSync()
这个方法,拿着用户提交的密码和存储的密码进行对比,它在内部就会进行运算,最终返回一个布尔值
返回值是布尔值(true 一致代表登录成功、false 不一致)
具体的实现代码如下:打开/router_handler/user.js
文件,前期已经在头部导入过bcryptjs,所以此处不用再导:
(1) 第一个是用户提交的密码userinfo.password
,第二个是数据库中所存储的密码,只要查询用户成功了,在result中必然会有一个用户的信息对象,results是一个数组,查询到的用户信息就是索引为0的那一项,是一个用户的信息对象results[0].password
// 拿着用户输入的密码,和数据库中存储的密码进行对比const compareResult = bcrypt.compareSync(userinfo.password, results[0].password)// 如果对比的结果等于 false, 则证明用户输入的密码错误if (!compareResult) { return res.cc('登录失败!')}// TODO:登录成功,生成 Token 字符串
2.6.4 生成 JWT 的 Token 字符串
核心注意点:在生成 Token 字符串的时候,一定要剔除 密码 和 头像 的值。
原因:最终生成的Token字符串是保存在客户端浏览器里面的,由于保存在客户端就很容易被黑客进行破解,此时不要把用户的敏感信息生成到Token中,所以在生成Token字符串的时候,一定要剔除 密码 和 头像 的值。
-
通过 ES6 的高级语法,快速剔除
密码
和头像
的值:results[0]就是用户的所有信息,但是里面会包含用户的密码和用户的头像的值,使用ES6中的高级语法中的展开运算符,将对象中的所有属性展开交给外边的自变量对象,同时又通过password和user_pic这两个属性,将前面results[0]属性中的password和user_pic给覆盖掉了(里面有值得话就覆盖成空值)如果前面results[0]中有某个属性,再在后面重新定义了那个属性,前面属性里的值就会被后面的值所覆盖,因此通过user就可以拿到空的密码和空的头像,就能保证用户的信息安全。
运行终端后,打开postman进行测试,(1)覆盖密码和头像前;(2)覆盖密码和头像后,打印出为空值
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-tFiwPjFL-1622724424554)(C:\Users\HP\AppData\Roaming\Typora\typora-user-images\image-20210410183500739.png)]
// 剔除完毕之后,user 中只保留了用户的 id, username, nickname, email 这四个属性的值//const user = { ...results[0] }//console.log(user);const user = { ...results[0], password: '', user_pic: '' }
- 运行如下的命令,安装生成 Token 字符串的包:
npm i jsonwebtoken@8.5.1
- 在
/router_handler/user.js
文件中的头部区域,导入jsonwebtoken
包:
// 用这个包来生成 Token 字符串const jwt = require('jsonwebtoken')
- 创建
config.js
文件,定义并向外共享 加密 和 还原 Token 的jwtSecretKey
字符串:在加密之前先定义一个加密的秘钥,在文件中定义和共享一个jwtSecretKey
属性,它的值就是一个加密的秘钥(任意写)
// 这是一个全局的配置文件module.exports = { // 加密和解密的 Token 秘钥 jwtSecretKey: 'itheima No1. ^_^',}
-
将用户信息对象加密成 Token 字符串:打开
/router_handler/user.js
文件,在头部导入配置文件,再在登录处理函数中调用jsonwebtoken包提供的sign方法,通过秘钥对用户的信息来进行加密第一个参数是要加密的用户对象;第二个参数是加密时需要用到的jwtSecretKey秘钥的值;第三个参数是配置对象(指定token有效期的)
// 导入配置文件const config = require('../config')// 对用户的信息进行加密,生成 Token 字符串const tokenStr = jwt.sign(user, config.jwtSecretKey, { expiresIn: '10h', // token 有效期为 10 个小时})
-
token有效期的另一种写法,把它抽离出去:
第一步:在config.js
文件里中module.exports中再定义一个 expiresInmodule.exports = { jwtSecretKey: 'itheima No1. ^_^', //token的有效期 expiresIn: '10h',}
第二步:expiresIn的值就不用直接写10h了
const tokenStr = jwt.sign(user, config.jwtSecretKey, { expiresIn: config.expiresIn // token 有效期为 10 个小时})
-
将生成的 Token 字符串响应给客户端:(在实际使用token时,必须在token字符串之前加上Bearer前缀)客户端就可以基于token字符串来实现身份的验证
//调用 res.send() 将token响应给客户端res.send({ status: 0, message: '登录成功!', // 为了方便客户端使用 Token,在服务器端直接拼接上 Bearer 的前缀 token: 'Bearer ' + tokenStr,})
**运行终端,打开postman进行测试,返回:**带有Bearer前缀
2.7 配置解析 Token 的中间件
- 运行如下的命令,安装解析 Token 的中间件:
npm i express-jwt@5.3.3
- 在
app.js
中注册路由之前,配置解析 Token 的中间件:
// 导入配置文件const config = require('./config')// 解析 token 的中间件const expressJWT = require('express-jwt')// 使用 .unless({ path: [/^\/api\//] }) 指定哪些接口不需要进行 Token 的身份认证:凡是以/api开头的都不需要身份认证app.use(expressJWT({ secret: config.jwtSecretKey }).unless({ path: [/^\/api\//] }))
- 很有可能会token认证失败,在
app.js
中的错误级别中间件
里面,捕获并处理 Token 认证失败后的错误:
// 6.在路由之后去定义错误级别中间件app.use(function (err, req, res, next) { // 省略其它代码... // 捕获身份认证失败的错误 if (err.name === 'UnauthorizedError') return res.cc('身份认证失败!') // 未知错误...})
运行终端,打开postman进行测试,
http://127.0.0.1:3007/my/textabc
假设用get访问的这个地址就返回身份认证失败
:因为这次身份认证请求的是
/my
开头的接口,而/my
并没有在unless
列表里,所以说/my
开头的接口需要进行身份认证,此时expressJWT
中间件就会判断请求头里有没有携带authorization
这个字段,发现没有提供所以就提示身份验证失败
如何使身份验证成功?
用postman测试时,在使用
post向http://127.0.0.1:3007/api/login
接口地址点击send
后,提示登录成功,此时服务器向客户端返回了token字符串,然后直接选中服务器返回的token字符串,粘贴到get:http://127.0.0.1:3007/my/textabc
的headers
中authorization
这个字段的值,然后再发起请求,此时就会身份认证成功
3. 个人中心
3.1 获取用户的基本信息
3.1.0 实现步骤
- 初始化 路由 模块
- 初始化 路由处理函数 模块
- 获取用户的基本信息
3.1.1 初始化路由模块
-
创建
/router/userinfo.js
路由模块,并初始化如下的代码结构:打开大事件API文档,【个人中心】-【获取用户的基本信息】,复制地址
/userinfo
,注意:/my不需要手动去粘贴,之后统一去挂载
// 导入 expressconst express = require('express')// 创建路由对象const router = express.Router()// 获取用户的基本信息router.get('/userinfo', (req, res) => { res.send('ok')})// 向外共享路由对象module.exports = router
- 在
app.js
中导入并注册用户路由模块
的后面去导入并使用个人中心的路由模块:
// 导入并使用用户信息路由模块const userinfoRouter = require('./router/userinfo')// 注意:以 /my 开头的接口,都是有权限的接口,需要进行 Token 身份认证app.use('/my', userinfoRouter)
运行终端,使用postman进行测试,用get:http://127.0.0.1:3007/my/userinfo,点击send,返回:{ “status”: 1, “message”: “身份认证失败!” }
失败的原因:因为请求的是一个有权限的接口,需要在
headers
里添加一个认证的字段authorization
,值为post:http://127.0.0.1:3007/api/login
返回的token值,点击send再次发送请求,返回ok,就证明这个路由可以正常工作
3.1.2 初始化路由处理函数模块
- 创建
/router_handler/userinfo.js
路由处理函数模块,并初始化如下的代码结构:先将/router/userinfo.js
文件里[获取用户基本信息的路由]中的回调函数截取走,再在/router_handler/userinfo.js
路由处理函数模块写入
// 获取用户基本信息的处理函数exports.getUserInfo = (req, res) => { res.send('ok')}
-
修改
/router/userinfo.js
中的代码如下:(1)导入用户信息的处理函数模块;(2)获取用户的基本信息(将回调函数剪切走,写入userinfo_handler.getUserInfo)
const express = require('express')const router = express.Router()// 导入用户信息的处理函数模块const userinfo_handler = require('../router_handler/userinfo')// 获取用户的基本信息(将回调函数剪切走,写入userinfo_handler.getUserInfo)router.get('/userinfo', userinfo_handler.getUserInfo)module.exports = router
3.1.3 获取用户的基本信息
- 在
/router_handler/userinfo.js
头部导入数据库操作模块:
// 导入数据库操作模块const db = require('../db/index')
-
定义 SQL 语句:id后有一个占位符?
问题:占位符?值从何而来?怎么知道要查询哪个人的用户信息?
解答:只要客户端请求服务器时携带了token,就可以从token里把用户的信息解析还原出来,还原成功之后就可以得到当前这个人的id了,因为在token中本身就保存着用户的id
// 根据用户的 id,查询用户的基本信息// 注意:为了防止用户的密码泄露,需要排除 password 字段// 从ev_users数据表中查询指定id的用户所包含的id、用户登录名、用户昵称、邮箱、头像信息。const sql = `select id, username, nickname, email, user_pic from ev_users where id=?`
- 调用
db.query()
执行 SQL 语句:将一、获取用户基本信息的处理函数
中res,send('ok')
删去写入下列代码
// 注意:req 对象上的 user 属性,是 Token 解析成功,express-jwt 中间件帮我们挂载上去的。只要身份认证成功了,在req身上就会多一个 user 属性,它是一个对象,里面会包含用户的iddb.query(sql, req.user.id, (err, results) => { // 1. 执行 SQL 语句失败 if (err) return res.cc(err) // 2. 执行 SQL 语句成功,但是查询到的数据条数不等于 1 if (results.length !== 1) return res.cc('获取用户信息失败!') // 3. 将用户信息响应给客户端 res.send({ status: 0, message: '获取用户基本信息成功!', data: results[0], })})
3.2 更新用户的基本信息
3.2.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 实现更新用户基本信息的功能
3.2.1 定义路由和处理函数
- 在
/router/userinfo.js
模块中,新增更新用户基本信息
的路由:
// 更新用户的基本信息router.post('/userinfo', userinfo_handler.updateUserInfo)
- 在
/router_handler/userinfo.js
模块中,定义并向外共享更新用户基本信息
的路由处理函数:
// 更新用户基本信息的处理函数exports.updateUserInfo = (req, res) => { res.send('ok')}
3.2.2 验证表单数据
- 在
/schema/user.js
验证规则模块中,定义id
,nickname
,email
的验证规则如下:
// 定义 id, nickname, emial 的验证规则const id = joi.number().integer().min(1).required()const nickname = joi.string().required()const email = joi.string().email().required()
- 并使用
exports
向外共享如下的验证规则对象
:
// 验证规则对象 - 更新用户基本信息exports.update_userinfo_schema = { body: { id, nickname, email, },}
- 在
/router/userinfo.js
模块中,导入验证数据合法性的中间件:
// 导入验证数据合法性的中间件const expressJoi = require('@escook/express-joi')
- 在
/router/userinfo.js
模块中,导入需要的验证规则对象:
// 导入需要的验证规则对象const { update_userinfo_schema } = require('../schema/user')
- 在
/router/userinfo.js
模块中,修改更新用户的基本信息
的路由如下:
// 更新用户的基本信息router.post('/userinfo', expressJoi(update_userinfo_schema), userinfo_handler.updateUserInfo)
3.2.3 实现更新用户基本信息的功能
- 定义待执行的 SQL 语句:
const sql = `update ev_users set ? where id=?`
- 调用
db.query()
执行 SQL 语句并传参:
db.query(sql, [req.body, req.body.id], (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // 执行 SQL 语句成功,但影响行数不为 1 if (results.affectedRows !== 1) return res.cc('修改用户基本信息失败!') // 修改用户信息成功 return res.cc('修改用户基本信息成功!', 0)})
3.3 重置密码
3.3.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 实现重置密码的功能
3.3.1 定义路由和处理函数
- 在
/router/userinfo.js
模块中,新增重置密码
的路由:
// 重置密码的路由router.post('/updatepwd', userinfo_handler.updatePassword)
- 在
/router_handler/userinfo.js
模块中,定义并向外共享重置密码
的路由处理函数:
// 更新用户密码的处理函数exports.updatePassword = (req, res) => { res.send('ok')}
用postman测试:POST:http://127.0.0.1:3007/my/updatepwd
,点击send后,服务器响应{ "status": 1, "message": "身份认证失败!" }
响应失败的原因是:这是一个有权限的接口,需要在headers里添加身份认证的字段,值为POST:http://127.0.0.1:3007/api/login
返回回来的token字符串,再点击send就返回ok代表请求成功了
3.3.2 验证表单数据
核心验证思路:旧密码与新密码,必须符合密码的验证规则,并且新密码不能与旧密码一致!
- 在
/schema/user.js
模块中,使用exports
向外共享如下的验证规则对象
:
// 验证规则对象 - 重置密码exports.update_password_schema = { body: { // 使用 password 这个规则,验证 req.body.oldPwd 的值,旧密码必须符合密码的验证规则 oldPwd: password, // 使用 joi.not(joi.ref('oldPwd')).concat(password) 规则,验证 req.body.newPwd 的值 // 解读: // 1. joi.ref('oldPwd') 表示 newPwd 的值必须和 oldPwd 的值保持一致 // 2. joi.not(joi.ref('oldPwd')) 表示 newPwd 的值不能等于 oldPwd 的值 // 3. .concat() 用于合并 joi.not(joi.ref('oldPwd')) 和 password 这两条验证规则 newPwd: joi.not(joi.ref('oldPwd')).concat(password), },}
- 在
/router/userinfo.js
模块中,导入需要的验证规则对象:在导入需要的验证规则对象
中添加update_password_schema
// 导入需要的验证规则对象const { update_userinfo_schema, update_password_schema } = require('../schema/user')
- 并在
更新密码的路由
中,使用update_password_schema
规则验证表单的数据,示例代码如下:在更新密码的路由
中添加expressJoi(update_password_schema)
router.post('/updatepwd', expressJoi(update_password_schema), userinfo_handler.updatePassword)
3.3.3 实现重置密码的功能
- 根据
id
查询用户是否存在:打开/router_handler/userinfo.js
中的四、更新用户密码的处理函数
,将里面的res.send('ok')
删去,写入下面代码
// 定义根据 id 查询用户数据的 SQL 语句const sql = `select * from ev_users where id=?`// 执行 SQL 语句查询用户是否存在db.query(sql, req.user.id, (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // 检查指定 id 的用户是否存在 if (results.length !== 1) return res.cc('用户不存在!') // TODO:判断提交的旧密码是否正确})
- 判断提交的 旧密码 是否正确:不能使用等号来进行直接的判断,要调用
bcryptjs
里的compareSync
方法来进行密码的对比,如果是true
的话就是密码正确,否则原密码错误
// 在头部区域导入 bcryptjs // 即可使用 bcrypt.compareSync(提交的密码,数据库中的密码) 方法验证密码是否正确// compareSync() 函数的返回值为布尔值,true 表示密码正确,false 表示密码错误const bcrypt = require('bcryptjs')// 判断提交的旧密码是否正确const compareResult = bcrypt.compareSync(req.body.oldPwd, results[0].password)//如果compareResult不等于trueif (!compareResult) return res.cc('原密码错误!')
- 对新密码进行
bcrypt
加密之后,更新到数据库中:打开/router_handler/userinfo.js
中
// 定义更新用户密码的 SQL 语句:更新ev_users表里的id对应的人的密码const sql = `update ev_users set password=? where id=?`// 对新密码进行 bcrypt 加密处理const newPwd = bcrypt.hashSync(req.body.newPwd, 10)// 执行 SQL 语句,根据 id 更新用户的密码db.query(sql, [newPwd, req.user.id], (err, results) => { // SQL 语句执行失败 if (err) return res.cc(err) // SQL 语句执行成功,但是影响行数不等于 1 if (results.affectedRows !== 1) return res.cc('更新密码失败!') // 更新密码成功 res.cc('更新密码成功!', 0)})
3.4 更新用户头像
打开API文档【个人中心】-【更换头像】发现请求URL地址是以/my开头的所以是个有权限的接口,要加headers请求字段,并且需要客户端向服务器提交一个avatar请求体参数
3.4.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 实现更新用户头像的功能
3.4.1 定义路由和处理函数
- 在
/router/userinfo.js
模块中,新增更新用户头像
的路由:
// 更新用户头像的路由router.post('/update/avatar', userinfo_handler.updateAvatar)
- 在
/router_handler/userinfo.js
模块中,定义并向外共享更新用户头像
的路由处理函数:
// 更新用户头像的处理函数exports.updateAvatar = (req, res) => { res.send('ok')}
3.4.2 验证表单数据
- 在
/schema/user.js
验证规则模块中,定义avatar
的验证规则如下:avatar是字符串、base64格式、必填项
// dataUri() 指的是base64格式的字符串数据:// data:image/png;base64,VE9PTUFOWVNFQ1JFVFM=const avatar = joi.string().dataUri().required()
- 并使用
exports
向外共享如下的验证规则对象
:
// 验证规则对象 - 更新头像exports.update_avatar_schema = { body: { avatar, },}
- 在
/router/userinfo.js
模块中,导入需要的验证规则对象:
const { update_avatar_schema } = require('../schema/user')
- 在
/router/userinfo.js
模块中,修改更新用户头像
的路由如下:
router.post('/update/avatar', expressJoi(update_avatar_schema), userinfo_handler.updateAvatar)
使用postman进行测试:
POST:http://127.0.0.1:3007/my/update/avatar
在headers中添加请求头,值为登录接口返回回来的token字符串,再在body面板中X-WWW写入avatar,值为一个base64格式的字符串数据,点击send,服务器返回OK,证明验证通过
3.4.3 实现更新用户头像的功能
- 定义更新用户头像的 SQL 语句:通过id来更新表中这个人的头像信息
const sql = 'update ev_users set user_pic=? where id=?'
- 调用
db.query()
执行 SQL 语句,更新对应用户的头像:
db.query(sql, [req.body.avatar, req.user.id], (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // 执行 SQL 语句成功,但是影响行数不等于 1 if (results.affectedRows !== 1) return res.cc('更新头像失败!') // 更新用户头像成功 return res.cc('更新头像成功!', 0)})
使用postman测试:基于上面的测试操作,直接点击send,返回:
{ "status": 0, "message": "更新头像成功!"}
,再打开数据库,会发现sun2用户多了个头像值
4. 文章分类管理
4.1 新建 ev_article_cate 表
4.1.1 创建表结构
4.1.2 新增两条初始数据
4.2 获取文章分类列表
4.2.0 实现步骤
- 初始化路由模块
- 初始化路由处理函数模块
- 获取文章分类列表数据
4.2.1 初始化路由模块
- 创建
/router/artcate.js
路由模块,并初始化如下的代码结构:
// 导入 expressconst express = require('express')// 创建路由对象const router = express.Router()// 获取文章分类的列表数据router.get('/cates', (req, res) => { res.send('ok')})// 向外共享路由对象module.exports = router
- 在
app.js
中导入并使用文章分类的路由模块:
// 导入并使用文章分类路由模块const artCateRouter = require('./router/artcate')// 为文章分类的路由挂载统一的访问前缀 /my/articleapp.use('/my/article', artCateRouter)
4.2.2 初始化路由处理函数模块
- 创建
/router_handler/artcate.js
路由处理函数模块,并初始化如下的代码结构:
// 获取文章分类列表数据的处理函数exports.getArticleCates = (req, res) => { res.send('ok')}
- 修改
/router/artcate.js
中的代码如下:
const express = require('express')const router = express.Router()// 导入文章分类的路由处理函数模块const artcate_handler = require('../router_handler/artcate')// 获取文章分类的列表数据router.get('/cates', artcate_handler.getArticleCates)module.exports = router
4.2.3 获取文章分类列表数据
- 在
/router_handler/artcate.js
头部导入数据库操作模块:
// 导入数据库操作模块const db = require('../db/index')
- 定义 SQL 语句:在ev_article_cate表中查找分类状态为0(未被删除)文章分类数据,再根据id从小到大(asc)进行排序
// 根据分类的状态,获取所有未被删除的分类列表数据// is_delete 为 0 表示没有被 标记为删除 的数据const sql = 'select * from ev_article_cate where is_delete=0 order by id asc'
- 调用
db.query()
执行 SQL 语句:results是个数组
db.query(sql, (err, results) => { // 1. 执行 SQL 语句失败 if (err) return res.cc(err) // 2. 执行 SQL 语句成功 res.send({ status: 0, message: '获取文章分类列表成功!', data: results, })})
使用postman测试:
GET:http://127.0.0.1:3007/my/article/cates
4.3 新增文章分类
4.3.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 查询
分类名称
与分类别名
是否被占用 - 实现新增文章分类的功能
4.3.1 定义路由和处理函数
- 在
/router/artcate.js
模块中,添加新增文章分类
的路由:
// 新增文章分类的路由router.post('/addcates', artcate_handler.addArticleCates)
- 在
/router_handler/artcate.js
模块中,定义并向外共享新增文章分类
的路由处理函数:
// 新增文章分类的处理函数exports.addArticleCates = (req, res) => { res.send('ok')}
4.3.2 验证表单数据
- 创建
/schema/artcate.js
文章分类数据验证模块,并定义如下的验证规则:
// 导入定义验证规则的模块const joi = require('@hapi/joi')// 定义 分类名称 和 分类别名 的校验规则alphanum():只能包含字母或数字const name = joi.string().required()const alias = joi.string().alphanum().required()// 校验规则对象 - 添加分类exports.add_cate_schema = { body: { name, alias, },}
- 在
/router/artcate.js
模块中,使用add_cate_schema
对数据进行验证:
// 导入验证数据的中间件const expressJoi = require('@escook/express-joi')// 导入需要的验证规则对象(添加分类)const { add_cate_schema } = require('../schema/artcate')// 新增文章分类的路由router.post('/addcates', expressJoi(add_cate_schema), artcate_handler.addArticleCates)
使用postman测试:POST:http://127.0.0.1:3007/my/article/addcates
4.3.3 查询分类名称与别名是否被占用
-
定义查重的 SQL 语句:打开
/router_handler/artcate.js
文件中新增文章分类的处理函数
中写入下面代码有四种查询结果:
(1)results.length === 2 ;代表分类名称和分类别名同时被两条数据占用
(2)results.length === 1 && results[0].name === req.body.name && results[0].alias === req.body.alias ;代表分类名称和分类别名同时被一条数据所占用
(3)results.length === 1 && results[0].name === req.body.name ;只有分类名称被占用,分类别名是可以用的
(4)results.length === 1 && results[0].alias === req.body.alias ;只有分类别名被占用,分类名称是可以用的
// 定义查询 分类名称 与 分类别名 是否被占用的 SQL 语句const sql = `select * from ev_article_cate where name=? or alias=?`
- 调用
db.query()
执行查重的操作:
// 新增文章分类的处理函数exports.addArticleCates = (req, res) => { // 1. 定义查重的 SQL 语句 const sql = `select * from ev_article_cate where name=? or alias=?` // 2. 执行查重的 SQL 语句 db.query(sql, [req.body.name, req.body.alias], (err, results) => { // 3. 判断是否执行 SQL 语句失败 if (err) return res.cc(err) // 4.1. 判断数据的 length if (results.length === 2) return res.cc('分类名称与别名被占用,请更换后重试!') // 4.2 length 等于 1 的三种情况 if (results.length === 1 && results[0].name === req.body.name && results[0].alias === req.body.alias) return res.cc('分类名称与别名被占用,请更换后重试!') if (results.length === 1 && results[0].name === req.body.name) return res.cc('分类名称被占用,请更换后重试!') if (results.length === 1 && results[0].alias === req.body.alias) return res.cc('分类别名被占用,请更换后重试!') // TODO:新增文章分类 })}
postman测试:
4.3.4 实现新增文章分类的功能
- 定义新增文章分类的 SQL 语句:
const sql = `insert into ev_article_cate set ?`
- 调用
db.query()
执行新增文章分类的 SQL 语句:
db.query(sql, req.body, (err, results) => { // SQL 语句执行失败 if (err) return res.cc(err) // SQL 语句执行成功,但是影响行数不等于 1 if (results.affectedRows !== 1) return res.cc('新增文章分类失败!') // 新增文章分类成功 res.cc('新增文章分类成功!', 0)})
4.4 根据 Id 删除文章分类
4.4.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 实现删除文章分类的功能
4.4.1 定义路由和处理函数
- 在
/router/artcate.js
模块中,添加删除文章分类
的路由:
// 删除文章分类的路由router.get('/deletecate/:id', artcate_handler.deleteCateById)
- 在
/router_handler/artcate.js
模块中,定义并向外共享删除文章分类
的路由处理函数:
// 删除文章分类的处理函数exports.deleteCateById = (req, res) => { res.send('ok')}
4.4.2 验证表单数据
- 在
/schema/artcate.js
验证规则模块中,定义 id 的验证规则如下:
// 定义 分类Id 的校验规则const id = joi.number().integer().min(1).required()
- 并使用
exports
向外共享如下的验证规则对象
:
// 校验规则对象 - 删除分类exports.delete_cate_schema = { params: { id, },}
- 在
/router/artcate.js
模块中,导入需要的验证规则对象,并在路由中使用:直接在{ }里用逗号连接
// 导入需要的验证规则对象(添加分类、删除分类)const { add_cate_schema, delete_cate_schema } = require('../schema/artcate')// 根据Id删除文章分类的路由router.get('/deletecate/:id', expressJoi(delete_cate_schema), artcate_handler.deleteCateById)
4.4.3 实现删除文章分类的功能
- 定义删除文章分类的 SQL 语句:没有执行delete语句直接去删掉这条数据而是执行update更新语句,原因是:数据表中有is_delete状态字段(0代表没有被删除,1代表被删除),通过标记删除,使删除动作更加的安全
const sql = `update ev_article_cate set is_delete=1 where id=?`
- 调用
db.query()
执行删除文章分类的 SQL 语句:
db.query(sql, req.params.id, (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // SQL 语句执行成功,但是影响行数不等于 1 if (results.affectedRows !== 1) return res.cc('删除文章分类失败!') // 删除文章分类成功 res.cc('删除文章分类成功!', 0)})
postman测试:
GET:http://127.0.0.1:3007/my/article/deletecate/1
打开数据库,发现id为1的数据的is_delete标记为1,代表已经被删除了
4.5 根据 Id 获取文章分类数据
4.5.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 实现获取文章分类的功能
4.5.1 定义路由和处理函数
- 在
/router/artcate.js
模块中,添加根据 Id 获取文章分类
的路由:
router.get('/cates/:id', artcate_handler.getArticleById)
- 在
/router_handler/artcate.js
模块中,定义并向外共享根据 Id 获取文章分类
的路由处理函数:
// 根据 Id 获取文章分类的处理函数exports.getArticleById = (req, res) => { res.send('ok')}
4.5.2 验证表单数据
- 在
/schema/artcate.js
验证规则模块中,使用exports
向外共享如下的验证规则对象
:
// 校验规则对象 - 根据 Id 获取分类exports.get_cate_schema = { params: { id, },}
- 在
/router/artcate.js
模块中,导入需要的验证规则对象,并在路由中使用:
// 导入根据 Id 获取分类的验证规则对象const { get_cate_schema } = require('../schema/artcate')// 根据 Id 获取文章分类的路由router.get('/cates/:id', expressJoi(get_cate_schema), artcate_handler.getArticleById)
4.5.3 实现获取文章分类的功能
- 定义根据 Id 获取文章分类的 SQL 语句:
const sql = `select * from ev_article_cate where id=?`
- 调用
db.query()
执行 SQL 语句:
db.query(sql, req.params.id, (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // SQL 语句执行成功,但是没有查询到任何数据 if (results.length !== 1) return res.cc('获取文章分类数据失败!') // 把数据响应给客户端 res.send({ status: 0, message: '获取文章分类数据成功!', data: results[0], })})
postman测试:
GET:http://127.0.0.1:3007/my/article/cates/1
4.6 根据 Id 更新文章分类数据
根据API接口文档里的内容:对外提供的是POST类型的接口,请求的URL地址是/my/article/updatecate
,因为地址也是以/my
开头的,所以是个有权限的接口,客户端在请求接口期间,要通过header请求头来提供一个身份认证的字段,同时还需要通过POST请求体向服务器去发送id、name、alias三个参数
4.6.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 查询
分类名称
与分类别名
是否被占用 - 实现更新文章分类的功能
4.6.1 定义路由和处理函数
- 在
/router/artcate.js
模块中,添加更新文章分类
的路由:
// 根据Id更新文章分类的路由router.post('/updatecate', artcate_handler.updateCateById)
- 在
/router_handler/artcate.js
模块中,定义并向外共享更新文章分类
的路由处理函数:
// 根据Id更新文章分类的路由exports.updateCateById = (req, res) => { res.send('ok')}
4.6.2 验证表单数据
- 在
/schema/artcate.js
验证规则模块中,使用exports
向外共享如下的验证规则对象
:
// 校验规则对象 - 更新分类exports.update_cate_schema = { body: { Id: id, name, alias, },}
- 在
/router/artcate.js
模块中,导入需要的验证规则对象,并在路由中使用:
// 导入更新文章分类的验证规则对象const { update_cate_schema } = require('../schema/artcate')// 更新文章分类的路由router.post('/updatecate', expressJoi(update_cate_schema), artcate_handler.updateCateById)
4.5.4 查询分类名称与别名是否被占用
- 定义查重的 SQL 语句:id不等于用户提交过来的id并且name等于用户提交过来的name或者说alias等于用户提交过来的alias
// 定义查询 分类名称 与 分类别名 是否被占用的 SQL 语句const sql = `select * from ev_article_cate where Id<>? and (name=? or alias=?)`
- 调用
db.query()
执行查重的操作:
// 执行查重操作db.query(sql, [req.body.Id, req.body.name, req.body.alias], (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // 判断 名称 和 别名 被占用的4中情况: // (1)分类名称 和 分类别名 都被占用 if (results.length === 2) return res.cc('分类名称与别名被占用,请更换后重试!') if (results.length === 1 && results[0].name === req.body.name && results[0].alias === req.body.alias) return res.cc('分类名称与别名被占用,请更换后重试!') // (2)分类名称 或 分类别名 被占用 if (results.length === 1 && results[0].name === req.body.name) return res.cc('分类名称被占用,请更换后重试!') if (results.length === 1 && results[0].alias === req.body.alias) return res.cc('分类别名被占用,请更换后重试!') // TODO:更新文章分类})
4.5.5 实现更新文章分类的功能
- 定义更新文章分类的 SQL 语句:
const sql = `update ev_article_cate set ? where Id=?`
- 调用
db.query()
执行 SQL 语句:
db.query(sql, [req.body, req.body.Id], (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // SQL 语句执行成功,但是影响行数不等于 1 if (results.affectedRows !== 1) return res.cc('更新文章分类失败!') // 更新文章分类成功 res.cc('更新文章分类成功!')})
postman测试,将id为1的数据里的分类名称和别名修改为美术和meishu:
POST:http://127.0.0.1:3007/my/article/updatecate
打开数据库发现:修改已完成
5. 文章管理
5.1 新建 ev_articles 表
5.2 发布新文章
根据API文档里【文章管理】-【发布新文章】的内容设计接口:对外提供POST类型的接口,请求URL地址是
/my/article/add
,客户端在请求这个接口期间,要向服务器去提交一个FormDate
格式的请求体数据(重点:在服务器端如何去解析FormDate
格式的请求体数据?)里面包含文章的title
标题、cate_id
所属分类id、content
文章内容、cover_img
封面、state
状态
5.2.0 实现步骤
- 初始化路由模块
- 初始化路由处理函数模块
- 使用 multer 解析表单数据
- 验证表单数据
- 实现发布文章的功能
5.2.1 初始化路由模块
- 创建
/router/article.js
路由模块,并初始化如下的代码结构:
// 导入 expressconst express = require('express')// 创建路由对象const router = express.Router()// 发布新文章router.post('/add', (req, res) => { res.send('ok')})// 向外共享路由对象module.exports = router
- 在
app.js
中导入并使用文章的路由模块:
// 导入并使用文章路由模块const articleRouter = require('./router/article')// 为文章的路由挂载统一的访问前缀 /my/articleapp.use('/my/article', articleRouter)
5.2.2 初始化路由处理函数模块
- 创建
/router_handler/article.js
路由处理函数模块,并初始化如下的代码结构:
// 发布新文章的处理函数exports.addArticle = (req, res) => { res.send('ok')}
- 修改
/router/artcate.js
中的代码如下:
const express = require('express')const router = express.Router()// 导入文章的路由处理函数模块const article_handler = require('../router_handler/article')// 发布新文章router.post('/add', article_handler.addArticle)module.exports = router
5.2.3 使用 multer 解析表单数据
注意:使用
express.urlencoded()
中间件无法解析multipart/form-data
格式的请求体数据。
当前项目,推荐使用 multer 来解析
multipart/form-data
格式的表单数据。https://www.npmjs.com/package/multer
- 运行如下的终端命令,在项目中安装
multer
:
npm i multer@1.4.2
- 在
/router/article.js
模块中导入并配置multer
:
// 导入解析 formdata 格式表单数据的包const multer = require('multer')// 导入处理路径的核心模块const path = require('path')// 创建 multer 的实例对象可以解析客户端提交到服务器的FormDate格式的表单,通过 dest 属性指定文件的存放路径const upload = multer({ dest: path.join(__dirname, '../uploads') })
- 修改
发布新文章
的路由如下:
// 发布新文章的路由// upload.single() 是一个局部生效的中间件,用来解析 FormData 格式的表单数据// 将文件类型的数据,解析并挂载到 req.file 属性中// 将文本类型的数据,解析并挂载到 req.body 属性中router.post('/add', upload.single('cover_img'), article_handler.addArticle)
- 在
/router_handler/article.js
模块中的addArticle
处理函数中,将multer
解析出来的数据进行打印:
// 发布新文章的处理函数exports.addArticle = (req, res) => { console.log(req.body) // 文本类型的数据 console.log('--------分割线----------') console.log(req.file) // 文件类型的数据 res.send('ok')})
运行终端,打开postman,点击send,终端打印的req.body是一个空对象,req.file是undefined
使用postman测试:
POST:http://127.0.0.1:3007/my/article/add
再打开终端,发现响应了两个对象,第一个对象里面包含了标题、分类的id、内容、状态;第二个对象中包含了文件的信息
5.2.4 验证表单数据
实现思路:通过 express-joi 自动验证 req.body 中的文本数据;通过 if 判断手动验证 req.file 中的文件数据;
因为经过multer解析之后,数据分成了两部分,一部分是普通文本类型的数据被挂载到req.body身上;另一部分是文件类型的数据,是先把文件存到upload是目录中,并且将文件的信息挂载为了req.file这么一个对象。因此要通过两个步骤来对数据进行处理验证
- 创建
/schema/article.js
验证规则模块,并初始化如下的代码结构:
// 导入定义验证规则的模块const joi = require('@hapi/joi')// 定义 标题、分类Id、内容、发布状态 的验证规则;integer()整数;allow('')允许为空字符串;valid('已发布', '草稿')只允许是这两种状态;const title = joi.string().required()const cate_id = joi.number().integer().min(1).required()const content = joi.string().required().allow('')const state = joi.string().valid('已发布', '草稿').required()// 验证规则对象 - 发布文章exports.add_article_schema = { body: { title, cate_id, content, state, },}
- 在
/router/article.js
模块中,导入需要的验证规则对象,并在路由中使用:
// 导入验证数据的中间件const expressJoi = require('@escook/express-joi')// 导入文章的验证模块const { add_article_schema } = require('../schema/article')// 发布新文章的路由// 注意:在当前的路由中,先后使用了两个中间件:// 先使用 multer 解析表单数据// 再使用 expressJoi 对解析的表单数据进行验证router.post('/add', upload.single('cover_img'), expressJoi(add_article_schema), article_handler.addArticle)
- 在
/router_handler/article.js
模块中的addArticle
处理函数中,通过if
判断客户端是否提交了封面图片
:
// 发布新文章的处理函数exports.addArticle = (req, res) => { // 手动判断是否上传了文章封面 if (!req.file || req.file.fieldname !== 'cover_img') return res.cc('文章封面是必选参数!') // TODO:表单数据合法,继续后面的处理流程...})
5.2.5 实现发布文章的功能
-
整理要插入数据库的文章信息对象:定义一个叫articleInfo的对象,里面用来整理所有用到的数据
(1)首先将req.body里面所携带的标题、内容、状态、所属的分类Id通过展开运算符将这四个属性交给articleInfo这个新对象,这样的话,articleInfo里就包含了这四个属性;
(2)接下来又进一步处理了文章封面的存放路径,调用path模块提供的join方法去做这个路径的拼接,因为当我们把文章封面上传到服务器之后,会得到req.file来指向一个对象,这个对象中包含的有filename属性就是文件对应的名称,接下来需要将这个文件名称和他对应的存放路径进行拼接,然后把这个拼接的值保存到cover_img属性里
(3)经过处理后,articleInfo对象中包含7个属性,而数据表中有9个属性,id和is_delete的值是不需要提供的,因为id的值是自动增长的,is_delete的值是默认为0的
// 导入处理路径的 path 核心模块(头部导入)const path = require('path')const articleInfo = { // 标题、内容、状态、所属的分类Id ...req.body, // 文章封面在服务器端的存放路径 cover_img: path.join('/uploads', req.file.filename), // 文章发布时间 pub_date: new Date(), // 文章作者的Id author_id: req.user.id,}console.log(articleInfo);res.send('okok')
-
使用postman进行测试,服务器返回okok;终端响应了一个对象:
{
title: ‘abc’,
cate_id: 2,
content: ‘abcdefg’,
state: ‘草稿’,
cover_img: ‘\uploads\16840ae75a2087a5d11b9cdfe89bcc9a’,
pub_date: 2021-04-17T13:27:45.507Z,
author_id: 6
} -
定义发布文章的 SQL 语句:
const sql = `insert into ev_articles set ?`
- 调用
db.query()
执行发布文章的 SQL 语句:
// 导入数据库操作模块(头部导入)const db = require('../db/index')// 执行 SQL 语句db.query(sql, articleInfo, (err, results) => { // 执行 SQL 语句失败 if (err) return res.cc(err) // 执行 SQL 语句成功,但是影响行数不等于 1 if (results.affectedRows !== 1) return res.cc('发布文章失败!') // 发布文章成功 res.cc('发布文章成功', 0)})
- 在
app.js
中,使用express.static()
中间件,将uploads
目录中的图片托管为静态资源:
// 托管静态资源文件app.use('/uploads', express.static('./uploads'))
使用postman进行测试:
打开数据库,发现表中新增了数据:
演示API接口的使用
-
用VSCode打开【大事件项目】,找到
/assets/js/baseAPI.js
文件,将里面的请求根路径去进行修改:换成自己终端响应回来的路径http://127.0.0.1:3007// 1. 在发起真正的 Ajax 请求之前,统一拼接请求的根路径// options.url = 'http://ajax.frontend.itheima.net' + options.urloptions.url = 'http://127.0.0.1:3007' + options.url
-
【Ctrl+shift+P】输入express,选择
Host Current Workspace and open inbrowser
就自动在浏览器中打开了这个项目 -
登录进去后,检查个接口功能是否能正常使用
-
2和3步骤是为了打开页面,但是会出现问题,页面打开失败(不知道原因)所以可以直接找到index.html文件,右键open with live server打开页面进行登录