node.js基础

344 阅读40分钟

1.node.js简介

node.js是一个基于 Chrome V8引擎的 javascript运行环境

  • JavaScript之所以可以在浏览器中执行,因为浏览器中都有JavaScript解析引擎。
  • 各主流浏览器的 javascript解析引擎:Chrome->v8,FireFox->OdinMonkey(奥丁猴), Safari-> JSCore,IE-> Chakra(查克拉)。
  • 在众多浏览器当中 Chrome V8解析和执行效率最高,所以 node.js采用了该引擎作为运行环境。

1653207790(1).png

node.js运行环境:

  1. node.js运行环境包含 v8引擎和内置API两个最核心的部分;
  2. v8引擎负责解析和执行js代码,内置 API提供了在js中调用这些API去实现一些后端相关功能的能力;
  3. 上面示意图中的流程表示在待执行的 js代码中可以调用 node提供的内置 API,然后这些待执行的js代码可以交给 v8引擎解析和执行。

注意1. 浏览器是 javascript的前端运行环境;2. node.js是 javascript的后端运行环境;3.node.js中无法调用 DOM和 BOM等浏览器内置 API。

node.js可以做什么:node.js作为一个 javascript的运行环境。仅仅提供了基础的功能和 API。然后基于这些基础功能,很多强大的工具和框架如雨后春笋,存出不穷。

  1. 基于 Express框架,可以快速构建 web应用;
  2. 基于 Electron框架,可以构建跨平台的桌面应用;
  3. 基于 Restify框架,可以快速构建 API接口项目;
  4. 读写和操作数据库、创建使用的命令行工具辅助前端开发、etc...

2.node.js环境的安装

如果希望通过 node.js来运行 javascript代码,则必须在计算机上安装 node.j环境才行。

安装包可以从 node.js官网首页直接下载,进入到 node.js官网首页(nodejs.org/en/), 点击绿色的按钮,下载所需的版本后,双击直接安装即可。

区分 LTS版本和 Current版本的不同:

  • LTS为长期稳定版,对于追求稳定性的企业级项目,推荐安装 LTS版本的 node.js;
  • Current为新特性尝鲜版,对热衷于尝试新特性的用户来说,推荐安装 Current版本的 node.js。但是,Current版本中可能存在隐藏的 bug或安全漏洞,因此不推荐在企业级项目中使用 Current版本的 node.js。

查看是否安装成功或安装的版本号: 打开终端,在终端输入命令 node -v后,按下回车键,即可查看安装的 node.js版本号。

3.什么是终端

终端是专门为开发人员设计的,用于实现人机交互的一种方式。

作为一名合格的程序员,我们有必要识记一些常用的终端命令,来辅助我们更好的操作与使用计算机。

4.在 node.js环境中执行 javascript代码

① 打开终端; ② 输入:node 要执行的js文件的路径(例如:C:\Users>node C:\Users\nodes\test.js,C:\Users\nodes>node test.js)

终端中的快捷键:在 Windows的 powershell或 cmd终端中,我们可以通过如下快捷键,来提高终端的操作效率。

① 使用 键,可以快速定位到上一次或后面执行过的命令; ② 使用 tab键,能够快速补全路径;③ 使用 esc键,能够快速清空当前已输入的命令;④ 输入 cls命令,可以清空终端。

5.fs文件系统模块

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

例如:① fs.readFile()方法,用来读取指定文件中的内容;② fs.writeFile()方法,用来向指定的文件中写入内容。

如果需要在 javascript代码中,使用 fs模块来操作文件,则需要使用如下的方式先导入它:const fs = reqiure('fs');

读取指定文件中的内容:

/**
* 语法: fs.readFile(path, options, callback)
* 参数: 1.path: 必需,字符串,表示文件的路径; 2.options: 可选,表示以什么编码格式来读取文件; 
* 3.callback: 必需,文件读取完成后,通过回调函数拿到读取的结果。
* 注意: 1.回调函数中参数 err表示读取失败后的结果; 2.回调函数中参数 res表示读取成功后的结果。
*/
const fs = require('fs');

fs.readFile('./files/readData.txt', 'utf8', function(err, res) {
    console.log(err, res);                                   
});

向指定的文件中写入内容:

/**
* 语法: fs.writeFile(file, data, options, callback)
* 参数: 1.file: 必需,需要指定一个文件路径的字符串,表示文件的存放路径; 2.data: 必需,表示要
* 写入的内容; 3.options: 可选,表示以什么格式写入内容,默认值是 utf8; 4.callback: 必需,文件
* 写入后的回调函数。
* 注意: 1.如果写入成功,回调函数中参数 err的值等于 null; 2.如果写入失败,回调函数中参数 err
* 的值等于一个错误对象。
*/
const fs =  require('fs');

fs.writeFile('./files/writeData.js', 'hahgahga', function(err) {
    console.log(err);
});

fs模块 - 路径动态拼接的问题:

  • 在使用 fs模块操作文件时,如果提供的操作路径是以 ./ ../ 开头的相对路径时,很容易出现路径动态拼接错误的问题。
  • 原因:代码在运行的时候,会以执行 node命令时所处的目录,动态拼接出被操作文件的完整路径。
  • 解决方案:在使用 fs模块操作文件时,直接提供完整的路径,不要提供./ ../ 开头的相对路径,从而防止路径动态拼接的问题。
/**
* nodes/read.js:
* 注意: 1.__dirname表示当前文件所处的目录。
*/
const fs = require('fs');

fs.readFile('./files/data.txt', 'utf8', function(err, res) {
    console.log(err, res);
});

// 运行 nodes/read.js文件:
C:\Users\nodes>node read.js // 读取文件成功, 路径为: C:\Users\nodes\files\data.txt
C:\Users>node .\nodes\read.js // 读取文件失败, readFile()方法中文件是相对路径,此时相对
                              // Users目录,路径为: C:\Users\files\data.txt

fs.readFile('C:\\Users\\files\\data.txt', 'utf8', function(err, res) { // 该方式不会有
    console.log(err, res);                                             // 问题。
});

fs.readFile(__dirname + '/files/data.txt', 'utf8', function(err, res) { // 该方式不会
    console.log(err, res);                                              // 有问题。
});

6.path路径模块

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

例如:① path.join()方法,用来将多个路径片段拼接成一个完整的路径字符串;② path.basename() 方法,用来从路径字符串中,将文件名解析出来。

如果要在 javascript代码中,使用 path模块来处理路径,则需要使用如下的方式先导入它:const path = require('path');

路径拼接:使用 path.join( )方法,可以把多个路径片段拼接为完整的路径字符串。

/**
* 语法: path.join(...paths)
* 参数: 1.paths: 路径片段的序列。
* 返回值: 拼接后的路径字符串。
* 注意: 1. ../ 会抵消前面的路径; 2.今后凡是涉及到路径拼接的操作,都要使用 path.join()方法进
* 行处理。不要直接使用 + 进行字符串的拼接。
*/
const fs = require('fs');
const path = require('path');

const pathStr = path.join('/a', '/b','./c', '/d/e', '../', 'f');
console.log(pathStr); // \a\b\c\d\f

fs.readFile(path.join(__dirname, '/files/readData.txt'), 'utf8', function(err, res){
    console.log(err, res);
})

获取路径中的文件名:使用 path.basename( )方法,可以获取路径中的最后一部分,经常通过这个方法获取路径中的文件名。

/**
* 语法: path.basename(path, ext)
* 参数: 1.path: 必需,表示一个路径的字符串; 2.ext: 可选,表示文件扩展名。
* 返回值: 表示路径中的最后一部分。
*/
const path = require('path');

const fpath = 'a/b/c/index.html';
const fullName = path.basename(fpath);
console.log(fullName); // index.html

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

获取路径中的文件扩展名:使用 path.extname( )方法,可以获取路径中的扩展名部分。

/**
* 语法: path.extname(path)
* 参数: 1.path: 必需,表示一个路径的字符串。
* 返回值: 返回得到的扩展名字符串。
*/
const path = require('path');

const fpath = 'a/b/c/index.html';
const extStr = path.extname(fpath);
console.log(extStr); // .html

