Node.js(含npm、包、模块化、身份认证、CORS跨域、Mysql基础、API接口)

目录

  • 初识Node.js及其内置模块
    初识Node.js

    fs文件系统模块
    path路径模块
    http模块
  • 模块化
    模块化的基本概念
    Node.js中的模块化
    npm与包
  • Express模块
    初识Express
    Express路由

    Express中间件
    使用Express写接口
  • 数据库与身份认证
    Mysql的基本使用
    在项目中操作Mysql
    前后端的身份认证

一、初识Node.js及其内置模块

1. 初识Node.js

1.1 了解Node.js

Node.js 作为一个 JavaScript 的运行环境,仅仅提供了基础的功能和 API。

然而,基于 Node.js 提供的这些基础能,很多强大的工具和框架如雨后春笋,层出不穷,所以学会了 Node.js ,可以让前端程序员胜任更多的工作和岗位:

1 基于 Express 框架(http://www.expressjs.com.cn/),可以快速构建 Web 应用

2 基于 Electron 框架(https://electronjs.org/),可以构建跨平台的桌面应用

3 基于 restify 框架(http://restify.com/),可以快速构建 API 接口项目

4 读写和操作数据库、创建实用的命令行工具辅助前端开发、etc...

总之:Node.js 是大前端时代的“大宝剑”,有了 Node.js 这个超级 buff 的加持,前端程序员的行业竞争力会越来越强!

1.2 Node.js 的学习路径

JavaScript 基础语法 + Node.js 内置 API 模块(fs、path、http等)+ 第三方 API 模块(express、mysql 等)

1.3 Node.js的两个版本

1 LTS 为长期稳定版,对于追求稳定性的企业级项目来说,推荐安装 LTS 版本的 Node.js。

2 Current 为新特性尝鲜版,对热衷于尝试新特性的用户来说,推荐安装 Current 版本的 Node.js。但是,Current 版本中可 能存在隐藏的 Bug 或安全性漏洞,因此不推荐在企业级项目中使用 Current 版本的 Node.js。

1.4 Node.js环境执行js代码

node 要运行的js文件路径

1.5 终端四个快捷键

2. fs文件系统模块

2.1 认识fs模块

fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性,用来满足用户对文件的操作需求。例如:

fs.readFile() 方法,用来读取指定文件中的内容
fs.writeFile() 方法,用来向指定的文件中写入内容

2.2 使用fs模块

需要使用fs模块需要先导入fs模块,并用一个常量来接收:

const fs = require(      'fs' )

2.3 fs.readFile()语法格式

fs.readFile(path[,option],callback)
path:必选,文件路径。
option:可选,表示用什么编码格式读取文件
callback:必选,文件读取完成后,通过回调函数拿到读取结果

2.4 fs.readFile()示例代码

以 utf8 的编码格式,读取指定文件的内容, err 代表出错时的内容,dataStr 表示成功后读到的内容:

可以判断 err 对象是否为 null,从而知晓文件读取的结果: 

//先导入fs模块
const fs = require('fs')
//再读取
fs.readFile('./files/11.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败!' + err.message)
  }
  console.log('读取文件成功!' + dataStr)
})

2.5 fs.writeFile()语法格式

fs.writeFile(     file ,data[,options],callback)

参数1:必选参数,需要指定一个文件路径的字符串,表示文件的存放路径。

参数2:必选参数,表示要写入的内容。

参数3:可选参数,表示以什么格式写入文件内容,默认值是 utf8。

参数4:必选参数,文件写入完成后的回调函数。

2.6 fs.writeFile()示例代码

// 1. 导入 fs 文件系统模块
const fs = require('fs')

// 2. 调用 fs.writeFile() 方法,写入文件的内容
//    参数1:表示文件的存放路径
//    参数2:表示要写入的内容
//    参数3:回调函数
fs.writeFile('./files/3.txt', 'ok123', function(err) {
  // 2.1 如果文件写入成功,则 err 的值等于 null
  // 2.2 如果文件写入失败,则 err 的值等于一个 错误对象
  // console.log(err)

  if (err) {
    return console.log('文件写入失败!' + err.message)
  }
  console.log('文件写入成功!')
})

2.7 路径动态拼接的问题

在使用 fs 模块操作文件时,如果提供的操作路径是以 ./ 或 ../ 开头的相对路径时,很容易出现路径动态拼接错误的问题。 原因:代码在运行的时候,会以执行 node 命令时所处的目录,动态拼接出被操作文件的完整路径。
解决方案:在使用 fs 模块操作文件时,直接提供完整的路径,不要提供 ./ 或 ../ 开头的相对路径,从而防止路径动态拼接的问题。

