Nodejs 基础

官网传送门

初识 Nodejs

Node.js® is a Javascript runtime built on Chrome’s V8 Javascript engine

Node.js® 是一个基于 Chrome V8 引擎 的 Javascript 运行时环境

• 基于 Express 框架&＃xff0c;可以快速构建 Web 应用
• 基于 Electron 框架&＃xff0c;可以构建跨平台的桌面应用
• 基于 restify 框架&＃xff0c;可以快速构建 API 接口项目
• 读写和操作数据库、创建实用的命令行工具辅助前端开发、etc…

Buffer 缓冲区

Buffer 缓冲区文档

• Buffer 的结构与数组类似&＃xff0c;操作方法也与数组类似
• 数组不能存储二进制文件&＃xff0c;Buffer 是专门存储二进制数据的
• Buffer 存储的是二进制数据&＃xff0c;显示时以 16 进制的形式显示
• Buffer 每一个元素范围是 00~ff&＃xff0c;即 0_{255、00000000}11111111
• 每一个元素占用一个字节内存
• Buffer 是对底层内存的直接操作&＃xff0c;因此大小一旦确定就不能修改

Buffer 常用方法&＃xff1a;

• Buffer.from(str[, encoding])&＃xff1a;将一个字符串转换为 Buffer
• Buffer.alloc(size)&＃xff1a;创建指定大小的 Buffer
• Buffer.alloUnsafe(size)&＃xff1a;创建指定大小的 Buffer&＃xff0c;可能包含敏感数据&＃xff08;分配内存时不会清除内存残留的数据&＃xff09;
• buf.toString()&＃xff1a;将 Buffer 数据转为字符串

var str &＃61; &＃39;Hello前端&＃39;var buf &＃61; Buffer.from(str)// 占用内存的大小&＃xff0c;一个汉字3字节 13
console.log(buf.length)
// 字符串的长度 7
console.log(str.length)
// 8进制输出第一个元素 145
console.log(buf[1].toString(8))//创建一个10个字节的buffer
var buf2 &＃61; Buffer.alloc(10)
//通过索引&＃xff0c;来操作buf中的元素
buf2[0] &＃61; 88
buf2[1] &＃61; 255
buf2[2] &＃61; 0xaa
buf2[3] &＃61; 255var buf3 &＃61; Buffer.allocUnsafe(10)
console.log(buf3)


fs 文件系统模块

• fs 模块中所有的操作都有两种形式可供选择:同步和异步
• 同步文件系统会阻塞程序的执行&＃xff0c;也就是除非操作完毕&＃xff0c;否则不会向下执行代码
• 异步文件系统不会阻塞程序的执行&＃xff0c;而是在操作完成时&＃xff0c;通过回调函数将结果返回
• 实际开发很少用同步方式&＃xff0c;因此只介绍异步方式

打开模式&＃xff1a;

读取文件

简单文件读取

语法格式&＃xff1a;

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


• path&＃xff1a;文件路径
• options&＃xff1a;配置选项&＃xff0c;若是字符串则指定编码格式
  • encoding&＃xff1a;编码格式
  • flag&＃xff1a;打开方式
• callback&＃xff1a;回调函数
  • err&＃xff1a;错误信息
  • data&＃xff1a;读取的数据&＃xff0c;如果未指定编码格式则返回一个 Buffer

