NodeJs

Buffer模块

Buffer 是一个类似于数组的 对象 ,用于表示固定长度的字节序列

Buffer 本质是一段内存空间,专门用来处理 二进制数据

特点:

  1. Buffer 大小固定且无法调整
  2. Buffer 性能较好,可以直接对计算机内存进行操作
  3. 每个元素的大小为 1 字节(byte)

使用

创建 Buffer

Node.js 中创建 Buffer 的方式主要如下几种:

  1. Buffer.alloc

    1
    2
    // 创建了一个长度为 10 字节的 Buffer,相当于申请了 10 字节的内存空间,每个字节的值为 0
    let buf_1 = Buffer.alloc(10) //=>结果为<Buffer 00 00 00 00 00 00 00 00 00 00>
  2. Buffer.allocUnsafe

    1
    2
    // 创建了一个长度为 10 字节的 Buffer,buffer 中可能存在旧数据,可能会影响执行结果,所以叫 unsafe ,但是效率比 alloc 高
    let buf_2 = Buffer.allocUnsafe(10)
  1. Buffer.from

    1
    2
    3
    4
    // 通过字符串创建 Buffer
    let buf_3 = Buffer.from('hello')
    // 通过数组创建 Buffer
    let buf_4 = Buffer.from([105, 108, 111, 118, 101, 121, 111, 117])

Buffer 与字符串的转化

我们可以借助 toString 方法将 Buffer 转为字符串

1
2
let buf_4 = Buffer.from([105, 108, 111, 118, 101, 121, 111, 117])
console.log(buf_4.toString()) //=>iloveyou

**注意: **toString 默认是按照 utf-8 编码方式进行转换的

Buffer 的读写

Buffer 可以直接通过 [] 的方式对数据进行处理。

1
2
3
4
5
6
7
let buf_3 = Buffer.from('hello')
// 读取
console.log(buf_3[1]) //=>101
// 修改
buf_3[1] = 97
//查看字符串结果
console.log(buf_3.toString()) //=>hallo

注意:

  1. 如果修改的数值超过 255 ,则超过 8 位数据会被舍弃
  2. 一个 utf-8 的字符 一般 占3个字节

fs 模块

fs 全称为 file system ,称之为 文件系统 ,是 Node.js 中的 内置模块 ,可以对计算机中的磁盘进行操作:

  1. 文件写入

  2. 文件读取

  3. 文件移动与重命名

  4. 文件删除

  5. 文件夹操作

  6. 查看资源状态

文件写入

文件写入就是将 数据 保存到 文件 中,我们可以使用如下几个方法来实现该效果

方法 说明
writeFile 异步写入
writeFileSync 同步写入
appendFile / appendFileSync 追加写入
createWriteStream 流式写入

writeFile 异步写入

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

参数说明

  • file 文件名

  • data 待写入的数据

  • options 选项设置 (可选)

  • callback 写入回调

返回值undefined

代码示例

1
2
3
4
5
6
7
8
9
10
11
12
// require 是 Node.js 环境中的 '全局' 变量,用来导入模块
const fs = require('fs')

// 将 [三人行,必有我师焉。] 写入到当前文件夹下的 [座右铭.txt] 文件中
fs.writeFile('./座右铭.txt', '三人行,必有我师焉。', err =>{
// 如果写入失败,则回调函数调用时,会传入错误对象,如写入成功,会传入 null
if(err){
console.log(err)
return
}
console.log('写入成功')
})

writeFileSync 同步写入

语法: fs.writeFileSync(file, data[, options])

参数与 fs.writeFile 大体一致,只是没有 callback 参数

返回值:undefined

代码示例:

1
2
3
4
5
try{
fs.writeFileSync('./座右铭.txt', '三人行,必有我师焉。')
}catch(e){
console.log(e)
}

Node.js 中的磁盘操作是由其他 线程 完成的,结果的处理有两种模式:

  • 同步处理 JavaScript 主线程 会等待 其线程的执行结果,然后再继续执行主线程的代码,效率较低
  • 异步处理 JavaScript 主线程 不会等待 其线程的执行结果,直接执行后续的主线程代码,效率较好

appendFile / appendFileSync 追加写入

appendFile 作用是在文件尾部追加内容,appendFile 语法与 writeFile 语法完全相同

语法:

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

fs.appendFileSync(file, data[, options])

返回值:二者都为 undefined

实例代码:

1
2
3
4
5
6
fs.append('./座右铭.txt', '则其善者而从之,其不善者而改之。', err =>{
if(err) throw err
console.log('追加成功')
})

fs.appendFileSync('./座右铭.txt','\r\n温故而知新,可以为师矣')

createWriteStream 流式写入

语法fs.createWriteStream(path[, options])