const fs = require('fs')

// 出现路径拼接错误的问题,是因为提供了 ./ 或 ../ 开头的相对路径
// 如果要解决这个问题,可以直接提供一个完整的文件存放路径就行
/* fs.readFile('./files/1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败!' + err.message)
  }
  console.log('读取文件成功!' + dataStr)
}) */

// 移植性非常差、不利于维护
/* fs.readFile('C:\\Users\\escook\\Desktop\\Node.js基础\\day1\\code\\files\\1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败!' + err.message)
  }
  console.log('读取文件成功!' + dataStr)
}) */

// __dirname 表示当前文件所处的目录
// console.log(__dirname)

fs.readFile(__dirname + '/files/1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败!' + err.message)
  }
  console.log('读取文件成功!' + dataStr)
})

 

3. path路径模块

3.1 path模块介绍

path 模块是 Node.js 官方提供的、用来处理路径的模块。它提供了一系列的方法和属性,用来满足用户对路径的处理需求。例如:

path.join() 方法,用来将多个路径片段拼接成一个完整的路径字符串。

path.basename() 方法,用来从路径字符串中,将文件名解析出来

path.extname()方法,获取路径中的扩展名部分。

3.2 使用前都需要先导入path模块

const path = require(  'path' )

3.3 path.join()

path.  join ([...paths])
const path = require('path')
const fs = require('fs')

// 注意:  ../ 会抵消前面的路径
const pathStr = path.join('/a', '/b/c', '../../', './d', 'e')
console.log(pathStr)  // 输出\a\b\d\e

fs.readFile(__dirname + '/files/1.txt')//当前文件路径/files/1.txt

注意:今后凡是涉及到路径拼接的操作,都要使用 path.join() 方法进行处理。不要直接使用 + 进行字符串的拼接。

3.4 path.basename()

path.  basename (path[,ext])
//path 必选参数,路径字符串
//ext 可选,表示文件扩展名
const path = require('path')

// 定义文件的存放路径
const fpath = '/a/b/c/index.html'

const fullName = path.basename(fpath)
console.log(fullName)  //输出index

const nameWithoutExt = path.basename(fpath, '.html')
console.log(nameWithoutExt) //输出index.html

3.5 path.extname()

path.extname(path)
const path = require('path')

// 这是文件的存放路径
const fpath = '/a/b/c/index.html'

const fext = path.extname(fpath)
console.log(fext)//输出.html

 

4. http模块

4.1 认识http模块

http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。通过 http 模块提供的 http.createServer() 方法,就 能方便的把一台普通的电脑,变成一台 Web 服务器,从而对外提供 Web 资源服务。

4.2 使用http模块创建web服务器

// 步骤1. 导入 http 模块
const http = require('http')
// 步骤2. 创建 web 服务器实例
const server = http.createServer()
// 步骤3. 为服务器实例绑定 request 事件,监听客户端的请求
server.on('request', function (req, res) {
  console.log('Someone visit our web server.')
})
// 步骤4. 启动服务器,监听8080端口
server.listen(8080, function () {  
  console.log('server running at http://127.0.0.1:8080')
})

4.3 req请求对象:

const http = require('http')
const server = http.createServer()
// req 是请求对象,包含了与客户端相关的数据和属性
server.on('request', (req, res) => {
  // req.url 是客户端请求的 URL 地址
  const url = req.url
  // req.method 是客户端请求的 method 类型
  const method = req.method
  const str = `Your request url is ${url}, and request method is ${method}`
  console.log(str)
  // 调用 res.end() 方法,向客户端响应一些内容
  res.end(str)
})
server.listen(80, () => {
  console.log('server running at http://127.0.0.1')
})

4.4 res响应对象(含解决中文乱码)

const http = require('http')
const server = http.createServer()

server.on('request', (req, res) => {
  // 定义一个字符串,包含中文的内容
  const str = `您请求的 URL 地址是 ${req.url},请求的 method 类型为 ${req.method}`
  // 调用 res.setHeader() 方法,设置 Content-Type 响应头,解决中文乱码的问题
  res.setHeader('Content-Type', 'text/html; charset=utf-8')
  // res.end() 将内容响应给客户端
  res.end(str)
})

server.listen(80, () => {
  console.log('server running at http://127.0.0.1')
})

 

二、模块化