const fs &＃61; require(&＃39;fs&＃39;)fs.readFile(&＃39;./files/1.txt&＃39;, &＃39;utf-8&＃39;, function(err, data) &＃61;> {if(err) {return console.log(&＃39;failed!&＃39; &＃43; err.message)}console.log(&＃39;content:&＃39; &＃43; data)
})// 复制文件内容
fs.readFile("C:/Users/笔记.mp3", function(err, data) {if(!err) {console.log(data);// 将data写入到文件中fs.writeFile("C:/Users/hello.jpg", data, function(err){if(!err){console.log("文件写入成功");}} );}
});


流式文件读取

• 简单文件读取的方式会一次性读取文件内容到内存中&＃xff0c;若文件较大&＃xff0c;会占用过多内存影响系统性能&＃xff0c;且读取速度慢
• 大文件适合用流式文件读取&＃xff0c;它会分多次将文件读取到内存中

var fs &＃61; require(&＃39;fs&＃39;)// 创建一个可读流
var rs &＃61; fs.createReadStream(&＃39;C:/Users/笔记.mp3&＃39;)
// 创建一个可写流
var ws &＃61; fs.createWriteStream(&＃39;a.mp3&＃39;)// 监听流的开启和关闭
// 这几个监听不是必须的
rs.once(&＃39;open&＃39;, function () {console.log(&＃39;可读流打开了~~&＃39;)
})rs.once(&＃39;close&＃39;, function () {console.log(&＃39;可读流关闭了~~&＃39;)//数据读取完毕&＃xff0c;关闭可写流ws.end()
})ws.once(&＃39;open&＃39;, function () {console.log(&＃39;可写流打开了~~&＃39;)
})ws.once(&＃39;close&＃39;, function () {console.log(&＃39;可写流关闭了~~&＃39;)
})//要读取一个可读流中的数据&＃xff0c;要为可读流绑定一个data事件&＃xff0c;data事件绑定完毕自动开始读取数据
rs.on(&＃39;data&＃39;, function (data) {console.log(data)//将读取到的数据写入到可写流中ws.write(data)
})


简便方式&＃xff1a;

var fs &＃61; require(&＃39;fs&＃39;)var rs &＃61; fs.createReadStream(&＃39;C:/Users/lilichao/Desktop/笔记.mp3&＃39;)
var ws &＃61; fs.createWriteStream(&＃39;b.mp3&＃39;)// pipe()可以将可读流中的内容&＃xff0c;直接输出到可写流中
rs.pipe(ws)


写入文件

简单文件写入

语法格式&＃xff1a;

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


• file&＃xff1a;文件路径
• data&＃xff1a;写入内容
• options&＃xff1a;配置选项&＃xff0c;包含 encoding, mode, flag&＃xff1b;若是字符串则指定编码格式
• callback&＃xff1a;回调函数

const fs &＃61; require(&＃39;fs&＃39;)
fs.writeFile(&＃39;./files/2.txt&＃39;, &＃39;Hello Nodejs&＃39;, function (err) {if (err) {return console.log(&＃39;failed!&＃39; &＃43; err.message)}console.log(&＃39;success!&＃39;)
})fs.writeFile(&＃39;C:/Users/hello.txt&＃39;, &＃39;通过 writeFile 写入的内容&＃39;, { flag: &＃39;w&＃39; }, function (err) {if (!err) {console.log(&＃39;写入成功&＃xff01;&＃39;)} else {console.log(err)}
})


流式文件写入

// 同步、异步、简单文件的写入都不适合大文件的写入&＃xff0c;性能较差&＃xff0c;容易导致内存溢出
var fs &＃61; require(&＃39;fs&＃39;)// 创建一个可写流
var ws &＃61; fs.createWriteStream(&＃39;hello3.txt&＃39;)ws.once(&＃39;open&＃39;, function () {console.log(&＃39;流打开了~~&＃39;)
})ws.once(&＃39;close&＃39;, function () {console.log(&＃39;流关闭了~~&＃39;)
})// 通过ws向文件中输出内容
ws.write(&＃39;通过可写流写入文件的内容&＃39;)
ws.write(&＃39;1&＃39;)
ws.write(&＃39;2&＃39;)
ws.write(&＃39;3&＃39;)
ws.write(&＃39;4&＃39;)// 关闭流
ws.end()


路径动态拼接问题 __dirname

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

fs.readFile(__dirname &＃43; &＃39;/files/1.txt&＃39;, &＃39;utf8&＃39;, function(err, data) {...
})


其它操作

验证路径是否存在&＃xff1a;

• fs.exists(path, callback)
• fs.existsSync(path)

获取文件信息&＃xff1a;

• fs.stat(path, callback)
• fs.stat(path)

删除文件&＃xff1a;

• fs.unlink(path, callback)
• fs.unlinkSync(path)

列出文件&＃xff1a;

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

截断文件&＃xff1a;

• fs.truncate(path, len, callback)
• fs.truncateSync(path, len)

建立目录&＃xff1a;

• fs.mkdir(path[, mode], callback)
• fs.mkdirSync(path[, mode])

删除目录&＃xff1a;

• fs.rmdir(path, callback)
• fs.rmdirSync(path)

重命名文件和目录&＃xff1a;

• fs.rename(oldPath, newPath, callback)
• fs.renameSync(oldPath, newPath)

监视文件更改&＃xff1a;

• fs.watchFile(filename[, options], listener)

path 路径模块

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

路径拼接 path.join()

const path &＃61; require(&＃39;path&＃39;)
const fs &＃61; require(&＃39;fs&＃39;)// 注意 ../ 会抵消前面的路径
// ./ 会被忽略
const pathStr &＃61; path.join(&＃39;/a&＃39;, &＃39;/b/c&＃39;, &＃39;../../&＃39;, &＃39;./d&＃39;, &＃39;e&＃39;)
console.log(pathStr) // \a\d\efs.readFile(path.join(__dirname, &＃39;./files/1.txt&＃39;), &＃39;utf8&＃39;, function (err, dataStr) {if (err) {return console.log(err.message)}console.log(dataStr)
})


获取路径中文件名 path.basename()

使用 path.basename() 方法&＃xff0c;可以获取路径中的最后一部分&＃xff0c;常通过该方法获取路径中的文件名

path.basename(path[, ext])


• path: 文件路径
• ext: 文件扩展名

