Node之文件流与文件路径操作
流的基本概念
用途 | 使用异步方式 | 使用同步方式1 |
---|---|---|
将文件完整写入缓存区 | readFile | readFileSync |
将文件部分读入缓存区 | read | readSync |
将数据完整写入文件 | writeFile | writeFileSync |
将缓存区中的部分内容写入文件 | write | writeSync |
在一个应用程序中,流是一组有序的、有起点和终点的字节数据的传输手段。在应用程序中各种对象之间交换与传输数据的时候,总是先将该对象中所包含的数据转换为各种形式的流数据(即字节数据),再通过流的传输,到达目的对象后再将流数据转换为该对象中可以使用的数据。
Node.js中的各种用于读取数据的对象
各种用于读取数据的对象将会触发的事件
各种用于读取数据的对象所拥有的方法
Node.js中的各种用于写入数据的对象
各种用于写入数据的对象将会触发的事件
各种用于写入数据的对象所拥有的方法
使用ReadStream对象读取文件
在fs模块中,可以使用createReadStream方法创建一个将文件内容读取为流数据的ReadStream对象
fs.createReadStream(path,[options])
- path:用于指定需要被读取的文件的完整路径及文件名。
options:
- flags:用于指定对该文件采取什么操作,默认值为'r',可指定属性值与readFile方法中所使用的options参数对象中所使用的flags属性的可指定属性值相同。
- encoding:用于指定使用什么编码格式来读取该文件,可指定属性值为“utf8”、“ascii”与“base64”。默认值为null。
- autoClose:用于指定是否关闭在读取文件时操作系统内部使用的文件描述符。如果属性值设定为false,则文件不会自动关闭,即使在读取文件过程中产生了错误,开发者也必须通过使用close方法或closeSync方法来手动关闭文件。如果属性值设定为true,当文件读取完毕或读取文件过程中产生错误时文件将自动关闭。autoClose属性的默认属性值为true。
- start:使用整数值来指定文件的开始读取位置(单位为字节数)。
- end:使用整数值来指定文件的结束读取位置(单位为字节数)。
示例:
var fs = require('fs');
var file = fs.createReadStream('./message.txt',{start:3,end:12});
file.on('open',function(fd) {
console.log('开始读取文件。');
});
file.on('data', function(data) {
console.log('读取到数据:');
console.log(data);
});
file.on('end', function(){
console.log('文件已全部读取完毕。');
});
file.on('close', function(){
console.log('文件被关闭。');
});
file.on('error', function(err) {
console.log('读取文件失败。');
});
使用WriteStream对象写入文件
在fs模块中,可以使用createWriteStream方法创建一个将流数据写入文件中的WriteStream对象
fs.createWriteStream(path,[options])
- path:数用于指定需要被写入的文件的完整路径及文件名。
options:
- options:用于指定对该文件采取什么操作,默认值为'w',可指定属性值与readFile方法中options参数对象的flags属性的可指定属性值相同。
- encoding:用于指定使用什么编码格式来读取该文件,可指定属性值为“utf8”、“ascii”与“base64”。默认值为null。
- start:使用整数值来指定文件的开始写入位置(单位为字节数)。如果要在文件中追加写入数据,需要将flags属性值设置为'a'。
WriteStream对象具有一个write方法,用于将流数据写入到目标对象中,该方法的使用方式如下所示(代码中的writable代表一个WriteStream对象)。
writable.write(chunk,[encoding],[callback])
- chunk:为一个Buffer对象或一个字符串,用于指定需要写入的数据,当参数值为Buffer对象时表示将Buffer对象中的数据写入目标对象,参数值为字符串时表示将字符串写入目标对象。
- encoding:编码方式
- callback:当数据被写入完毕时所要调用的回调函数,在该回调函数中不使用任何参数。
WriteStream对象具有一个end方法,在写入文件的场合中,当没有数据再被写入流中时可调用该方法关闭文件。这将迫使操作系统缓存区中的剩余数据被立即写入文件中。可以在该方法的回调函数中指定在文件被关闭之前所要执行的处理。该方法的使用方式如下所示(代码中的writable代表一个WriteStream对象)。
writable.end([chunk],[encoding],[callback])
- chunk:为一个Buffer对象或一个字符串,用于指定在文件关闭之前需要在文件中追加写入的数据,当参数值为Buffer对象时表示将Buffer对象中的数据追加写入目标对象,参数值为字符串时表示将字符串追加写入目标对象。
- encoding:编码
- callback:指定当数据被追加写入完毕时所要调用的回调函数,在该回调函数中不使用任何参数。
对路径进行操作
在Node.js中,提供了一个path模块,在这个模块中,提供了许多实用的、可被用来处理与转换路径的方法及属性。
normalize方法
该方法将非标准路径字符串转换为标准路径字符串,在转换过程中执行以下处理:
- 解析路径字符串中的“..”字符串与“.”字符串,返回解析后的标准路径。
- 将多个斜杠字符串转换为一个斜杠字符串,例如将“\”转换为“\”。
- 将Windows操作系统中的反斜杠字符串转换为正斜杠字符串。
如果路径字符串以斜杠字符串结尾,则在转换后的完整路径字符串末尾保留该斜杠字符串。
path.normalize(p)
join方法
该方法将多个参数值字符串结合为一个路径字符串,使用方式如下所示
path.join([path1], [path2], [...])
示例:
var fs=require('fs'); var path=require('path'); var myPath=path.join(__dirname,'a','b','c'); console.log(myPath); var file = fs.createReadStream(myPath+'/message.txt'); file.on('data', function(data) { console.log(data.toString()); });
resolve方法
path.resolve(path1, [path2], [...])
resolve方法的具体解析过程如下所示:
- 以应用程序根目录为起点,解析第一个参数值字符串。
- 如果该参数值字符串不以“..”、“.”或“/”开头,则将参数值字符串解析为应用程序根目录下的某个子目录,将当前参考目录定为该子目录的绝对路径。例如应用程序根目录为Windows操作系统的“d:\a\b”,第一个参数值字符串为“c”,则将当前参考目录定为“d:\a\b\c”。
- 如果该参数值字符串以“..”开头,则将“..”解析为应用程序根目录的上级目录,然后将“..”后的字符串解析为该目录下的某个子目录,将当前参考目录定为该子目录的绝对路径。例如应用程序根目录为Windows操作系统中的“d:\a\b”,第一个参数值字符串为“../c”,则将当前参考目录定为“d:\a\c”。
- 如果该参数值字符串以“..”开头,则将“..”解析为应用程序根目录的上级目录,然后将“..”后的字符串解析为该目录下的某个子目录,将当前参考目录定为该子目录的绝对路径。例如应用程序根目录为Windows操作系统中的“d:\a\b”,第一个参数值字符串为“../c”,则将当前参考目录定为“d:\a\c”。
- 如果该参数值字符串以“/”开头,表示指定了一个绝对路径,则将当前参考目录定为该绝对路径,例如应用程序根目录为Windows操作系统中的“d:\a\b”,第一个参数值字符串为“/c”,则将当前参考目录定为“d:\c”。
- 如果没有下一个参数值字符串,则resolve方法返回当前参考目录的绝对路径。
- 如果存在下一个参数值字符串,则以当前参考目录为起点,解析下一个参数值字符串。
- 如果下一个参数值字符串不以“..”、“.”或“/”开头,则将参数值字符串解析为当前参考目录下的某个子目录,将当前参考目录转变为该子目录的绝对路径。例如当前参考目录为Windows操作系统中的“d:\a\b\c”,下一个参数值字符串为“d”,则将当前参考目录转变为“d:\a\b\c\d”。
- 如果下一个参数值字符串不以“..”、“.”或“/”开头,则将参数值字符串解析为当前参考目录下的某个子目录,将当前参考目录转变为该子目录的绝对路径。例如当前参考目录为Windows操作系统中的“d:\a\b\c”,下一个参数值字符串为“d”,则将当前参考目录转变为“d:\a\b\c\d”。
- 如果下一个参数值字符串以“.”开头,则将“.”解析为当前参考目录的当前目录,即当前参考目录,然后将“.”后的字符串解析为当前参考目录下的某个子目录,将当前参考目录转变为该子目录的绝对路径。例如当前参考目录为Windows操作系统中的“d:\a\b\c”,下一个参数值字符串为“./d”,则将当前参考目录转变为“d:\a\b\c\d”。
- 如果下一个参数值字符串以“/”开头,表示指定了一个绝对路径,则将当前参考目录转变为该绝对路径,例如当前参考目录为Windows操作系统中的“d:\c”,第一个参数值字符串为“/d”,则将当前参考目录转变为“d:\d”。
- 如果没有下一个参数值字符串,则resolve方法返回当前参考目录的绝对路径。
- 如果存在下一个参数值字符串,则继续执行步骤7~步骤13。
relative方法
该方法用于获取两个路径之间的相对关系
path.relative(from,to)
dirname方法
该方法用于获取一个路径中的目录名
path.dirname(p)
basename方法
basename方法用于获取一个路径中的文件名
path.basename(p,[ext])
- p:路径
- etx:去除扩展名
extname方法
extname方法用于获取一个路径中的扩展名
path.extname(p
path.sep属性
属性值为操作系统指定的文件分隔符,可能的属性值为“\”(在Windows操作系统中)或“/”(在UNIX操作系统中)。
path.delimiter属性
属性值为操作系统指定的路径分隔符,可能的属性值为“;”(在Windows操作系统中)或“:”(在UNIX操作系统中)。在Windows操作系统的REPL运行环境中获取path.delimiter属性值
本作品采用 知识共享署名-相同方式共享 4.0 国际许可协议 进行许可。