1. 了解模块化

1.1 把代码进行模块化拆分的好处

1 提高了代码的复用性
2 提高了代码的可维护性
3 可以实现按需加载

1.2 模块化规范

就是对代码进行模块化的拆分与组合时,需要遵守的那些规则。例如:

1 使用什么样的语法格式来 引用模块

2 在模块中使用什么样的语法格式向外 暴露成员。

2. Node.js中的模块化

2.1 Node.js模块化三大类

1 内置模块(内置模块是由 Node.js 官方提供的,例如 fs、path、http 等)

2 自定义模块(用户创建的每个 .js 文件,都是自定义模块)

3 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)

2.2 使用require()方法加载模块:

使用强大的 require() 方法,可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。

注意:使用 require() 方法加载其它模块时,会执行被加载模块中的代码。

2.3 模块作用域

和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块 作用域。防止了全局变量污染的问题。

2.4 如何暴露成员

// 在一个自定义模块中,默认情况下, module.exports = {}
const age = 20

// 向 module.exports 对象上挂载 username 属性
module.exports.username = 'zs'
// 向 module.exports 对象上挂载 sayHello 方法
module.exports.sayHello = function() {
  console.log('Hello!')
}
module.exports.age = age

// 如果让module.exports 指向一个全新的对象,最终上面的指向作废
module.exports = {
  nickname: '小黑',
  sayHi() {
    console.log('Hi!')
  }
}

在每个 .js 自定义模块中都有一个 module 对象,它里面存储了和当前模块有关的信息。

在自定义模块中,可以使用 module.exports 对象,将模块内的成员共享出去,供外界使用。 外界用 require() 方法导入自定义模块时,得到的就是 module.exports 所指向的对象

注意:使用 require() 方法导入模块时,导入的结果,永远以 module.exports 指向的对象为准。

由于 module.exports 单词写起来比较复杂,为了简化向外共享成员的代码,Node 提供了 exports 对象。默认情况 下,exports 和 module.exports 指向同一个对象。

最终共享的结果,还是以 module.exports 指向的对象为准

注意:为了防止混乱,建议大家不要在同一个模块中同时使用 exports 和 module.exports

3. npm与包

3.1 什么是包:

Node.js 中的第三方模块又叫做

注意:Node.js 中的包都是免费且开源的,不需要付费即可免费下载使用。

3.2 为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API,导致在基于内置模块进行项目开发的时,效率很低。包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率。

3.3 npm包管理工具

Node Package Manager(简称 npm 包管理工具)。

3.4 在项目中安装npm包的命令

npm   install 包的完整名称
npm i 包的完整名称        // 简写模式

3.5 包配置文件

初次装包完成后,在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 配置文件夹。

node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时,就是从这个目录中查找并加载包。

package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等。

注意:程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码,npm 包管理工具会自动维护它们。

package.json 的包管理配置文件:

npm 规定,在项目根目录中,必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置 信息。例如:

1 项目的名称、版本号、描述等。

2 项目中都用到了哪些包。

3 哪些包只在开发期间会用到。

4 那些包在开发和部署时都需要用到。

dependencies 节点(记录核心包):

package.json 文件中,有一个 dependencies 节点,专门用来记录您使用 npm install命令安装了哪些包。

devDependencies 节点(记录开发包):

如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 devDependencies 节点中。 与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到 dependencies 节点中。

快速创建package.json:

npm init -y

 注意:

1 上述命令只能在英文的目录下成功运行!所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格。

2 运行 npm install 命令安装包的时候,npm 包管理工具会自动把包的名称和版本号,记录到 package.json 中。

剔除node_modules 目录:

node_modules文件夹太大了,不用上传远程仓库。今后在项目开发中,一定要把 node_modules 文件夹,添加到 .gitignore 忽略文件中。在项目根目录中,创建一个叫做 package.json 的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除node_modules 目录之后,在团队成员之间共享项目的源代码。

当我们拿到一个剔除了 node_modules 的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。

一次性安装所有包:

npm i

安装到 dependencies 节点中:

npm i 包名 -D

卸载包:

npm uninstall 具体包名

注意:npm uninstall 命令执行成功后,会把卸载的包,自动从 package.json 的 dependencies 中移除掉。

使用淘宝NPM镜像服务器解决下包慢的方案:

#查看当前包镜像源有哪些
npm config get registry

#将镜像源切换为淘宝镜像源
npm config   set registry=https:  //registry .npm.taobao.org/