7.http

什么是客户端,什么是服务器:在网络节点中,负责消费资源的电脑,叫做客户端;负责对外提供网络资源的电脑,叫做服务器

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

如果要希望使用 http模块创建 web服务器,则需要先导入它:const http = require('http');

服务器和普通电脑的区别在于,服务器上安装了 web服务器软件,例如:IIS、Apache等。通过安装这些服务器软件,就能把一台普通的电脑变成一台 web服务器。

在 node.js中,我们不需要 IIS、Apache等这些第三方 web服务器软件。因为我们可以基于 node.js提供的 http模块,通过几行简单的代码,就能轻松的手写一个 web服务器软件,从而对外提供 web服务。

服务器相关的概念

  • IP地址
    1. IP地址就是互联网上每台计算机的唯一地址,因此 IP地址具有唯一性。如果把 “个人电脑” 比作 “一台电话” ,那么 “IP地址” 就相当于 “电话号码” ,只有在知道对方 IP 地址的情况下,才能与对应的电脑之间进行数据通信。
    2. IP地址的格式:通常用 “点分十进制” 表示成 (a.b.c.d)的形式,其中,a,b,c,d都是 0~255 之间的十进制整数。例如:用点分十进制表示的 IP地址(192.168.1.1) 注意:① 互联网中每台 web服务器,都有自己的 IP地址,例如:大家可以在 Windows终端中运行 ping www.baidu.com 命令,即可查看百度服务器的 IP地址;② 在开发期间,自己的电脑既是一台服务器,也是一个客户端,为了方便测试,可以在自己的浏览器中输入 127.0.0.1 这个 IP地址,就能把自己的电脑当做一台服务器进行访问了。
  • 域名和域名服务器
    1. 尽管 IP地址能够唯一标记网络上的计算机,但 IP地址是一长串数字,不直观,而且不便于记忆,于是人们又发明了另一套字符型的地址方案,即所谓的域名(Domain Name)地址
    2. IP地址和域名是一一对应的关系,这份对应关系存放在一种叫做域名服务器(DNS,Domain Name Server)的电脑中。使用者只需要通过好记的域名访问对应的服务器即可,对应的转换工作由域名服务器实现。因此,域名服务器就是提供 IP地址和域名之间的转换服务的服务器。 注意:① 单纯使用 IP地址,互联网中的电脑也能够正常工作。但是有了域名的加持,能让互联网的世界变得更加方便;② 在开发测试期间,127.0.0.1对应的域名是 localhost,它们都代表我们自己的这台电脑,在使用效果上没有任何区别。
  • 端口号
    1. 计算机中的端口号,就像是现实生活中的门牌号一样。通过门牌号,外卖小哥可以在整栋大楼众多的房间中,准确把外卖送到你的手中。
    2. 同样的道理,在一台电脑中,可以运行成百上千个 web服务。每个 web服务都对应一个唯一的端口号。客户端发送过来的网络请求,通过端口号,可以被准确地交给对应的 web服务进行处理。

1653301326(1).png

  • 创建最基本的 web服务器: 创建 web服务器的基本步骤:① 导入 http模块;② 创建 web服务器实例;③ 为服务器实例绑定 request事件,监听客户端的请求;④ 启动服务器。
/**
* 导入 http模块;
* 如果希望在自己的电脑上创建一个 web服务器,从而对外提供 web服务,则需要导入 http模块
*/
const http = require('http');

/**
* 创建 web服务器实例:
* 调用 http.createServer()方法,即可快速创建一个 web服务器实例
*/
const server = http.createServer();

/**
* 为服务器实例绑定 request事件:
* 为服务器实例绑定 request事件,即可监听客户端发送过来的网络请求
*/
server.on('request', (req, res) => { // 使用服务器实例的 .on()方法,为服务器绑定一个 
                                     // request事件。
    console.log('someone visit our web server.'); // 只要有客户端来请求我们自己的服务器,
})                                                // 就会触发 request事件,从而调用这个
                                                  // 事件处理函数。
                                                  
/**
* 启动服务器:
* 调用服务器实例的 .listen()方法,即可启动当前的 web服务器实例
*/
server.listen(80, () => { // 调用 server.listen(端口号, callback回调函数)方法, 即可启动
                          // 当前的 web服务器实例。
    console.log('http server running at http://127.0.0.1');
})

// 完整代码:
const http = require('http');
const server = http.createServer();

server.on('request', function(req, res) {
    console.log('someone visit our web server.');
})
server.listen(80, function() {
    console.log('http server running at http://127.0.0.1');
})

req请求对象:只要服务器接收到了客户端的请求,就会调用通过 server.on( )为服务器绑定的 request事件处理函数

如果想在事件处理函数中,访问与客户端相关的数据或属性,可以使用如下的方式:

/**
* 注意: 1.req是请求对象,它包含了与客户端相关的数据和属性,例如: req.url 是客户端请求的 url地
* 址,req.method是客户端的 method请求类型。
*/
const http = require('http');
const server = http.createServer();

server.on('request', function(req) {
    const { url, method } = req;
    const str = `your request url is ${url}, and request method is ${method}`;
    console.log(str);
});
server.listen(80, () => {
    console.log('server running at http://127.0.0.1');
});

res响应对象:在服务器的 request事件处理函数中,如果想访问与服务器相关的数据或属性,可以使用如下的方式:

/**
* 注意: 1.res是响应对象,它包含了与服务器相关的数据和属性,例如: 要发送到客户端的字符串; 
* 2.res.end()方法的作用: 向客户端发送指定的内容,并结束这次请求的处理过程。
*/
const http = require('http');
const server = http.createServer();

server.on('request', (req, res) => {
    const { url, method } = req;
    const str = `your request url is ${url}, and request method is ${method}`;
    console.log(str);
    res.end(str)
});
server.listen(80, () => {
    console.log('server running at http://127.0.0.1');
});

解决中文乱码问题: 当调用 res.end( )方法,向客户端发送中文内容的时候,会出现乱码问题,此时,需要手动设置内容的编码格式:

/**
* 注意: 1.为了防止中文显示乱码问题,需要设置响应头 Content-type的值为
* text/html; charset=utf-8。
*/
const http = require('http');
const server = http.createServer();

server.on('request', (req, res) => {
    const url = req.url;
    const method = req.method;
    const str = `您请求的 url 地址是 ${url},请求的 method 类型是 ${method}`;
    res.setHeader('Content-type', 'text/html; charset=utf-8');
    res.end(str)
});
server.listen(80, () => {
    console.log('server running at http://127.0.0.1');
});
  • 根据不同的 url响应不同的 html内容核心实现步骤:① 获取请求的 url地址;② 设置默认的响应内容为 404 Not found;③ 判断用户请求的是否为 //index.html首页;④ 判断用户请求的是否为 /about.html关于页面;⑤ 设置 Content-type 响应头,防止中文乱码;⑥ 使用 res.end()把内容响应给客户端。
const http = require('http');
const server = http.createServer();

server.on('request', (req, res) => {
    const url = req.url;
    let content = '<h1>404 Not found</h1>';
    if(url === '/' || url === '/index.html') {
        content = '<h1>首页</h1>';
    }else if(url === '/about.html') {
        content = '<h1>关于页面</h1>';
    }
    res.setHeader('Content-type', 'text/html; charset=utf-8');
    res.end(content)
});
server.listen(80, () => {
    console.log('server running at http://127.0.0.1');
});

8.模块化

模块化的基本概念

什么是模块化:在编程领域中的模块化,就是遵守固定的规则,把一个大文件拆成独立并互相依赖的多个小模块。

把代码进行模块化拆分的好处:① 提高了代码的复用性;② 提高了代码的可维护性;③ 可以实现按需加载。

模块化规范:模块化规范就是对代码进行模块化拆分与组合时,需要遵守的那些规则。例如:① 使用什么样的语法格式来引用模块;② 在模块中使用什么样的语法格式向外暴露成员

模块化规范的好处:大家都遵守同样的模块化规范写代码,降低了沟通的成本,极大方便了各个模块之间的相互调用,利人利己。

