新建 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(3007, function () { console.log('api server running at <http://127.0.0.1:3007>')})
运行如下的命令,安装 cors
中间件:
npm i [email protected]
在 app.js
中导入并配置 cors
中间件:
const cors = require('cors')
app.use(cors())
通过如下的代码,配置解析 application/x-www-form-urlencoded
格式的表单数据的中间件:
app.use(express.urlencoded({ extended: false }))
在项目根目录中,新建 router
文件夹,用来存放所有的路由
模块
路由模块中,只存放客户端的请求与处理函数之间的映射关系
在项目根目录中,新建 router_handler
文件夹,用来存放所有的 路由处理函数模块
路由处理函数模块中,专门负责存放每个路由对应的处理函数
在 router
文件夹中,新建 user.js
文件,作为用户的路由模块,并初始化代码:
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
中,导入注册用户路由模块 :
const userRouter = require('./router/user')
app.use('/api', userRouter)
目的:为了保证 路由模块 的纯粹性,所有的 路由处理函数,必须抽离到对应的 路由处理函数模块 中
在 /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
test
数据库中,新建 ev_users
表如下:ev_users表结构
在 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: 'admin123', database: 'my_db_01',})
// 向外共享 db 数据库连接对象
module.exports = db
判断用户名和密码是否为空
// 接收表单数据
const userinfo = req.body
// 判断数据是否合法
if (!userinfo.username || !userinfo.password) {
return res.send({ status: 1, message: '用户名或密码不能为空!' }
)}
导入数据库操作模块:
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: 用户名可用,继续后续流程...})
为了保证密码的安全性,不建议在数据库以 明文 的形式保存用户密码,推荐对密码进行 加密存储
在当前项目中,使用 bcryptjs
对用户密码进行加密,优点:
运行如下命令,安装指定版本的 bcryptjs
:
npm i [email protected]
在 /router_handler/user.js
中,导入 bcryptjs
:
const bcrypt = require('bcryptjs')
在注册用户的处理函数中,确认用户名可用之后,调用 bcrypt.hashSync(明文密码, 随机盐的长度)
方法,对用户的密码进行加密处理:
// 对用户的密码,进行 bcrype 加密,返回值是加密之后的密码字符串
userinfo.password = bcrypt.hashSync(userinfo.password, 10)
定义插入用户的 SQL 语句:
const sql = 'insert into ev_users set ?'
调用 db.query()
执行 SQL 语句,插入新用户:
在处理函数中,需要多次调用 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()})
表单验证的原则:前端验证为辅,后端验证为主,后端永远不要相信前端提交过来的任何内容
在实际开发中,前后端都需要对表单的数据进行合法性的验证,而且,后端做为数据合法性验证的最后一个关口,在拦截非法数据方面,起到了至关重要的作用。
单纯的使用 if...else...
的形式对数据合法性进行验证,效率低下、出错率高、维护性差。因此,推荐使用第三方数据验证模块,来降低出错率、提高验证的效率与可维护性,让后端程序员把更多的精力放在核心业务逻辑的处理上。
joi
包,为表单中携带的每个数据项,定义验证规则:@escook/express-joi
中间件,来实现自动对表单数据进行验证的功能:/schema/user.js
用户信息验证规则模块,并初始化代码如下:/router/user.js
中的代码如下:app.js
的全局错误级别中间件中,捕获验证失败的错误,并把验证失败的结果响应给客户端:/router/user.js
中 登录
的路由代码修改如下: