NodeJS简易博客系统（五）NodeJS入门学习（上）

你的名字 2022-05-04 08:58 212阅读 0赞

# 一、模块 #

在NodeJS中，一般将代码合理拆分到不同的JS文件中，每一个文件就是一个模块，而文件路径就是模块名。在编写每个模块时，都有`require`、`exports`、`module`三个预先定义好的变量可供使用。

## 1、require ##

`require`函数用于在当前模块中加载和使用别的模块，传入一个模块名，返回一个模块导出对象。模块名可使用相对路径（以`./`开头），或者是绝对路径（以`/`或`C:`之类的盘符开头）。

## 2、exports ##

`exports`对象是当前模块的导出对象，用于导出模块公有方法和属性。别的模块通过`require`函数使用当前模块时得到的就是当前模块的`exports`对象。

## 3、module ##

通过`module`对象可以访问到当前模块的一些相关信息，但最多的用途是替换当前模块的导出对象。

## 4、模块初始化 ##

一个模块中的JS代码仅在模块第一次被使用时执行一次，并在执行过程中初始化模块的导出对象。之后，缓存起来的导出对象被重复利用。

## 5、主模块 ##

通过命令行参数传递给NodeJS以启动程序的模块被称为主模块。主模块负责调度组成整个程序的其它模块完成工作。例如通过以下命令启动程序时，`main.js`就是主模块。

## 完整例子 ##

有以下目录：

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td>- /home/user/hello/ &nbsp; &nbsp; - util/ &nbsp; &nbsp; &nbsp; &nbsp; counter.js &nbsp; &nbsp; main.js</td> 
 </tr> 
 </tbody> 
</table>

其中`counter.js`内容如下：

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> var i = 0; function count() { &nbsp; &nbsp; return ++i; } exports.count = count; </td> 
 </tr> 
 </tbody> 
</table>

该模块内部定义了一个私有变量i，并在exports对象导出了一个公有方法count。

主模块`main.js`内容如下：

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> var counter1 = require('./util/counter'); var &nbsp; &nbsp;counter2 = require('./util/counter'); console.log(counter1.count()); console.log(counter2.count()); console.log(counter2.count()); </td> 
 </tr> 
 </tbody> 
</table>

运行结果：

# 二、文件操作 #

## 1、文件拷贝小例子 ##

*  ### 小文件拷贝（同步，一次性读取到内存） ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> var fs = require('fs'); function copy(src, dst) { &nbsp; &nbsp; fs.writeFileSync(dst, fs.readFileSync(src)); } function main(argv) { &nbsp; &nbsp; copy(argv[0], argv[1]); } main(process.argv.slice(2)); </td> 
 </tr> 
 </tbody> 
</table>

*  ### 大文件拷贝（流） ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> var fs = require('fs'); function copy(src, dst) { &nbsp; &nbsp; fs.createReadStream(src).pipe(fs.createWriteStream(dst)); } function main(argv) { &nbsp; &nbsp; copy(argv[0], argv[1]); } main(process.argv.slice(2)); </td> 
 </tr> 
 </tbody> 
</table>

## 2、常用 ##

*  ### Buffer（数据块） ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> var bin = new Buffer([ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]); Buffer与字符串类似，除了可以用.length属性得到字节长度外，还可以用[index]方式读取指定位置的字节，例如： bin[0]; // =&gt; 0x68; Buffer与字符串能够互相转化，例如可以使用指定编码将二进制数据转化为字符串： var str = bin.toString('utf-8'); // =&gt; "hello" 或者反过来，将字符串转换为指定编码下的二进制数据： var bin = new Buffer('hello', 'utf-8'); // =&gt; &lt;Buffer 68 65 6c 6c 6f&gt; Buffer与字符串有一个重要区别。字符串是只读的，并且对字符串的任何修改得到的都是一个新字符串，原字符串保持不变。至于Buffer，更像是可以做指针操作的C语言数组。例如，可以用[index]方式直接修改某个位置的字节。 bin[0] = 0x48; 而.slice方法也不是返回一个新的Buffer，而更像是返回了指向原Buffer中间的某个位置的指针，如下所示。 [ 0x68, 0x65, 0x6c, 0x6c, 0x6f ] &nbsp; &nbsp; ^ &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ^ &nbsp; &nbsp; | &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | &nbsp; &nbsp;bin &nbsp; &nbsp; bin.slice(2) 因此对.slice方法返回的Buffer的修改会作用于原Buffer，例如： var bin = new Buffer([ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]); var sub = bin.slice(2); sub[0] = 0x65; console.log(bin); // =&gt; &lt;Buffer 68 65 65 6c 6f&gt; 也因此，如果想要拷贝一份Buffer，得首先创建一个新的Buffer，并通过.copy方法把原Buffer中的数据复制过去。这个类似于申请一块新的内存，并把已有内存中的数据复制过去。以下是一个例子。 var bin = new Buffer([ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]); var dup = new Buffer(bin.length); bin.copy(dup); dup[0] = 0x48; console.log(bin); // =&gt; &lt;Buffer 68 65 6c 6c 6f&gt; console.log(dup); // =&gt; &lt;Buffer 48 65 65 6c 6f&gt; 总之，Buffer将JS的数据处理能力从字符串扩展到了任意二进制数据。 </td> 
 </tr> 
 </tbody> 