#检查是否成功
npm config get registry

 nrm:

为了更方便的切换下包的镜像源,我们可以安装 nrm 这个小工具,利用 nrm 提供的终端命令,可以快速查看和切换包的镜像源

#通过 npm ,将nrm安装为全局可用的工具
npm i nrm -g

#查看可用镜像源
nrm ls

#切换为淘宝镜像源
nrm use taobao

全局包和项目包:

全局包安装到电脑本地文件保存,相当于工具类

项目包下载到项目文件夹里的node_modules 文件夹

关于如何判断包的官方文档会说明的

规范包的结构:

1 包必须以单独的目录而存在

2 包的顶级目录下要必须包含 package.json 这个包管理配置文件

3 package.json 中必须包含 name,version,main 这三个属性,分别代表包的名字、版本号、包的入口。

开发属于自己的包:

1 新建 XXX 文件夹,作为包的根目录

2 在 XXX 文件夹中,新建如下三个文件:

① package.json (包管理配置文件)
② index.js (包的入口文件) (最后使用module.exports把对应方法暴露出去)

    这里可以模块化建立多个相应功能的js文件,然后在index,js文件导入它们。
③ README.md (包的说明文档)

发布自己的包:

保证在npm官方地址下(非镜像下)在终端中执行 npm login 命令,依次输入用户名、密码、邮箱后,即可登录成功。

将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到 npm 上(注意:包名不能雷同)。

 运行 npm unpublish 包名 --force 命令,即可从 npm 删除已发布的包

模块加载机制:

内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高

使用 require() 加载自定义模块时,必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./ 或 ../这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载。

同时,在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则 Node.js 会按顺序分别尝试加载以下的文件:

1 按照确切的文件名进行加载

2 补全 .js 扩展名进行加载

3 补全 .json 扩展名进行加载

4 补全 .node 扩展名进行加载

5 加载失败,终端报错

如果传递给 require() 的模块标识符不是一个内置模块,也没有以 ‘./’ 或 ‘../’ 开头,则 Node.js 会从当前模块的父 目录开始,尝试从 /node_modules 文件夹中加载第三方模块

如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。例如,假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools'),则 Node.js 会按以下顺序查找:

1 C:\Users\itheima\project\node_modules\tools
2 C:\Users\itheima\node_modules\tools
3 C:\Users\node_modules\tools
4 C:\node_modules\tools

当把目录作为模块标识符,传递给 require() 进行加载的时候,有三种加载方式:
1 在被加载的目录下查找一个叫做 package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
2 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件。 3 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannot find module 'xxx'

 

三、Express模块


1. 初识Express

官方给出的概念:Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架。

通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的。Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。

对于前端程序员来说,最常见的两种服务器,分别是: 1 Web 网站服务器:专门对外提供 Web 网页资源的服务器。 2 API 接口服务器:专门对外提供 API 接口的服务器。 使用 Express,我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。

1.1 安装:

npm i express

1.2 基本使用示例

// 1. 导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()

// 4. 监听客户端的 GET 和 POST 请求,并向客户端响应具体的内容
app.get('/user', (req, res) => {
  // 调用 express 提供的 res.send() 方法,向客户端响应一个 JSON 对象
  res.send({ name: 'zs', age: 20, gender: '男' })
})
app.post('/user', (req, res) => {
  // 调用 express 提供的 res.send() 方法,向客户端响应一个 文本字符串
  res.send('请求成功')
})
app.get('/', (req, res) => {
  // 通过 req.query 可以获取到客户端发送过来的 查询参数
  // 注意:默认情况下,req.query 是一个空对象,必须解析才能有内容
  console.log(req.query)
  res.send(req.query)
})
// 注意:这里的 :id 是一个动态的参数
app.get('/user/:ids/:username', (req, res) => {
  // req.params 是动态匹配到的 URL 参数,默认也是一个空对象
  console.log(req.params)
  res.send(req.params)
})

// 3. 启动 web 服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

1.3 通过express.static()托管静态资源

const express = require('express')
const app = express()

// 在这里,调用 express.static() 方法,快速的对外提供静态资源
app.use('/public', express.static('public'))  //挂载路径前缀public
app.use(express.static('public'))   //不挂载路径前缀

//托管多个的话,使用多条托管语句即可,但是访问时按照托管的先后顺序查找
app.listen(80, () => { console.log('express server running at http://127.0.0.1') })

这样,public下的文件外界都可访问了。

1.4 nodemon工具

在编写调试 Node.js 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐。

