node项目开发(-)

749 阅读5分钟

本文已参与掘金创作者训练营第三期「话题写作」赛道,详情查看:掘力计划|创作者训练营第三期正在进行,「写」出个人影响力

NodeJS 项目

0. 初始化

1.1 创建项目

  1. 新建 api_server 文件夹作为项目根目录,并在项目根目录中运行如下的命令,初始化包管理配置文件:

npm init -y

  1. 运行如下的命令,安装特定版本的 express:

npm i express@4.17.1

  1. 在项目根目录中新建 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'](http://127.0.0.1:3007%27/))

})

2.1 配置 cors 跨域

1、运行如下的命令,安装 cors 中间件:

npm i cors@2.8.5

2、在 app.js 中导入并配置 cors 中间件:

// 导入 cors 中间件

const cors = require('cors')

// 将 cors 注册为全局中间件

app.use(cors())

1.3 配置解析表单数据的中间件

1 通过如下的代码,配置解析 application/x-www-form-urlencoded 格式的表单数据的中间件:

app.use(express.urlencoded({ extended: false }))

1.4 初始化路由相关的文件夹

1在项目根目录中,新建 router 文件夹,用来存放所有的路由模块

路由模块中,只存放客户端的请求与处理函数之间的映射关系

1在项目根目录中,新建 router_handler 文件夹,用来存放所有的 路由处理函数模块

路由处理函数模块中,专门负责存放每个路由对应的处理函数

1.5 初始化用户路由模块

1在 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

2在 app.js 中,导入并使用 用户路由模块 :

// 导入并注册用户路由模块

const userRouter = require('./router/user')

app.use('/api', userRouter)

1.6 抽离用户路由模块中的处理函数

目的:为了保证 路由模块 的纯粹性,所有的 路由处理函数,必须抽离到对应的 路由处理函数模块 中

1在 /router_handler/user.js 中,使用 exports 对象,分别向外共享如下两个 路由处理函数 :

/**

* 在这里定义和用户相关的路由处理函数,供 /router/user.js 模块进行调用

*/

// 注册用户的处理函数

exports.regUser = (req, res) => {

res.send('reguser OK')

}

// 登录的处理函数

exports.login = (req, res) => {

res.send('login OK')

}

2将 /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
  1. 登录注册 2.1 新建 ev_users 表

1在 my_db_01 数据库中,新建 ev_users 表如下:

2.2 安装并配置 mysql 模块

在 API 接口项目中,需要安装并配置 mysql 这个第三方模块,来连接和操作 MySQL 数据库

1运行如下命令,安装 mysql 模块:

npm i mysql@2.18.1

2在项目根目录中新建 /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 实现步骤

1检测表单数据是否合法

2检测用户名是否被占用

3对密码进行加密处理

4插入新用户

2.3.1 检测表单数据是否合法

1判断用户名和密码是否为空

// 接收表单数据

const userinfo = req.body

// 判断数据是否合法

if (!userinfo.username || !userinfo.password) {

return res.send({ status: 1, message: '用户名或密码不能为空!' })

}

2.3.2 检测用户名是否被占用

1导入数据库操作模块:

const db = require('../db/index')

2定义 SQL 语句:

const sql = select * from ev_users where username=?``

3执行 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: 用户名可用,继续后续流程...

})

2.3.3 对密码进行加密处理

为了保证密码的安全性,不建议在数据库以 明文 的形式保存用户密码,推荐对密码进行 加密存储

在当前项目中,使用 bcryptjs 对用户密码进行加密,优点:

●加密之后的密码,无法被逆向破解

●同一明文密码多次加密,得到的加密结果各不相同,保证了安全性

1运行如下命令,安装指定版本的 bcryptjs :

npm i bcryptjs@2.4.3

2在 /router_handler/user.js 中,导入 bcryptjs :

const bcrypt = require('bcryptjs')

3 在注册用户的处理函数中,确认用户名可用之后,调用 bcrypt.hashSync(明文密码, 随机盐的长度) 方法,对用户的密码进行加密处理:

// 对用户的密码,进行 bcrype 加密,返回值是加密之后的密码字符串

userinfo.password = bcrypt.hashSync(userinfo.password, 10)

2.3.4 插入新用户

1定义插入用户的 SQL 语句:

const sql = 'insert into ev_users set ?'

2调用 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() 函数

1在 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()

})