</table>

*  ### Stream（数据流） ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> 当内存中无法一次装下需要处理的数据时，或者一边读取一边处理更加高效时，我们就需要用到数据流。NodeJS中通过各种Stream来提供对数据流的操作。 以上边的大文件拷贝程序为例，我们可以为数据来源创建一个只读数据流，示例如下： var rs = fs.createReadStream(pathname); rs.on('data', function (chunk) { &nbsp; &nbsp; doSomething(chunk); }); rs.on('end', function () { &nbsp; &nbsp; cleanUp(); }); 注意： Stream基于事件机制工作，所有Stream的实例都继承于NodeJS提供的EventEmitter。 上边的代码中data事件会源源不断地被触发，不管doSomething函数是否处理得过来。代码可以继续做如下改造，以解决这个问题。 var rs = fs.createReadStream(src); rs.on('data', function (chunk) { &nbsp; &nbsp; rs.pause(); &nbsp; &nbsp; doSomething(chunk, function () { &nbsp; &nbsp; &nbsp; &nbsp; rs.resume(); &nbsp; &nbsp; }); }); rs.on('end', function () { &nbsp; &nbsp; cleanUp(); }); 以上代码给doSomething函数加上了回调，因此我们可以在处理数据前暂停数据读取，并在处理数据后继续读取数据。 此外，我们也可以为数据目标创建一个只写数据流，示例如下： var rs = fs.createReadStream(src); var ws = fs.createWriteStream(dst); rs.on('data', function (chunk) { &nbsp; &nbsp; ws.write(chunk); }); rs.on('end', function () { &nbsp; &nbsp; ws.end(); }); 我们把doSomething换成了往只写数据流里写入数据后，以上代码看起来就像是一个文件拷贝程序了。但是以上代码存在上边提到的问题，如果写入速度跟不上读取速度的话，只写数据流内部的缓存会爆仓。我们可以根据.write方法的返回值来判断传入的数据是写入目标了，还是临时放在了缓存了，并根据drain事件来判断什么时候只写数据流已经将缓存中的数据写入目标，可以传入下一个待写数据了。因此代码可以改造如下： var rs = fs.createReadStream(src); var ws = fs.createWriteStream(dst); rs.on('data', function (chunk) { &nbsp; &nbsp; if (ws.write(chunk) === false) { &nbsp; &nbsp; &nbsp; &nbsp; rs.pause(); &nbsp; &nbsp; } }); rs.on('end', function () { &nbsp; &nbsp; ws.end(); }); ws.on('drain', function () { &nbsp; &nbsp; rs.resume(); }); 以上代码实现了数据从只读数据流到只写数据流的搬运，并包括了防爆仓控制。因为这种使用场景很多，例如上边的大文件拷贝程序，NodeJS直接提供了.pipe方法来做这件事情，其内部实现方式与上边的代码类似。 </td> 
 </tr> 
 </tbody> 
</table>