const path &＃61; require(&＃39;path&＃39;)// 定义文件的存放路径
const fpath &＃61; &＃39;/a/b/c/index.html&＃39;const fullName &＃61; path.basename(fpath)
console.log(fullName) // index.htmlconst nameWithoutExt &＃61; path.basename(fpath, &＃39;.html&＃39;)
console.log(nameWithoutExt) // index


获取路径中文件扩展名 path.extname()

const path &＃61; require(&＃39;path&＃39;)const fpath &＃61; &＃39;/a/b/c/index.html&＃39;const fext &＃61; path.extname(fpath)
console.log(fext) // .html


http 模块

http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。

创建基本 Web 服务器

const http &＃61; require(&＃39;http&＃39;)// 创建 web 服务器实例
const server &＃61; http.createServer()// 为服务器实例绑定 request 事件&＃xff0c;监听客户端的请求
server.on(&＃39;request&＃39;, function (req, res) {const url &＃61; req.urlconst method &＃61; req.methodconst str &＃61; &＃96;Your request url is ${url}, and request method is ${method}&＃96;console.log(str)// 设置 Content-Type 响应头&＃xff0c;解决中文乱码的问题res.setHeader(&＃39;Content-Type&＃39;, &＃39;text/html; charset&＃61;utf-8&＃39;)// 向客户端响应内容res.end(str)
})server.listen(8080, function () {console.log(&＃39;server running at http://127.0.0.1:8080&＃39;)
})


实现简陋路由效果

const http &＃61; require(&＃39;http&＃39;)
const server &＃61; http.createServer()server.on(&＃39;request&＃39;, (req, res) &＃61;> {const url &＃61; req.url// 设置默认的响应内容为 404 Not foundlet content &＃61; &＃39;

404 Not found!

模块化

模块化概念

• 模块化是指解决一个复杂问题时&＃xff0c;自顶向下逐层把系统划分为若干模块的过程&＃xff0c;模块是可组合、分解和更换的单元。
• 模块化可提高代码的复用性和可维护性&＃xff0c;实现按需加载。
• 模块化规范是对代码进行模块化拆分和组合时需要遵守的规则&＃xff0c;如使用何种语法格式引用模块和向外暴露成员。

Node.js 中模块的分类

• 内置模块
• 自定义模块
• 第三方模块

Node.js 中的模块作用域

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

模块作用域的成员

• 自定义模块中都有一个 module 对象&＃xff0c;存储了和当前模块有关的信息
• 在自定义模块中&＃xff0c;可以使用 module.exports 对象&＃xff0c;将模块内的成员共享出去&＃xff0c;供外界使用。导入自定义模块时&＃xff0c;得到的就是 module.exports 指向的对象。
• 默认情况下&＃xff0c;exports 和 module.exports 指向同一个对象。最终共享的结果&＃xff0c;以 module.exports 指向的对象为准。

CommonJS 模块化规范

• 每个模块内部&＃xff0c;module 变量代表当前模块
• module 变量是一个对象&＃xff0c;module.exports 是对外的接口
• 加载某个模块即加载该模块的 module.exports 属性

模块加载机制

模块第一次加载后会被缓存&＃xff0c;即多次调用 require() 不会导致模块的代码被执行多次&＃xff0c;提高模块加载效率。

内置模块加载

内置模块加载优先级最高。

自定义模块加载

加载自定义模块时&＃xff0c;路径要以 ./ 或 ../ 开头&＃xff0c;否则会作为内置模块或第三方模块加载。

导入自定义模块时&＃xff0c;若省略文件扩展名&＃xff0c;则 Node.js 会按顺序尝试加载文件&＃xff1a;

• 按确切的文件名加载
• 补全 .js 扩展名加载
• 补全 .json 扩展名加载
• 补全 .node 扩展名加载
• 报错

第三方模块加载

• 若导入第三方模块&＃xff0c; Node.js 会从当前模块的父目录开始&＃xff0c;尝试从 /node_modules 文件夹中加载第三方模块。
• 如果没有找到对应的第三方模块&＃xff0c;则移动到再上一层父目录中&＃xff0c;进行加载&＃xff0c;直到文件系统的根目录。

例如&＃xff0c;假设在 C:\Users\bruce\project\foo.js 文件里调用了 require(&＃39;tools&＃39;)&＃xff0c;则 Node.js 会按以下顺序查找&＃xff1a;

• C:\Users\bruce\project\node_modules\tools
• C:\Users\bruce\node_modules\tools
• C:\Users\node_modules\tools
• C:\node_modules\tools

目录作为模块加载

当把目录作为模块标识符进行加载的时候&＃xff0c;有三种加载方式&＃xff1a;

• 在被加载的目录下查找 package.json 的文件&＃xff0c;并寻找 main 属性&＃xff0c;作为 require() 加载的入口
• 如果没有 package.json 文件&＃xff0c;或者 main 入口不存在或无法解析&＃xff0c;则 Node.js 将会试图加载目录下的 index.js 文件。
• 若失败则报错