nodemon自动监听代码改动,自动重启项目服务。

全局安装nodemon:

npm i -g nodemon

 然后就可以用nodemon代替node来命令了,如启动app.js

nodemon app.js

2. Express路由

 2.1 最简单的路由挂载

const express = require('express')
const app = express()

// 挂载路由
app.get('/', (req, res) => {
  res.send('hello world.')
})
app.post('/', (req, res) => {
  res.send('Post Request.')
})

app.listen(80, () => {
  console.log('http://127.0.0.1')
})

2.2 模块化路由

为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块。 将路由抽离为单独模块的步骤如下:

1 创建路由模块对应的 .js 文件

2 调用 express.Router() 函数创建路由对象

3 向路由对象上挂载具体的路由

4 使用 module.exports 向外共享路由对象 5 使用 app.use() 函数注册路由模块

例如:

创建router文件夹,存放所有的路由模块,在里面创建 user.js 文件作为user路由模块,代码如下

查看代码

var express = require('express') // 1.导入 express 
var router = express.Router() // 2.创建路由对象 

router.get('/user/list', function (req,res){ // 3.挂载获取用户列表的路由 
    res.send('Get user list.')
})
router.post('/user/add', function(req,res){//4.挂载添加用户的路由 
    res.send('Add new user.")
             })
module.exports = router //5.向外导出路由对象

app.js服务器端使用user模块的路由

const express = require('express')
const app = express()

// 1. 导入user路由模块
const router = require('./router/user.js')

// 2. 注册路由模块,并且挂载了路由前缀,不挂载可省略/api
app.use('/api', router) 

// 注意: app.use() 函数的作用,就是来注册全局中间件

app.listen(80, () => {
  console.log('http://127.0.0.1')
})

3. Express中间件

注意:中间件函数的形参列表中,必须包含 next 参数而路由处理函数中只包含 req 和 res。

3.1 局部中间件及其使用

查看代码
// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 定义中间件函数
const mw1 = (req, res, next) => {
  console.log('调用了局部生效的中间件')
  next()
}

// 2. 创建路由
app.get('/', mw1, (req, res) => {
  res.send('Home page.')
})
app.get('/user', (req, res) => {
  res.send('User page.')
})

// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

3.2 全局中间件

查看代码

const express = require('express')
const app = express()

// 定义一个最简单的中间件函数
const mw = function (req, res, next) {
   console.log('这是最简单的中间件函数')
   // 把流转关系,转交给下一个中间件或路由
   next()
}

// 将 mw 注册为全局生效的中间件
app.use(mw)

// 这是定义全局中间件的简化形式
app.use((req, res, next) => {
  console.log('这是最简单的中间件函数')
  next()
})

app.get('/', (req, res) => {
  console.log('调用了 / 这个路由')
  res.send('Home page.')
})
app.get('/user', (req, res) => {
  console.log('调用了 /user 这个路由')
  res.send('User page.')
})

app.listen(80, () => {
  console.log('http://127.0.0.1')
})

3.3 中间件注意事项

1 一定要在路由之前注册中间件
2 客户端发送过来的请求,可以连续调用多个中间件进行处理
3 执行完中间件的业务代码之后,不要忘记调用 next() 函数
4 为了防止代码逻辑混乱,调用 next() 函数后不要再写额外的代码
5 连续调用多个中间件时,多个中间件之间,共享 req 和 res 对象

3.4 中间件分类

应用级别的中间件
路由级别的中间件
错误级别的中间件
Express 内置的中间件
第三方的中间件

通过 app.use() 或 app.get() 或 app.post() ,绑定到 app 实例上的中间件,叫做应用级别的中间件

绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不 过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上。

3.5 错误级别中间件

作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。

格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)。

注意:错误级别的中间件,必须注册在所有路由之后!

查看代码

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 定义路由
app.get('/', (req, res) => {
  // 1.1 人为的制造错误
  throw new Error('服务器内部发生了错误!')
  res.send('Home page.')
})

// 2. 定义错误级别的中间件,捕获整个项目的异常错误,从而防止程序的崩溃
app.use((err, req, res, next) => {
  console.log('发生了错误!' + err.message)
  res.send('Error:' + err.message)
})

// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

3.6 Express内置中间件

自 Express 4.16.0 版本开始,Express 内置了 3 个常用的中间件,极大的提高了 Express 项目的开发效率和体验:

express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
express.json 解析 JSON 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 注意:除了错误级别的中间件,其他的中间件,必须在路由之前进行配置

