1、fs文件模块
fs.readFile()方法,用来读取指定文件中的内容
fs.readFile(path[,option],callback)
参数1:必选参数,表示文件路径
参数2:可选参数,表示声明编码格式来读取文件
参数3:必选参数,文件读取完成后,通过回调函数拿到读取的结果
例子
const fs = require('fs')
fs.readFile('./1.txt','utf8',function(err,dataStr){
console.log(err)
console.log('------------')
console.log(dataStr)
})
fs.writeFile()方法,用来读取指定文件中的内容
const fs = require('fs')
fs.writeFile('./2.txt','abcd',function(err){
console.log(err)
})
小红=23 小红:23
//将成绩的数组,按照空格进行分割
const arrOld = dataStr.split('')
//循环分割后的数组,对每一项数据,进行字符串的替换操作
const arrNew = []
arrOld.forEach(item => {
arrNew.push(item.replace('=',':'))
})
//把新数组中的每一项,进行合并换行,得到一个新的字符串
const newStr = arrNew.join('\r\n')
- 路径动态拼接
__dirname表示当前文件所处的目录
const fs = require('fs')
fs.readFile(__dirname+'/files/1.txt','utf8',function(err,dataStr){
console.log(err)
console.log('------------')
console.log(dataStr)
})
2、path路径模块
-
path.join()
方法,用来将多个路径片段拼接成一个完整的路径字符串const path = require('path') const pathStr = path.join('/a','/b/c','../','./d','e') console.log(pathStr) //输出\a\b\d\e ..\会抵消前一个路径 fs.readFile(path.join(__dirname,'/files/1.txt'),'utf8',function(err,dataStr){ })
-
path.basename()
方法,用来从路径字符串中,将文件名解析出来
const path = require('path')
//定义文件的存放路径
const fpath = '/a/b/c/index.html'
const fullName = path.basename(fpath)
console.log(fullName) //index.html
const fullName = path.basename(fpath,'html')
console.log(fullName) //index
path.extname()
获取文件扩展名
const path = require('path')
//定义文件的存放路径
const fpath = '/a/b/c/index.html'
const fext = path.extname(path)
console.log(fext) //.html
3、综合案例
const fs = require('fs')
const path = require('path')
//匹配<style></style>标签的正则表达式
// \s表示空白字符串 \S表示非空白字符 *表示匹配任意次
const regStyle = /<style>[\s\S]*<\/style>
const regScript = /<script>[\s\S]*<\/script>
//读取需要被处理的HTML文件
fs.readFile(path.join(__dirname,'./index.hrml'),'utf8',(err,dataStr) = >{
if(err){
return console.log('读取文件失败'+err.message)
}
resolveCSS(dataStr)
resolveJS(dataStr)
resolveHTML(dataStr)
})
//定义处理css样式的方法
function resolveCSS(htmlStr){
//使用正则提取需要的内容
const r1 = regStyle.exec(htmlStr)
//将提取出来的样式字符串,进行字符串的replace操作
const newCSS = r1[0].replace('<style>','').replace('</style>','')
//调用fs.writeFile()方法,将提取的样式,写入到clock目录中 index.css 的文件里面
fs.writeFile(path.join(__dirname,'./clock/index.css'),newCSS,function(err){
if(err)return console.log('写入样式失败'+err.message)
console.log('成功')
})
}
4、http模块
//导入http模块
const http = require('http')
//创建web服务器实例
const server = http.createServer()
//为服务器实例,绑定request事件,监听客户端的请求
//req是请求对象,它包含了与客户端相关的数据和属性
//req.url 是客户端请求的URL地址
//req.methods是客户端的method请求类型
server.on('request',function(req,res){
console.log('somone visit our web server')
})
//请求服务器
server.listen(8080,function(){
console.log('server running at http://127.0.0.1:8080')
})
解决中文乱码问题
res.setHeader('Content-Type','text/html;charset=utf-8')
5、模块化
5.1 模块化好处
模块化:是指解决一个复杂问题时,自顶逐层的把系统划分成若干模块的过程,对于整个系统来说,模块时可组合、分解和更换的单元。
复用性,可维护性,按需加载方便调用
5.2模块化规范
5.3 Node中的模块化
- 内置模块
- 自定义模块
- 第三方模块
1、加载模块
const fs = require('fs')
2、模块作用域
只能在当前模块被访问。防止全局变量污染问题
3、向外共享模块作用域中的成员
module对象
module.exports ={
name:'zf',
}
4、模块化规范。CommonJS模块化规范。
- 每个模块内部,module变量代表当前模块 。
- module 变量是一个对象,它的exports 属性(module.exports)是对外的接口。
- 加载某个模块,其实是加载该模块的module.exports属性。require()方法用于加载模块。
5.4 npm 与 包
6、Expres
1.创建基本的Web服务器
const express = require('express')
const app = express()
app.listen(80,()=>{
console.log('服务器已经启动!')
})
2、监听GET,POST请求
app.get('请求URL',(req,res)=>{
})
app.post('请求URL',(req,res)=>{
})
3、把内容响应给客户端 res.send(),可以把处理好的内容,发送给客户端。
app.get('/user',(req,res)=>{
//向客户端发送 JSON 对象
res.send({name:'zs',age:20})
})
app.post('/user',(req,res)=>{
//向客户端发送 JSON 对象
res.send({name:'zs',age:20})
})
4、获取URL中携带的查询参数
通过req.query对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数。
app.get('/user'()=>{
//req.query默认是一个空对象
//客户端使用 ?name=zs&age=20 这种查询字符串形式,发送到服务器的参数
//可以通过 req.query 对象访问到
//req.query.name req.query.age
console.log(req.query)
})
5、获取URL的动态参数
req.params对象 **: **匹配到的动态参数
app.get('/user/:id',()=>{
console.log(req.params)
res.send(req.params)
})
请求127.0.0.1/user/1
打印 {id:'1'}
6.1 express.static()快速 对外提供静态资源
app.use(express.static('./public'))
挂载路径前缀
app.use('public',express.static('./public'))
6.2 nodemon
npm i -g nodemon
nodemon app.js 代码保存后,会自动更新服务器
6.3 路由
客户端的请求与服务器处理函数之间的映射关系
app.METHOD(PATH,HANDLER)
请求类型 请求的URL地址 处理函数
6.4 路由模块
-
创建路由模块对应的 .js 文件
-
调用 express.Router() 函数创建路由
-
向路由对象上挂载具体的路由
-
使用 module.exports 向外共享路由对象
-
使用 app.use() 函数注册路由模块
var express = require('express') //导入express
var router = express.Router() //创建路由对象
router.get('/user/list',(req,res)=>{ //挂载获取用户列表的路由
res.send('得到用户列表')
})
router.post('/user/add',(req,res)=>{ //挂载添加用户的路由
res.send('添加新用户')
})
modules.exports = router //向外导出路由对象
使用 导入
const router = require('./router')
app.use('/api',router)
6.5 中间件
//中间件函数
app.get('/',(req,res,next) => {
next()
})
全局生效中间件
app.use((req,res,next)=>{
console.log('简单中间件')
next()
})
中间件作用,共享一份req,res
app.use((req,res,next) => {
//获取到请求到达服务器的时间
const time = Date.now()
//为req对象,挂载自定义属性,从而把时间共享给后面的所有路由
req.startTime = time
next()
})
局部生效的中间件
const mw1 = (req,res,next) => {
console.log('这是中间件函数')
next()
}
//mw1 这个中间件只在当前路由中生效,这种用法属于局部生效的中间件
app.get('/',mw1,(req,res) => {
res.send('home page')
})
//mw1 这个中间件不会影响下面这个路由
app.get('/user',(req,res) => {
res.send('user page')
})
- 路由之前注册中间件
- 客户端发送过来的请求,可以连续调用多个中间件进行处理
- 执行完中间件的业务代码之后,不要忘记调用next()函数
- 为了防止代码逻辑混乱,调用next()函数后不要写额外的代码
- 连续调用,多个中间件时,多个中间件,共享req,res对象
6.6 中间件的分类
1、应用级别的中间件
通过app.use() 或 app.get() 或 app.post() ,绑定到app实例上面的中间件,叫做应用级别的中间件。
2、路由级别的中间件
绑定 express.Router() 实例上面的中间件,叫做路由级别的中间件。
var router = express.Router()
3、错误级别的中间件
专门捕获整个项目中发生的异常错误,防止项目异常崩溃。错误级别中间件必须注册在所有路由之后
app.get('/',(req,res)=>{ //1.路由
throw new Error('服务器内部发生错误')//2.抛出一个自定义的错误
res.send('home page')
})
app.use((err,req,res,next)=>{//3.错误级别的中间件
console.log('发生了错误:'+ err.message)//4.在服务器打印错误消息
res.send('Error!'+ err.message)//5.向客户端响应错误相关的内容
})
4、内置中间件 4.16.0版本+
- expres.static:快速托管静态资源的内置中间件
- express.json:解析JSON格式的请求数据----兼容性
- express.urlencodeed:解析URL-encoded格式的请求体数据----兼容性
app.use(express.json())
//req.body 来获取 JSON 格式的表单数据和url-encoded格式的数据
app.use(express.urlencodeed({extended:false}))
5、第三方的中间件
6.7 自定义中间件
在中间件中,需要监听req对象的data事件,来获取客户端发送到服务器的数据
数据量大,则客户端会把数据切割后,分批发送到服务器。
所以data事件可能会触发多次,每一次触发data事件,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。
const express = require('express')
const app = express()
const qs = require('querystring')
app.use((req,res,next) => {
let str = '' //定义一个字符串,专门存储客户端发送过来的请求体数据
req.on('data',(chunk) => { //每次触发data都会把,数据存储在str中。
//拼接请求体数据
str += chunk
})
req.end('end',()=>{ //监听end事件,结束后打印全部数据
//把字符串格式的请求体数据,解析成对象格式。
const body = qs.parse(str)
req.body = body
//console.log(body)
next()
})
})
app.post('/user',(req,res)=>{
res.end('req.body')
})
将自定义中间件封装为模块------创建一个 .js文件
const qs = require('querystring')
const bodyParser = (req,res,next) => {
let str = '' //定义一个字符串,专门存储客户端发送过来的请求体数据
req.on('data',(chunk) => { //每次触发data都会把,数据存储在str中。
//拼接请求体数据
str += chunk
})
req.end('end',()=>{ //监听end事件,结束后打印全部数据
//把字符串格式的请求体数据,解析成对象格式。
const body = qs.parse(str)
req.body = body
//console.log(body)
next()
})
}
module.exports = bodyParser
//使用:导入自己封装的中间件函数,注册为全局可用的中间件
cosnt customBodyParser = require(./xx.js)
app.use(customBodyParser)
6.8 使用Express写接口 GET-POST
1、创建app.js文件
const express = require('express')
const app =express()
//导入路由模块
const router = require('./apiRouter')
//把路由模块,注册到app上
app.use('/api',router)
app.listen(80,()=>{
console.log('服务器已经启动')
})
2、创建API路由模块-----apiRouter.js
const express = require('express')
const router = express.Router
//挂载路由处
router.get('/get',(req,res) => {
//通过req.query获取客户端通过查询字符串,发送到服务器的数据
const query = req.query
//调用res.send方法,向客户端响应处理的结果
res.send({
status:0,//0表示处理成功 ,1表示处理失败
msg:'GET请求成功', .//状态描述
data:query //响应给客户端的数据
})
})
router.post('/post',(req,res) => {
//通过req.body获取客户端通过请求体,发送到服务器的URL-encoded数据,配置中间app.use(express.urlencoded({extended:fasle}))
const body = req.body
//调用res.send方法,向客户端响应处理的结果
res.send({
status:0,//0表示处理成功 ,1表示处理失败
msg:'POST请求成功', .//状态描述
data:body //响应给客户端的数据
})
})
module.exports = router
1、跨域问题---cors
npm i coars
const cors = require('cors')
- 在路由前调用
app.use(cors())
<html>
<head>
<script>
</script>
</head>
<body>
<button id="btnGET">
GET
</button>
<button id="btnPOST">
POST
</button>
<script>
$(function () {
$('#btnGET').on('click',function (){
$ajax({
type:'GET',
url:"http://127.0.0.1/api/get",
data:{name:'zd',age:20},
sucess: function (res) {
console.log(res)
}
})
})
})
$(function () {
$('#btnPOST').on('click',function (){
$ajax({
type:'POST',
url:"http://127.0.0.1/api/post",
data:{bookname:'谁属中国哑巴',age:23},
sucess: function (res) {
console.log(res)
}
})
})
})
</script>
</body>
</html>
- Access-Control-Allow-Origin字段的值为通配符*,表示允许来自任何域的请求。
res.setHeader('Access-Control-Allow-Origin','*')
- Access-Control-Allow-Headers,只支持客户端向服务器发送九个请求头
``````res.setHeader('Access-Control-Allow-Headers','Content-Type,X-Custom-Header')```
- Access-Control-Allow-Methods,如果希望通过PUT,DELETE等方式请求服务器的资源,则需要在服务器端,通过这个来指明实际请求所允许使用的HTTP方法
``````res.setHeader('Access-Control-Allow-Methods','*')```
7、数据库
id | username | password | status |
---|---|---|---|
1 | 张三 | 123456 | 0 |
2 | 李四 | 341125 | 1 |
3 | 托尼史塔克 | 7758258 | 1 |
1、查
select 列名 from 表名
select * from users /*查所有*/
select id from users
2、增
insert into 表名 (列1,列2,列3) values (值1,值2,值3)
insert into users (username,password) values ('托尼史塔克','20202020')
3、改
update 表名称 set 列名称 = 新值 where 列名称 = 某值 where更新的条件
update users set username='美国队长' where id=1
update users set username='雷神',password='7758258' where id=2
4、删
delete from 表名称 where 列名称 = 值
delete from users where id=3
5、where子句:限定选择的标准
select * from users where id>1
6、and 和 or 运算符 相当于 || 和 &&
select * from users where id>1 and status=1
7、order by 语句,更具指定的列,进行排序,默认升序排序,asc关键字代表升序排序
升序排序:select * from users order by status asc
降序排序:select * from users order by id desc
多重排序:select * from users order by status desc, username asc
8、count(*)函数,总数据条数
```select count(*) from users where status=1``
返回值 count=2
9、使用as为列设置别名
select count(*) as total from users where staus=1
8、使用 mysql
//安装 npm imysql
//导入
const mysql = require('mysql')
cosnt db = mysql.createPool({
host:'127.0.0.1',
user:'root',
password:'admin2022!',
database:'test'
})
module.exports = db
1、查询数据
const str1 = 'select * from users'
//查询表中数据
db.query(str1,(err,results) => {
if(err) return console.log(err.message)
console.log(results)
})
2、插入数据
//要插入到users表中的数据对象
const user = {username:'Doctor Strange',password:'123456'}
//待执行的SQL语句,其中英文的 ? 表示占位符
const sqlStr = 'insert into users (username,password) values (?,?)'
//使用数组的形式,依次为 ? 占位符指定的具体的值
db.query(sqlStr,[user.username,user.password],(err,results) => {
if(err) return console.log(err.message)
if(result.affectedRows ===1){ //判断数据是否插入成功
console.log('插入数据成功')
}
})
快速插入
//要插入到users表中的数据对象
const user = {username:'Doctor Strange',password:'123456'}
//待执行的SQL语句,其中英文的 ? 表示占位符
const sqlStr = 'insert into users set ?'
//使用数组的形式,依次为 ? 占位符指定的具体的值
db.query(sqlStr,user,(err,results) => {
if(err) return console.log(err.message)
if(result.affectedRows ===1){ //判断数据是否插入成功
console.log('插入数据成功')
}
})
3、更新数据
const user = {id:4,username:'Doctor Strange',password:'123456'}
const sqlStr = 'update users set username=?,password=? where id=?'
db.query(sqlStr,[user.username,user.password,user.id],(err,results) => {
if(err) return console.log(err.message)
if(result.affectedRows ===1){ //判断数据是否插入成功
console.log('更新数据成功')
}
})
便捷方式
const user = {id:4,username:'Doctor Strange',password:'123456'}
const sqlStr = 'update users set ? where id=?'
db.query(sqlStr,[user,user.id],(err,results) => {
if(err) return console.log(err.message)
if(result.affectedRows ===1){ //判断数据是否插入成功
console.log('更新数据成功')
}
})
4、删除数据
const sqlStr = 'delete from users where id=?'
db.query(sqlStr,2,(err,results) => {
if(err) return console.log(err.message)
if(result.affectedRows ===1){ //判断数据是否插入成功
console.log('删除数据成功')
}
})
标记删除
const sqlStr = 'update users set status=? where id=?'
8、身份认证
cookie:存储在用户浏览器中的不超过4kb的字符串。
自动发送,域名独立,过期时限。
图解
浏览器(客户端) ------------>>>>>>登录请求--------------->>>>>服务器
浏览器(客户端)---------------<<<<<<通过响应头,发送Cookie给浏览器------<<<<---服务器
浏览器(将身份认证的cookie保存到浏览器中)--->>>通过请求头,自动将cookie发送给服务器----->>服务器(服务器根据请求头中cookie,验明用户的身份)------>>>>响应当前用户对应的内容
Session的工作原理
在浏览器中进行登录----提交账号和密码到服务器-----服务器验证账号和密码-----将登录成功后的用户信息存储在服务器内存中,同时生成对应的cookie字符串------将生成的cookie响应给客户端-----浏览器自动把cookie存储在当前域名下----客户端再次发送请求时,通过请求头自动把当前域名下所有可用的cookie发送给服务器----服务器根据请求头中携带的cookie,从内存中查找对应的用户信息------用户的身份信息认证成功之后,服务器针对当前用户生成特定的响应内容------把当前用户对应的页面内容响应给浏览器。
JWT认证机制
1、jwt工作原理
在浏览器中进行登录----提交账号和密码到服务器-----服务器验证账号和密码-----验证通过后将用户信息加密之后生成对应的Token字符串------将生成的Token响应给客户端-----将Token存储到LocalStorage或SessionStorage----客户端再次发送请求时,通过请求头的Authorization字段,将Token发送给服务器----服务器把Token字符串还原成用户的信息对象------用户的身份信息认证成功之后,服务器针对当前用户生成特定的响应内容------把当前用户对应的页面内容响应给浏览器。
2、jwt组成部分,逗号分割
Header.Payload.Signature
Payload:才是真正的用户信息
Header、Signature保证Token的安全性
3、使用方式
Authorization:Bearer <token>
在express中使用
npm i jsonwebtoken express-jwt
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// TODO_01:安装并导入 JWT 相关的两个包,分别是 jsonwebtoken 和 express-jwt
const jwt = require('jsonwebtoken')
const expressJWT = require('express-jwt')
// 允许跨域资源共享
const cors = require('cors')
app.use(cors())
// 解析 post 表单数据的中间件
const bodyParser = require('body-parser')
app.use(bodyParser.urlencoded({ extended: false }))
// TODO_02:定义 secret 密钥,建议将密钥命名为 secretKey
const secretKey = 'zhangfan520'
// TODO_04:注册将 JWT 字符串解析还原成 JSON 对象的中间件
// 注意:只要配置成功了express-jwt这个中间件,就可以把解析出来的用户信息,挂载到req.user属性上
app.use(expressJWT({secret: secretKey }).unless({ path: [/^\/api\//] }))
// 登录接口
app.post('/api/login', function (req, res) {
// 将 req.body 请求体中的数据,转存为 userinfo 常量
const userinfo = req.body
// 登录失败
if (userinfo.username !== 'admin' || userinfo.password !== '000000') {
return res.send({
status: 400,
message: '登录失败!'
})
}
// 登录成功
const tokenStr = jwt.sign({ username: userinfo.username }, secretKey, { expiresIn: '1h' })
// TODO_03:在登录成功之后,调用 jwt.sign() 方法生成 JWT 字符串。并通过 token 属性发送给客户端
res.send({
status: 200,
message: '登录成功!',
token: tokenStr // 要发送给客户端的 token 字符串
})
})
// 这是一个有权限的 API 接口
app.get('/admin/getinfo', function (req, res) {
// TODO_05:使用 req.user 获取用户信息,并使用 data 属性将用户信息发送给客户端
console.log(req.user)
res.send({
status: 200,
message: '获取用户信息成功!',
data: req.user // 要发送给客户端的用户信息
})
})
// TODO_06:使用全局错误处理中间件,捕获解析 JWT 失败后产生的错误
app.use((err,req,res,next)=>{
if(err.name === 'UnauthorizedError'){
return res.send({
status:401,
message:'无效的Token'
})
}
res.send({
status:500,
message:'未知的错误'
})
})
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(8888, function () {
console.log('Express server running at http://127.0.0.1:8888')
})
9、接口项目
1. 项目初始化
1.1 创建项目
- 新建
api_server
文件夹作为项目根目录,并在项目根目录中运行如下的命令,初始化包管理配置文件:
npm init -y
- 运行如下的命令,安装特定版本的
express
:
npm i [email protected]
- 在项目根目录中新建
app.js
作为整个项目的入口文件,并初始化如下的代码:
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// write your code here...
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(3000, ()=> {
console.log('服务器启动在 http://127.0.0.1:3000')
})
1.2 配置 cors 跨域
- 运行如下的命令,安装
cors
中间件:
npm i [email protected]
- 在
app.js
中导入并配置cors
中间件:
const cors = require('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
文件,作为用户的路由模块,并初始化代码:
const express = require('express')
// 创建路由对象
const router = express.Router()
// 注册新用户
router.post('/register', (req, res) => {
res.send('register OK')
})
// 登录
router.post('/login', (req, res) => {
res.send('login OK')
})
//共享
module.exports = router
- 在
app.js
中,导入注册用户路由模块 :
//导入express
const express = require('express')
// 创建 express 的服务器实例
const app = express()
// 导入cors
const cors = require('cors')
// 将cors注册成全局中间件
app.use(cors())
// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))
// 导入并使用用户的路由模块
const userRouter = require('./router/user')
app.use('/api',userRouter)
// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(3000, () => {
console.log('服务器启动在 http://127.0.0.1:3000')
})
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 表
- 在
test
数据库中,新建ev_users
表如下:
2.2 安装并配置 mysql 模块
在 API 接口项目中,需要安装并配置
mysql
这个第三方模块,来连接和操作 MySQL 数据库
- 运行如下命令,安装
mysql
模块:
npm i [email protected]
- 在项目根目录中新建
/db/index.js
文件,在此自定义模块中创建数据库的连接对象:
const mysql = require('mysql')
// 创建数据库连接对象
const db = mysql.createPool({
host: '127.0.0.1',
user: 'root',
password: 'admin2022!',
database: 'test',
})
// 向外共享 db 数据库连接对象
module.exports = db
2.3 注册
2.3.0 实现步骤
- 检测表单数据是否合法
- 检测用户名是否被占用
- 对密码进行加密处理
- 插入新用户
2.3.1 检测表单数据是否合法 router_handler中的user.js
- 判断用户名和密码是否为空
// 注册用户的处理函数
exports.regUser = (req, res) => {
// 获取客户端提交到服务器的用户信息
const userinfo = req.body
// 对表单中的数据,进行合法性的校验:判断用户名和密码是否为空
if(!userinfo.username || !userinfo.password){
return res.send({
status:1,
message:'用户名或密码不合法!'
})
}
res.send('reguser OK')
}
2.3.2 检测用户名是否被占用
- 导入数据库操作模块:
const db = require('../db/index')
- 定义 SQL 语句:
const sql = `select * from ev_users where username=?`
- 执行 SQL 语句并根据结果判断用户名是否被占用:
/**
* 在这里定义和用户相关的路由处理函数,供 /router/user.js 模块进行调用
*/
// 导入数据库操作模块
const db = require('../db/index');
// 注册用户的处理函数
exports.regUser = (req, res) => {
// 获取客户端提交到服务器的用户信息
const userinfo = req.body
// 对表单中的数据,进行合法性的校验:判断用户名和密码是否为空
if (!userinfo.username || !userinfo.password) {
return res.send({
status: 1,
message: '用户名或密码不合法!'
})
}
// 定义sql语句,查询用户名是否被占用 查询语句results是数组
const sqlStr = 'select * from ev_users where username=?'
db.query(sqlStr, userinfo.username, (err, results) => {
// 执行sql语句失败
if (err) {
return res.send({
status: 1,
message: err.message
})
}
// 判断用户名是否被占用
if (results.length > 0) {
return res.send({
status: 1,
message: '用户名被占用,请重新输入!'
})
}
// 用户名可以使用
})
}
// 登录的处理函数
exports.login = (req, res) => {
res.send('login OK')
}
测试
2.3.3 对密码进行加密处理
为了保证密码的安全性,不建议在数据库以
明文
的形式保存用户密码,推荐对密码进行加密存储
在当前项目中,使用 bcryptjs
对用户密码进行加密,优点:
- 加密之后的密码,无法被逆向破解
- 同一明文密码多次加密,得到的加密结果各不相同,保证了安全性
- 运行如下命令,安装指定版本的
bcryptjs
:
npm i [email protected]
- 在
/router_handler/user.js
中,导入bcryptjs
:
const bcrypt = require('bcryptjs')
- 在注册用户的处理函数中,确认用户名可用之后,调用
bcrypt.hashSync(明文密码, 随机盐的长度)
方法,对用户的密码进行加密处理:
// 4、调用 bcrypt.hashSync方法,对用户的密码进行加密处理
userinfo.password = bcrypt.hashSync(userinfo.password,10)
console.log(userinfo)
2.3.4 插入新用户
- 定义插入用户的 SQL 语句:
const sql = 'insert into ev_users set ?'
- 调用
db.query()
执行 SQL 语句,插入新用户:
// 5、定义插入新用户的sql语句
const insertsql = 'insert into ev_users set ?'
// 6、调用db.query()执行sql语句
db.query(insertsql,{username:userinfo.username,password:userinfo.password},(err,results) => {
// 判断sql语句是否执行成功
if(err)return res.send({
status:1,
message:err.message
})
// 判断影响行数是否为1
if(results.affectedRows !== 1)return res.send({
status:1,
message:'注册用户失败,请稍后再试!'
})
// 注册用户成功
res.send({
status:0,
message:'注册成功'
})
})
测试
2.4 优化 res.send() 代码
在处理函数中,需要多次调用
res.send()
向客户端响应处理失败
的结果,为了简化代码,可以手动封装一个 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()
})
优化后的user.js代码
const db = require('../db/index');
const bcrypt = require('bcryptjs')
exports.regUser = (req, res) => {
// 1、获取客户端提交到服务器的用户信息
const userinfo = req.body
// 2、对表单中的数据,进行合法性的校验:判断用户名和密码是否为空
if (!userinfo.username || !userinfo.password) {
return res.send({
status: 1,
message: '用户名或密码不合法!'
})
}
// 3、定义sql语句,查询用户名是否被占用 查询语句results是数组
const sqlStr = 'select * from ev_users where username=?'
db.query(sqlStr, userinfo.username, (err, results) => {
// 执行sql语句失败
if (err) {
return res.cc(err)
}
// 判断用户名是否被占用
if (results.length > 0) {
return res.cc('用户名被占用,请重新输入!')
}
// 4、调用 bcrypt.hashSync方法,对用户的密码进行加密处理
userinfo.password = bcrypt.hashSync(userinfo.password,10)
// 5、定义插入新用户的sql语句
const insertsql = 'insert into ev_users set ?'
// 6、调用db.query()执行sql语句
db.query(insertsql,{username:userinfo.username,password:userinfo.password},(err,results) => {
// 判断sql语句是否执行成功
if(err) return res.cc(err)
// 判断影响行数是否为1
if(results.affectedRows !== 1) return res.cc('注册用户失败,请稍后再试!')
res.cc('注册成功!',0)
})
})
}
// 登录的处理函数
exports.login = (req, res) => {
res.send('login OK')
}
2.5 优化表单数据验证
表单验证的原则:前端验证为辅,后端验证为主,后端永远不要相信前端提交过来的任何内容
在实际开发中,前后端都需要对表单的数据进行合法性的验证,而且,后端做为数据合法性验证的最后一个关口,在拦截非法数据方面,起到了至关重要的作用。
单纯的使用 if...else...
的形式对数据合法性进行验证,效率低下、出错率高、维护性差。因此,推荐使用第三方数据验证模块,来降低出错率、提高验证的效率与可维护性,让后端程序员把更多的精力放在核心业务逻辑的处理上。
- 安装
joi
包,为表单中携带的每个数据项,定义验证规则:
npm install joi
- 安装
@escook/express-joi
中间件,来实现自动对表单数据进行验证的功能:
npm i @escook/express-joi
- 新建
/schema/user.js
用户信息验证规则模块,并初始化代码如下:
const joi = require('joi')
/**
* string() 值必须是字符串
* alphanum() 值只能是包含 a-zA-Z0-9 的字符串
* min(length) 最小长度
* max(length) 最大长度
* required() 值是必填项,不能为 undefined
* pattern(正则表达式) 值必须符合正则表达式的规则
*/
// 用户名的验证规则
const username = joi.string().alphanum().min(1).max(10).required()
// 密码的验证规则
const password = joi
.string()
.pattern(/^[\S]{6,12}$/)
.required()
// 注册和登录表单的验证规则对象
exports.reg_login_schema = {
// 表示需要对 req.body 中的数据进行验证
body: {
username,
password,
},
}
- 修改
/router/user.js
中的代码如下:
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('joi')
// 错误中间件
app.use(function (err, req, res, next) {
// 数据验证失败
if (err instanceof joi.ValidationError) return res.cc(err)
// 未知错误
res.cc(err)
})
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 语句,查询用户的数据:
// 登录的处理函数
exports.login = (req, res) => {
// 接受表单的数据
const userinfo = req.body
// 定义sql语句
const selsql = 'select * from ev_users where username =?'
// 执行sql语句,根据用户名查询用户信息
db.query(selsql,userinfo.username,(err,results) => {
// 执行sql语句失败
if(err) return res.cc(err)
// 执行sql语句成功,但是获取的数据条数不等于1
if(results.length !== 1) return res.cc('登陆失败!')
// 判断密码是否正确
res.send('login ok')
})
}
2.6.3 判断用户输入的密码是否正确
核心实现思路:调用
bcrypt.compareSync(用户提交的密码, 数据库中的密码)
方法比较密码是否一致
返回值是布尔值(true 一致、false 不一致)
具体的实现代码如下:
// 登录的处理函数
exports.login = (req, res) => {
// 接受表单的数据
const userinfo = req.body
// 定义sql语句
const selsql = 'select * from ev_users where username =?'
// 执行sql语句,根据用户名查询用户信息
db.query(selsql, userinfo.username, (err, results) => {
// 执行sql语句失败
if (err) return res.cc(err)
// 执行sql语句成功,但是获取的数据条数不等于1
if (results.length !== 1) return res.cc('登陆失败!')
// 判断密码是否正确
// 拿着用户输入的密码,和数据库中存储的密码进行对比
const compareResult = bcrypt.compareSync(userinfo.password, results[0].password)
// 如果对比的结果等于 false, 则证明用户输入的密码错误
if (!compareResult) {
return res.cc('登录失败!')
}
// TODO:登录成功,生成 Token 字符串
})
}
// TODO:登录成功,生成 Token 字符串
2.6.4 生成 JWT 的 Token 字符串
核心注意点:在生成 Token 字符串的时候,一定要剔除 密码 和 头像 的值
1.通过 ES6 的高级语法,快速剔除 密码
和 头像
的值:
// 剔除完毕之后,user 中只保留了用户的 id, username, nickname, email 这四个属性的值
const user = { ...results[0], password: '', user_pic: '' }
2.运行如下的命令,安装生成 Token 字符串的包:
npm i [email protected]
3.在 /router_handler/user.js
模块的头部区域,导入 jsonwebtoken
包:
// 用这个包来生成 Token 字符串
const jwt = require('jsonwebtoken')
4.创建 config.js
文件,并向外共享 加密 和 还原 Token 的 jwtSecretKey
字符串:
module.exports = {
// 加密和解密token的密钥
jwtSecretKey: 'zhangfan520',
}
5.将用户信息对象加密成 Token 字符串:
// 导入配置文件
const config = require('../config')
// 生成 Token 字符串
const tokenStr = jwt.sign(user, config.jwtSecretKey, {
expiresIn: '10h', // token 有效期为 10 个小时
})
6.将生成的 Token 字符串响应给客户端:
res.send({
status: 0,
message: '登录成功!',
// 为了方便客户端使用 Token,在服务器端直接拼接上 Bearer 的前缀
token: 'Bearer ' + tokenStr,
})
exports.login = (req, res) => {
// 接受表单的数据
const userinfo = req.body
// 定义sql语句
const selsql = 'select * from ev_users where username =?'
// 执行sql语句,根据用户名查询用户信息
db.query(selsql, userinfo.username, (err, results) => {
// 执行sql语句失败
if (err) return res.cc(err)
// 执行sql语句成功,但是获取的数据条数不等于1
if (results.length !== 1) return res.cc('登陆失败!')
// 判断密码是否正确
// 拿着用户输入的密码,和数据库中存储的密码进行对比
const compareResult = bcrypt.compareSync(userinfo.password, results[0].password)
// 如果对比的结果等于 false, 则证明用户输入的密码错误
if (!compareResult) {
return res.cc('登录失败!')
}
// TODO:登录成功,生成 Token 字符串
const user = {...results[0],password: '',user_pic:''}
const tokenStr = jwt.sign(user,config.jwtSecretKey,{expiresIn:config.expiresIn})
//调用res.send() 将Token响应给客户端
res.send({
status:0,
message:'登录成功,欢迎回来!',
token:'Bearer ' + tokenStr
})
})
}
2.7 配置解析 Token 的中间件
1.运行如下的命令,安装解析 Token 的中间件:
npm i [email protected]
2.在 app.js
中注册路由之前,配置解析 Token 的中间件:
// 导入配置文件
const config = require('./config')
// 解析 token 的中间件
const expressJWT = require('express-jwt')
// 使用 .unless({ path: [/^\/api\//] }) 指定哪些接口不需要进行 Token 的身份认证
app.use(expressJWT({ secret: config.jwtSecretKey }).unless({ path: [/^\/api\//] }))
3.在 app.js
中的 错误级别中间件
里面,捕获并处理 Token 认证失败后的错误:
// 定义错误级别的中间件
app.use(function (err, req, res, next) {
// 数据验证失败
if (err instanceof joi.ValidationError) return res.cc(err)
// 捕获身份认证失败的错误
if (err.name === 'UnauthorizedError') return res.cc('身份认证失败!')
// 未知错误
res.cc(err)
})
3. 个人中心
3.1 获取用户的基本信息
3.1.0 实现步骤
- 初始化 路由 模块
- 初始化 路由处理函数 模块
- 获取用户的基本信息
3.1.1 初始化路由模块
- 创建
/router/userinfo.js
路由模块,并初始化如下的代码结构:
// 导入 express
const express = require('express')
// 创建路由对象
const router = express.Router()
// 获取用户的基本信息
router.get('/userinfo', (req, res) => {
res.send('获取用户列表成功')
})
// 向外共享路由对象
module.exports = router
- 在
app.js
中导入并使用个人中心的路由模块:
// 导入并使用用户信息路由模块
const userinfoRouter = require('./router/userinfo')
// 注意:以 /my 开头的接口,都是有权限的接口,需要进行 Token 身份认证
app.use('/my', userinfoRouter)
测试:/my请求都需要携带认证
3.1.2 初始化路由处理函数模块
1.创建 /router_handler/userinfo.js
路由处理函数模块,并初始化如下的代码结构:
// 获取用户基本信息的处理函数
exports.getUserInfo = (req, res) => {
res.send('ok')
}
2.修改 /router/userinfo.js
中的代码如下:
const express = require('express')
const router = express.Router()
// 导入用户信息的处理函数模块
const userinfo_handler = require('../router_handler/userinfo')
// 获取用户的基本信息
router.get('/userinfo', userinfo_handler.getUserInfo)
module.exports = router
3.1.3 获取用户的基本信息
- 在
/router_handler/userinfo.js
头部导入数据库操作模块:
// 导入数据库操作模块
const db = require('../db/index')
- 定义 SQL 语句:
// 根据用户的 id,查询用户的基本信息
// 注意:为了防止用户的密码泄露,需要排除 password 字段
const sql = `select id, username, nickname, email, user_pic from ev_users where id=?`
- 调用
db.query()
执行 SQL 语句:
// 注意:req 对象上的 user 属性,是 Token 解析成功,express-jwt 中间件帮我们挂载上去的
db.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')
}
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
模块中,导入需要的验证规则对象:
// 导入需要的验证规则对象
const { update_userinfo_schema, update_password_schema } = require('../schema/user')
- 并在
重置密码的路由
中,使用update_password_schema
规则验证表单的数据,示例代码如下:
router.post('/updatepwd', expressJoi(update_password_schema), userinfo_handler.updatePassword)
3.3.3 实现重置密码的功能
router_handler文件下的userinfo文件
- 根据
id
查询用户是否存在:
// 定义根据 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:判断提交的旧密码是否正确
results.cc('修改ok')
})
- 判断提交的 旧密码 是否正确:
// 在头部区域导入 bcryptjs 后,
// 即可使用 bcrypt.compareSync(提交的密码,数据库中的密码) 方法验证密码是否正确
// compareSync() 函数的返回值为布尔值,true 表示密码正确,false 表示密码错误
const bcrypt = require('bcryptjs')
// 判断提交的旧密码是否正确
const compareResult = bcrypt.compareSync(req.body.oldPwd, results[0].password)
if (!compareResult) return res.cc('原密码错误!')
res.cc('ok')
测试
- 对新密码进行
bcrypt
加密之后,更新到数据库中:
// 定义更新用户密码的 SQL 语句
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 更新用户头像
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
的验证规则如下:
// dataUri() 指的是如下格式的字符串数据:
// 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)
3.4.3 实现更新用户头像的功能
- 定义更新用户头像的 SQL 语句:
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)
})
测试
4. 文章分类管理
4.1 新建 ev_article_cate 表
4.2 获取文章分类列表
4.2.0 实现步骤
- 初始化路由模块
- 初始化路由处理函数模块
- 获取文章分类列表数据
4.2.1 初始化路由模块
- 创建
/router/artcate.js
路由模块,并初始化如下的代码结构:
// 导入 express
const 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/article
app.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 语句:
// 根据分类的状态,获取所有未被删除的分类列表数据
// is_delete 为 0 表示没有被 标记为删除 的数据
const sql = 'select * from ev_article_cate where is_delete=0 order by id asc'
- 调用
db.query()
执行 SQL 语句:
db.query(sql, (err, results) => {
// 1. 执行 SQL 语句失败
if (err) return res.cc(err)
// 2. 执行 SQL 语句成功
res.send({
status: 0,
message: '获取文章分类列表成功!',
data: results,
})
})
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('joi')
// 定义 分类名称 和 分类别名 的校验规则
const name = joi.string().required()
const alias = joi.string().alphanum().required()
// 校验规则对象 - 添加分类 req.body
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)
4.3.3 查询分类名称与别名是否被占用
artcates.js
- 定义查重的 SQL 语句:
// 定义查询 分类名称 与 分类别名 是否被占用的 SQL 语句
const sql = `select * from ev_article_cate where name=? or alias=?`
- 调用
db.query()
执行查重的操作:
// 执行查重操作
db.query(sql, [req.body.name, req.body.alias], (err, results) => {
// 执行 SQL 语句失败
if (err) return res.cc(err)
// 判断 分类名称 和 分类别名 是否被占用
if (results.length === 2) 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:新增文章分类
})
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 { delete_cate_schema } = require('../schema/artcate')
// 删除文章分类的路由
router.get('/deletecate/:id', expressJoi(delete_cate_schema), artcate_handler.deleteCateById)
4.4.3 实现删除文章分类的功能
- 定义删除文章分类的 SQL 语句:
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)
})
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 实现获取文章分类的功能
在router_handler文件夹下的artcate.js中
- 定义根据 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],
})
})
4.6 根据 Id 更新文章分类数据
4.6.0 实现步骤
- 定义路由和处理函数
- 验证表单数据
- 查询
分类名称
与分类别名
是否被占用 - 实现更新文章分类的功能
4.6.1 定义路由和处理函数
- 在
/router/artcate.js
模块中,添加更新文章分类
的路由:
// 更新文章分类的路由
router.post('/updatecate', artcate_handler.updateCateById)
- 在
/router_handler/artcate.js
模块中,定义并向外共享更新文章分类
的路由处理函数:
// 更新文章分类的处理函数
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 语句:
// 定义查询 分类名称 与 分类别名 是否被占用的 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)
// 判断 分类名称 和 分类别名 是否被占用
if (results.length === 2) 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:更新文章分类
})
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('更新文章分类成功!', 0)
})
5. 文章管理
5.1 新建 ev_articles 表
5.2 发布新文章
5.2.0 实现步骤
- 初始化路由模块
- 初始化路由处理函数模块
- 使用 multer 解析表单数据
- 验证表单数据
- 实现发布文章的功能
5.2.1 初始化路由模块
- 创建
/router/article.js
路由模块,并初始化如下的代码结构:
// 导入 express
const 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/article
app.use('/my/article', articleRouter)
5.2.2 初始化路由处理函数模块
- 创建
/router_handler/article.js
路由处理函数模块,并初始化如下的代码结构:
// 发布新文章的处理函数
exports.addArticle = (req, res) => {
res.send('ok')
}
- 修改
/router/article.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 [email protected]
- 在
/router_handler/article.js
模块中导入并配置multer
:
// 导入解析 formdata 格式表单数据的包
const multer = require('multer')
// 导入处理路径的核心模块
const path = require('path')
// 创建 multer 的实例对象,通过 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')
})
5.2.4 验证表单数据
实现思路:通过 express-joi 自动验证 req.body 中的文本数据;通过 if 判断手动验证 req.file 中的文件数据;
- 创建
/schema/article.js
验证规则模块,并初始化如下的代码结构:
// 导入定义验证规则的模块
const joi = require('joi')
// 定义 标题、分类Id、内容、发布状态 的验证规则
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 实现发布文章的功能
- 整理要插入数据库的文章信息对象:
// 导入处理路径的 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,
}
- 定义发布文章的 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'))
6、websocket
const express = require('express');
const WebSocket = require('ws');
const app = express();
// 创建websocket服务器
const wss = new WebSocket.Server({ port: 8080 });
// 监听websocket连接事件
wss.on('connection', function connection(ws) {
console.log('websocket connected');
// 监听websocket消息事件
ws.on('message', function incoming(message) {
console.log('received: %!s(MISSING)', message);
});
// 发送消息
ws.send('something');
});
// 创建express服务器
app.get('/', function (req, res) {
res.send('Hello World');
});
// 监听express服务器端口
app.listen(3000, function () {
console.log('Example app listening on port 3000!');
});
在上面的代码中,我们创建了一个websocket服务器,监听了端口8080,并且在连接事件中打印了一条日志。同时,我们也创建了一个express服务器,监听了端口3000,并且返回了一个Hello World的字符串。
可以看到,在websocket中,我们可以通过监听connection事件来处理连接,同时也可以通过监听message事件来处理消息。在这个示例中,我们只是简单地打印了一条日志和发送了一条消息。在实际应用中,我们可以根据业务需求来处理这些事件。
在使用websocket改造express后端接口的时候,我们可以将原来的请求接口改为websocket接口,并且在连接和消息事件中处理业务逻辑。需要注意的是,websocket是一种长连接方式,需要考虑到连接的稳定性和性能问题。
标签:node,const,err,res,req,学习,router,路由 From: https://www.cnblogs.com/fanjiang/p/17516161.html