node.js中的模块化

node.js中模块的分类:node.js中根据模块来源的不同,将模块分为了 3大类,分别是:① 内置模块(内置模块是由 node.js官方提供的,例如 fs、path、http等);② 自定义模块(用户创建的每个 js文件,都是自定义模块);③ 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)。

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

// 加载内置的 fs模块
const fs = require('fs');

// 加载用户的自定义模块
const custom = require('./custom.js');

// 加载第三方模块
const moment = require('moment');

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

/**
* 注意: 1.在使用 require加载用户自定义模块期间,可以省略 .js的后缀名。
*/
// m1.js:
console.log('加载了用户自定义模块~');

// test.js:
const m1 =require('./m1');
console.log(m1);
// 加载了用户自定义模块~
// {}

node.js中的模块作用域:和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域。

模块作用域的好处:防止了全局变量污染的问题。

// m1.js:
const username = '张三';
function sayHello() {
    console.log('大家好,我是' + username);
}

// test.js:
const m1 =require('./m1');
console.log(m1);
// {}

向外共享模块作用域中的成员:① module对象:在每个 .js自定义模块中都有一个 module对象,它里面存储了和当前模块有关的信息;② module.exports对象:在自定义模块中,可以使用 module.exports对象,将模块内的成员共享出去,供外界使用。外界用 require()方法导入自定义模块时,得到的就是 module.exports所指向的对象;③ 共享成员时的注意点:使用 require()导入模块时,导入的结果,永远以 module.exports指向的对象为准;④ exports对象:由于 module.exports单词写起来比较复杂,为了简化向外共享成员的代码,node提供了 exports对象,默认情况下,exportsmodule.exports指向同一个对象。最终共享的结果,还是以 module.exports指向的对象为准;⑤ exportsmodule.exports的使用误区:时刻谨记,require()模块时,得到的永远是 module.exports指向的对象。

1653361086(1).png

1653361718(1).png

// m.js:
console.log(module);

// 终端中执行 m.js文件: C:\Users\Desktop\nodes>node me.js
Module {
  id: '.',
  path: 'C:\\Users\\Desktop\\nodes',
  exports: {},
  filename: 'C:\\Users\\Desktop\\nodes\\me.js',
  loaded: false,
  children: [],
  paths: [
    'C:\\Users\\Desktop\\nodes\\node_modules',
    'C:\\Users\\Desktop\\node_modules',
    'C:\\Users\\node_modules',
    'C:\\node_modules'
  ]
}
--------------------------------------------------------------
/**
* 注意: 1.在一个自定义模块中,默认情况下, module.exports = {}。
*/
// custom.js:
const age = 20;

module.exports.username = '张三';
module.exports.sayHello = function() {
    console.log('hello~');
}
module.exports.age = age;

// test.js:
const m = require('./custom');
console.log(m); // { username: '张三', sayHello: [Function (anonymous)], age: 20 }
--------------------------------------------------------------
// custom.js:
const age = 20;

module.exports.username = '张三';
module.exports.sayHello = function() {
    console.log('hello~');
}
module.exports.age = age;

module.exports = { // module.exports指向一个全新的对象(内存中指针地址变了)
    nickname: '李四',
    sayHi() {
        console.log('hi~');
    }
}

// test.js:
const m = require('./custom');
console.log(m); // { nickname: '李四', sayHi: [Function: sayHi] }
--------------------------------------------------------------
// exports.js:
console.log(exports);
console.log(module.exports);
console.log(exports === module.exports);

// test.js:
const m = require('./exports');
// {}
// {}
// true
--------------------------------------------------------------
// exports.js:
const username = '张三';

exports.username = username;
exports.age = 20;
module.exports.sex = '男';
exports.sayHello = function() {
    console.log('大家好~');
}

// test.js:
const m = require('./exports');
console.log(m);
// { username: '张三', age: 20, sex: '男', sayHello: [Function (anonymous)] }

node.js中模块化规范

node.js遵循了 CommonJS 模块化规范,CommonJS 规定了模块的特性和各模块之间如何相互依赖。

CommonJS 规定:① 每个模块内部,module变量代表当前模块;② module变量是一个对象,它的 exports属性(即module.exports)是对外的接口;③ 加载某个模块,其实是加载该模块的 module.exports属性。require()方法用于加载模块。

9.npm与包

什么是包:node.js中第三方模块又叫做包。

就像电脑和计算机指的是同样的东西,第三方模块和包指的是同一个概念,只不过叫法不同。

包的来源:不同于 node.js中的内置模块与自定义模块,包是由第三方个人或团队开发出来的,免费供所有人使用。

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

为什么需要包:由于 node.js的内置模块仅提供了一些底层的 API,导致在基于内置模块进行项目开发时,效率很低。

包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率。

包和内置模块之间的关系,类似于 jQuery和浏览器内置 API之间的关系。

从哪里下载包:国外有一家 IT公司,叫做 npm,lnc.这家公司旗下有一个非常著名的网站:www.npmjs.com/ ,它是全球最大的包共享平台,你可以从这个网站上搜索到任何你需要的东西,只要你有足够的耐心。

npm,lnc.公司提供了一个地址为 registry.npmjs.org/ 的服务器,来对外共享所有的包,我们可以从这个服务器上下载自己所需要的包。

注意:① 从 www.npmjs.com/ 网站上搜索自己所需要的包;② 从 registry.npmjs.org/ 服务器上下载自己需要的包。

如何下载包npm,lnc.公司提供了一个包管理工具,我们可以使用这个包管理工具,从 registry.npmjs.org/ 服务器把需要的包下载到本地使用。

这个包管理工具的名字叫做 Node Package Manager(简称 npm 包管理工具),这个包管理工具随着 node.js的安装包一起被安装到了用户的电脑上。

大家可以在终端中执行 npm -v命令,来查看自己电脑上所安装的 npm 包管理工具的版本号。

npm初体验:① 使用 npm包管理工具,在项目中安装格式化时间的包 moment;② 使用 require()导入格式化时间的包;③ 参考 moment的官方 API文档对时间进行格式化。

在项目中安装包的命令:如果想在项目中安装指定名称的包,需要运行如下的命令:npm install 包的完整名称,也可以简写为 npm install 包的完整名称

const moment = require('moment');

const dt = moment().format('YYYY-MM-DD HH:mm:ss');
console.log(dt); // 2022-05-22 15:34:32

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

其中:① node_modules 文件夹用来存放所有已安装到项目中的包。require()导入第三方包时,就是从这个目录中查找并加载包;② package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等。

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

安装指定版本的包:默认情况下,使用 npm install 命令安装包的时候,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过 @符号指定具体的版本,例如:npm i moment@2.22.2

包的语义化版本规范包的版本号是以 “点分十进制” 形式进行定义的,总共有三位数字,例如:2.23.0,其中每一位数字所代表的含义如下,第一位数字表示大版本第二位数字表示功能版本第三位数字表示bug修复版本

版本号提升的规则:只要前面的版本号增长了,则后面的版本号归零。

包管理配置文件

npm规定,在项目根目录中必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目管理有关的一些配置信息。例如:① 项目名称、版本号、描述等;② 项目中都用到了那些包;③ 哪些包只在开发期间会用到;④ 哪些包在开发部署时都需要用到。

多人协作的问题:① 例如一个项目的体积是 30.5M,第三方包的体积是 28.8M,项目源代码的体积是 1.7M;② 遇到的问题是:第三方包的体积过大,不方便团队成员之间共享项目源代码;③ 解决方案:共享时剔除 node_modules

如何记录项目中安装了哪些包:在项目根目录中,创建一个叫做 package.json的配置文件,即可用来记录项目中安装了哪些包,从而方便剔除 node_modules 目录之后,在团队成员之间共享项目的源代码。

注意:今后在项目开发中,一定要把 node_modules文件夹,添加到 .gitignore忽略文件中。

如何快速创建 package.json:npm包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 package.json这个包管理配置文件npm init -y

注意:① 上述命令只能在英文的目录下成功运行。所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格;② 运行 npm install 命令安装包的时候,npm包管理工具会自动把包的名称版本号,记录到 package.json中。

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