// 通过 express.json() 这个中间件,解析表单中的 JSON 格式的数据
app.use(express.json())
// 通过 express.urlencoded() 这个中间件,来解析 表单中的 url-encoded 格式的数据
app.use(express.urlencoded({ extended: false }))

app.post('/user', (req, res) => {
  // 在服务器,可以使用 req.body 这个属性,来接收客户端发送过来的请求体数据
  // 默认情况下,如果不配置解析表单数据的中间件,则 req.body 默认等于 undefined
  console.log(req.body)
  res.send('ok')
})

app.post('/book', (req, res) => {
  // 在服务器端,可以通过 req,body 来获取 JSON 格式的表单数据和 url-encoded 格式的数据
  console.log(req.body)
  res.send('ok')
})

// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

3.7 第三方中间件

在 express@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步 骤如下:

1 运行 npm install body-parser 安装中间件

2 使用 require 导入中间件
3 调用 app.use() 注册并使用中间件

注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的。

使用示例:

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 导入解析表单数据的中间件 body-parser
const parser = require('body-parser')
// 2. 使用 app.use() 注册中间件
app.use(parser.urlencoded({ extended: false }))
// app.use(express.urlencoded({ extended: false }))

app.post('/user', (req, res) => {
  // 如果没有配置任何解析表单数据的中间件,则 req.body 默认等于 undefined
  console.log(req.body)
  res.send('ok')
})

// 调用 app.listen 方法,指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

4. 使用Express写接口

4.1 写接口的步骤

1.创建基本服务器(app.js)

查看代码
// 导入 express
const express = require('express')
// 创建服务器实例
const app = express()

// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))

// 导入路由模块
const router = require('./16.apiRouter')
// 把路由模块,注册到 app 上
app.use('/api', router)

// 启动服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})
2.创建API路由模块(apiRouter.js)

3.编写GET接口(apiRouter.js)

4.编写POST模块(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, // 需要响应给客户端的数据
  })
})

// 定义 POST 接口
router.post('/post', (req, res) => {
  // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
  const body = req.body
  // 调用 res.send() 方法,向客户端响应结果
  res.send({
    status: 0,
    msg: 'POST 请求成功!',
    data: body,
  })
})

// 定义 DELETE 接口
router.delete('/delete', (req, res) => {
  res.send({
    status: 0,
    msg: 'DELETE请求成功',
  })
})

module.exports = router
 注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 app.use(express.urlencoded({ extended: false }))

4.2 CORS跨域资源共享

解决接口跨域问题的方案主要有两种:
1 CORS(主流的解决方案,推荐使用)
2 JSONP(有缺陷的解决方案:只支持 GET 请求)

使用第三方CORS中间件实现跨域:

步骤:
1 运行 npm install cors 安装中间件
2 使用 const cors = require('cors') 导入中间件
3 在路由之前调用 app.use(cors()) 配置中间件

示例如下:
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, // 需要响应给客户端的数据
  })
})

// 定义 POST 接口
router.post('/post', (req, res) => {
  // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
  const body = req.body
  // 调用 res.send() 方法,向客户端响应结果
  res.send({
    status: 0,
    msg: 'POST 请求成功!',
    data: body,
  })
})

// 定义 DELETE 接口
router.delete('/delete', (req, res) => {
  res.send({
    status: 0,
    msg: 'DELETE请求成功',
  })
})

module.exports = router

 app.js服务器调用路由,并实现跨域

// 导入 express
const express = require('express')
// 创建服务器实例
const app = express()

// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))

// 必须在配置 cors 中间件之前,配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {
  // TODO: 定义 JSONP 接口具体的实现过程
  // 1. 得到函数的名称
  const funcName = req.query.callback
  // 2. 定义要发送到客户端的数据对象
  const data = { name: 'zs', age: 22 }
  // 3. 拼接出一个函数的调用
  const scriptStr = `${funcName}(${JSON.stringify(data)})`
  // 4. 把拼接的字符串,响应给客户端
  res.send(scriptStr)
})

// 一定要在路由之前,配置 cors 这个中间件,从而解决接口跨域的问题
const cors = require('cors')
app.use(cors())

// 导入路由模块
const router = require('./16.apiRouter')
// 把路由模块,注册到 app 上
app.use('/api', router)

// 启动服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

