链接:第三四五章资料
链接:配套
提取码:1234
1. fs文件系统模块
1.1什么是fs文件系统模块
fs模块是Node.js官方提供的、用来操作文件的模块。它提供了一系列的方法和属性, 用来满足用户对文件的操作需求
例如:
●fs.readFile() 方法,用来读取指定文件中的内容
●fs.writeFile() 方法,来向指定的文件中写入内容
如果要在JavaScript代码中,使用fs 模块来操作文件,则需要使用如下的方式先导入它:
const fs = require('fs');
1.2读取指定文件中的内容
1.2.1 fs.readFile( ) 的语法格式
使用fs.readFile()方法,可以读取指定文件中的内容,语法格式如下:
fs. readFile(path[, options], callback)
参数解读:
●参数1:必选参数,字符串,表示文件的路径。
●参数2:可选参数,表示以什么编码格式来读取文件。
●参数3:必选参数,文件读取完成后,通过回调函数拿到读取的结果。
1.2.2判断文件是否读取成功
通过 err对象 是否为 null ,从而知晓文件读取的结果
const fs = require('fs');
fs.readFile('./files/1.txt', 'utf8', function(err, dataStr) {
if (err) {
return console.log('读取文件失败!' + err.message)
}
console.log('读取文件成功!' + dataStr)
})
1.3向指定的文件中写入内容
1.3.1 fs.writeFile( ) 的语法格式
使用fs.writeFile() 方法,可以向指定的文件中写入内容,语法格式如下:
fs.writeFile(file, data[, options], callback)
参数解读:
●参数1:必选参数,需要指定一个文件路径的字符串,显示文件的存放路径。
●参数2:必选参数,表示要写入的内容。
●参数3:可选参数,表示以什么格式写入文件内容,默认值是utf8.
// 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('文件写入成功!')
})
1.4 fs模块-路径动态拼接的问题
1.问题:
在使用fs 模块操作文件时,如果提供的操作路径是以 ./ 或 ./ 开头的相对路径时,很容易出现路径动态拼接错误的问题。
2.原因:
代码在运行的时候,会以执行node命令时所处的目录,动态拼接出被操作文件的完整路径。
3.解决:
如果要解决这个问题,可以直接提供一个完整的文件存放路径就行。
// __dirname 表示当前文件所处的目录
// console.log(__dirname)
fs.readFile(__dirname + '/files/1.txt', 'utf8', function (err, dataStr) {
if (err) {
return console.log('读取文件失败!' + err.message)
}
console.log('读取文件成功!' + dataStr)
})
2. path路径模块
2.1什么是path路径模块
path模块是Node.js官方提供的、用来处理路径的模块。它提供了一系列的方法和属性,用来满足用户对路径的处理需求。
例如:
●path.join( ) 方法,用来将多个路径片段拼接成一个完整的路径字符串
●path.basename( ) 方法,用来从路径字符串中,将文件名解析出来
如果要在JavaScript代码中,使用path模块来处理路径,则需要使用如下的方式先导入它:
const path = require( 'path')
2.2路径拼接
1. path.join()的语法格式
使用path.join0方法,可以把多个路径片段拼接为完整的路径字符串,语法格式如下:
path. join([... paths])
参数解读:
●...paths <string> 路径片段的序列
●<string> 返回值
// 注意: ../ 会抵消前面的路径
const pathStr = path.join('/a', '/b/c', '../../', './d', 'e')
console.log(pathStr) // \a\b\d\e
fs.readFile(__dirname + '/files/1.txt')
fs.readFile(path.join(__dirname, './files/1.txt'), 'utf8', function (err, dataStr) {
if (err) {
return console.log(err.message)
}
console.log(err, dataStr) // null 111
})
注意:
以后凡是涉及到 路径拼接 的操作,都要使用 path.join( ) 方法来进行处理。
2.3获取路径中的文件名
1. path.basename( ) 的语法格式
使用path.basename( ) 方法,可以获取路径中的最后一部分, 经常通过这个方法获取路径中的文件名,语法格式如下:
path.basename(path[, ext])
参数解读:
●path <string> 必选参数,表示个路径的字符串
●ext <string> 可选参数,表示文件扩展名
●<string> 返回值:表示路径中的最后一 分
2. path.basename( ) 的代码示例
使用path.basename( ) 方法,可以从一个文件路径中,获取到文件的名称部分:
const path = require('path')
// 定义文件的存放路径
const fpath = '/a/b/c/index.html'
// const fullName = path.basename(fpath)
// console.log(fullName)
const nameWithoutExt = path.basename(fpath, '.html')
console.log(nameWithoutExt)
注意:
①fs.writeFile( ) 方法只能用来创建文件,不能用来创建路径
②重复调用fs.writeFile( )写入同一个文件,新写入的内容会覆盖之前的旧内容
2.4获取路径中的文件扩展名
1. path.extname( ) 的语法格式
使用path.extname0方法,可以获取路径中的扩展名部分,语法格式如下:
path.extname(path)
参数解读: .
●path <string> 必选参数,表示一个路径的字符串
●<string> 返回值:返回得到的扩展名字符串
const path = require('path')
// 这是文件的存放路径
const fpath = '/a/b/c/index.html'
const fext = path.extname(fpath)
console.log(fext) // .html
3. http模块
3.1什么是http模块
1.回顾: 什么是客户端、什么是服务器?
在网络节点中,负责消费资源的电脑,叫做客户端;负责对外提供网络资源的电脑,叫做服务器。
2.http模块
是Node.js官方提供的、用来创建web服务器的模块。通过http模块提供的http.createServer() 方法,就能方便的把一台普通的电脑,变成一台Web服务器,从而对外提供Web资源服务。
3.导入
let http = require(‘http’);
3.2进一步理解http模块的作用
服务器和普通电脑的区别在于,服务器上安装了web服务器软件。
例如: IIS、 Apache 等。通过安装这些服务器软件,就能把一台普通的电脑变成一台web服务器。
http模块,通过几行简单的代码,就能轻松的手写一个服务器软件,从而对外提供web服务。
3.3服务器相关的概念
1. IP地址
IP地址就是互联网上每台计算机的唯一地址,因此IP地址具有唯-性。如果把“个人电脑”比作“一台电话”,那么“IP地址”就相当于“电话号码”,只有在知道对方IP地址的前提下,才能与对应的电脑之间进行数据通信。
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地址,就能把自己的电脑当作一台服务器进行访问了。
2.域名和域名服务器
尽管IP地址能够唯一地标记网络上的计算机,但IP地址是一长串数字, 不直观,而且不便于记忆,于是人们又发明了另一套字符型的地址方案,即所谓的域名(Domain Name)地址。
IP地址和域名是一对应的关系, 这份对应关系存放在一种叫做域名服务器(DNS, Domain name server)的电脑中。
使用者只需通过好记的域名访问对应的服务器即可,对应的转换工作由域名服务器实现。因此,域名服务器就是提供IP地址和域名之间的转换服务的服务器。
注意:
①单纯使用IP地址,互联网中的电脑也能够正常工作。但是有了域名的加持,能让互联网的世界变得更加方便。
②在开发测试期间,127.0.0.1 对应的域名是localhost,它们都代表我们自己的这台电脑,在使用效果上没有任何区别。
3.端口号
计算机中的端口号,就好像是现实生活中的门]牌号一样。 通过牌号,外卖小哥可以在整栋大楼众多的房间中,准确把外卖送到你的手中。
同样的道理,在一台电脑中,可以运行成百千个web服务。每个web服务都对应一个唯一的端口号。 客户端发送过来的网络请求,通过端口号,可以被
注意:
①每个端口号不能同时被多个web服务占用。
②在实际应用中,URL中的80端口可以被省略。
3.4创建最基本的web服务器
1.创建web服务器的基本步骤
①导入http 模块
②创建web服务器实例
③为服务器实例绑定request事件,监听客户端的请求
④启动服务器
// 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.', req, res)
})
// 4. 启动服务器
server.listen(8080, function () {
console.log('server running at http://127.0.0.1:8080')
})
2. req 请求对象
只要服务器接收到了客户端的请求,就会调用通过 server.on() 为服务器绑定的 request 事件处理函数。
3. res 响应对象
在服务器的 request 事件处理函数中,如果想访问与服务器相关的数据或属性,可以使用如下的方式:
// req 是请求对象,包含了与客户端相关的数据和属性
server.on('request', (req) => {
// req.url是客户端请求的 URL 地址
const url = req.url;
// req.method 是客户端请求的 method 类型
const method = req.method;
const str = `your request is ${url},reqused is ${method}`;
console.log(str);
})
5. 解决中文乱码问题
当调用 res.end( ) 方法,向客户端发送中文内容的时候,会出现乱码问题,此时,需要手动设置内容的编码格式:
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)})
3.5根据不同的 url 响应不同的 html 内容
1. 核心实现步骤
- 获取请求的 url 地址
- 设置默认的响应内容为 404 Not found
- 判断用户请求的是否为 / 或 /index.html 首页
- 判断用户请求的是否为 /about.html 关于页面
- 设置 Content-Type 响应头,防止中文乱码
- 使用 res.end() 把内容响应给客户端
server.on('request', (req, res) => {
// 1. 获取请求的 url 地址
const url = req.url;
// 2. 设置默认的响应内容为 404 Not found
let content = '<h1>404 Not found!</h1>';
// 3. 判断用户请求的是否为 / 或 /index.html 首页
// 4. 判断用户请求的是否为 /about.html 关于页面
if (url === '/' || url === '/index.html') {
content = '<h1>首页</h1>'
} else if (url === '/about.html') {
content = '<h1>关于页面</h1>'
}
// 5. 设置 Content-Type 响应头,防止中文乱码
res.setHeader('Content-Type', 'text/html; charset=utf-8')
// 6. 使用 res.end() 把内容响应给客户端
res.end(content)
})
4.模块化
4.1模块化的基本概念
1.什么是模块化
模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说,模块是可组合、分解和更换的单元。
2. 编程领域中的模块化
编程领域中的模块化,就是遵守固定的规则,把一个大文件拆成独立并互相依赖的多个小模块。
把代码进行模块化拆分的好处:
① 提高了代码的复用性
② 提高了代码的可维护性
③ 可以实现按需加载
3.模块化规范
模块化规范就是对代码进行模块化的拆分与组合时,需要遵守的那些规则。
例如:
1.使用什么样的语法格式来引用模块
2.在模块中使用什么样的语法格式向外暴露成员
模块化规范的好处:
大家都遵守同样的模块化规范写代码,降低了沟通的成本,极大方便了各个模块之间的相互调用。
4.2 Node.js 中的模块化
4.2.1 Node.js 中模块的分类
Node.js 中根据模块来源的不同,将模块分为了 3 大类,分别是:
1.内置模块(内置模块是由 Node.js 官方提供的,例如 fs、path、http 等)
2.自定义模块(用户创建的每个 .js 文件,都是自定义模块)
3.第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载
4.2.2加载模块
使用强大的 require() 方法,可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。
// 加载用户的自定义模块
const custom = require('./custom.js’)
注意:
使用 require() 方法加载其它模块时,会执行被加载模块中的代码。
4.2.3 Node.js 中的模块作用域
1.什么是模块作用域
和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域。
2.模块作用域的好处
防止了全局变量污染的问题
4.2.4 向外 共享模块作用域中的成员
1. module 对象
在每个 .js 自定义模块中都有一个 module 对象,它里面存储了和当前模块有关的信息
2. module.exports 对象
在自定义模块中,可以使用 module.exports 对象,将模块内的成员共享出去,供外界使用。
外界用 require() 方法导入自定义模块时,得到的就是 module.exports 所指向的对象。
/** 在外界使用 require 导入一个自定义模块的时候,得到的成员,
就是 那个模块中,通过 module.exports 指向的那个对象
在一个自定义模块中,默认情况下, module.exports = {};**/
const age = 20;
module.exports.age = age;
// 向 module.exports 对象上挂载 username 属性
module.exports.username = 'zx';
// 向 module.exports 对象上挂载 sayHello 方法
module.exports.sayHello = function () {
console.log('hello');
}
3.共享成员时的注意点
使用 require() 方法导入模块时,导入的结果,永远以 module.exports 指向的对象为准。
4. exports 和 module.exports 的使用误区
特备注意:require() 模块时,得到的永远是 module.exports 指向的对象。
注意:为了防止混乱,建议大家不要在同一个模块中同时使用 exports 和 module.export
4.2.5 Node.js 中的模块化规范
Node.js 遵循了 CommonJS 模块化规范,CommonJS 规定了模块的特性和各模块之间如何相互依赖。
1.CommonJS 规定:
① 每个模块内部,module 变量代表当前模块。
② module 变量是一个对象,它的 exports 属性(即 module.exports)是对外的接口。
③ 加载某个模块,其实是加载该模块的 module.exports 属性。require( ) 方法用于加载模块
5. npm与包
5.1 包
1.什么是包
Node.js 中的第三方模块又叫做包。
就像电脑和计算机指的是相同的东西,第三方模块和包指的是同一个概念,只不过叫法不同。
2.包的来源
不同于 Node.js 中的内置模块与自定义模块,包是由第三方个人或团队开发出来的,免费供所有人使用。
注意:
Node.js 中的包都是免费且开源的,不需要付费即可免费下载使用
3.为什么需要包
由于 Node.js 的内置模块仅提供了一些底层的 API,导致在基于内置模块进行项目开发的时,效率很低。
包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率。
包和内置模块之间的关系,类似于 jQuery 和 浏览器内置 API 之间的关系
4.从哪里下载包
国外有一家 IT 公司,叫做 npm, Inc. 这家公司旗下有一个非常著名的网站: npm ,它是全球最大的包共享平台,你可以从这个网站上搜索到任何你需要的包,只要你有足够的耐心!
到目前位置,全球约 1100 多万的开发人员,通过这个包共享平台,开发并共享了超过 120 多万个包 供我们使用。
npm, Inc. 公司提供了一个地址为https:/registry.npmjs.org/ 的服务器,来对外共享所有的包,我们可以从这个服务器上下载自己所需要的包。
注意:
⚫ 从npm网站上搜索自己所需要的包
⚫ 从https:/registry.npmjs.org/ 服务器上下载自己需要的包
5.如何下载包
npm, Inc. 公司提供了一个包管理工具,我们可以使用这个包管理工具,从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。
这个包管理工具的名字叫做 Node Package Manager(简称 npm 包管理工具),这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。
大家可以在终端中执行 npm -v 命令,来查看自己电脑上所安装的 npm 包管理工具的版本号
5.2 npm 初体验
1. 格式化时间的传统做法
① 创建格式化时间的自定义模块
② 定义格式化时间的方法
③ 创建补零函数
④ 从自定义模块中导出格式化时间的函数
⑤ 导入格式化时间的自定义模块
⑥ 调用格式化时间的函数
2. 格式化时间的高级做法
① 使用 npm 包管理工具,在项目中安装格式化时间的包 moment
② 使用 require() 导入格式化时间的包
③ 参考 moment 的官方 API 文档对时间进行格式化
3. 在项目中安装包的命令
如果想在项目中安装指定名称的包,需要运行如下的命令:
npm install 包的完整名称
上述的装包命令,可以简写成如下格式
npm i 包的完整名称
4. 初次装包后多了哪些文件
初次装包完成后,在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件。
其中:
node_modules 文件夹用来存放所有已安装到项目中的包。
require() 导入第三方包时,就是从这个目录中查找并加载包。
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等。
注意:
程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码,npm 包管理工具会自动维护它们
5. 安装指定版本的包
默认情况下,使用 npm install 命令安装包的时候,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过 @ 符号指定具体的版本,例如
npm i moment@2.22.2
6. 包的语义化版本规范
包的版本号是以“点分十进制”形式进行定义的,总共有三位数字,
例如 2.24.0
其中每一位数字所代表的含义如下:
第1位数字:大版本
第2位数字:功能版本
第3位数字:Bug修复版本
版本号提升的规则:只要前面的版本号增长了,则后面的版本号归零。
5.3 包管理配置文件
npm 规定,在项目根目录中,必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
1.项目的名称、版本号、描述等
2.项目中都用到了哪些包
3.哪些包只在开发期间会用到
4.那些包在开发和部署时都需要用到
1. 多人协作的问题
整个项目的体积是 30.4M
第三方包的体积是 28.8M
项目源代码的体积 1.6M
遇到的问题:第三方包的体积过大,不方便团队成员之间共享项目源代码。
解决方案:共享时剔除node_module
2. 如何记录项目中安装了哪些包
在项目根目录中,创建一个叫做 package.json 的配置文件,即可用来记录项目中安装了哪些包。
从而方便剔除node_modules 目录之后,在团队成员之间共享项目的源代码。
注意:
今后在项目开发中,一定要把 node_modules 文件夹,添加到 .gitignore 忽略文件中
3. 快速创建 package.json
npm 包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 package.json 这个包管理配置文件:
// 作用:在执行命令所处的目录中,快速新建package.json文件
npm init -y
注意:
① 上述命令只能在英文的目录下成功运行!所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格。
② 运行 npm install 命令安装包的时候,npm 包管理工具会自动把包的名称和版本号,记录到 package.json 中。
4. dependencies 节点
package.json 文件中,有一个 dependencies 节点,专门用来记录您使用 npm install 命令安装了哪些包。
5. 一次性安装所有的包
当我们拿到一个剔除了 node_modules 的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。否则会报类似于下面的错误
// 由于项目运行依赖于moment这个包,如果没有提前安装好这个包,就会报如下的错误:
Error: Cannot find module 'moment'
可以运行 npm install 命令(或 npm i)一次性安装所有的依赖包
// 执行npm install 命令时,npm包管理工具会先读取package.json 中的 dependencies 节点,读取到记录的所有依赖包名称和版本号之后,npm包管理工具会把这些包一次性下载到项目中
npm install
6. 卸载包
可以运行 npm uninstall 命令,来卸载指定的包:
注意:
npm uninstall 命令执行成功后,会把卸载的包,自动从 package.json 的 dependencies 中移除掉。
7. devDependencies 节点
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 devDependencies 节点中。
与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到 dependencies 节点中。
可以使用如下的命令,将包记录到 devDependencies 节点中
// 安装指定的包,并记录到devDependencies节点中
npm i 包名 -D
// 注意:上述命令是简写形式,等价于下面完整的写法:
npm install 包名 --save-dev
5.4 解决下包速度慢的问题
1. 为什么下包速度慢
在使用 npm 下包的时候,默认从国外的 https://registry.npmjs.org/ 服务器进行下载,此时,网络数据的传输需要经过漫长的海底光缆,因此下包速度会很慢。
扩展阅读 - 海底光缆:
2. 淘宝 NPM 镜像服务器
淘宝在国内搭建了一个服务器,专门把国外官方服务器上的包同步到国内的服务器,然后在国内提供下包的服务。从而极大的提高了下包的速度。
扩展:
镜像(Mirroring)是一种文件存储形式,一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像。
3. 切换 npm 的下包镜像源
下包的镜像源,指的就是下包的服务器地址
#查看当前的下包镜像源
npm config get registry
#将下包的镜像源切换为淘宝镜像源
npm config set registry=https://registry.npm.taobao.org/
#检查镜像源是否下载成功
npm config get registry
4. nrm
为了更方便的切换下包的镜像源,我们可以安装 nrm 这个小工具,利用 nrm 提供的终端命令,可以快速查看和切换下包的镜像源。
#通过npm包管理器,将nrm安装为全局可用的工具
npm i nrm -g
#查看所有可用的镜像源
nrm ls
#将下包的镜像源切换为taobao镜像
nrm use taobao
5.5 包的分类
使用 npm 包管理工具下载的包,共分为两大类,分别是:
5.5.1.项目包
那些被安装到项目的 node_modules 目录中的包,都是项目包。
项目包又分为两类,分别是:
1.开发依赖包(被记录到 devDependencies 节点中的包,只在开发期间会用到)
2.核心依赖包(被记录到 dependencies 节点中的包,在开发期间和项目上线之后都会用到)
npm i 包名 -D #开发依赖包((会被记录到devDependencies节点下)
npm i 包名 #核心依赖包(会被记录到dependencies节点下)
5.5.2.全局包
在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包。
全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。
npm i 包名 -g #全局安装指定的包
npm uninstall包名 -g #卸载全同女装的包
注意:
① 只有工具性质的包,才有全局安装的必要性。因为它们提供了好用的终端命令。
② 判断某个包是否需要全局安装后才能使用,可以参考官方提供的使用说明即可。
5.5.3. i5ting_toc
i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具,使用步骤如下
#将i5ting toc安装为全局包
npm install -g i5ting_toc
#调用i5ting toc,轻松实现md 转html 的功能
i5ting_toc -f 要转换的md文件路径 -o
i5ting_toc -f day1.md -o
i5ting_toc -f qaq.md -o
第一步:查看npm相关配置
在dos命令窗口输入npm config ls
第二步: 修改npm默认全局安装路径
npm config set prefix "D:\nodejs\node_global" (全局安装模块)
npm config set prefix "D:\nodejs\node_modules" (全局安装模块)
npm config set cache "D:\nodejs\node_cache" (缓存模块)
npm config ls (查看npm配置)
npm view i5ting_toc versions (查看i5ting_toc版本号)
检测PATH环境变量是否配置了Node.js,点击开始=》运行=》输入"cmd" => 输入命令"path",输出如下结果:
PATH=C:\oraclexe\app\oracle\product\10.2.0\server\bin;C:\Windows\system32;
C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;
C:\python32\python;C:\MinGW\bin;C:\Program Files\GTK2-Runtime\lib;
C:\Program Files\MySQL\MySQL Server 5.5\bin;C:\Program Files\nodejs\;
C:\Users\rg\AppData\Roaming\npm
5.6 规范的包结构
在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下包的内部结构。
一个规范的包,它的组成结构,必须符合以下 3 点要求:
① 包必须以单独的目录而存在
② 包的顶级目录下要必须包含 package.json 这个包管理配置文件
③ package.json 中必须包含 name,version,main 这三个属性,分别代表包的名字、版本号、包的入口。
注意:
以上 3 点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考如下网址:
https://yarnpkg.com/zh-Hans/docs/package-json
5.7 开发属于自己的包
5.7.1. 需要实现的功能
① 格式化日期
② 转义 HTML 中的特殊字符
③ 还原 HTML 中的特殊字符
1. 需要实现的功能
2. 初始化包的基本结构
① 新建 qaq-tools 文件夹,作为包的根目录
② 在 qaq-tools 文件夹中,新建如下三个文件:
package.json (包管理配置文件)
index.js (包的入口文件)
README.md (包的说明文档)
3. 初始化 package.json
关于更多 license 许可协议相关的内容,可参考 https://www.jianshu.com/p/86251523e898
4. 在 index.js 中定义格式化时间的方法
5. 在 index.js 中定义转义 HTML 的方法
6. 在 index.js 中定义还原 HTML 的方法
见代码
7. 将不同的功能进行模块化拆分
① 将格式化时间的功能,拆分到 src -> dateFormat.js 中
② 将处理 HTML 字符串的功能,拆分到 src -> htmlEscape.js 中
③ 在 index.js 中,导入两个模块,得到需要向外共享的方法
④ 在 index.js 中,使用 module.exports 把对应的方法共享出去
8. 编写包的说明文档
包根目录中的 README.md 文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown 的格式写出来,方便用户参考。
README 文件中具体写什么内容,没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。
我们所创建的这个包的 README.md 文档中,会包含以下 6 项内容:
安装方式、导入方式、格式化时间、转义 HTML 中的特殊字符、还原 HTML 中的特殊字符、开源协议
5.8 发布包
5.8.1 注册 npm 账号
①访问 npm 网站,点击 sign up 按钮,进入注册用户界面
②填写账号相关的信息:Full Name、Public Email、Username、Password
③点击 Create an Account 按钮,注册账号
④登录邮箱,点击验证链接,进行账号的验证
5.8.2 登录 npm 账号
npm 账号注册完成后,可以在终端中执行 npm login 命令,依次输入用户名、密码、邮箱后,即可登录成功。
注意:
![]() |
在运行 npm login 命令之前,必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败!
5.8.3 把包发布到 npm 上
将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到 npm 上(注意:包名不能雷同)。
5.8.4 删除已发布的包
运行 npm unpublish 包名 --force 命令,即可从 npm 删除已发布的包。
注意:
① npm unpublish 命令只能删除 72 小时以内发布的包
② npm unpublish 删除的包,在 24 小时内不允许重复发布
③ 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包!
6. 模块的加载机制
6.1 优先从缓存中加载
模块在第一次加载后会被缓存。
这也意味着多次调用 require() 不会导致模块的代码被执行多次。
注意:
不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。
6.2 内置模块的加载机制
内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。
例如,
require('fs') 始终返回内置的 fs 模块,即使在 node_modules 目录下有名字相同的包也叫做 fs。
6.3 自定义模块的加载机制
使用 require() 加载自定义模块时,必须指定以 ./ 或 ../ 开头的路径标识符。
在加载自定义模块时,如果没有指定 ./ 或 ../ 这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载。
同时,在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则 Node.js 会按顺序分别尝试加载以下的文件:
① 按照确切的文件名进行加载
② 补全 .js 扩展名进行加载
③ 补全 .json 扩展名进行加载
④ 补全 .node 扩展名进行加载
⑤ 加载失败,终端报错
6.4 第三方模块的加载机制
如果传递给 require() 的模块标识符不是一个内置模块,也没有以 ‘./’ 或 ‘../’ 开头,则 Node.js 会从当前模块的父目录开始,尝试从 /node_modules 文件夹中加载第三方模块。
如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。
例如,
假设在 'C:\Users\qaq\project\foo.js' 文件里调用了 require('tools'),则 Node.js 会按以下顺序查找:
① C:\Users\qaq\project\node_modules\tools
② C:\Users\qaq\node_modules\tools
③ C:\Users\node_modules\tools
④ C:\node_modules\tools
6.5 目录作为模块
当把目录作为模块标识符,传递给 require() 进行加载的时候,有三种加载方式:
① 在被加载的目录下查找一个叫做 package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
② 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件。
③ 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannot find module 'xxx