一次性安装所有的包:当我们拿到一个剔除了 node_modules 的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。可以运行 npm install命令(或 npm i)一次性安装所有的依赖包。

卸载包:可以运行 npm uninstall 命令,来卸载指定的包。例如:npm uninstall moment。

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

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

你可以使用如下的命令,将包记录到 devDependencies 节点中:npm install 包名 --save-dev,简写形式为 npm i 包名 -D

解决下包速度慢的问题

为什么下包速度慢:在使用 npm下包的时候,默认从国外的 registry.npmjs.org/ 服务器进行下载,此时,网络数据的传输需要经过漫长的海底光缆,因此下包速度会很慢。

淘宝 npm镜像服务器

1653443096(1).png 切换 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;③ 将下包的镜像源切换为 taobao 镜像nrm use taobao

包的分类

使用 npm 包管理工具下载的包,共分为两大类,分别是:① 项目包:那些被安装到项目的 node_modules 目录中的包,都是项目包;② 全局包:在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包。

项目包又分为两大类,分别是:① 开发依赖包(被记录到 devDependencies节点中的包,只在开发期间会用到,npm i 包名 -D);② 核心依赖包(被记录到 dependencies节点中的包,在开发期间和项目上线之后都会用到,npm i 包名)。

全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。① 全局安装指定的包npm i 包名 -g;② 卸载全局安装的包npm uninstall 包名 -g

注意:① 只有工具性质的包,才有全局安装的必要性。因为它们提供了好用的终端命令;② 判断某个包是否需要全局安装后才能使用,可以参考官方提供的使用说明即可。

i5ting_toc:i5ting_toc是一个可以把 md文档转为 html 页面的小工具,使用步骤如下:① 将 i5ting_toc 安装为全局包:npm i -g i5ting_toc;② 调用 i5ting_toc,轻松实现 md 转 html 的功能:i5ting_toc -f 要转换的md文件路径 -o

规范的包结构

在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下包的内部结构。

一个规范的包,它的组成结构,必须符合以下3点要求:① 包必须以单独的目录而存在;② 包的顶级目录下必须包含 package.json 这个包管理配置文件;③ package.json 中必须包含 nameversionmain这三个属性,分别代表包的名字版本号包的入口

注意:以上 3 点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考:yarnpkg.com/zh-Hans/doc…

开发属于自己的包

初始化包的基本结构:① 新建 my-package 文件夹,作为包的根目录;② 在根目录 my-package 文件夹中,新建如下三个文件:package.json(包管理配置文件)、index.js(包的入口文件)、README.md(包的说明文档)。

/**
* package/my-package/package.json:
* 注意: 1.根目录的名称可以随便定义,与包的名称无关; 2.包的名称不能重复,因为在 npm服务器上有
* 很多的包,这些包的名称具有唯一性,因此取包名的时候必须保证这个名称在 npm上不存在。
*/
{
    "name": "my-calc-tools", // 包的名称(包上传到 npm服务器后,别人需要下载,就得根据这个包名)
    "version": "1.0.0", // 包的版本号(默认版本号从 1.0.0开始)
    "main": "index.js", // 指定包的入口文件[外界在使用 require('my-package')导入这个包的
                        // 时候,导入的是 main属性所指向的这个文件]
    "description": "用于检测自定义包的功能", // 包的简短描述信息(在 npm中搜索包的时候会该
                                           // 内容的智能提示)。
    "keywords": ["my-package", "add"], // 搜索的关键字(可以根据关键字进行包的搜索)
    "license": "ISC" // 包所遵守的开源协议(npm默认希望开发者提供 'ISC'的许可协议)
}

/**
* package/my-package/index.js:
*
*/
function add(x, y) {
    return x + y;
}
function sub(x, y) {
    return x - y;
}
function mult(x, y) {
    return x * y;
}
function div(x, y) {
    return x / y;
}

module.exports = {
    add,
    sub,
    mult,
    div,
}

/**
* package/test.js:
* 注意: 1.require('./my-package'), node.js导入这个文件夹的时候发现没有具体导入哪个文件,就
* 会去查找导入路径的这个目录中有没有 package.json文件,如果有就会去查找这个文件有没有指定 
* main属性,没有的话, main默认值为 index.js, 如果有,外界在 require('./my-package')导入这
* 个文件夹的时候就会自动根据 main属性的值来导入文件夹下的这个文件。
*/
const myPackage = require('./my-package');

const val = myPackage.add(1,2);
console.log(val); // 3

将不同功能进行模块化拆分

// package/my-package/src/add.js:
function add(x, y) {
    return x + y;
}

module.exports = {
    add,
}

// package/my-package/src/sub.js:
function sub(x, y) {
    return x - y;
}

module.exports = {
    sub,
}

// package/my-package/src/mult.js:
function mult(x, y) {
    return x * y;
}

module.exports = {
    mult,
}

// package/my-package/src/div.js:
function div(x, y) {
    return x / y;
}

module.exports = {
    div,
}

// package/my-package/index.js:
const add = require('./src/add');
const sub = require('./src/sub');
const mult = require('./src/mult');
const div = require('./src/div');

module.exports = {
    ...add,
    ...sub,
    ...mult,
    ...div,
}

// package/test.js:
const myPackage = require('./my-package');

const val = myPackage.add(1,2);
console.log(val); // 3

编写包的说明文档

  • 包根目录中的 README.md文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown的格式写出来,方便用户参考。
  • README文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。我们所创建的这个包的README.md文档中,会包含以下6项内容:安装方式、导入方式、add、sub、mult、div、开源协议。 README.md

1653486519(1).png image.png

发布包

注册 npm 账号:① 访问 www.npmjs.com/ 网站,点击 sign up按钮,进入注册界面;② 填写账号相关的信息:Full Name、Public Email、Username、Password;③ 点击 Create an Account按钮,注册账号;④ 登录邮箱,点击验证链接,进行账号的验证。

1653483706(1).png 1653483869(1).png

登录 npm 账号:npm 账号注册完成后,可以在终端中执行 npm login 命令,依次输入用户名密码邮箱后,即可登录成功。

注意:在运行 npm login 命令之前,必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败。

1653485666(1).png

1653485130(1).png

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

1653486419(1).png

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

1653487628(1).png 注意:① npm unpublish 命令只能删除 72小时以内发布的包;② npm unpublish 删除的包,在 24小时内不允许重复发布;③ 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包

10.模块的加载机制

优先从缓存中加载模块在第一次加载后会被缓存,这也意味着多次调用 require()不会导致模块的代码被执行多次。

注意:不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。

// custom.js:
console.log('加载了~');

// test.js:
require('./custom');
require('./custom'); //从缓存中加载
require('./custom'); //从缓存中加载

// 加载了~ (只会打印一次)

内置模块的加载机制:内置模块是由 node.js 官方提供的模块,内置模块的加载优先级最高。 例如:require('fs') 始终返回内置的 fs 模块,即使在 node_modules 目录下有名字相同的包也叫做 fs

自定义模块的加载机制:① 使用 require() 加载自定义模块时,必须指定以 ./../ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./../ 这样的路径标识符,则 node 会把它当作内置模块第三方模块进行加载;② 同时,在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则 node.js按顺序分别尝试加载以下的文件:按照确切的文件名进行加载补全 .js 扩展名进行加载补全 .json 扩展名进行加载补全 .node 扩展名进行加载加载失败,终端报错

// data:
console.log('加载了 data 文件~');

// data.js:
console.log('加载了 data.js 文件~');

// data.json:
{
    "name": "加载了data.json 文件~"
}

//data.node:

// test.js:
const data = require('./data'); 
console.log(data);

// 打印: 加载了 data 文件~ 、{} (当 data、data.js、data.json、data.node文件都存在时)
// 打印: 加载了 data.js 文件~ 、{} (当只有 data.js、data.json、data.node文件存在时)
// 打印: { name: '加载了data.json 文件~' } (当只有 data.json、data.node文件存在时)
// 打印: Error: \\?\C:\Users\TDH\Desktop\pack\data.node is not a valid Win32 application.
//      \\?\C:\Users\TDH\Desktop\pack\data.node (当只有 data.node文件存在时)
// 打印: Error: Cannot find module './data' (当没有文件时)