*  ### File System（文件系统） ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> NodeJS通过fs内置模块提供对文件的操作。fs模块提供的API基本上可以分为以下三类： 文件属性读写。 其中常用的有fs.stat、fs.chmod、fs.chown等等。 文件内容读写。 其中常用的有fs.readFile、fs.readdir、fs.writeFile、fs.mkdir等等。 底层文件操作。 其中常用的有fs.open、fs.read、fs.write、fs.close等等。 NodeJS最精华的异步IO模型在fs模块里有着充分的体现，例如上边提到的这些API都通过回调函数传递结果。以fs.readFile为例： fs.readFile(pathname, function (err, data) { &nbsp; &nbsp; if (err) { &nbsp; &nbsp; &nbsp; &nbsp; // Deal with error. &nbsp; &nbsp; } else { &nbsp; &nbsp; &nbsp; &nbsp; // Deal with data. &nbsp; &nbsp; } }); 如上边代码所示，基本上所有fs模块API的回调参数都有两个。第一个参数在有错误发生时等于异常对象，第二个参数始终用于返回API方法执行结果。 此外，fs模块的所有异步API都有对应的同步版本，用于无法使用异步操作时，或者同步操作更方便时的情况。同步API除了方法名的末尾多了一个Sync之外，异常对象与执行结果的传递方式也有相应变化。同样以fs.readFileSync为例： try { &nbsp; &nbsp; var data = fs.readFileSync(pathname); &nbsp; &nbsp; // Deal with data. } catch (err) { &nbsp; &nbsp; // Deal with error. } </td> 
 </tr> 
 </tbody> 
</table>

## 3、遍历目录 ##

*  ### 同步遍历 ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> function travel(dir, callback) { &nbsp; &nbsp; fs.readdirSync(dir).forEach(function (file) { &nbsp; &nbsp; &nbsp; &nbsp; var pathname = path.join(dir, file); &nbsp; &nbsp; &nbsp; &nbsp; if (fs.statSync(pathname).isDirectory()) { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; travel(pathname, callback); &nbsp; &nbsp; &nbsp; &nbsp; } else { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; callback(pathname); &nbsp; &nbsp; &nbsp; &nbsp; } &nbsp; &nbsp; }); } 可以看到，该函数以某个目录作为遍历的起点。遇到一个子目录时，就先接着遍历子目录。遇到一个文件时，就把文件的绝对路径传给回调函数。回调函数拿到文件路径后，就可以做各种判断和处理。因此假设有以下目录： - /home/user/ &nbsp; &nbsp; - foo/ &nbsp; &nbsp; &nbsp; &nbsp; x.js &nbsp; &nbsp; - bar/ &nbsp; &nbsp; &nbsp; &nbsp; y.js &nbsp; &nbsp; z.css 使用以下代码遍历该目录时，得到的输入如下： travel('/home/user', function (pathname) { &nbsp; &nbsp; console.log(pathname); }); ------------------------ /home/user/foo/x.js /home/user/bar/y.js /home/user/z.css </td> 
 </tr> 
 </tbody> 
</table>

*  ### 异步遍历 ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> function travel(dir, callback, finish) { &nbsp; &nbsp; fs.readdir(dir, function (err, files) { &nbsp; &nbsp; &nbsp; &nbsp; (function next(i) { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (i &lt; files.length) { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; var pathname = path.join(dir, files[i]); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; fs.stat(pathname, function (err, stats) { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (stats.isDirectory()) { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; travel(pathname, callback, function () { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; next(i + 1); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; } else { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; callback(pathname, function () { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; next(i + 1); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; } &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; } else { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; finish &amp;&amp; finish(); &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; } &nbsp; &nbsp; &nbsp; &nbsp; }(0)); &nbsp; &nbsp; }); } </td> 
 </tr> 
 </tbody> 
</table>

## 4、文本编码 ##