测试跨域接口.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
    <script src="https://cdn.staticfile.org/jquery/3.4.1/jquery.min.js"></script>
  </head>
  <body>
    <button id="btnGET">GET</button>
    <button id="btnPOST">POST</button>
    <button id="btnDelete">DELETE</button>
    <button id="btnJSONP">JSONP</button>

    <script>
      $(function () {
        // 1. 测试GET接口
        $('#btnGET').on('click', function () {
          $.ajax({
            type: 'GET',
            url: 'http://127.0.0.1/api/get',
            data: { name: 'zs', age: 20 },
            success: function (res) {
              console.log(res)
            },
          })
        })
        // 2. 测试POST接口
        $('#btnPOST').on('click', function () {
          $.ajax({
            type: 'POST',
            url: 'http://127.0.0.1/api/post',
            data: { bookname: '水浒传', author: '施耐庵' },
            success: function (res) {
              console.log(res)
            },
          })
        })

        // 3. 为删除按钮绑定点击事件处理函数
        $('#btnDelete').on('click', function () {
          $.ajax({
            type: 'DELETE',
            url: 'http://127.0.0.1/api/delete',
            success: function (res) {
              console.log(res)
            },
          })
        })

        // 4. 为 JSONP 按钮绑定点击事件处理函数
        $('#btnJSONP').on('click', function () {
          $.ajax({
            type: 'GET',
            url: 'http://127.0.0.1/api/jsonp',
            dataType: 'jsonp',
            success: function (res) {
              console.log(res)
            },
          })
        })
      })
    </script>
  </body>
</html>

注意:

1 CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。

2 CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服 务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。

 

四、数据库与身份认证


1. Mysql的基本使用

重点掌握如何使用 SQL 从数据表中:
查询数据(select) 、插入数据(insert into) 、更新数据(update) 、删除数据(delete)

额外需要掌握的 4 种 SQL 语法:
where 条件、and 和 or 运算符、order by 排序、count(*) 函数

常用语句:

查看代码
//查询语句
select * from 表名
select 列名称 from 表名称
//插入语句
insert into table_name(列1,列2...)values(值1,值2,...)
//更新语句
update 表名称 set 列名称 = 新值 where 列名称 = 某值
//删除语句
delect from 表名称 where 列名称 = 值
//where字句
//运算符
//and   or
//order by  默认升序ASC,DESC降序
//count(*)查询结果条数
select count(*) from 表名称

安装mysql模块:

npm i mysql

在项目中示例:

查看代码
// 1. 导入 mysql 模块
const mysql = require('mysql')
// 2. 建立与 MySQL 数据库的连接关系
const db = mysql.createPool({
  host: '127.0.0.1', // 数据库的 IP 地址
  user: 'root', // 登录数据库的账号
  password: 'admin123', // 登录数据库的密码
  database: 'my_db_01', // 指定要操作哪个数据库
})

// 测试 mysql 模块能否正常工作
db.query('select 1', (err, results) => {
  // mysql 模块工作期间报错了
  if(err) return console.log(err.message)
  // 能够成功的执行 SQL 语句
  console.log(results)
}) 

// 查询 users 表中所有的数据
const sqlStr = 'select * from users'
db.query(sqlStr, (err, results) => {
  // 查询数据失败
  if (err) return console.log(err.message)
  // 查询数据成功
  // 注意:如果执行的是 select 查询语句,则执行的结果是数组
  console.log(results)
})

// 向 users 表中,新增一条数据,其中 username 的值为 Spider-Man,password 的值为 pcc123
const user = { username: 'Spider-Man', password: 'pcc123' }
// 定义待执行的 SQL 语句
const sqlStr = 'insert into users (username, password) values (?, ?)'
// 执行 SQL 语句
db.query(sqlStr, [user.username, user.password], (err, results) => {
  // 执行 SQL 语句失败了
  if (err) return console.log(err.message)
  // 成功了
  // 注意:如果执行的是 insert into 插入语句,则 results 是一个对象
  // 可以通过 affectedRows 属性,来判断是否插入数据成功
  if (results.affectedRows === 1) {
    console.log('插入数据成功!')
  }
})

// 演示插入数据的便捷方式
const user = { username: 'Spider-Man2', password: 'pcc4321' }
// 定义待执行的 SQL 语句
const sqlStr = 'insert into users set ?'
// 执行 SQL 语句
db.query(sqlStr, user, (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('插入数据成功')
  }
})