第三方模块的加载机制:① 如果传递给 require() 的模块标识符不是一个内置模块,也没有以 './''../' 开头,则 node.js 会从当前模块的父目录开始,尝试从 /node_modules 文件夹中加载第三方模块;② 如果没有找到对应的第三方模块,则移动到上一层父目录中,进行加载,直到文件系统的根目录。例如:假设在 C:\Users\TDH\Desktop\pack\foo.js 文件里调用了 require('tools'),则 node.js 会按以下顺序查找:C:\Users\TDH\Desktop\pack\node_modules\toolsC:\Users\TDH\Desktop\node_modules\toolsC:\Users\TDH\node_modules\toolsC:\Users\node_modules\toolsC:\node_modules\tools

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

// pack/try/package.json:
{
    "main": "./a.js"
}

// pack/try/a.js:
console.log('加载了 a.js 文件~');

// pack/try/index.js:
console.log('加载了 index.js 文件~');

// pack/test.js:
require('./try');

// 打印: 加载了 a.js 文件~ (当 package.json存在且 main属性值为 './a.js'时)
// 打印: 加载了 index.js 文件~ (当 package.json存在 且 main属性没有自定义时
//                            或 package.json不存在时)。

11.初识 Express

Express 简介

什么是 Express:① 官方的概念:Express 是基于 node.js 平台,快速开放极简 的web开发框架;② 通俗理解:Express 的作用和 node.js 内置的 http 模块类似,是专门用来创建 web服务器的

Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 web服务器的便捷方法。

进一步理解 Express:① 不使用 Express 能否创建 web服务器:能,使用 node.js提供的原生 http模块即可;② 有了 http内置模块,为什么还要用 Express:http内置模块用起来很复杂,开发效率低,Express是基于内置的 http模块进一步封装出来的,能够极大的提高开发效率;③ http与内置模块 Express是什么关系:类似于浏览器中 Web API 和 jQuery的关系。后者是基于前者进一步封装出来的。

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

Express 的基本使用

安装:在项目所处的目录中,运行如下的终端命令,即可将 Express 安装到项目中使用:npm i express@4.17.1。

创建基本的 Web服务器

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

app.listen(80, () => { // 调用 app.listen(端口号, 启动成功后的回调函数),启动服务器
    console.log('express server running at http://127.0.0.1');
});

监听 GET 请求:通过 app.get()方法,可以监听客户端的 GET请求。

/**
* 参数 1: 客户端请求的 URL地址;
* 参数 2: 请求对应的处理函数, req: 请求对象(包含了与请求相关的属性与方法), res: 响应对象
* (包含了与响应相关的属性与方法)。
*/
app.get('请求 URL', function(req, res){ /*处理函数*/ })

监听 POST 请求:通过 app.post()方法,可以监听客户端的 POST请求。

/**
* 参数 1: 客户端请求的 URL地址;
* 参数 2: 请求对应的处理函数, req: 请求对象(包含了与请求相关的属性与方法), res: 响应对象
* (包含了与响应相关的属性与方法)。
*/
app.post('请求 URL', function(req, res){ /*处理函数*/ })

把内容响应给客户端:通过 res.send()方法,可以把处理好的内容,发送给客户端。

app.get('/user', (req, res) => {
    res.send({ name: '张三', age: 20, gender: '男' }); // 向客户端发送 JSON 对象
})
app.post('/user', (req, res) => {
    res.send('请求成功'); // 向客户端发送文本内容
})

获取 URL 中携带的查询参数:通过 res.query 对象,可以访问到通过客户端查询字符串的形式,发送到服务器的参数。

/**
* 注意: 1.req.query 默认是一个空对象; 2.客户端使用?name=zs&age=20这种查询字符串形式,发送
* 到服务器的参数,可以通过 req.query对象访问到,例如: req.query.name。
*/
app.get('/', (req, res) => {
    res.send(req.query);
})

// 接口请求: http://127.0.0.1/
// 接口响应: {}

// 接口请求: http://127.0.0.1?name=张三&age=20
// 接口响应: { "name": "张三", "age": "20" }

获取 URL 中的动态参数:通过 req.params 对象,可以访问到 URL 中,通过 : 匹配到的动态参数。

/**
* 注意: 1.URL地址中,可以通过 :参数名 的形式,匹配动态参数值; 2.req.params 默认是一个空对
* 象,里面存放着通过 : 动态匹配到的参数值。
*
*/
app.get('/user/:id', (req, res) => {
    res.send(req.params);
})

// 接口请求: http://127.0.0.1/user/10
// 接口响应: { "id": "10" }
------------------------------------------------------
app.get('/user/:id/:username', (req, res) => {
    res.send(req.params);
})

// 接口请求: http://127.0.0.1/user/10/张三
// 接口响应: { "id": "10", "username": "张三" }

托管静态资源

express.static()express 提供了一个非常好用的函数,叫做 express.static(),通过它,我们可以非常方便地创建一个静态资源服务器。

注意:Express 在指定的 静态目录中查找文件,并对外提供资源的访问路径。因此,存放静态文件的目录名不会出现在 URL 中

例如,通过如下代码就可以将 public 目录 下的图片CSS 文件Javascript 文件 对外开放访问了。

app.use(express.static('public'))

现在,你就可以访问 public 目录 中的所有文件了:http:localhost:80/images/bg.png 、 http:localhost:80/css/style.css 、http:localhost:80/js/index.js 。

// pack/public/css/style.css:
*{ padding: 0px; margin: 0px; }

// pack/createServer.js:
const express = require('express');
const app = express();

app.use(express.static('./public')); // 调用 express.static(),快速的对外提供静态资源。
app.listen(80, () => {
    console.log('express server running at http://127.0.0.1');
});

// 访问 http://localhost:80/css/index.css:
*{
    padding: 0px;
    margin: 0px;
}

托管多个静态资源目录:如果要托管多个静态资源目录,请多次调用 express.static() 函数。

app.use(express.static('public'))
app.use(express.static('files'))

访问静态资源文件时, express.static()函数会根据目录的添加顺序查找所需的文件。

// pack/public/css/style.css:
*{ padding: 0px; margin: 0px; }

// pack/files/css/index.css:
p { color: red; }

// pack/createServer.js:
const express = require('express');
const app = express();

app.use(express.static('./public')); // 调用 express.static(),快速的对外提供静态资源。
app.use(express.static('./files'));
app.listen(80, () => {
    console.log('express server running at http://127.0.0.1');
});

// 访问 http://localhost:80/css/style.css:
*{
    padding: 0px;
    margin: 0px;
}

// 访问 http://localhost:80/css/index.css:
p { color: red; }

挂载路径前缀:如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下方式。

app.use('/public', express.static('./public'))

现在,你可以通过带有 /public 前缀地址来访问 public 目录 中的文件了:http:localhost:80/public/images/bg.png 、 http:localhost:80/public/css/style.css 、http:localhost:80/public/js/index.js 。

nodemon

为什么要使用 nodemon:在编写调试 node.js 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐。现在我们可以使用 nodemonwww.npmjs.com/package/nod… )这个工具,它能够监听项目文件的变动,当代码被修改后,nodemon 会自动帮我们重启项目,极大方便了开发和调试。

安装 nodemon:在终端中,运行如下命令,即可将 nodemon 安装为全局可用的工具:npm install -g nodemon

使用 nodemon:当基于 node.js 编写了一个网站应用的时候,① 传统的方式,是运行 node app.js 命令,来启动项目。这样做的坏处是:代码被修改之后,需要手动重启项目。 ② 现在 ,我们可以将 node 命令 替换为 nodemon 命令 ,使用 nodemon createServer.js 来启动项目。这样做的好处是:代码被修改之后,会被 nodemon 监听到,从而实现自动重启项目的效果。

// 原来的命令,修改了代码,不会自动重启
node createServer.js

// 现在的命令,修改代码后,会自动重启项目
nodemon createServer.js