参数说明

  • path 文件路径

  • options 选项配置( 可选

**返回值: **Object

代码示例:

1
2
3
4
5
6
7
8
9
10
let ws = fs.createWriteStream('./观书有感.txt')

//写入数据到流
ws.write('半亩方塘一鉴开\r\n')
ws.write('天光云影共徘徊\r\n')
ws.write('问渠那得清如许\r\n')
ws.write('为有源头活水来\r\n')

//关闭写入流,表明已没有数据要被写入可写流
ws.end()

程序打开一个文件是需要消耗资源的,流式写入可以减少打开关闭文件的次数。

流式写入方式适用于 大文件写入或者频繁写入的场景,writeFile适合于 写入频率较低的场景

文件读取

文件读取顾名思义,就是通过程序从文件中取出其中的数据,我们可以使用如下几种方式:

方法 说明
readFile 异步读取
readFileSync 同步读取
createReadStream 流式读取

文件移动与重命名

在 Node.js 中,我们可以使用 renamerenameSync 来移动或重命名 文件或文件夹

语法:

fs.rename(oldPath, newPath, callback)

fs.renameSync(oldPath, newPath)

参数说明:

  • oldPath 文件当前的路径

  • newPath 文件新的路径

  • callback 操作后的回调

代码示例:

1
2
3
4
5
6
fs.rename('./观书有感.txt', './论语/观书有感.txt', err =>{
if(err) throw err
console.log('移动完成')
})

fs.renameSync('./座右铭.txt', './论语/.我的座右铭.txt')

: 如果还是移动到当前路径,但是修改了名字,就是重命名了

文件删除

在 Node.js 中,我们可以使用 unlinkunlinkSync 来删除文件

语法:

fs.unlink(path, callback)

fs.unlinkSync(path)

参数说明

  • path 文件路径

  • callback 操作后的回调

代码示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
const fs = require('fs')

fs.unlink('./test.txt', err =>{
if(err) throw err
console.log('删除成功')
})

fs.unlinkSync('./test2.txt')


// 调用 rm 方法 14.4 同步 rmSync
fs.rm('./论语.txt', err => {
if (err) {
console.log('删除失败')
return

}
console.log('删除成功')
})

文件夹操作

借助 Node.js 的能力,我们可以对文件夹进行 创建读取删除 等操作

方法 说明
mkdir / mkdirSync 创建文件夹
readdir / readdirSync 读取文件夹
rmdir / rmdirSync 删除文件夹

mkdir 创建文件夹

在 Node.js 中,我们可以使用 mkdirmkdirSync 来创建文件夹

语法:

fs.mkdir(path[, options], callback)

fs.mkdirSync(path[, options])

参数说明

  • path 文件夹路径

  • options 选项配置( 可选

  • callback 操作后的回调

示例代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 异步创建文件夹  mk  make  制作   dir  directory  文件夹
fs.mkdir('./page', err =>{
if(err) throw err
console.log('创建成功')
})

// 递归异步创建
fs.mkdir('./1/2/3', {recursive: true}, err =>{
if(err) throw err
console.log('递归创建成功')
})

// 递归同步创建文件夹
fs.mkdirSync('./x/y/z', {recursive: true})

readdir 读取文件夹

在 Node.js 中,我们可以使用 readdirreaddirSync 来读取文件夹

语法:

fs.readdir(path[, options], callback)

fs.readdirSync(path[, options])

参数说明:

  • path 文件夹路径

  • options 选项配置( 可选

  • callback 操作后的回调

示例代码:

1
2
3
4
5
6
7
8
// 异步读取
fs.readdir('./论语', (err, data) => {
if(err) throw err
console.log(data)
})
// 同步读取
let data = fs.readdirSync('./论语')
console.log(data)

rmdir 删除文件夹

在 Node.js 中,我们可以使用 rmdirrmdirSync 来删除文件夹

语法

fs.rmdir(path[, options], callback)

fs.redirSync(path[, options])

参数说明

  • path 文件夹路径

  • options 选项配置( 可选 )

  • callback 操作后的回调

示例代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// 异步删除文件夹  rm  remove 移除
fs.rmdir('./page', err => {
if(err) throw err
console.log('删除成功')
})
//异步递归删除文件夹 不推荐
//=>DeprecationWarning: In future versions of Node.js, fs.rmdir(path, { recursive: true }) will be removed. Use fs.rm(path, { recursive: true }) instead
fs.rmdirSync('./1', {recursive: true}, err => {
if(err){
console.log(err)
return
}
console.log('递归删除')
})
//同步递归删除文件夹
fs.rmdirSync('./x', {recursive: true})

// 建议使用
fs.rm('./a', { recursive: true }, err => {
if (err) {
console.log(err)
return
}
console.log('删除成功')
})

查看资源状态

在 Node.js 中,我们可以使用 statstatSync 来查看资源的详细信息

语法

fs.stat(path[, options], callback)

fs.statSync(path[, options])

参数说明

  • path 文件夹路径

  • options 选项配置( 可选 )

  • callback 操作后的回调

示例代码:

1
2
3
4
5
6
7
8
// 异步获取状态
// stat 方法 status 缩写 状态
fs.stat('/data.txt', (err, data) =>{
if(err) throw err
console.log(data)
})
// 同步获取状态
let data = fs.statSync('./data.txt')

相对路径问题

fs 模块对资源进行操作时,路径的写法有两种:

  • 相对路径

    • ./座右铭.txt 当前目录下的 座右铭.txt
    • 座右铭.txt 等效于上面的写法
    • ../座右铭.txt 当前目录的上一级目录中的 座右铭.txt
  • 绝对路径

    • D:/Program Files windows 系统下的绝对路径
    • /user/bin Linux 系统下的绝对路径

相对路径中所谓的 当前目录 ,指的是 命名行的工作目录 ,而并非是文件的所在目录

所以当命名行的工作目录与文件所在目录不一致时,会出现一些 Bug

__dirname

__dirnamerequire 类似,都是 Node.js 环境中的 ‘全局’ 变量

__dirname 保存着 当前文件夹所在目录的绝对路径,可以使用 __dirname 与文件名拼接成绝对路径

代码示例:

1
2
3
//=>__dirname + '/data.txt'  === 'D:\\Desktop\\Node\\code\\03-fs模块/data.txt'
let data = fs.readFileSync(__dirname + '/data.txt')
console.log(data)

使用 fs 模块的时候,尽量使用 __dirname 路径转换为绝对路径,这样可以避免相对路径产生的 Bug

path模块

path 模块提供了 操作路径 的功能,我们将介绍如下几个较为常用的几个 API:

API 说明
path.resolve 拼接规范的绝对路径 常用
path.sep 获取操作系统的路径分隔符
path.parse 解析路径并返回对象
path.basename 获取路径的基础名称
path.dirname 获取路径的目录名
path.extname 获得路径的扩展名

代码示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// 导入 fs 模块
const fs = require('fs')
// 导入 path 模块
const path = require('path')

// 写入文件
// fs.writeFileSync(__dirname + '/index.html', 'love')
console.log(__dirname + '/index.html') //=>D:\Desktop\Node\code\04-path/index.html

// resolve 解决问题 拼接绝对路径
console.log(path.resolve(__dirname, './index.html')) //=>D:\Desktop\Node\code\04-path\index.html
console.log(path.resolve(__dirname, 'index.html')) //=>D:\Desktop\Node\code\04-path\index.html
console.log(path.resolve(__dirname, '/index.html', './test')) //=>D:\index.html\test

// sep 获取路径分隔符
console.log(path.sep) //=> window \ linux /

// parse 方法 __filename '全局变量'
console.log(__filename) //=>文件的绝对路径 //=>D:\Desktop\Node\code\04-path\01-path.js
// 解析路径
let str = 'D:\\Desktop\\Node\\code\\04-path\\01-path.js'
console.log(path.parse(str))

// 获取路径基础名称
console.log(path.basename(pathname))

// 获取路径的目录名
console.log(path.dirname(pathname))

// 获取路径的拓展名
console.log(path.extname(pathname))

HTTP模块

使用 nodejs 创建 HTTP 服务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//1. 导入 http 模块
const http = require('http');


//2. 创建服务对象 create 创建 server 服务
// request 意为请求. 是对请求报文的封装对象, 通过 request 对象可以获得请求报文的数据
// response 意为响应. 是对响应报文的封装对象, 通过 response 对象可以设置响应报文
const server = http.createServer((request, response) => {
// 设置响应体
response.end('Hello HTTP server');
}); //=>返回结果是一个对象

//3. 监听端口, 启动服务
server.listen(9000, () => {
console.log('服务已经启动, 端口 9000 监听中...');
});

获取 HTTP 请求报文

含义 语法
请求方法 request.method
请求版本 request.httpVersion
请求路径 request.url
URL 路径 require('url').parse(request.url).pathname
URL 查询字符串 require('url').parse(request.url, true).query
请求头 request.headers
请求体 request.on(‘data’, function(chunk){}) request.on(‘end’, function(){})

设置 HTTP 响应报文

作用 语法
设置响应状态码 response.statusCode
设置响应状态描述 response.statusMessage ( 用的非常少 )
设置响应头信息 response.setHeader(‘头名’, ‘头值’) (可以自定义)
设置响应体 response.write(‘xx’) response.end(‘xxx’)

Node.js 模块化

介绍

将一个复杂的程序文件依据一定规则(规范)拆分成多个文件的过程称之为 模块化

其中拆分出的 每个文件就是一个模块,模块的内部数据是私有的,不过模块可以暴露内部数据以便其他模块使用。

下面是模块化的一些好处:

  1. 防止命名冲突

  2. 高复用性

  3. 高维护性

模块暴露数据

模块暴露数据的方式有两种:

  1. module.exports = value
  2. exports.name = value

使用:

  1. 创建 me.js

    1
    2
    3
    4
    5
    6
    //声明函数
    function tiemo(){
    console.log('贴膜....');
    }
    //暴露数据
    module.exports = tiemo;
  2. 创建 index.js

    1
    2
    3
    4
    //导入模块
    const tiemo = require('./me.js');
    //调用函数
    tiemo(); //=> 贴膜....

使用时有几点注意:

  • module.exports 可以暴露 任意 数据
  • 不能使用 exports = value 的形式暴露数据,模块内部 module 与 exports 的隐式关系
    exports = module.exports = {} ,require 返回的是目标模块中 module.exports 的值

导入(引入)模块

在模块中使用 require 传入文件路径即可引入文件

1
const test = require('./me.js')

require 使用的一些注意事项:

  1. 对于自己创建的模块,导入时路径建议写 相对路径,且不能省略 ./../

  2. jsjson 文件导入时可以不用写后缀,c/c++编写的 node 扩展文件也可以不写后缀,但是一般用不到,直接使用 noderequire() 方法即可将 JSON 文件转换成 JS 对象

  3. 如果导入其他类型的文件,会以 js 文件进行处理

  4. 如果导入的路径是个文件夹,则会 首先 检测该文件夹下 package.json 文件中 main 属性对应的文件,

    如果存在则导入,反之如果文件不存在会报错。

    如果 main 属性不存在,或者 package.json 不存在,则会尝试导入文件夹下的 index.js
    index.json

    如果还是没找到,就会报错

  5. 导入 node.js 内置模块时,直接 require 模块的名字即可,无需加 ./../

导入模块的基本流程

这里我们介绍一下 require 导入 自定义模块 的基本流程

  1. 将相对路径转为绝对路径,定位目标文件
  2. 缓存检测
  3. 读取目标文件代码
  4. 包裹为一个函数并执行(自执行函数)。通过 arguments.callee.toString() 查看自执行函数
  5. 缓存模块的值
  6. 返回 module.exports 的值
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/**
* 伪代码
*/

function require(file){
//1. 将相对路径转为绝对路径,定位目标文件
let absolutePath = path.resolve(__dirname, file);
//2. 缓存检测
if(caches[absolutePath]){
return caches[absolutePath];
}
//3. 读取文件的代码
let code = fs.readFileSync(absolutePath).toString();
//4. 包裹为一个函数 然后执行
let module = {};
let exports = module.exports = {};
(function (exports, require, module, __filename, __dirname) {
const test = {
name: '尚硅谷'
}

module.exports = test;

//输出
console.log(arguments.callee.toString());
})(exports, require, module, __filename, __dirname)
//5. 缓存结果
caches[absolutePath] = module.exports;
//6. 返回 module.exports 的值
return module.exports;
}

CommonJS 规范

module.exportsexports 以及 require 这些都是 CommonJS 模块化规范中的内容。

而 Node.js 是实现了 CommonJS 模块化规范,二者关系有点像 JavaScript 与 ECMAScript。

CommonJS

CommonJS 是 Node.js 最初采用的模块系统,主要特点包括:

语法

1
2
3
4
5
6
7
8
9
// 导出
module.exports = { function1, function2 };
// 或
exports.function1 = function1;

// 导入
const module = require('./module');
// 或
const { function1 } = require('./module');

特点

  1. 同步加载:模块在运行时同步加载
  2. 动态导入:可以在条件语句中导入
  3. 值拷贝:导入的是值的拷贝,而非引用
  4. 循环依赖处理:通过缓存部分执行的模块解决

使用场景

  • Node.js 服务端开发
  • 较老的前端项目(通过 Browserify 或 Webpack 等工具转换)

ES Module

ES Module 是 ECMAScript 标准的一部分,是现代 JavaScript 推荐的模块系统:

语法

1
2
3
4
5
6
7
8
9
10
11
12
// 导出
export function function1() {}
export const variable = 'value';
// 或
export default function() {}

// 导入
import { function1, variable } from './module';
// 或
import defaultExport from './module';
// 动态导入
import('./module').then(module => {});

特点

  1. 静态分析:导入导出语句在编译时处理,支持静态分析
  2. 异步加载:模块可以异步加载
  3. 值引用:导入的是值的引用,而非拷贝
  4. 不可修改:导入的绑定是只读的
  5. 支持 Tree Shaking:可以在构建时移除未使用的代码

使用场景

  • 现代浏览器
  • 现代前端框架(React, Vue, Angular 等)
  • 使用 TypeScript 的项目
  • 支持 ES Module 的 Node.js 版本

CommonJS 和 ES Moudle的区别

  1. 语法差异

    • CommonJS: require()module.exports
    • ES Module: importexport
  2. 加载时机

    • CommonJS: 运行时加载
    • ES Module: 编译时加载(静态分析)
  3. 导入内容

    • CommonJS: 导入的是值的拷贝
    • ES Module: 导入的是值的引用(实时绑定)
  4. 顶层作用域

    • CommonJS: this 指向当前模块
    • ES Module: this 是 undefined
  5. 文件扩展名

    • CommonJS: 通常是 .js
    • ES Module: 在 Node.js 中通常是 .mjs,或在 package.json 中设置 "type": "module"

在 Node.js 中使用 ES Module

在 Node.js 中使用 ES Module 有两种方式:

  1. 使用 .mjs 扩展名
  2. 在 package.json 中设置 "type": "module"
1
2
3
4
5
6
7
{
"name": "my-package",
"type": "module",
"dependencies": {
// ...
}
}

互操作性

在现代项目中,可能需要在 ES Module 中导入 CommonJS 模块,或反之:

1
2
3
4
5
// ES Module 导入 CommonJS 模块
import cjsModule from 'commonjs-module';

// CommonJS 导入 ES Module (Node.js 14+)
const { default: esModule } = require('es-module');

不过,这种互操作性有一些限制,特别是在处理默认导出和命名导出时。

npm包管理工具

介绍

管理『包』的应用软件,可以对「包」进行 下载安装更新删除上传等操作

借助包管理工具,可以快速开发项目,提升开发效率

包管理工具是一个通用的概念,很多编程语言都有包管理工具,所以 掌握好包管理工具非常重要

常用的包管理工具

下面列举了前端常用的包管理工具

  • npm
  • yarn
  • cnpm

npm 的安装

node.js 在安装时会 自动安装 npm ,所以如果你已经安装了 node.js,可以直接使用 npm

可以通过 npm -v 查看版本号测试,如果显示版本号说明安装成功,反之安装失败

npm 基本使用

初始化

创建一个空目录,然后以此目录作为工作目录 启动命令行工具,执行 npm init

npm init 命令的作用是将文件夹初始化为一个『包』, 交互式创建 package.json 文件

package.json 是包的配置文件,每个包都必须要有 package.json

package.json 内容示例:

1
2
3
4
5
6
7
8
9
10
11
{
"name": "01_npm",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}

属性翻译

1
2
3
4
5
6
7
8
9
10
11
{
"name": "1-npm", #包的名字
"version": "1.0.0", #包的版本
"description": "", #包的描述
"main": "index.js", #包的入口文件
"scripts": { #脚本配置
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "", #作者
"license": "ISC" #开源证书
}

初始化的过程中还有一些注意事项:

  1. package name (包名) 不能使用中文、大写,默认值是文件夹的名称,所以文件夹名称也不
    能使用中文和大写
  2. version (版本号)要求 x.x.x 的形式定义,x 必须是数字,默认值是 1.0.0
  3. ISC 证书与 MIT 证书功能上是相同的,关于开源证书扩展阅读 http://www.ruanyifeng.com/blog/2011/05/how_to_choose_free_software_licenses.html
  4. package.json 可以手动创建与修改
  5. 使用 npm init -y 或者 npm init --yes 极速创建 package.json

搜索包

搜索包的方式有两种

  1. 命令行 『npm s/search 关键字』

  2. 网站搜索 网址是 https://www.npmjs.com/

require 导入 npm 包基本流程

  1. 在当前文件夹下 node_modules 中寻找同名的文件夹
  2. 在上级目录中下的 node_modules 中寻找同名的文件夹,直至找到磁盘根目录

生产依赖与开发依赖

我们可以在安装时设置选项来区分 依赖的类型,目前分为两类:

类型 命令 补充
生产依赖 npm i -S uniq
npm i –save uniq
-S 等效于 –save,-S 是默认选项
包信息保存在 package.json 中 dependencies 属性
开发依赖 npm i -D less
npm i –save-dev less
-D 等效于 –save-dev
包信息保存在 package.json 中 devDependencies 属性

开发依赖 是只在开发阶段使用的依赖包,而 生产依赖 是开发阶段和最终上线运行阶段都用到的依赖包

全局安装

我们可以执行安装选项 -g 进行全局安装

1
npm i -g nodemon

全局安装完成之后就可以在命令行的任何位置运行 nodemon 命令

该命令的作用是 自动重启 node 应用程序

说明:

  • 全局安装的命令不受工作目录位置影响
  • 可以通过 npm root -g 可以查看全局安装包的位置
  • 不是所有的包都适合全局安装,只有全局类的工具才适合,可以通过查看包的官方文档来确定安装方式

修改 windows 执行策略

windows 默认不允许 npm 全局命令执行脚本文件,所以需要修改执行策略

  1. 管理员身份打开 powershell 命令行

  2. 键入命令 set-ExecutionPolicy remoteSigned

  3. 键入 A 然后敲回车 👌

安装包依赖

在项目协作中有一个常用的命令就是 npm i,通过该命令可以依据 package.jsonpackage-lock.json 的依赖声明安装项目依赖

1
2
npm i
npm install

运行之后文件夹下会增加两个资源

  • node_modules 文件夹 存放下载的包
  • package-lock.json 包的锁文件,用来锁定包的版本

node_modules 文件夹大多数情况都不会存入版本库

安装指定版本的包

项目中可能会遇到版本不匹配的情况,有时就需要安装指定版本的包,可以使用下面的命令的

1
2
3
4
5
## 格式
npm i <包名@版本号>

## 示例
npm i jquery@1.11.2

删除依赖

项目中可能需要删除某些不需要的包,可以使用下面的命令

1
2
3
4
5
6
## 局部删除
npm remove uniq
npm r uniq

## 全局删除
npm remove -g nodemon

配置命令别名

通过配置命令别名可以更简单的执行命令

配置 package.json 中的 scripts 属性

1
2
3
4
5
6
{
"scripts": {
"server": "node server.js",
"start": "node index.js",
},
}

配置完成之后,可以使用别名执行命令

1
2
npm run server
npm run start

不过 start 别名比较特别,使用时可以省略 run

1
npm start

补充说明:

  • npm start 是项目中常用的一个命令,一般用来启动项目
  • npm run 有自动向上级目录查找的特性,跟 require 函数也一样
  • 对于陌生的项目,我们可以通过查看 scripts 属性来参考项目的一些操作

npx

npx (Node Package Execute) 是 npm 5.2.0 版本引入的工具,主要用于:

  1. 临时执行包:无需全局安装即可执行 npm 包

    1
    npx cowsay "Hello"
  2. 一次性使用:适合那些不需要长期安装的工具

    1
    npx create-react-app my-app
  3. 确保使用最新版本:每次都会使用最新版本的包

    1
    npx eslint --init
  4. 执行 GitHub gist 或仓库:可以直接运行 GitHub 上的代码

    1
    npx github:user/repo

npm和npx的区别

  1. 安装方式

    • npm 将包安装到本地 node_modules 或全局环境
    • npx 临时下载并执行包,不会留下持久安装
  2. 使用场景

    • npm 适合安装项目依赖和常用工具
    • npx 适合一次性命令和避免全局污染
  3. 版本控制

    • npm 安装后使用固定版本
    • npx 每次执行都会使用最新版本(除非指定)

实际应用示例

创建 React 应用时:

  • 使用 npm:
    1
    2
    npm install -g create-react-app
    create-react-app my-app
  • 使用 npx(推荐):
    1
    npx create-react-app my-app

npx 方式避免了全局安装,并确保每次都使用最新版本的 create-react-app。

cnpm

介绍

cnpm 是一个淘宝构建的npmjs.com的完整镜像,也称为『淘宝镜像』,网址https://npmmirror.com/
cnpm 服务部署在国内 阿里云服务器上,可以提高包的下载速度

官方也提供了一个全局工具包 cnpm ,操作命令与 npm 大体相同

安装

我们可以通过 npm 来安装 cnpm 工具

1
npm install -g cnpm --registry=https://registry.npmmirror.com

操作命令

功能 命令
初始化 cnpm init / cnpm init
安装包 cnpm i uniq
cnpm i -S uniq
cnpm i -D uniq
cnpm i -g nodemon
安装项目依赖 cnpm i
删除 cnpm r uniq

npm 配置淘宝镜像

用 npm 也可以使用淘宝镜像,配置的方式有两种

  • 直接配置
  • 工具配置

直接配置

执行如下命令即可完成配置

1
npm config set registry https://registry.npmmirror.com/

工具配置

使用 nrm 配置 npm 的镜像地址 npm registry manager

  1. 安装 nrm

    1
    npm i -g nrm
  2. 修改镜像

    1
    nrm use taobao
  3. 检查是否配置成功(选做)

    1
    npm config list

yarn

yarn 介绍

yarn 是由 Facebook 在 2016 年推出的新的 Javascript 包管理工具,官方网址:https://yarnpkg.com/

yarn 特点

yarn 官方宣称的一些特点

  • 速度超快:yarn 缓存了每个下载过的包,所以再次使用时无需重复下载。 同时利用并行下载以最大化资源利用率,因此安装速度更快
  • 超级安全:在执行代码之前,yarn 会通过算法校验每个安装包的完整性
  • 超级可靠:使用详细、简洁的锁文件格式和明确的安装算法,yarn 能够保证在不同系统上无差异的工作

yarn 安装

我们可以使用 npm 安装 yarn

1
npm i -g yarn

yarn 常用命令

功能 命令
初始化 yarn init / yarn init -y
安装包 yarn add uniq 生产依赖
yarn add less –dev 开发依赖
yarn global add nodemon 全局安装
删除包 yarn remove uniq 删除项目依赖包
yarn global remove nodemon 全局删除包
安装项目依赖 yarn
运行命令别名 yarn <别名> # 不需要添加 run

yarn 全局安装包的位置可以通过 yarn global bin来查看。

如果全局安装的包不可用:

  • 配置 path 环境

yarn 配置淘宝镜像

可以通过如下命令配置淘宝镜像

1
yarn config set registry https://registry.npmmirror.com/

可以通过 yarn config list 查看 yarn 的配置项

管理发布包

创建与发布

我们可以将自己开发的工具包发布到 npm 服务上,方便自己和其他开发者使用,操作步骤如下:

  1. 创建文件夹,并创建文件 index.js, 在文件中声明函数,使用 module.exports 暴露

  2. npm 初始化工具包,package.json 填写包的信息 (包的名字是唯一的)

  3. 注册账号 https://www.npmjs.com/signup

  4. 激活账号 ( 一定要激活账号

  5. 修改为官方的官方镜像 (命令行中运行 nrm use npm )

  6. 命令行下 npm login 填写相关用户信息

  7. 命令行下 npm publish 提交包 👌

更新包

后续可以对自己发布的包进行更新,操作步骤如下

  1. 更新包中的代码

  2. 测试代码是否可用

  3. 修改 package.json 中的版本号

  4. 发布更新

    1
    npm publish

删除包

执行如下命令删除包

1
npm unpublish --force

删除包需要满足一定的条件, https://docs.npmjs.com/policies/unpublish

  • 你是包的作者
  • 发布小于 24 小时
  • 大于 24 小时后,没有其他包依赖,并且每周小于 300 下载量,并且只有一个维护者

扩展内容

在很多语言中都有包管理工具,比如:

语言 包管理工具
PHP composer
Python pip
Java maven
Go go mod
JavaScript npm/yarn/cnpm/other
Ruby rubyGems

除了编程语言领域有包管理工具之外,操作系统层面也存在包管理工具,不过这个包指的是『软件包

操作系统 包管理工具 网址
Centos yum https://packages.debian.org/stable/
Ubuntu apt https://packages.ubuntu.com/
MacOS homebrew https://brew.sh/
Windows chocolatey https://chocolatey.org/

express 介绍

express 是一个基于 Node.js 平台的极简、灵活的 WEB 应用开发框架,官方网址: https://www.expressjs.com.cn/

简单来说,express 是一个封装好的工具包,封装了很多功能,便于我们开发 WEB 应用(HTTP 服务)

express 使用

express 下载

express 本身是一个 npm 包,所以可以通过 npm 安装

1
2
npm init
npm i express

express 初体验

大家可以按照这个步骤进行操作:

1
2
3
4
5
6
7
8
9
10
11
12
//1. 导入 express
const express = require('express');
//2. 创建应用对象
const app = express();
//3. 创建路由规则
app.get('/home', (req, res) => {
res.end('hello express server');
});
//4. 监听端口 启动服务
app.listen(3000, () =>{
console.log('服务已经启动, 端口监听为 3000...');
});

express 路由

什么是路由

官方定义: 路由确定了应用程序如何响应客户端对特定端点的请求

路由的使用

一个路由的组成有 请求方法路径回调函数 组成

express 中提供了一系列方法,可以很方便的使用路由,使用格式如下:

1
app.<method>(path,callback)

代码示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建 get 路由
app.get('/home', (req, res) => {
res.send('网站首页');
});

//首页路由
app.get('/', (req,res) => {
res.send('我才是真正的首页');
});

//创建 post 路由
app.post('/login', (req, res) => {
res.send('登录成功');
});

//匹配所有的请求方法
app.all('/search', (req, res) => {
res.send('1 秒钟为您找到相关结果约 100,000,000 个');
});

//自定义 404 路由
app.all("*", (req, res) => {
res.send('<h1>404 Not Found</h1>')
});

//监听端口 启动服务
app.listen(3000, () =>{
console.log('服务已经启动, 端口监听为 3000');
});

获取请求参数

express 框架封装了一些 API 来方便获取请求报文中的数据,并且兼容原生 HTTP 模块的获取方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
//导入 express
const express = require('express');

//创建应用对象
const app = express();

//获取请求的路由规则
app.get('/request', (req, res) => {
// 1. 获取报文的方式与原生 HTTP 获取方式是兼容的
console.log(req.method);
console.log(req.url);
console.log(req.httpVersion);
console.log(req.headers);

// 2. express 独有的获取报文的方式
// 获取路径
console.log(req.path)
//获取查询字符串
console.log(req.query); // 『相对重要』对象形式返回所有的查询字符串
// 获取指定的请求头
console.log(req.get('host'));
res.send('请求报文的获取');
});
//启动服务
app.listen(3000, () => {
console.log('启动成功....')
})

获取路由参数

路由参数指的是 URL 路径中的参数(数据)

1
2
3
app.get('/:id.html', (req, res) => {
res.send('商品详情, 商品 id 为' + req.params.id);
});

express 响应设置

express 框架封装了一些 API 来方便给客户端响应数据,并且兼容原生 HTTP 模块的获取方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//获取请求的路由规则
app.get("/response", (req, res) => {
//1. express 中设置响应的方式兼容 HTTP 模块的方式
res.statusCode = 404;
res.statusMessage = 'xxx';
res.setHeader('abc','xyz');
res.write('响应体');
res.end('xxx');

//2. express 的响应方法
res.status(500); //设置响应状态码
res.set('xxx','yyy');//设置响应头
res.send('中文响应不乱码');//设置响应体
//连贯操作
res.status(404).set('xxx','yyy').send('你好朋友')

//3. 其他响应
res.redirect('http://atguigu.com')//重定向
res.download('./package.json');//下载响应
res.json();//响应 JSON
res.sendFile(__dirname + '/home.html') //响应文件内容
});

express 中间件

什么是中间件

中间件(Middleware)本质是一个回调函数

中间件函数 可以像路由回调一样访问 请求对象(request)响应对象(response)

中间件的类型

全局中间件
路由中间件

定义全局中间件

每一个请求 到达服务端之后 都会执行全局中间件函数

声明中间件函数:

1
2
3
4
5
6
let recordMiddleware = function(request,response,next){
//实现功能代码
//.....
//执行next函数(当如果希望执行完中间件函数之后,仍然继续执行路由中的回调函数,必须调用next)
next();
}

应用中间件:

1
app.use(recordMiddleware)

声明时可以直接将匿名函数传递给 use

1
2
3
4
app.use(function (request, response, next) {
console.log('定义第一个中间件');
next();
})

多个全局中间件

express 允许使用 app.use() 定义多个全局中间件

1
2
3
4
5
6
7
8
app.use(function (request, response, next) {
console.log('定义第一个中间件');
next();
})
app.use(function (request, response, next) {
console.log('定义第二个中间件');
next();
})

定义路由中间件

如果只需要对某一些路由进行功能封装,则就需要路由中间件

调用格式如下:

1
2
3
4
5
6
7
app.get('/路径',`中间件函数`,(request,response)=>{

});

app.get('/路径',`中间件函数1`,`中间件函数2`,(request,response)=>{

});

静态资源中间件

express 内置处理静态资源的中间件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//引入express框架
const express = require('express');
//创建服务对象
const app = express();
//静态资源中间件的设置,将当前文件夹下的public目录作为网站的根目录
app.use(express.static('./public')); //当然这个目录中都是一些静态资源
//如果访问的内容经常变化,还是需要设置路由
//但是,在这里有一个问题,如果public目录下有index.html文件,单独也有index.html的路由
//则谁书写在前,优先执行谁
app.get('/index.html',(request,response)=>{
respsonse.send('首页');
});
//监听端口
app.listen(3000,()=>{
console.log('3000 端口启动....');
});

注意事项:

  1. index.html 文件为默认打开的资源
  2. 如果静态资源与路由规则同时匹配,谁先匹配谁就响应
  3. 路由响应动态资源,静态资源中间件响应静态资源

获取请求体数据

1
2
3
4
5
6
7
const express = require('express');

const app = express();
// 解析 JSON 格式的请求体的中间件
app.use(express.json())
// 解析 querystring 格式请求体的中间件
app.use(express.urlencoded({ extended: false }))

Router

什么是 Router

express 中的 Router 是一个完整的中间件和路由系统,可以看做是一个小型的 app 对象。

Router 作用

对路由进行模块化,更好的管理路由

Router 使用

创建独立的 JS 文件(homeRouter.js)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
//1. 导入 express
const express = require('express');

//2. 创建路由器对象
const router = express.Router();

//3. 在 router 对象身上添加路由
router.get('/', (req, res) => {
res.send('首页');
})

router.get('/cart', (req, res) => {
res.send('购物车');
});

//4. 暴露
module.exports = router;

主文件

1
2
3
4
5
6
7
8
9
10
11
const express = require('express');

const app = express();
//5.引入子路由文件
const homeRouter = require('./routes/homeRouter');
//6.设置和使用中间件
app.use(homeRouter);

app.listen(3000,()=>{
console.log('3000 端口启动....');
})

EJS 模板引擎

什么是模板引擎

模板引擎是分离 用户界面和业务数据 的一种技术

什么是 EJS

EJS 是一个高效的 Javascript 的模板引擎
官网: https://ejs.co/
中文站: https://ejs.bootcss.com/

EJS 初体验

下载安装EJS

1
npm i ejs --save

代码示例

1
2
3
4
5
6
7
8
9
10
//1.引入ejs
const ejs = require('ejs');
//2.定义数据
let person = ['张三','李四','王五'];
//3.ejs解析模板返回结构
//<%= %> 是ejs解析内容的标记,作用是输出当前表达式的执行结构
//"<%= %>"可以直接输出变量或表达式的值,变量或表达式的值将作为一个字符串在浏览器中输出。
let html = ejs.render(‘<%= person.join(",") %>’, {person:person});
//4.输出结果
console.log(html);

命令行下运行

EJS 常用语法

执行JS代码

1
<% code %>

输出转义的数据到模板上

1
<%= code %>

输出非转义的数据到模板上

1
<%- code %>

在express中使用ejs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// 导入 express
const express = require('express')
const path = require('path')

// 创建应用对象
const app = express()
// 1. 设置模板引擎
app.set('view engine', 'ejs') // pug twing
// 2. 设置模板文件的存放位置
// 模板文件: 具有模板语法内容的文件
app.set('views', path.resolve(__dirname, './views'))

// 创建路由
app.get('/home', (req, res) => {
// 3. render 响应
// res.render('模板的文件名','数据')
let title = '网页标题'
res.render('home', { title })
// 4. 创建模板文件
// 如下面文件 views/home.ejs
})

// 监听端口,启动服务
app.listen(3000, () => {
console.log('服务器已启动~~~~')
})

views/home.ejs:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>

<body>
<h2>
<%=title %>
</h2>
</body>

</html>

express-generator

可使用应用程序生成器工具 (express-generator) 快速创建应用程序框架。

安装:npm install -g express-generator

创建工程命令:express -e 项目名称

  • -e:代表使用EJS模板引擎

MongoDB

MongoDB 是一个基于分布式文件存储的数据库,官方地址 https://www.mongodb.com/

操作语法与 JavaScript 类似,容易上手,学习成本低

Mongodb 中有三个重要概念需要掌握:

  • 数据库(database) 数据库是一个数据仓库,数据库服务下可以创建很多数据库,数据库中可以存放很多集合
  • 集合(collection) 集合类似于 JS 中的数组,在集合中可以存放很多文档
  • 文档(document) 文档是数据库中的最小单位,类似于 JS 中的对象

MongoDB 命令

Mongoose

介绍

Mongoose 是一个对象文档模型库,官网 http://www.mongoosejs.net/

作用

方便使用代码操作 mongodb 数据库

使用流程

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 //1. 安装 mongoose
//2. 导入 mongoose
const mongoose = require('mongoose');

//3. 连接数据库 数据库名称
mongoose.connect('mongodb://127.0.0.1:27017/bilibili');

//4. 设置连接回调
//连接成功 once 一次 事件回调函数只执行一次
mongoose.connection.on('open', () => {
console.log('连接成功');
//5. 创建文档结构对象
// 设置集合中 文档的属性以及属性值得类型
let BookSchema = new mongoose.Schema({
title: String,
author: String,
price: Number
});

//6. 创建文档模型对象 对文档操作的封装对象 mongoose会使用集合名称的复数,创建集合
let BookModel = mongoose.model('book', BookSchema);

//7. 插入文档
BookModel.create({
title: '西游记',
author: '吴承恩',
price: 19.9
}, (err, data) => {
// 判断是否有错误
if (err) throw err;
//输出 data 对象 如果没有出错,则输出插入后的文档对象
console.log(data);
//8. 断开连接 关闭数据链接 (项目运行过程中,不会添加该代码)
mongoose.disconnect();
});
});

//连接出错
mongoose.connection.on('error', () => {
console.log('连接出错~~');
})

//连接关闭
mongoose.connection.on('close', () => {
console.log('连接关闭');
})

字段类型

文档结构可选的常用字段类型列表

类型 描述
String 字符串
Number 数字
Boolean 布尔值
Array 数组,也可以使用 [] 来标识
Date 日期
Buffer Buffer 对象
Mixed 任意类型,需要使用 mongoose.Schema.Types.Mixed 指定
ObjectId 对象 ID,需要使用 mongoose.Schema.Types.ObjectId 指定
Decimal128 高精度数字,需要使用 mongoose.Schema.Types.Decimal128 指定

字段值验证

Mongoose 有一些内建验证器,可以对字段值进行验证

必填项

1
2
3
4
title: {
type: String,
required: true // 设置必填项
},

默认值

1
2
3
4
author: {
type: String,
default: '匿名' //默认值
},

枚举值

1
2
3
4
gender: {
type: String,
enum: ['男','女'] //设置的值必须是数组中的
},

唯一值

1
2
3
4
username: {
type: String,
unique: true
},

unique 需要 重建集合 才能有效果

CURD

数据库的基本操作包括四个,增加(create),删除(delete),修改(update),查(read)

增加

插入一条

1
2
3
4
5
6
7
8
9
SongModel.create({
title:'给我一首歌的时间',
author: 'Jay'
}, function(err, data){
//错误
console.log(err);
//插入后的数据对象
console.log(data);
});

批量插入

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
//1.引入mongoose
const mongoose = require('mongoose');

//2.链接mongodb数据库 connect 连接
mongoose.connect('mongodb://127.0.0.1:27017/project');

//3.设置连接的回调
mongoose.connection.on('open',()=>{
//4.声明文档结构
const PhoneSchema = new mongoose.Schema({
brand:String,
color:String,
price:Number,
tags:Array
})
//6.创建模型对象
const PhoneModel = mongoose.model('phone',PhoneSchema);
PhoneModel.insertMany([
{
brand:'华为',
color:'灰色',
price:2399,
tags:['电量大','屏幕大','信号好']
},
{
brand:'小米',
color:'白色',
price:2099,
tags:['电量大','屏幕大','信号好']
}
],(err,data)=>{
if(err) throw err;
console.log('写入成功');
mongoose.connection.close();
})
})

删除

删除一条数据

1
2
3
4
5
SongModel.deleteOne({_id:'5dd65f32be6401035cb5b1ed'}, function(err){
if(err) throw err;
console.log('删除成功');
mongoose.connection.close();
});

批量删除

1
2
3
4
5
SongModel.deleteMany({author:'Jay'}, function(err){
if(err) throw err;
console.log('删除成功');
mongoose.connection.close();
});

更新

更新一条数据

1
2
3
4
SongModel.updateOne({author: 'JJ Lin'}, {author: '林俊杰'}, function (err) {
if(err) throw err;
mongoose.connection.close();
});

批量更新数据

1
2
3
4
SongModel.updateMany({author: 'Leehom Wang'}, {author: '王力宏'}, function (err) {
if(err) throw err;
mongoose.connection.close();
});

查询

查询一条数据

1
2
3
4
5
6
7
8
9
10
11
SongModel.findOne({author: '王力宏'}, function(err, data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});
//根据 id 查询数据
SongModel.findById('5dd662b5381fc316b44ce167',function(err, data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});

批量查询数据

1
2
3
4
5
6
7
8
9
10
11
12
//不加条件查询
SongModel.find(function(err, data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});
//加条件查询
SongModel.find({author: '王力宏'}, function(err, data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});

条件控制

运算符

在 mongodb 不能 > < >= <= !== 等运算符,需要使用替代符号

  • >使用 $gt
  • < 使用 $lt
  • = 使用 $gte
  • <= 使用 $lte
  • !== 使用 $ne
1
2
3
4
5
6
7
8
9
10
db.students.find({id:{$gt:3}}); id号比3大的所有的记录

// 价格小于 20 的图书
BookModel.find({ price: { $lt: 20 } }, (err, data) => {
if (err) {
console.log('读取失败~~~')
return
}
console.log(data)
})

逻辑运算

$or 逻辑或的情况

1
2
3
4
5
6
7
8
9
10
db.students.find({$or:[{age:18},{age:24}]});

// 曹雪芹 或者 余华的书
BookModel.find({ $or: [{ author: '曹雪芹' }, { author: '余华' }] }, (err, data)=>{
if (err) {
console.log('读取失败~~~')
return
}
console.log(data)
})

$and 逻辑与的情况

1
2
3
4
5
6
7
8
9
10
db.students.find({$and: [{age: {$lt:20}}, {age: {$gt: 15}}]});

// 价格大于 30 且 小于 70
BookModel.find({ $and: [{ price: { $gt: 30 } }, { price: { $lt: 70 } }] }, (err, data) => {
if (err) {
console.log('读取失败~~~')
return
}
console.log(data)
})

正则匹配

条件中可以直接使用 JS 的正则语法,通过正则可以进行模糊查询

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
db.students.find({name:/imissyou/});

正则表达式,搜索书籍名称中带有 '三' 的图书
BookModel.find({ name: /三/ }, (err, data) => {
if (err) {
console.log('读取失败~~~')
return
}
console.log(data)
})

BookModel.find({ name: new RegExp('三') }, (err, data) => {
if (err) {
console.log('读取失败~~~')
return
}
console.log(data)
})

个性化读取

字段筛选

1
2
3
4
5
6
7
//0:不要的字段
//1:要的字段
SongModel.find().select({_id:0,title:1}).exec(function(err,data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});

数据排序

1
2
3
4
5
6
7
8
// sort 排序
// 1:升序
// -1:倒序
SongModel.find().sort({hot:1}).exec(function(err,data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});

数据截取

1
2
3
4
5
6
//skip 跳过   limit 限定
SongModel.find().skip(10).limit(10).exec(function(err,data){
if(err) throw err;
console.log(data);
mongoose.connection.close();
});

会话控制

介绍

所谓会话控制就是 对会话进行控制

HTTP 是一种无状态的协议,它没有办法区分多次的请求是否来自于同一个客户端,无法区分用户

而产品中又大量存在的这样的需求,所以我们需要通过 会话控制 来解决该问题

常见的会话控制技术有三种:

  • cookie
  • session
  • token

cookie 是 HTTP 服务器发送到用户浏览器并保存在本地的一小块数据

cookie 是保存在浏览器端的一小块数据

cookie 是按照域名划分保存的

简单示例:

域名 cookie
www.baidu.com a=100; b=200
www.bilibili.com xid=1020abce121; hm=112411213
jd.com x=100; ocw=12414cce

浏览器向服务器发送请求时,会自动将 当前域名下 可用的 cookie 设置在请求头中,然后传递给服务器

这个请求头的名字也叫 cookie ,所以将 cookie 理解为一个 HTTP 的请求头也是可以的

填写账号和密码校验身份,校验通过后下发 cookie
有了 cookie 之后,后续向服务器发送请求时,就会自动携带 cookie

浏览器操作 cookie 的操作,使用相对较少,大家了解即可

  1. 禁用所有 cookie
  2. 删除 cookie
  3. 查看 cookie

express 中可以使用 cookie-parser 进行处理

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
const express =require('express');
//1. 安装 cookie-parser npm i cookie-parser
//2. 引入 cookieParser 包
const cookieParser = require('cookie-parser');

const app = express();

//3. 设置 cookieParser 中间件
app.use(cookieParser());

//4-1 设置 cookie
app.get('/set-cookie', (request, response) => {
// 不带时效性 会在浏览器关闭的时候,销毁
response.cookie('username','wangwu');
// 带时效性
response.cookie('email','23123456@qq.com', {maxAge: 5*60*1000 });
//响应
response.send('Cookie的设置');
});

//4-2 读取 cookie
app.get('/get-cookie', (request, response) => {
//读取 cookie
console.log(request.cookies);
//响应体
response.send('Cookie的读取');
});

//4-3 删除cookie
app.get('/delete-cookie', (request, response) => {
//删除
response.clearCookie('username');
//响应
response.send('cookie 的清除');
});

//4. 启动服务
app.listen(3000, () => {
console.log('服务已经启动....');
});

不同浏览器中的 cookie 是相互独立的,不共享

session

session 是保存在 服务器端的一块儿数据,保存当前访问用户的相关信息

实现会话控制,可以识别用户的身份,快速获取当前用户的相关信息

session 运行流程

填写账号和密码校验身份,校验通过后创建 session 信息,然后将 session_id 的值通过响应头返回给浏览器

有了cookie,下次发送请求时会自动携带cookie,服务器通过 cookie 中的 session_id 的值确定用
户的身份

session 的代码操作

express 中可以使用 express-session 对 session 进行操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
const express = require('express');
//1. 安装包 npm i express-session connect-mongo
//2. 引入 express-session connect-mongo
const session = require("express-session");
const MongoStore = require('connect-mongo');

const app = express();

//3. 设置 session 的中间件
app.use(session({
name: 'sid', //设置cookie的name,默认值是:connect.sid
secret: 'atguigu', //参与加密的字符串(又称签名) 加盐
saveUninitialized: false, //是否为每次请求都设置一个cookie用来存储session的id
resave: true, //是否在每次请求时重新保存session
store: MongoStore.create({
mongoUrl: 'mongodb://127.0.0.1:27017/project' //数据库的连接配置
}),
cookie: {
httpOnly: true, // 开启后前端无法通过 JS 操作
maxAge: 1000 * 300 // 这一条 是控制 sessionID 的过期时间的!!!
},
}))

//创建 session session的设置
app.get('/login', (req, res) => {
//设置session
req.session.username = 'zhangsan';
req.session.email = 'zhangsan@qq.com'
res.send('登录成功');
})

//获取 session
app.get('/home', (req, res) => {
console.log('session的信息');
console.log(req.session.username);
// 检测 session 是否存在用户数据
if (req.session.username) {
res.send(`你好 ${req.session.username}`);
}else{
res.send('登录 注册');
}
})

//销毁 session
app.get('/logout', (req, res) => {
//销毁session
// res.send('设置session');
req.session.destroy(() => {
res.send('成功退出');
});
});
app.listen(3000, () => {
console.log('服务已经启动, 端口 ' + 3000 + ' 监听中...');
});

cookie 和 session 的区别主要有如下几点:

  1. 存在的位置
  • cookie:浏览器端
  • session:服务端
  1. 安全性
  • cookie 是以明文的方式存放在客户端的,安全性相对较低
  • session 存放于服务器中,所以安全性 相对 较好
  1. 网络传输量
  • cookie 设置内容过多会增大报文体积, 会影响传输效率
  • session 数据存储在服务器,只是通过 cookie 传递 id,所以不影响传输效率
  1. 存储限制
  • 浏览器限制单个 cookie 保存的数据不能超过 4K ,且单个域名下的存储数量也有限制
  • session 数据存储在服务器中,所以没有这些限制

token

token 是服务端生成并返回给 HTTP 客户端的一串加密字符串, token 中保存着用户信息

token 不属于 http 标准,完全由前后端协商而定,但 cookie 属于 http 标准

token 的工作流程

填写账号和密码校验身份,校验通过后响应 token,token 一般是在响应体中返回给客户端的
后续发送请求时,需要手动将 token 添加在请求报文中(cookie是自动携带的),一般是放在请求头中

token 的特点

  • 服务端压力更小

    • 数据存储在客户端
  • 相对更安全

    • 数据加密
    • 可以避免 CSRF(跨站请求伪造)
  • 扩展性更强

    • 服务间可以共享
    • 增加服务节点更简单

JWT

JWT(JSON Web Token )是目前最流行的跨域认证解决方案,可用于基于 token 的身份验证

JWT 使 token 的生成与校验更规范

我们可以使用 jsonwebtoken 包 来操作 token

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
//导入 jsonwebtokan
const jwt = require('jsonwebtoken');

//创建 token
// jwt.sign(数据, 加密字符串, 配置对象)
let token = jwt.sign({
username: 'zhangsan'
}, 'atguigu', {
expiresIn: 60 //单位是 秒
})

//解析 token
// jwt.verify(token,加密字符串,回调函数)
jwt.verify(token, 'atguigu', (err, data) => {
if(err){
console.log('校验失败~~');
return
}
console.log(data);// { username: '张三', iat: (创建时间), exp:(过期时间)}
})

本地域名

所谓本地域名就是 只能在本机使用的域名,一般在开发阶段使用

操作流程

编辑文件 C:\Windows\System32\drivers\etc\hosts

1
127.0.0.1   www.baidu.com

如果修改失败,可以修改该文件的权限

原理

在地址栏输入 域名 之后,浏览器会先进行 DNS(Domain Name System)查询,获取该域名对应的 IP 地址
请求会发送到 DNS 服务器,可以 根据域名返回 IP 地址

可以通过 ipconfig /all 查看本机的 DNS 服务器

hosts 文件也可以设置域名与 IP 的映射关系,在发送请求前,可以通过该文件获取域名的 IP 地址