// 演示如何更新用户的信息
const user = { id: 6, username: 'aaa', password: '000' }
// 定义 SQL 语句
const sqlStr = 'update users set username=?, password=? where id=?'
// 执行 SQL 语句
db.query(sqlStr, [user.username, user.password, user.id], (err, results) => {
  if (err) return console.log(err.message)
  // 注意:执行了 update 语句之后,执行的结果,也是一个对象,可以通过 affectedRows 判断是否更新成功
  if (results.affectedRows === 1) {
    console.log('更新成功')
  }
})

// 演示更新数据的便捷方式
const user = { id: 6, username: 'aaaa', password: '0000' }
// 定义 SQL 语句
const sqlStr = 'update users set ? where id=?'
// 执行 SQL 语句
db.query(sqlStr, [user, user.id], (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('更新数据成功')
  }
})

// 删除 id 为 5 的用户
const sqlStr = 'delete from users where id=?'
db.query(sqlStr, 5, (err, results) => {
  if (err) return console.log(err.message)
  // 注意:执行 delete 语句之后,结果也是一个对象,也会包含 affectedRows 属性
  if (results.affectedRows === 1) {
    console.log('删除数据成功')
  }
})

// 标记删除,不是真实删除
const sqlStr = 'update users set status=? where id=?'
db.query(sqlStr, [1, 6], (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('标记删除成功')
  }
})

2. 前后端的身份认证

目前主流的 Web 开发模式有两种,分别是:

1 基于服务端渲染的传统 Web 开发模式
2 基于前后端分离的新型 Web 开发模式

服务端渲染的概念:服务器发送给客户端的 HTML 页面,是在服务器通过字符串的拼接,动态生成的。因此,客户端不需要使用 Ajax 这样的技术额外请求页面的数据。

 
服务端渲染优缺点:

优点:
1 前端耗时少。因为服务器端负责动态生成 HTML 内容,浏览器只需要直接渲染页面即可。尤其是移动端,更省电。 2 有利于SEO。因为服务器端响应的是完整的 HTML 页面内容,所以爬虫更容易爬取获得信息,更有利于 SEO。

缺点:

1 占用服务器端资源。即服务器端完成 HTML 页面内容的拼接,如果请求较多,会对服务器造成一定的访问压力。

2 不利于前后端分离,开发效率低。使用服务器端渲染,则无法进行分工合作,尤其对于前端复杂度高的项目,不利于 项目高效开发。

 

前后端分离的概念:前后端分离的开发模式,依赖于 Ajax 技术的广泛应用。简而言之,前后端分离的 Web 开发模式, 就是后端只负责提供 API 接口,前端使用 Ajax 调用接口的开发模式。

 

前后端分离优缺点:

优点:
1 开发体验好。前端专注于 UI 页面的开发,后端专注于api 的开发,且前端有更多的选择性。
2 用户体验好。Ajax 技术的广泛应用,极大的提高了用户的体验,可以轻松实现页面的局部刷新。 3 减轻了服务器端的渲染压力。因为页面最终是在每个用户的浏览器中生成的。

缺点:

1 不利于 SEO。因为完整的 HTML 页面需要在客户端动态拼接完成,所以爬虫对无法爬取页面的有效信息。(解决方 案:利用 Vue、React 等前端框架的 SSR (server side render)技术能够很好的解决 SEO 问题!)


不谈业务场景而盲目选择使用何种开发模式都是耍流氓。

比如企业级网站,主要功能是展示而没有复杂的交互,并且需要良好的 SEO,则这时我们就需要使用服务器端渲染;

而类似后台管理项目,交互性比较强,不需要考虑 SEO,那么就可以使用前后端分离的开发模式。

另外,具体使用何种开发模式并不是绝对的,为了同时兼顾了首页的渲染速度和前后端分离的开发效率,一些网站采用了 首屏服务器端渲染 + 其他页面前后端分离的开发模式。

 

对于服务端渲染和前后端分离这两种开发模式来说,分别有着不同的身份认证方案:

1 服务端渲染推荐使用 Session 认证机制
2 前后端分离推荐使用 JWT 认证机制

 

Session 认证机制需要配合 Cookie 才能实现。由于 Cookie 默认不支持跨域访问,所以,当涉及到前端跨域请求后端接

口的时候,需要做很多额外的配置,才能实现跨域 Session 认证。

注意:
1 当前端请求后端接口不存在跨域问题的时候,推荐使用 Session 身份认证机制。
2 当前端需要跨域请求后端接口的时候,不推荐使用 Session 身份认证机制,推荐使用 JWT 认证机制。

 

posted @ 2022-04-07 13:56  RHCHIK  阅读(392)  评论(0编辑  收藏  举报