fs模塊即Node.js的文件系統(tǒng)模塊齐遵,是Node.js的核心模塊之一,它提供了一個API壹无,以模仿標(biāo)準 POSIX 函數(shù)的方式與文件系統(tǒng)進行交互脚祟。
POSIX(Portable Operating System Interface for Computing Systems,可移植操作系統(tǒng)接口)是由 IEEE 和 ISO/IEC 開發(fā)的一簇標(biāo)準凄诞,該標(biāo)準是基于現(xiàn)有的 UNIX 實踐和經(jīng)驗圆雁,描述了操作系統(tǒng)的調(diào)用服務(wù)接口。用于保證編制的應(yīng)用程序可以在源碼一級上在多種操作系統(tǒng)上移植和運行帆谍。要使用此模塊:
const fs = require('fs');
同步和異步
所有的文件系統(tǒng)操作都具有同步和異步的方式摸柄。
- 同步:使用同步的操作,代碼按順序執(zhí)行既忆,且在進行完這行操作之前不會進行下一步操作驱负,發(fā)生的異常會立即拋出。
const fs = require('fs');
try {
//讀取一個文件
//同步讀取患雇,阻塞操作跃脊,這行代碼不完成之后的代碼不執(zhí)行
const data = fs.readFileSync('./text.js')
console.log(data );
} catch (err) {
// 處理錯誤
}
- 異步:異步的形式總是把回調(diào)函數(shù)作為其最后一個參數(shù),回調(diào)的參數(shù)中第一個參數(shù)總是異常信息苛吱。使用異步的形式酪术,無法保證順序,建議都使用異步形式翠储。
const fs = require('fs');
//異步版本
fs.readFile('./text.js',(err,data)=>{
if (err) throw err;
console.log(data)
})
文件路徑
文件操作可接受的文件路徑如下:
- 字符串:解析為標(biāo)識絕對或相對文件名的 UTF-8 字符序列
- 絕對路徑:以
/
開頭
const fs = require('fs');
fs.open('/open/some/file.txt', 'r', (err, fd) => {
if (err) throw err;
fs.close(fd, (err) => {
if (err) throw err;
});
});
- 相對路徑:直接用文件名
fs.open('file.txt', 'r', (err, fd) => {
if (err) throw err;
fs.close(fd, (err) => {
if (err) throw err;
});
});
- Buffer路徑:與字符串路徑一樣绘雁,Buffer 路徑可以是相對路徑或絕對路徑
絕對路徑:
fs.open(Buffer.from('/open/some/file.txt'), 'r', (err, fd) => {
if (err) throw err;
fs.close(fd, (err) => {
if (err) throw err;
});
});
- 使用
file:
協(xié)議的URL
對象
對于大多數(shù)fs
模塊的函數(shù),path
或filename
參數(shù)可以傳入 WHATWGURL
對象援所。 僅支持使用file:
協(xié)議的URL
對象
const fs = require('fs');
const fileUrl = new URL('file:///tmp/hello');
fs.readFileSync(fileUrl);
創(chuàng)建目錄
異步:fs.mkdir(path[, options], callback)
-
callback
<Function>-
err
<Error>
-
// 創(chuàng)建 /tmp/a/apple 目錄挪略,無論是否存在 /tmp 和 /tmp/a 目錄历帚。
fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => {
if (err) throw err;
});
同步:fs.mkdirSync(path[, options])
讀取目錄內(nèi)容
異步:fs.readdir(path[, options], callback)
-
callback
<Function>-
err
<Error> -
files
<string[]> | <Buffer[]> | <fs.Dirent[]>
-
同步:fs.readdirSync(path[, options])
打開關(guān)閉文件
打開:
異步:fs.open(path, flags[, mode], callback)
flags
<string> | <number> 參閱支持的文件系統(tǒng)標(biāo)志挽牢。mode
<integer> 默認值:0o666
(可讀寫)。-
callback
<Function> 同步:fs.openSync(path, flags[, mode])
關(guān)閉:
- 異步:fs.close(fd, callback)
- 同步:fs.closeSync(fd)
讀取文件全部內(nèi)容
異步:fs.readFile(path[, options], callback)
-
-
encoding
<string> | <null> 默認值:null
禽拔。 -
flag
<string> 參閱支持的文件系統(tǒng)標(biāo)志。默認值:'r'
室叉。
-
-
callback
<Function>
fs.readFile('/text', (err, data) => {
if (err) throw err;
console.log(data);
});
同步:fs.readFileSync(path[, options])
寫入文件內(nèi)容
異步:fs.writeFile(file, data[, options], callback)
data
<string> | <Buffer> | <TypedArray> | <DataView>-
-
encoding
<string> | <null> 默認值:'utf8'
。 -
mode
<integer> 默認值:0o666
太惠。 -
flag
<string> 參閱支持的文件系統(tǒng)標(biāo)志磨淌。默認值:'w'
。
-
-
callback
<Function>-
err
<Error>
-
const data = new Uint8Array(Buffer.from('Node.js中文網(wǎng)'));
fs.writeFile('文件.txt', data, (err) => {
if (err) throw err;
console.log('文件已保存');
});
同步:fs.writeFileSync(file, data[, options])
追加數(shù)據(jù)(文件不存在則創(chuàng)建)
異步:fs.appendFile(path, data[, options], callback)
-
-
encoding
<string> | <null> 默認值:'utf8'
梁只。 -
mode
<integer> 默認值:0o666
。 -
flag
<string> 參閱支持的文件系統(tǒng)標(biāo)志埃脏。默認值:'a'
搪锣。
-
-
callback
<Function>-
err
<Error>
-
fs.appendFile('message.txt', '追加的數(shù)據(jù)', (err) => {
if (err) throw err;
console.log('數(shù)據(jù)已追加到文件');
});
//如果 options 是字符串,則它指定字符編碼
fs.appendFile('message.txt1', '追加的數(shù)據(jù)', 'utf8', callback);
打開一個文件彩掐,并追加數(shù)據(jù):
fs.open('message.txt', 'a', (err, fd) => {
if (err) throw err;
fs.appendFile(fd, '追加的數(shù)據(jù)', 'utf8', (err) => {
fs.close(fd, (err) => {
if (err) throw err;
});
if (err) throw err;
});
});
同步:fs.appendFileSync(path, data[, options])构舟,使用方法同上
拷貝源文件到目標(biāo)文件
異步:fs.copyFile(src, dest[, flags], callback)
-
src
<string> | <Buffer> | <URL> 要拷貝的源文件名。 -
dest
<string> | <Buffer> | <URL> 拷貝操作的目標(biāo)文件名堵幽。 -
flags
<number> 用于拷貝操作的修飾符狗超。默認值:0
。 -
callback
<Function>
const fs = require('fs');
// 默認情況下將創(chuàng)建或覆蓋目標(biāo)文件朴下。
fs.copyFile('源文件.txt', '目標(biāo)文件.txt', (err) => {
if (err) throw err;
console.log('源文件已拷貝到目標(biāo)文件');
});
同步:fs.copyFileSync(src, dest[, flags])努咐,使用同上
流的讀寫與輸出
創(chuàng)建讀寫流:fs.createReadStream(path[, options])
返回: <fs.ReadStream> 參閱可讀流拱燃。
從一個大小為 100 字節(jié)的文件中讀取最后 10 個字節(jié):
fs.createReadStream('sample.txt', { start: 90, end: 99 });