12.Express 路由

路由的概念

什么是路由:广义上来讲,路由就是映射关系。

现实生活中的路由

1653836395(1).png Express 中的路由:① 在 Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系;② Express 中的路由分 3 部分组成,分别是请求的类型请求的 URL地址处理函数,格式如下。

app.METHOD(PATH, HANDLER)

Express 中的路由的例子

// 匹配 GET 请求,且请求 URL 为 /
app.get('/', function(req, res) {
    res.send('Hello Word!');
})

// 匹配 POST 请求,且请求 URL 为 /
app.post('/', function(req, res) {
    res.send('get a POST request');
})

路由的匹配过程:① 每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数;② 在匹配时,会按照路由的顺序进行匹配,如果请求类型请求的URL同时匹配成功,则 Express 会将这次请求,转交给对应的 function 函数进行处理。

1653837881(1).png 路由的使用

最简单的用法:在 Express 中使用路由最简单的方式,就是把路由挂载到 app 上。

const express = require('express');
const app = express(); // 创建 Web 服务器,命名为 app

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

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

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

将路由抽离为单独模块的步骤如下:① 创建路由模块对应的 .js 文件;② 调用 express.Router() 函数创建路由对象;③ 向路由对象上挂载具体的路由;④ 使用 module.exports 向外共享路由对象;⑤ 使用 app.use() 函数注册路由模块。

创建路由模块

// pack/router.js:
const express = require('express'); // 导入 express
const router = express.Router(); // 创建路由对象

router.get('/user/list', (req, res) => { // 挂载获取用户列表的路由
    res.send('get user list');
});

router.post('/user/add', (req, res) => { // 挂载添加用户的路由
    res.send('add new user');
});

module.exports = router; // 向外导出路由对象

注册路由模块

// pack/createServer.js:
const express = require('express');
const app = express();

const router = require('./router'); // 导入路由模块

app.use(router); // 注册路由模块

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

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

为路由模块添加前缀:类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式也非常简单。

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

app.use('/api', useRouter); // 使用 app.use()注册路由模块,并添加统一的访问前缀 /api
// pack/router.js:
const express = require('express');
const router = express.Router();

router.get('/user/list', (req, res) => {
    res.send('get user list');
});

router.post('/user/add', (req, res) => {
    res.send('add new user');
});

module.exports = router; 

// pack/createServer.js:
const express = require('express');
const app = express();

const router = require('./router'); 

app.use('/api', router); // 使用 app.use()注册路由模块,并添加统一的访问前缀 

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

// 访问接口: http://127.0.0.1/api/user/add
// 接口返回: add new user

// 访问接口: http://127.0.0.1/api/user/list
// 接口返回: get user list

13.Express 中间件

中间件的概念

什么是中间件:中间件(Middleware),特指业务流程中间处理环节

现实生活中的例子:在处理污水的时候,一般都要经过三个处理环节,从而保证处理后的废水,达到排放标准。

1653874126(1).png

Express 中间件的调用流程:当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理

1653874362(1).png Express 中间件的格式Express 的中间件本质 上就是一个 function 处理函数Express 中间件 的格式如下。 1653874562(1).png next 函数的作用next函数 是实现多个中间件连续调用 的关键,它表示把流转关系转交 给下一个中间件路由

1653874953(1).png

Express 中间件的初体验

定义中间件函数:可以通过如下方式,定义一个最简单的中间件函数。

/**
* 注意: 1.在当前中间件的业务处理完毕后,必须调用 next() 函数,表示把流转关系转交给下一个中间
* 件或路由。
*/
const mw = function(req, res, next) { // 常量 mw 所指向的,就是一个中间件函数
    console.log('这是一个最简单的中间件函数');
    next();
}

全局生效的中间件:客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件。

通过调用 app.use(中间件函数),即可定义一个全局生效的中间件。

const mw = function(req, res, next) { // 常量 mw 所指向的,就是一个中间件函数
    console.log('这是一个最简单的中间件函数');
    next();
}

app.use(mw) // 将 mw 注册为全局生效的中间件
// pack/router.js:
const express = require('express');
const router = express.Router();

router.get('/user/list', (req, res) => {
    console.log('调用了 /user/list 这个路由');
    res.send('get user list');
});

router.post('/user/add', (req, res) => {
    res.send('add new user');
});

module.exports = router; 

// pack/createServer.js:
const express = require('express');
const app = express();
const router = require('./router'); 

const mw = function(req, res, next) {
    console.log('这是一个最简单的中间件函数');
    next(); // 把流转关系,转交给下一个中间件或路由
}
app.use(mw); // 将 mw 注册为全局生效的中间件
app.use('/api', router); // 使用 app.use()注册路由模块,并添加统一的访问前缀 
app.listen(80, () => {
    console.log('express server running at http://127.0.0.1');
});

// 访问接口: http://127.0.0.1/api/user/list
// 先依次打印日志: '这是一个最简单的中间件函数', '调用了 /user/list 这个路由'
// 然后接口响应: get user list

定义全局中间件的简化形式

app.use(function(req, res, next) { // 全局生效的中间件
    console.log('这是一个最简单的中间件函数');
    next();
})

中间件的作用:多个中间件之间,共享同一份 req 和 res。基于这样的特性,我们可以在上游 的中间件中,统一 为 req 或 res 对象添加自定义属性方法,供下游 的中间件或路由进行使用。

1653879897(1).png

// pack/router.js:
const express = require('express');
const router = express.Router();

router.get('/user/list', (req, res) => {
    res.send(`get user list ${req.startTime}`);
});

router.post('/user/add', (req, res) => {
    res.send('add new user');
});

module.exports = router;

// pack/createServer.js:
const express = require('express');
const app = express();

const router = require('./router');

app.use(function(req, res, next) { // 这是定义全局中间件的简化形式
    const time = Date.now();
    req.startTime = time; // 为 req 对象,挂载自定义属性,从而把时间共享给后面的所有路由
    next();
});

app.use('/api', router); // 注册路由模块

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

// 访问接口: http://127.0.0.1/api/user/list
// 接口响应: get user list 1653880701816

定义多个全局中间件:可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用。

// pack/router.js:
const express = require('express');
const router = express.Router();

router.get('/user/list', (req, res) => {
    res.send('get user list');
});

router.post('/user/add', (req, res) => {
    res.send('add new user');
});

module.exports = router;

// pack/createServer.js:
const express = require('express');
const app = express();

const router = require('./router');

app.use(function(req, res, next) { // 第一个全局中间件
    console.log('调用了第一个全局中间件');
    next();
});
app.use(function(req, res, next) { // 第二个全局中间件
    console.log('调用了第二个全局中间件');
    next();
});
app.use(function(req, res, next) { // 第三个全局中间件
    console.log('调用了第三个全局中间件');
    next();
});

app.use('/api', router); // 注册路由模块

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

// 访问接口: http://127.0.0.1/api/user/list
// 先依次打印日志: '调用了第一个全局中间件'、'调用了第二个全局中间件'、'调用了第三个全局中
// 间件'、'调用了 /user/list 这个路由'
// 然后接口响应: get user list

局部生效的中间件:不使用 app.use()定义的中间件,叫做局部生效的中间件。

// pack/createServer.js:
const express = require('express');
const app = express();

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

app.get('/getList', mw1, function(req, res) { // mw1 这个中间件只在'当前路由中生效',这
    res.send('获取列表数据');                  // 种用法属于'局部生效的中间件'。
});
app.get('/', function(req, res) { // mw1 这个中间件不会影响这个路由
    res.send('获取首页数据');
});

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

// 访问接口: http://127.0.0.1/getList
// 先打印日志: '调用了局部生效的中间件'
// 然后接口响应: '获取列表数据'

// 访问接口: http://127.0.0.1/
// 接口响应: '获取首页数据'

定义多个局部中间件:可以在路由中,通过如下两种等价的方式,使用多个局部中间件。

// 以下两种写法是完全等价的,可根据自己的喜好,选择任意一种方式进行使用
app.get('/', mw1, mw2, (req, res) => { res.send('Home Page.'); });
app.get('/', [mw1, mw2], (req, res) => { res.send('Home Page.'); });
// pack/createServer.js:
const express = require('express');
const app = express();

