本文仅为个人学习笔记,资料来自黑马前端
1、Node.js 简介
1.1 概念
Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。
Node.js 的官网地址: https://nodejs.org/zh-cn/
- Node.js 中的 JavaScript 运行环境
浏览器是 JavaScript 的前端运行环境
Node.js 是JavaScript 的后端运行环境
Node.js 中无法调用 DOM 和 BOM 等浏览器内置 API
- 基于 Node.js 基础功能的工具和框架
基于 Express 框架 http://www.expressjs.com.cn/ ,可以快速构建 Web 应用
基于 Electron 框架 https://electronjs.org/,可以构建跨平台的桌面应用
基于 restify 框架 http://restify.com/ ,可以快速构建 API 接口项目
1.2 安装
进入 Node.js 的官网下载: https://nodejs.org/zh-cn/
- 在 Node.js 环境中执行 JavaScript 代码
打开终端,输入 node 要执行的 js 文件路径
(1)tab 键:快速补全路径
(2)esc 键:快速清空当前已输入的命令
(3)cls 指令:清空终端
2、内置模块
2.1 fs 文件系统模块
fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性,用来满足用户对文件的操作需求。
- 导入模块
const fs = require('fs')
- fs.readFile() 方法:读取指定文件中的内容
fs.readFile(path[,options],callback)
- 参数1:必选参数,字符串,表示文件的路径
- 参数2:可选参数,表示以什么编码格式来读取文件
- 参数3:必选参数,文件读取完成后,通过回调函数拿到读取的结果
fs.readFile('./files/study.txt','utf8',function(err,dataStr) {
if (err) { //判断 err 对象是否为 null
return console.log('文件读取失败' + err.message)
}
console.log('文件读取成功,内容是:' + result)
})
- fs.writeFile() 方法:向指定文件写入内容
fs.writeFile(file,data[,options],callback)
- 必选参数,需要指定一个文件路径的字符串,表示文件的存放路径
- 参数2:必选参数,表示要写入的内容
- 参数3:可选参数,表示入文件内容,默认值是 utf8
- 参数4:必选参数,文件写入完成后的回调函数
fs.writeFile('E:/files/study.txt','123456789',function(err) {
if (err) { //判断 err 对象是否为 null
return console.log('文件写入失败' + err.message)
}
console.log('文件写入成功')
})
-
fs 模块 - 路径动态拼接的问题
在使用 fs 模块操作文件时,如果提供的操作路径是以 ./ 或 …/ 开头的相对路径时,很容易出现路径动态拼接错误的问题
原因:代码在运行的时候,会以执行 node 命令时所处的目录,动态拼接出被操作文件的完整路径
解决方案:在使用 fs 模块操作文件时,直接提供完整的路径,不要提供 ./ 或 …/ 开头的相对路径,从而防止路径动态拼接的问题;使用 path.join()
2.2 path 路径模块
path 模块是 Node.js 官方提供的、用来处理路径的模块。它提供了一系列的方法和属性,用来满足用户对路径的处理需求
- 导入模块
const path = require('path')
- path.join() 方法:将多个路径片段拼接成一个完整的路径字符
path.join([...paths])
- …paths
<string>
路径片段的序列 - 返回值:
<string>
const pathStr = path.join('/a','/b/c','../','./d','e')
console.log(pathStr) // 输出:\a\b\d\e
// __dirname 表示当前文件所处的目录
const pathStr = path.join(__dirname,'./files/study.txt')
console.log(pathStr)
// 输出:当前文件件所处目录\files\study.txt
- path.basename() 方法:从路径字符中,将文件名解析出来
path.basename(path[,ext])
- path
<string>
必选参数,表示一个路径的字符串 - ext
<string>
可选参数,表示文件扩展名 - 返回:
<string>
表示路径中的最后一部分
const fpath = 'a/b/c/index.html' // 文件的存在路径
var fullName = path.basename(fpath)
console.log(fullName) // 输出:index.html
var nameWithoutExt = path.basename(fpath,'.html')
console.log(nameWithoutExt) // 输出:index
- path.extname() 方法:获取路径中的文件拓展名
path.extname(path)
- path
<string>
必选参数,表示一个路径的字符串 - 返回:
<string>
返回得到的扩展名字符串
const fpath = '/a/b/c/index.html'
const fext = path.extname(fpath)
console.log(fext) // 输出:.html
2.3 http 模块
http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。通过 http 模块提供的 http.createServer() 方法,就能方便的把一台普通的电脑,变成一台 Web 服务器,从而对外提供 Web 资源服务
- 导入模块
const http = require('http')
-
http 模块的作用
服务器和普通电脑的区别在于,服务器上安装了 web 服务器软件,例如:IIS、Apache 等。通过安装这些服务器软件,就能把一台普通的电脑变成一台 web 服务器。
在 Node.js 中,我们不需要使用 IIS、Apache 等这些第三方 web 服务器软件。因为我们可以基于 Node.js 提供的
http 模块,通过几行简单的代码,就能轻松的手写一个服务器软件,从而对外提供 web 服务 -
创建最基本的 web 服务器
- 导入 http 模块
const http = require('http')
- 创建 web 服务器实例
const server = http.createServer()
- 为服务器实例绑定 request 事件
// 绑定 request 事件,即可监听客户端发送过来的网络请求
server.on('request',(req,res) => {
// 只要有客户端请求就会触发 request 事件,从而调用这个事件处理函数
console.log('Someone visit our web server.')
})
- 启动服务器
// 调用 server.listen(端口号,callback)方法
server.listen(80,() =>{
console.log('http server running at http:127.0.0.1')
})
- req 请求对象
req 是请求对象,它包含了与客户端相关的数据和属性
例如:
req.url : 客户端请求的 URL 地址
req.method :客户端的 method 请求类型
- res 响应对象
res 是相应对象,它包含了与服务器相关的数据和属性
例如:
res.end() :向客户端发送指定的内容,并结束本次请求的处理过程
res.method:类型
- 解决中文乱码问题
当调用 res.end() 方法,向客户端发送中文内容的时候,会出现乱码问题,此时,需要手动设置内容的编码格式
server.on('request',(req,res) => {
const str = '请求的地址是 ${req.url},请求的 method 类型是 ${req.method}'
// 防止中文乱码问题,设置响应头 Content-Type 的值为 text/html:charset=utf-8
res.setHeader('Content-Type','text/html:charset=utf-8')
})
- 根据不同的 URL 相应不同的 html 内容
动态相应内容:
① 获取请求的 url 地址
② 设置默认的响应内容为 404 Not found
③ 判断用户请求的是否为 / 或 /index.html 首页
④ 判断用户请求的是否为 /about.html 关于页面
⑤ 设置 Content-Type 响应头,防止中文乱码
⑥ 使用 res.end() 把内容响应给客户端
server.on('request',function(req,res) {
const url = req.url // 1.获取请求的 URL 地址
let content = '<h1> 404 Not found! </h1>' // 2.设置默认的内容为 404 Not found
if (url ==='/' || url === '/index.html') {
content = '<h1> 首页 </h1>' // 3.用户请求的是首页
}else if (url === '/about.html') {
content = '<h1>关于页面</h1>' // 4.用户请求的关于页面
}
res.setHeader('Content-Type','text/html:charset=utf-8') // 4.设置 Content-Type 响应头,防止中文乱码
res.end(content) // 6.把内容发送给客户端
})
3、模块化
3.1 模块化概念
模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说,模块是可组合、分解和更换的单元
把代码进行模块化拆分的好处:
① 提高了代码的复用性
② 提高了代码的可维护性
③ 可以实现按需加载
3.2 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')
- Node.js 中的模块作用域
和函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域
作用:防止全局变量污染
- 向外共享模块作用域中的成员
使用 require() 方法导入模块时,导入的结果,永远以 module.exports 指向的对象为准
- module 对象
每个 .js 自定义模块中都有一个 module 对象,它里面存储了和当前模块有关的信息
- module.exports 对象
在自定义模块中,可以使用 module.exports 对象,将模块内的成员共享出去,供外界使用。
外界用 require() 方法导入自定义模块时,得到的就是 module.exports 所指向的对象
- exports 对象
默认情况下,exports 和 module.exports 指向同一个对象。最终共享的结果,还是以 module.exports 指向的对象为准。
- Node.js 中的模块化规范
Node.js 遵循了 CommonJS 模块化规范,CommonJS 规定了模块的特性和各模块之间如何相互依赖
CommonJS 规定:
① 每个模块内部,module 变量代表当前模块。
② module 变量是一个对象,它的 exports 属性(即 module.exports)是对外的接口。 ③ 加载某个模块,其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。
3.3 npm 与包
Node.js 中的第三方模块又叫做包
- 包的下载
(1)全球最大的包共享平台:https://www.npmjs.com/ ,可以从这个网站上搜索到任何你需要的包,只要你有足够的耐心!
(2)服务器:https://registry.npmjs.org/ ,对外共享所有的包,我们可以从这个服务器上下载自己所需要的包。
(3)包管理工具:Node Package Manage(简称 npm 包管理工具)
- 在项目中安装指定名称的包的指令
npm install 包的完整名称
// 简写
npm i 包的完整名称
// 安装指定版本的包(默认安装最新版本)
npm i moment@3.22.2
// 一次性安装所有包
npm install
- 卸载包
npm uninstall 包名
- 初次装包后产生的文件
node_modules 的文件夹:
node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时,就是从这个目录中查找并加载包
package-lock.json 的配置文件:
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等
- 包管理配置文件 package.json
npm 规定,在项目根目录中,必须提供一个叫做 package.json
的包管理配置文件。用来记录与项目有关的一些配置信息。例如:
项目的名称、版本号、描述等
项目中都用到了哪些包
哪些包只在开发期间会用到
哪些包在开发和部署时都需要用到
package.json
可用来记录项目中安装了哪些包,从而方便剔除 node_modules
目录之后,在团队成员之间共享项目的源代码(一定要把 node_modules
文件夹,添加到 .gitignore 忽略文件中
)
- 快速创建 package.json
npm 包管理工具提供了一个快捷命令,可以在执行命令时所处的目录中,快速创建 package.json 这个包管理配置文件:
npm init -y
注意:
- 只能在英文的目录下成功运行
- 运行 npm install 命令安装包的时候,npm 包管理工具会自动把包的名称和版本号,记录到 package.json 中
- 包管理配置文件中的 dependencies 节点和 devDependencies 节点
dependencies 节点:
专门用来记录您使用 npm install 命令安装了哪些包
如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到 dependencies 节点中
devDependencies 节点:
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到 devDependencies 节点中
// 安装指定的包,并记录到 devDependencies 节点中
npm i 包名 -D
- 解决包虾藻慢问题
切换 npm 的下载包镜像源
# 查看当前下载包镜像源
npm config get registry
# 将下载的镜像源切换为淘宝镜像源
npm config set registry=https://registry.npm.taobao.org/
# 检查镜像是否下载成功
npm config get registry
安装 nrm 工具,利用 nrm 提供的终端命令,可以快速查看和切换下
包的镜像源:
# 通过 npm 包管理器,将 nrm 安装为全局可用的工具
npm i nrm -g
# 查看所有可用的镜像源
nrm ls
# 将下包的镜像源切换为 taobao 镜像
nrm use taobao
- 包的分类
项目包:
那些被安装到项目的 node_modules 目录中的包,都是项目包
项目包又分为两类,分别是:
开发依赖包(被记录到 devDependencies 节点中的包,只在开发期间会用到)
核心依赖包(被记录到 dependencies 节点中的包,在开发期间和项目上线之后都会用到)
全局包:
在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包
全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下
npm i 包名 -g # 全局安装指定包
npm uninstall 包名 -g # 卸载全局安装的包
注意:
① 只有工具性质的包,才有全局安装的必要性。因为它们提供了好用的终端命令
② 判断某个包是否需要全局安装后才能使用,可以参考官方提供的使用说明即可
- i5ting_toc 工具
i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具,使用步骤如下:
# 将 i5ting_toc 安装为全局包
npm install -g i5ting_toc
# 调用 i5ting_toc ,实现 md 转 html 功能
i5ting_toc -f 要转换的 md 文件路径 -o
3.4 开发包、发布包
- 规范的包结构
一个规范的包,它的组成结构,必须符合以下 3 点要求:
① 包必须以单独的目录而存在
② 包的顶级目录下要必须包含 package.json 这个包管理配置文件
③ package.json 中必须包含 name,version,main 这三个属性,分别代表包的名字、版本号、包的入口
更多的约束,可以参考如下网址:https://yarnpkg.com/zh-Hans/docs/package-json
- 开发包
步骤:
(1)设计实现需要的功能
(2)初始化包的基本结构
例如:
① 新建 itheima-tools 文件夹,作为包的根目录
② 在 itheima-tools 文件夹中,新建如下三个文件:
package.json (包管理配置文件)
index.js (包的入口文件)
README.md (包的说明文档)
(3)初始化 package.json
(4)在 index.js 中定义 XX 功能的方法
(5)将不同的功能进行模块化拆分
① 将格式化时间的功能,拆分到 src -> dateFormat.js 中
② 将处理 HTML 字符串的功能,拆分到 src -> htmlEscape.js 中
③ 在 index.js 中,导入两个模块,得到需要向外共享的方法
④ 在 index.js 中,使用 module.exports 把对应的方法共享出去
(6)编写包的说明文档
包根目录中的 README.md 文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown 的格式写出来,方便用户参考。
一般的 README.md 文档中,会包含以下 6 项内容:
安装方式、导入方式、格式化时间、转义 HTML 中的特殊字符、还原 HTML 中的特殊字符、开源协议
- 发布包
(1)注册 npm 账号
① 访问 https://www.npmjs.com/ 网站,点击 sign up 按钮,进入注册用户界面
② 填写账号相关的信息:Full Name、Public Email、Username、Password
③ 点击 Create an Account 按钮,注册账号
④ 登录邮箱,点击验证链接,进行账号的验证
(2)登录 npm 账号
npm 账号注册完成后,可以在终端中执行 npm login 命令,依次输入用户名、密码、邮箱后,即可登录成功
(3)把包发布到 npm 上
将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到 npm 上(注意:包名不能雷同)
(4)删除已发布的包
运行 npm unpublish 包名 --force 命令,即可从 npm 删除已发布的包
注意:
① npm unpublish 命令只能删除 72 小时以内发布的包
② npm unpublish 删除的包,在 24 小时内不允许重复发布
③ 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包
3.5 模块的加载机制
- 优先从缓存中加载
模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次
- 内置模块的加载机制
内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。
例如:
require(‘fs’) 始终返回内置的 fs 模块,即使在 node_modules 目录下有名字相同的包也叫做 fs
- 自定义模块的加载机制
使用 require() 加载自定义模块时,必须指定以 ./ 或 …/ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./ 或 …/ 这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载
同时,在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则 Node.js 会按顺序分别尝试加载以下的文件:
① 按照确切的文件名进行加载
② 补全 .js 扩展名进行加载
③ 补全 .json 扩展名进行加载
④ 补全 .node 扩展名进行加载
⑤ 加载失败,终端报错
- 第三方模块的加载机制
如果传递给 require() 的模块标识符不是一个内置模块,也没有以 ‘./’ 或 ‘…/’ 开头,则 Node.js 会从当前模块的父目录开始,尝试从 /node_modules 文件夹中加载第三方模块。如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。
例如,假设在 ‘C:\Users\itheima\project\foo.js’ 文件里调用了 require(‘tools’),则 Node.js 会按以下顺序查找:
① C:\Users\itheima\project\node_modules\tools
② C:\Users\itheima\node_modules\tools
③ C:\Users\node_modules\tools
④ C:\node_modules\tools
- 目录作为模块
当把目录作为模块标识符,传递给 require() 进行加载的时候,有三种加载方式:
① 在被加载的目录下查找一个叫做 package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
② 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件。
③ 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannot find module ‘xxx’