1.nodejs基础学习笔记

1.nodejs基础学习笔记

nodejs中文文档

一、fs 模块文件读写操作

//  导入 fs 模块，填node:fs 或 fs 都可以
const fs = require('node:fs');

// fs.readFile(path[, options], callback) ：options可选参数，encoding默认utf8
fs.readFile('./files/1.info.txt','utf8', (err,dataStr)=>{
    if (err){
        // 失败时 err为错误对象，成功为null
        return console.log(err);
    }
    console.log(dataStr);
})

fs.writeFile('./files/1.info.txt','需要写入的内容通过data参数传入','utf8',(err)=>{
    if (err){
        // 写入失败时 err为错误对象，成功为null
        return console.log(err);
    }
    console.log('写入成功');
})

• __dirname 来替代 ./ 和 …/ 相对路径

因为在cmd执行 nodejs文件时，./ 和…/ 得到的路径是执行命令所在的路径而不是js文件所在的路径

• 使用path 模块处理路径,<string>path.join([...paths])将所有给定的path 片段连接在一起，然后规范化生成的路径
  • 零长度的 path 片段被忽略，如果连接的路径字符串是零长度字符串，则将返回 ‘.’，表示当前工作目录。
  • 任何路径片段不是字符串，则抛出 TypeError。
  • ‘…’ 和 ‘…/’ 代表舍弃上一段路径

path.join('/foo', 'bar', 'baz/asdf', 'quux', '..'，'adc');
// 返回: '/foo/bar/baz/asdf/adc'

path.join('foo', {}, 'bar');
// 抛出 'TypeError: Path must be a string. Received {}'

const fs = require('node:fs');
const path = require('path')

const p = path.join(__dirname,'./files/1.info.txt')
console.log('全路径:'+p);
console.log( 'dirname:' + path.dirname('./files/1.info.txt'));
console.log('extname:' + path.extname(p));
console.log('parse:' + JSON.stringify(path.parse(p)));
console.log('delimiter:'+p.split(path.delimiter))

// 打印
全路径:/Users/liuyunfei/Documents/HFiveStudy/02.node基础/js/files/1.info.txt
dirname:./files
extname:.txt
parse:{"root":"/","dir":"/Users/liuyunfei/Documents/HFiveStudy/02.node基础/js/files","base":"1.info.txt","ext":".txt","name":"1.info"}
delimiter:/Users/liuyunfei/Documents/HFiveStudy/02.node基础/js/files/1.info.txt

// 使用path.join 和 __dirname 拼接文件路径
fs.readFile(path.join(__dirname,'./files/1.info.txt'),'utf8', (err,dataStr)=>{
    if (err){
        // 失败时 err为错误对象，成功为null
        return console.log(err.message);
    }
    console.log(dataStr);
})

1.2 fs其他操作

验证路径是否存在：

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

获取文件信息：

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

删除文件：

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

列出文件：

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

截断文件：

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

建立目录：

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

删除目录：

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

重命名文件和目录：

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

监视文件更改：

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

1.3 path模块

---

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

路径拼接

path.join()

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

path.basename(path[, ext])

• path: 文件路径
• 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()

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

二、http 模块

在网络节点中，负责消费资源的电脑，叫做客户端;负责对外提供网络资源的电脑，叫做服务器。
http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。

2.1 创建基本 Web 服务器

const http = require('http')

// 创建 web 服务器实例
const server = http.createServer()

// 为服务器实例绑定 request 事件，监听客户端的请求
server.on('request', function (req, res) {
  const url = req.url
  const method = req.method
  const str = `Your request url is ${url}, and request method is ${method}`
  console.log(str)

  // 设置 Content-Type 响应头，解决中文乱码的问题
  res.setHeader('Content-Type', 'text/html; charset=utf-8')
  // 向客户端响应内容
  res.end(str)
})

server.listen(8080, function () {
  console.log('server running at http://127.0.0.1:8080')
})

2.2 实现简陋路由效果

const fs = require('fs')
const path = require('path')
const http = require('http')

const server = http.createServer()

server.on('request', (req, res) => {
  const url = req.url
  // 设置默认的响应内容为 404 Not found
  let content = '<h1>404 Not found!</h1>'
  // 判断用户请求的是否为 / 或 /index.html 首页
  // 判断用户请求的是否为 /about.html 关于页面
  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')
})

三、模块化

3.1 模块化概念

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

3.2 Node.js 中模块的分类

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

// 1.加载内置模块
const fs = require('fs')
// 2.加载用户自定义的模块
const cutsom = require('./custom.js')
// 3.加载第三方模块（需要先下载）
const moment = require('moment')

3.3 Node.js 中的模块作用域

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

3.4 模块作用域的成员

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

3.5 CommonJS 模块化规范

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

3.6 模块加载机制

1. 注意:使用 require() 方法加载其它模块时，会执行被加载模块中的代码。
2. 优先从缓存中加载 ,模块第一次加载后会被缓存，即多次调用 require() 不会导致模块的代码被执行多次，提高模块加载效率。
3. 内置模块加载优先级最高。
4. 加载自定义模块时，路径要以 ./ 或 …/ 开头，否则会作为内置模块或第三方模块加载。

例如，require(‘fs’) 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs。

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

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

第三方模块的加载

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

例如，假设在 C:\Users\bruce\project\foo.js 文件里调用了 require('tools')，则 Node.js 会按以下顺序查找：
C:\Users\bruce\project\node_modules\tools
C:\Users\bruce\node_modules\tools
C:\Users\node_modules\tools
C:\node_modules\tools

3.7 目录作为模块加载

把目录作为模块标识符进行加载的时候，有三种加载方式：

① 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
② 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的index.js 文件。
③ 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失:Error: Cannot find module ‘xxx’

四、npm与包

4.1 解决下包速度慢的问题

• 切换npm的下包镜像源
  下包的镜像源，指的就是下包的服务器地址。

# 查看当前下包镜像源
npm config get registry
默认： https://registry.npmjs.org/
# 将下包的镜像源切换为淘宝的镜像源
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

4.2 包的分类

使用 npm 包管理工具下载的包，共分为两大类，分别是：

• 项目包
• 全局包

项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包。
项目包又分为两类，分别是:
⚫ 开发依赖包(被记录到 devDependencies 节点中的包，只在开发期间会用到)
⚫ 核心依赖包(被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到)

npm i 包名 -D # 开发依赖包(会被记录到 devDependencies 节点下)
npm i 包名  # 核心依赖包(会被记录到 dependencies 节点下)

全局包

在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包。

npm i 包名 -g # 全局安装指定的包
npm uninstall 包名 -g # 卸载全局安装的包
npm root -g # 查询全局包安装的路径
# 修改全局包安装路径
npm config set prefix "E:/Developer/nodejs/npm_global"
# 修改全局包缓存路径
npm config set cache "E:/Developer/nodejs/npm_cache"

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

栗子：i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具，使用步骤如下:

npm install i5ting_toc -g
# 调用i5ting_toc，轻松实现md 转html的功能
i5ting_toc -f 要转换的md文件路径 -o

4.3 规范的包结构

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

注意:以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址:
https://yarnpkg.com/zh-Hans/docs/package-json

关于如何制作npm 包请参考规范尝试；

4.4 发布包

• 登录 npm 账号

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

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

现在也可能是这样的，直接走网页验证

• 把包发布到 npm 上

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

• 删除已发布的包

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

① npm unpublish 命令只能删除 72 小时以内发布的包
② npm unpublish 删除的包，在 24 小时内不允许重复发布
③ 发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包!