*  ### BOM的移除 ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> BOM用于标记一个文本文件使用Unicode编码，其本身是一个Unicode字符（"\uFEFF"），位于文本文件头部。在不同的Unicode编码下，BOM字符对应的二进制字节如下： &nbsp; &nbsp; Bytes &nbsp; &nbsp; &nbsp;Encoding ---------------------------- &nbsp; &nbsp; FE FF &nbsp; &nbsp; &nbsp; UTF16BE &nbsp; &nbsp; FF FE &nbsp; &nbsp; &nbsp; UTF16LE &nbsp; &nbsp; EF BB BF &nbsp; &nbsp;UTF8 因此，我们可以根据文本文件头几个字节等于啥来判断文件是否包含BOM，以及使用哪种Unicode编码。但是，BOM字符虽然起到了标记文件编码的作用，其本身却不属于文件内容的一部分，如果读取文本文件时不去掉BOM，在某些使用场景下就会有问题。例如我们把几个JS文件合并成一个文件后，如果文件中间含有BOM字符，就会导致浏览器JS语法错误。因此，使用NodeJS读取文本文件时，一般需要去掉BOM。例如，以下代码实现了识别和去除UTF8 BOM的功能。 function readText(pathname) { &nbsp; &nbsp; var bin = fs.readFileSync(pathname); &nbsp; &nbsp; if (bin[0] === 0xEF &amp;&amp; bin[1] === 0xBB &amp;&amp; bin[2] === 0xBF) { &nbsp; &nbsp; &nbsp; &nbsp; bin = bin.slice(3); &nbsp; &nbsp; } &nbsp; &nbsp; return bin.toString('utf-8'); } </td> 
 </tr> 
 </tbody> 
</table>

*  ### GBK转UTF8 ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> NodeJS支持在读取文本文件时，或者在Buffer转换为字符串时指定文本编码，但遗憾的是，GBK编码不在NodeJS自身支持范围内。因此，一般我们借助iconv-lite这个三方包来转换编码。使用NPM下载该包后，我们可以按下边方式编写一个读取GBK文本文件的函数。 var iconv = require('iconv-lite'); function readGBKText(pathname) { &nbsp; &nbsp; var bin = fs.readFileSync(pathname); &nbsp; &nbsp; return iconv.decode(bin, 'gbk'); } </td> 
 </tr> 
 </tbody> 
</table>

*  ### 单字节编码 ###

<table style="width:500px;"> 
 <tbody> 
 <tr> 
 <td> 有时候，我们无法预知需要读取的文件采用哪种编码，因此也就无法指定正确的编码。比如我们要处理的某些CSS文件中，有的用GBK编码，有的用UTF8编码。虽然可以一定程度可以根据文件的字节内容猜测出文本编码，但这里要介绍的是有些局限，但是要简单得多的一种技术。 首先我们知道，如果一个文本文件只包含英文字符，比如Hello World，那无论用GBK编码或是UTF8编码读取这个文件都是没问题的。这是因为在这些编码下，ASCII0~128范围内字符都使用相同的单字节编码。 反过来讲，即使一个文本文件中有中文等字符，如果我们需要处理的字符仅在ASCII0~128范围内，比如除了注释和字符串以外的JS代码，我们就可以统一使用单字节编码来读取文件，不用关心文件的实际编码是GBK还是UTF8。以下示例说明了这种方法。 1. GBK编码源文件内容： &nbsp; &nbsp; var foo = '中文'; 2. 对应字节： &nbsp; &nbsp; 76 61 72 20 66 6F 6F 20 3D 20 27 D6 D0 CE C4 27 3B 3. 使用单字节编码读取后得到的内容： &nbsp; &nbsp; var foo = '{乱码}{乱码}{乱码}{乱码}'; 4. 替换内容： &nbsp; &nbsp; var bar = '{乱码}{乱码}{乱码}{乱码}'; 5. 使用单字节编码保存后对应字节： &nbsp; &nbsp; 76 61 72 20 62 61 72 20 3D 20 27 D6 D0 CE C4 27 3B 6. 使用GBK编码读取后得到内容： &nbsp; &nbsp; var bar = '中文'; 这里的诀窍在于，不管大于0xEF的单个字节在单字节编码下被解析成什么乱码字符，使用同样的单字节编码保存这些乱码字符时，背后对应的字节保持不变。 NodeJS中自带了一种binary编码可以用来实现这个方法，因此在下例中，我们使用这种编码来演示上例对应的代码该怎么写。 function replace(pathname) { &nbsp; &nbsp; var str = fs.readFileSync(pathname, 'binary'); &nbsp; &nbsp; str = str.replace('foo', 'bar'); &nbsp; &nbsp; fs.writeFileSync(pathname, str, 'binary'); } </td> 
 </tr> 
 </tbody> 
</table>