const mw1 = function(req, res, next) {
    console.log('调用了第一个局部生效的中间件');
    next();
}
const mw2 = function(req, res, next) {
    console.log('调用了第二个局部生效的中间件');
    next();
}

app.get('/getList', mw1, mw2, function(req, res) {
    res.send('获取列表数据');
});
app.get('/', [mw1, mw2],function(req, res) {
    res.send('获取首页数据');
});

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

// 访问接口: http://127.0.0.1/
// 先打印日志: '调用了第一个局部生效的中间件'、'调用了第二个局部生效的中间件'
// 然后接口响应: '获取首页数据'

// 访问接口: http://127.0.0.1/getList
// 先打印日志: '调用了第一个局部生效的中间件'、'调用了第二个局部生效的中间件'
// 然后接口响应: '获取列表数据'

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

中间件的分类

为了方便大家理解记忆 中间件的使用,Express 官方把常见的中间件用法,分成了 5大类,分别是:① 应用级别 的中间件;② 路由级别 的中间件;③ 错误级别 的中间件;④ Express 内置 的中间件;⑤ 第三方 的中间件。

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

// 应用级别的中间件(全局中间件)
app.use((req, res, next) => {
    next();
})

// 应用级别的中间件(局部中间件)
app.get('/', mw1, (req, res) => {
    res.send('Home Page.');
})

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

const express = require('express');
const app = express();
const router = express.Router();

// 路由级别的中间件
router.use(function(req, res, next) {
    next();
})

app.use('/', router);

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

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

app.get('/', function(req, res) { // 路由
    throw new Error('服务器内部发生了错误!'); // 抛出一个自定义的错误
    res.send('Home Page.');
})
app.use(function(err,req,res,next) { // 错误级别的中间件
    console.log('发生了错误:' + err.message); // 在服务器打印错误消息
    res.send('Error!' + err.message); // 向客户端响应错误相关的内容
})

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+ 版本中可用)

// 配置解析 application/json 格式数据的内置中间件
app.use(express.json());

// 配置解析 application/x-www-form-urlencoded 格式数据的内置中间件
app.use(express.urlencoded({ extended: false }));
/**
* 注意: 1.在服务器,可以使用 req.body这个属性,来接收客户端发送过来的请求体数据; 2.默认情况
* 下,如果不配置解析表单数据的中间件,则 req.body 默认等于 undefined; 3.通过 express.json()
* 这个中间件,解析表单中的 JSON 格式的数据; 4.除了错误级别的中间件,其他的中间件,必须在路由之
* 前进行配置。
*/
const express = require('express');
const app = express();

app.use(express.json()) // 配置解析 application/json 格式数据的内置中间件
app.use(express.urlencoded({ extended: false }));

app.post('/user', function(req, res) {
    console.log(req.body); // 接收请求体数据
    res.send('ok');
});

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

// 接口请求: http://127.0.0.1/user
// application/json 参数: { name: 'zs' }
// 先打印日志: { name: 'zs' }
// 然后响应接口: ok

// 接口请求: http://127.0.0.1/user
// application/x-www-form-urlencoded 参数: { age: 20 }
// 先打印日志: { age: 20 }
// 然后响应接口: ok

第三方的中间件:非 Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。

例如:在 express@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:① 运行 npm install body-parser 安装中间件;② 使用 require 导入中间件;③ 调用 app.use() 注册并使用中间件。

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

const express = require('express');
const app = express();
const parser = require('body-parser'); // 导入解析表单数据的中间件 body-parser

app.use(parser.urlencoded({ extended: false })); // 注册中间件 body-parser
app.post('/user', function(req, res) {
    console.log(req.body);
    res.send('ok');
});

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

// 访问接口: http://127.0.0.1/user
// application/x-www-form-urlencoded 参数: { age: 20 }
// 先打印日志: { age: 20 }
// 然后响应接口: ok

自定义中间件

需求描述与实现步骤:自己手动模拟一个类似于 express.urlencoded 这样的中间件,来解析 POST 提交到服务器的表单数据。

实现步骤:① 定义中间件;② 监听 reqdata 事件;③ 监听 reqend 事件;④ 使用 querystring 模块解析请求体数据;⑤ 将解析出来的数据对象挂载为 req.body;⑥ 将自动义中间件封装为模块。

定义中间件:使用 app.use() 来定义全局生效的中间件。

app.use((req, res, next) => {
    // 中间件的业务逻辑
})

监听 req 的 data 事件:在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。

如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。

let str = ''; // 定义变量,用来存储客户端发送过来的请求体数据
req.on('data', (chunk) => { // 监听 req 对象的 data 事件 (客户端发送过来的新的请求体数据)
    str += chunk // 拼接请求体数据,隐式转换为字符串
});

监听 req 的 end 事件:当请求体数据接收完毕之后,会自动触发 req 的 end 事件。

因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。

req.on('end', () => { // 监听 req 对象的 end 事件 (请求体发送完毕后自动触发)
    console.log(str); // 打印完整的请求体数据
    // TODO: 把字符串格式的请求体数据,解析成对象格式
})

使用 querystring 模块解析请求体数据:node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse()函数,可以轻松把查询字符串,解析成对象的格式。

const qs = require('querystring'); // 导入处理 querystring 的 node.js 内置模块
const body = qs.parse(str); // 调用 qs.parse() 方法,把查询字符串解析为对象

将解析出来的数据对象挂载为 req.body:上游的中间件和下游的中间件及路由之间,共享同一份 req 和 res。因此,我们可以将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body,供下游使用。

req.on('end', () => {
    const body = qs.parse(str); // 调用 qs.parse() 方法,把查询字符串解析为对象
    req.body = body; // 将解析出来的请求体对象,挂载为 req.body 属性
    next(); // 最后,一定要调用 next() 函数,执行后续的业务逻辑
});
const express = require('express');
const app = express();
const qs = require('querystring');

app.use((req, res, next) => { // 这是解析表单数据的中间件
    let str = '';
    req.on('data', (chunk) => {
        str += chunk
    });
    req.on('end', () => {
        console.log(str);
        const body = qs.parse(str);
        console.log(body);
        req.body = body
        next();
    });
});

app.post('/user', function(req, res) {
    res.send(req.body);
});

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

// 访问接口: http://127.0.0.1/user
// application/x-www-form-urlencoded 参数: { name: 'zs', age: 20 }
// 先打印日志: 'name=zs&age=20'、{ name: 'zs', age: 20 }
// 然后响应接口: { name: 'zs', age: 20 }

将自定义的中间件封装为模块:为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块。

// pack/custom-body-parser.js:
const qs = require('querystring');

const bodyParser = (req, res, next) => { // 这是解析表单数据的中间件
    let str = '';
    req.on('data', (chunk) => {
        str += chunk
    });
    req.on('end', () => {
        console.log(str);
        const body = qs.parse(str);
        console.log(body);
        req.body = body
        next();
    });
};

module.exports = bodyParser;

// pack/createServer.js:
const express = require('express');
const app = express();
const bodyParser = require('./custom-body-parser'); // 导入自己封装的中间件模块

app.use(bodyParser); // 将自定义的中间件函数,注册为全局可用的中间件
app.post('/user', function(req, res) {
    res.send(req.body);
});

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

14.使用 Express 写接口

创建基本的服务器

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

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

创建 API 路由模块

// pack/apiRouter.js:
const express = require('express');
const router = express.Router();

router.get('/add', (req, res) => {
    res.send('添加数据');
});

module.exports = router;

// pack/createServer.js:
const express = require('express'); // 导入 express 模块
const app = express(); // 创建 express 的服务器实例

const router = require('./apiRouter'); // 导入路由模块
app.use('/api', router); // 把路由模块,注册到 app 上,可以认为 router是中间件

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

编写 GET 接口

// pack/apiRouter.js:
const express = require('express');
const router = express.Router();

