淺談Node.js:fs文件系統(tǒng)模塊
fs文件系統(tǒng)模塊,這是一個(gè)非常重要的模塊,對(duì)文件的操作都基于它。該模塊的所有方法都有同步和異步兩種方式,下面便介紹一下該模塊的使用。
1、檢測(cè)當(dāng)前進(jìn)程對(duì)文件的權(quán)限
使用fs.access(path[, mode], callback)
方法檢查權(quán)限,mode參數(shù)是一個(gè)整數(shù),有以下常量值:
- fs.constants.F_OK path對(duì)調(diào)用進(jìn)程是可見(jiàn)的,既存在
- fs.constants.R_OK path是可讀的
- fs.constants.W_OK path是可寫(xiě)的
- fs.constants.X_OK path是可執(zhí)行的
使用如下所示:
fs.access('./note.txt',fs.constants.F_OK,(err)=>{ console.log(err?'文件不存在':'文件已經(jīng)存在'); });
同步版本,如果發(fā)生異常,則直接拋出異常,否則什么也不做。同步版本可以利用try..catch來(lái)做,適用所有方法,如下所示:
try{ fs.accessSync('./note.txt',fs.constants.F_OK); }catch(ex){ console.log('文件不存在'); }
2、獲取文件狀態(tài)
使用fs.stat(path, callback)
,fs.statSync(path)
方法來(lái)獲取指定path的狀性,callback有(err, stats)兩個(gè)參數(shù),stats是fs.stats對(duì)象,具有以下屬性:
{ dev: 638212, mode: 33206, nlink: 1, uid: 0, gid: 0, rdev: 0, blksize: undefined, ino: 105553116266564850, size: 1094, blocks: undefined, atime: 2016-11-22T08:45:43.505Z, mtime: 2016-11-22T09:33:13.535Z, ctime: 2016-11-22T09:33:13.535Z, birthtime: 2016-11-22T08:45:43.505Z }
還有以下方法:
stats.isFile() stats.isDirectory() stats.isBlockDevice() stats.isCharacterDevice() stats.isSymbolicLink() (only valid with fs.lstat()) stats.isFIFO() stats.isSocket()
使用如下所示:
fs.stat('./app.js',(err,stats)=>{ if(err) throw err; console.log(stats); }); var stats = fs.statSync('../test.txt');//同步版本
3、文件追加
使用fs.appendFile(file, data[, options], callback)
方法向file寫(xiě)入數(shù)據(jù),如果file不存在,則創(chuàng)建file,data參數(shù)為字符串或buffer,options可選參數(shù)是對(duì)象或字符串,具有以下屬性:
- encoding | default = 'utf8' 編碼
- mode default = 0o666 打開(kāi)模式
- flag default = 'a'
使用如下所示:
fs.appendFile('./test.txt','hello world!\r\n',(err)=>{ if(err) throw err; console.log('寫(xiě)入成功'); }); //appendFile同步版本,返回值為undefined fs.appendFileSync('./test.txt','hello nodejs!\r\n');
4、文件讀取和寫(xiě)入
文件讀取使用fs.readFile(file[, options], callback)
方法,參數(shù)含義如下:
- file 文件名或文件描述符
- options 對(duì)象或字符串,如果是對(duì)象,則包含encoding和flag,前者默認(rèn)為null,后者為'r'
- callback 參數(shù)為(err,data)
如果指定的文件不存在,則直接拋出錯(cuò)誤。使用如下所示:
fs.readFile('./test4.txt',{encoding:'utf8',flag:'r'},(err,data)=>{ if(err) throw err; console.log(data); }); var data = fs.readFileSync('../test4.txt',{encoding:'utf8',flag:'r'});
文件寫(xiě)入數(shù)據(jù),使用fs.writeFile(file, data[, options], callback)
方法,參數(shù)含義如下:
- file 文件名或文件描述符
- data 字符串或buffer
- options 對(duì)象或字符串,如果是對(duì)象,則包含encoding、mode以及flag,依次默認(rèn)為utf8,0o666,'w'
- callback 參數(shù)err
如果指定的文件不存在,則創(chuàng)建該文件,相反則替換原來(lái)的文件。使用如下所示:
var data = "hello node!"; fs.writeFile('./test1.txt',data,{flag:'w'},(err)=>{ if(err) throw err; console.log('written ok.'); }); fs.writeFileSync('./test1.txt',data,{flag:'w'});
我們也可以利用fs的open,read,write,stat等方法來(lái)實(shí)現(xiàn)文件的讀取和寫(xiě)入。
fs.open(path, flags[, mode], callback)
方法打開(kāi)一個(gè)文件獲取句柄,flags參數(shù)有以下這些:
- 'r' - 以只讀方式打開(kāi)文件,若文件不存在則報(bào)錯(cuò)。
- 'r+' - 以讀寫(xiě)方式打開(kāi)文件,若文件不存在則報(bào)錯(cuò)。
- 'rs+' 在同步模式下,以讀寫(xiě)方式打開(kāi)文件
- 'w' - 以寫(xiě)方式打開(kāi)文件,若文件不存在則創(chuàng)建
- 'wx' - 以寫(xiě)方式打開(kāi)文件,若文件不存在則拋出異常.
- 'w+' - 以讀寫(xiě)方式打開(kāi)文件,若文件不存在則創(chuàng)建,相反則清空文件.
- 'wx+' - 以讀寫(xiě)方式打開(kāi)文件,若文件不存在則拋出異常.
- 'a' - 以追加方式打開(kāi)文件,若文件不存則創(chuàng)建文件
- 'ax' - 以追加方式打開(kāi)文件,若文件不存則拋出異常.
- 'a+' - 以追加和讀方式打開(kāi)文件,若文件不存則創(chuàng)建文件
- 'ax+' - 以追加和讀方式打開(kāi)文件,若文件不存則失敗
callback回調(diào)函數(shù)有(err,fd)兩個(gè)參數(shù)。
fs.read(fd, buffer, offset, length, position, callback)
方法,從一個(gè)文件中讀取數(shù)據(jù)存入buffer中,參數(shù)含義如下:
- buffer Buffer對(duì)象,用來(lái)存儲(chǔ)讀取的數(shù)據(jù)
- offset buffer開(kāi)始寫(xiě)的位置
- length 需要讀取的長(zhǎng)度
- position 指定從文件的哪個(gè)位置開(kāi)始讀取,若設(shè)置為null,則從文件當(dāng)前位置開(kāi)始讀取
- callback 有三個(gè)參數(shù)(err, bytesRead, buffer) bytesRead為實(shí)際讀取字節(jié)數(shù)
fs.write(fd, buffer, offset, length[, position], callback)
方法,將buffer數(shù)據(jù)寫(xiě)如指定文件中,參數(shù)含義如下:- offset和length指定buffer的部分
- position 指定文件的開(kāi)始寫(xiě)入的文件,若不為數(shù)字則從文件當(dāng)前位置開(kāi)始寫(xiě)入
下面是一個(gè)使用open,write,read,stat方法實(shí)現(xiàn)的文件內(nèi)容復(fù)制的函數(shù),如下所示:
function copy(src, dest) { const destFd = fs.openSync(dest, 'w+'), srcStat = fs.statSync(src); const buffer = new Buffer(srcStat.size); console.log('復(fù)制開(kāi)始...'); console.log(src+'大?。?+srcStat.size) fs.open(src,'r',(err,fd)=>{ if(err) throw err; fs.read(fd,buffer,0,srcStat.size,null,(err,bytesRead,buff)=>{ if(err) throw err; console.log('實(shí)際讀取大小:'+bytesRead); fs.close(fd,()=>{}); fs.write(destFd,buff,0,bytesRead,null,(err, written, buffer)=>{ if(err) throw err; console.log('已完成復(fù)制,向'+dest+'寫(xiě)入了'+written); fs.close(destFd,()=>{}); }); }); }); } copy('./app.js','./appbak.js');
執(zhí)行結(jié)果如下:
E:\developmentdocument\nodejsdemo>node fs-examples.js
復(fù)制開(kāi)始...
./app.js大?。?094
實(shí)際讀取大小:1094
已完成復(fù)制,向./appbak.js寫(xiě)入了1094
5、文件重命名、刪除
方法fs.rename(oldPath, newPath, callback)
可以實(shí)現(xiàn)文件的重命名,還能實(shí)現(xiàn)文件的移動(dòng),如果oldPath與newPath在同一目錄下,則是重命名,否則是移動(dòng)文件并重命名,使用如下所示:
fs.rename('../test4.txt','./test4.txt',(err)=>{ if(err) throw err; console.log('rename success.'); }); fs.renameSync('../test2.txt','../test4.txt');
文件刪除需要用到fs.unlink(path, callback)
方法,使用也很簡(jiǎn)單,如下所示:
fs.unlink('./dir/11.txt',(err)=>{ if(err) throw err; console.log('delete file success.'); }); fs.unlinkSync('./dir/11.txt');
6、創(chuàng)建、讀取、刪除目錄
創(chuàng)建目錄使用的是fs.mkdir(path[, mode], callback)
方法,mode參數(shù)默認(rèn)為0o777,但是該方法只能創(chuàng)建一級(jí)目錄,否則拋出異常,如下所示:
fs.mkdir('./a',0o777,(err)=>{ if(err) throw err; console.log('mkdir success'); }); //mkdir的同步版本,返回值為undefined fs.mkdirSync('./test',0o777);
為了能夠創(chuàng)建多級(jí)目錄,可以自己定義一個(gè)函數(shù)來(lái)實(shí)現(xiàn),需要用到path模塊的dirname方法,如下所示:
function isFileExists(filePath){ var bool = !0; try{ fs.accessSync(filePath,fs.F_OK); }catch(err){ bool = !1; } return bool; } function mkdirp(dirpath,mode,cb){ if(isFileExists(dirpath)){ cb(dirpath); }else{ mkdirp(path.dirname(dirpath),mode,function(){ fs.mkdir(dirpath,mode,cb); }); } }
掃描目錄需要用到fs.readdir(path[, options], callback)
方法,options參數(shù)為字符串或?qū)ο?,callback回調(diào)函數(shù)有(err, files)兩個(gè)參數(shù),files是一個(gè)文件名數(shù)組,該方法也是只能掃描一級(jí)目錄,使用如下所示:
fs.readdir('./',(err,files)=>{ if(err) throw err; console.log(files); });
如果要實(shí)現(xiàn)可以遞歸掃描目錄,可以自己定義一個(gè)函數(shù),如下所示:
function scandir(dirpath){ var filesArr = {}; if(!isFileExists(dirpath)) return !1; function scan(filepath){ var statObj = fs.statSync(filepath); if(!statObj.isDirectory()) return filesArr.push(filepath); var files = fs.readdirSync(filepath); files.forEach((file,idx,arr)=>{ scan(filepath+'/'+file); }); } scan(dirpath); return filesArr; }
刪除目錄使用fs.rmdir(path, callback)
方法,只能刪除一級(jí)目錄且目錄須為空,使用如下所示:
fs.rmdir('./dir',(err)=>{ if(err) throw err; console.log('delete dir success.'); });
要實(shí)現(xiàn)類(lèi)似rm -rf的遞歸刪除效果,可以使用如下代碼:
function deldirs(dirpath){ var stat = null, emptyFoldersArr = []; function scan(spath){ var files = fs.readdirSync(spath); emptyFoldersArr.push(spath); if(files.length>0){ files.forEach((file,idx,arr)=>{ if(fs.statSync(spath+'/'+file).isDirectory()){ scan(spath+'/'+file); }else{ return fs.unlinkSync(spath+'/'+file),!0; } }); } } scan(dirpath); for(var l=emptyFoldersArr.length-1,i=l;i>=0;i--){ fs.rmdirSync(emptyFoldersArr[i]); } }
7、獲取路徑的絕對(duì)路徑
使用fs.realpath(path[, options], callback)
方法可以獲取path的絕對(duì)路徑,callback有(err, resolvedPath)兩個(gè)參數(shù),使用如下所示:
fs.realpath('./test.txt',(err,resolvePath)=>{ if(err) throw err; console.log(resolvePath); }); console.log(fs.realpathSync('./test.txt'));
執(zhí)行結(jié)果如下所示:
E:\developmentdocument\nodejsdemo>node fs-examples.js
E:\developmentdocument\nodejsdemo\test.txt
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- Node.js?內(nèi)置模塊fs文件系統(tǒng)操作示例詳解
- Node.js?操作本地文件及深入了解fs內(nèi)置模塊
- 總結(jié)Node.js中9種fs模塊文件操作方法(文件夾遞歸刪除知識(shí))
- Node.js中fs模塊的使用方法
- node.js-fs文件系統(tǒng)模塊這是你知道嗎
- Node.js 中的 fs 模塊與Path模塊方法詳解
- Node.js中文件系統(tǒng)fs模塊的使用及常用接口
- Node.js fs模塊(文件模塊)創(chuàng)建、刪除目錄(文件)讀取寫(xiě)入文件流的方法
- node.js基于fs模塊對(duì)系統(tǒng)文件及目錄進(jìn)行讀寫(xiě)操作的方法詳解
- Node.js?中?fs?模塊的高級(jí)用法實(shí)例詳解
相關(guān)文章
詳解如何用typescript開(kāi)發(fā)koa2的二三事
這篇文章主要介紹了詳解如何用typescript開(kāi)發(fā)koa2的二三事,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-11-11nodejs+koa2 實(shí)現(xiàn)模仿springMVC框架
這篇文章主要介紹了nodejs+koa2 實(shí)現(xiàn)模仿springMVC框架,本文通過(guò)實(shí)例圖文相結(jié)合給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-10-10nodejs redis 發(fā)布訂閱機(jī)制封裝實(shí)現(xiàn)方法及實(shí)例代碼
這篇文章主要介紹了nodejs redis 發(fā)布訂閱機(jī)制封裝的相關(guān)資料,這里提供了實(shí)現(xiàn)方法,及實(shí)例代碼,具有參考價(jià)值,需要的朋友可以參考下2016-12-12package.json與package-lock.json創(chuàng)建及使用詳解
這篇文章主要為大家介紹了package.json與package-lock.json創(chuàng)建及使用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-07-07Node.js+express+socket實(shí)現(xiàn)在線(xiàn)實(shí)時(shí)多人聊天室
這篇文章主要為大家詳細(xì)介紹了Node.js+express+socket實(shí)現(xiàn)在線(xiàn)實(shí)時(shí)多人聊天室,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-07-07在Debian(Raspberry Pi)樹(shù)莓派上安裝NodeJS的教程詳解
在樹(shù)莓派上運(yùn)行NodeJS并不需要特別的配置,你只需要確??梢杂胦penssh遠(yuǎn)程連接到你的樹(shù)莓派就ok了,關(guān)于在Debian(Raspberry Pi)樹(shù)莓派上安裝NodeJS的方法,大家可以通過(guò)本文了解下2017-09-09Node.JS循環(huán)刪除非空文件夾及子目錄下的所有文件
這篇文章主要介紹了Node.JS循環(huán)刪除非空文件夾及子目錄下的所有文件及node.js遞歸刪除非空文件夾的實(shí)例代碼,需要的朋友可以參考下2018-03-03