router.get('/get', (req, res) => { // 挂载对应的路由
    const query = req.query; // 获取到客户端通过查询字符串,发送到服务器的数据
    res.send({ // 调用 res.send() 方法,把数据响应给客户端
        status: 0, // 状态, 0: 表示成功, 1: 表示失败
        msg: 'GET请求成功!', // 状态描述
        data: query // 需要响应给客户端的具体数据
    });
});

module.exports = router;

// pack/createServer.js:
const express = require('express'); // 导入 express 模块
const app = express(); // 创建 express 的服务器实例

const router = require('./apiRouter'); // 导入路由模块
app.use('/api', router); // 把路由模块,注册到 app 上,可以认为 router是中间件

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

// 访问接口: http://127.0.0.1/api/get?name=zs
// 接口响应: { "status": 0, "msg": "GET请求成功!", "data": { "name": "zs" } }

编写 POST 接口

// pack/apiRouter.js:
const express = require('express');
const router = express.Router();

router.post('/post', (req, res) => { // 定义 POST 接口
    const body = req.body; // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
    res.send({ // 调用 res.send() 方法,把数据响应给客户端
        status: 0, // 状态, 0: 表示成功, 1: 表示失败
        msg: 'POST请求成功!', // 状态描述
        data: body // 需要响应给客户端的具体数据
    });
});

module.exports = router;

// pack/createServer.js:
const express = require('express'); // 导入 express 模块
const app = express(); // 创建 express 的服务器实例

app.use(express.urlencoded({ extended: false })); // 配置解析表单数据的中间件
const router = require('./apiRouter'); // 导入路由模块

app.use('/api', router); // 把路由模块,注册到 app 上,可以认为 router是中间件

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

// 访问接口: http://127.0.0.1/api/post
// application/x-www-form-urlencoded 参数: { name: 'zs', age: 20 }
// 先打印日志: 'name=zs&age=20'、{ name: 'zs', age: 20 }
// 然后响应接口: { "status": 0, "msg": "POST请求成功!", "data": { "age": "20", 
//                "name": "zs" } }

CORS 跨域资源共享

接口的跨域问题:上面的 GETPOST 接口,存在一个很严重的问题:不支持跨域请求

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

使用 CORS 中间件解决跨域问题corsExpress 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。

使用步骤分为如下三步:① 运行 npm install cors 安装中间件;② 使用 const cors = require('cors') 导入中间件;③ 在路由之前调用 app.use(cors()) 配置中间件。

// pack/apiRouter.js:
const express = require('express');
const router = express.Router();

router.get('/get', (req, res) => { // 挂载对应的路由
    const query = req.query; // 获取到客户端通过查询字符串,发送到服务器的数据
    res.send({ // 调用 res.send() 方法,把数据响应给客户端
        status: 0, // 状态, 0: 表示成功, 1: 表示失败
        msg: 'GET请求成功!', // 状态描述
        data: query // 需要响应给客户端的具体数据
    });
});
router.post('/post', (req, res) => { // 定义 POST 接口
    const body = req.body; // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
    res.send({ // 调用 res.send() 方法,把数据响应给客户端
        status: 0, // 状态, 0: 表示成功, 1: 表示失败
        msg: 'POST请求成功!', // 状态描述
        data: body // 需要响应给客户端的具体数据
    });
});

module.exports = router;

// pack/createServer.js:
const express = require('express'); // 导入 express 模块
const app = express(); // 创建 express 的服务器实例

app.use(express.urlencoded({ extended: false })); // 配置解析表单数据的中间件
const cors = require('cors'); // 一定要在路由之前,配置 cors 这个中间件,从而解决接口跨域
app.use(cors());              // 的问题。

const router = require('./apiRouter'); // 导入路由模块

app.use('/api', router); // 把路由模块,注册到 app 上,可以认为 router是中间件

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

什么是 CORSCORS(Cross-Origin-Resource Sharing,跨域资源共享)由一系列 HTTP 响应头 组成,这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源

浏览器的同源安全策略 默认会阻止网页 “跨域” 获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可以解除浏览器端的跨域访问限制

1653925855(1).png CORS 的注意事项:① CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口;② CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务器接口(例如:IE10+、Chrome4+、FireFox3.5+)。

CORS 响应头部-Access-Control-Allow-Origin:响应头部中可以携带一个 Access-Control-Allow-Origin 字段,语法:Access-Control-Allow-Origin: <origin> | *,其中,origin 参数的值指定了允许访问该资源的外域 URL。

例如,下面的字段值将只允许 来自 http://itcast.cn 的请求:

res.setHeader('Access-Control-Allow-Origin', 'http://itcast.cn')

如果指定了 Access-Control-Allow-Origin 字段的值为通配符 * ,表示允许来自任何域的请求:

res.setHeader('Access-Control-Allow-Origin', '*')

CORS 响应头部-Access-Control-Allow-Headers:默认情况下,CORS 仅支持客户端向服务器发送如下的 9个请求头:Accept、Accept-LanguageContent-LanguageDPRDownlinkSave-DataViewport-WidthWidthContent-Type(值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一)如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 Access-Control-Allow-Headers 对额外的请求头进行声明,否则这次请求会失败。

// 允许客户端额外向服务器发送 Content-Type 请求头和 X-Custom-Header 请求头
// 注意: 多个请求头之间使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')

CORS 响应头部-Access-Control-Allow-Methods:默认情况下,CORS 仅支持客户端发起 GETPOSTHEAD 请求。 如果客户端希望通过 PUTDELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Allow-Methods 来指明实际请求所允许使用的 HTTP 方法。

// 只允许 GET, POST, DELETE, HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'GET, POST, DELETE, HEAD')
// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods', '*')

CORS 请求的分类:客户端在请求 CORS 接口时,根据请求方式请求头 的不同,可以将 CORS 的请求分为两大类,分别是:① 简单请求;② 预检请求。

简单请求:同时满足以下两大条件的请求,就属于简单请求:① 请求方式:GETPOSTDELETE 三者之一;② HTTP 头部信息 不超过以下几种字段:无自定义头部字段Accept、Accept-LanguageContent-LanguageDPRDownlinkSave-DataViewport-WidthWidthContent-Type(值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一)。

预检请求:只要符合以下任何一个条件的请求,都需要进行预检请求:① 请求方式为 GET、POST、DELETE 之外的请求 Method 类型;② 请求头中包含自定义头部信息;③ 向服务器发送了 application/json 格式的数据

在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为 “预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据

简单请求和预检请求的区别:① 简单请求的特点:客户端与服务器之间只会发生一次请求;② 预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求

JSONP 接口

回顾 JSONP 的概念与特点:① 概念:浏览器端通过 <script> 标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP;② 特点:1. JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象;2. JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE等请求。

创建 JSONP 接口的注意事项:如果项目中已经配置了 CORS 跨域资源共享,为了防止冲突,必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。

app.get('/api/jsonp', (req, res) => { }); // 优先创建 JSONP 接口(这个接口不会被处理成
                                          // CORS 接口)。
                                          
app.use(cors()); // 再配置 CORS 中间件(后续的所有接口,都会被处理成 CORS 接口)
app.get('/api/get', (req, res) => { }); // 这是一个开启了 CORS 的接口

实现 JSONP 接口的步骤:① 获取客户端发送过来的回调函数的名字;② 得到要通过 JSONP 形式发送给客户端的数据;③ 根据前两步得到的数据,拼接出一个函数调用的字符串;④ 把上一步拼接得到的字符串,响应给客户端的 <script> 标签进行解析执行。

实现 JSONP 的具体代码

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

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

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

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

const router = require('./apiRouter'); // 导入路由模块

app.use('/api', router); // 把路由模块,注册到 app 上,可以认为 router是中间件

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

在网页中使用 jQuery 发起 JSONP 请求:调用 $.ajax()函数,提供 JSONP 的配置选项,从而发起 JSONP 请求。

<script type="text/javascript">
$('#jsonpBtn').click(function() {
    $.ajax({
        method: 'GET',
        url: 'http://127.0.0.1/api/jsonp',
        dataType:'jsonp',
        success: function(res) {
            console.log(res); // {name: 'zs', age: 20}
        }
    });
});
</script>