分享一些Nodejs常用檔案fs模組API（總結）

本篇文章整理記錄了工作中常用的一些Nodejs檔案fs模組API，免的下次又忘了。

身為web開發工程師，免不了跟Nodejs打交道，其中的fs模組非常有用，可以執行一些檔案相關的操作，可總是記了忘、忘了記。今天打算再整理記錄一下，免的下次又忘了。

同步與非同步

fs模組的檔案操作一般支援同步與非同步兩種API，非同步又包含了回呼函數與promsie的形式。同步一般後面帶sync字樣。 【推薦學習：《nodejs 教學》】

開啟、關閉檔案

fs.open(path:string,callback: (err,fd)=>void)用於開啟文件，取得文件描述符（file descriptor），基於拿到的文件描述符做文件操作。 fs.close(fd:number,callback:(err)=>void)用於關閉檔案

//打开文件
fs.open(path,(err,fd)=>{
    //针对拿到的fd 进行操作
    
    //关闭文件
    fs.close(fd, (err) => {
        if (err) throw err;
    });
})

一般用於對檔案做多種操作時使用。如果你只是想讀取檔案的內容建議用fs.readFile

讀取檔案（目錄）

讀取檔案：fs.readFile(path:string,callback:(err,data)=>void)

fs.readFile(path,(err,data)=>{
    //string或者buffer
    console.log(data)
})

讀取目錄:fs.readdir(path:string,callback:(err ,files:Array<string>)=>void)

fs.readdir("./dir",(err,fileNames)=>{
    console.log(fileNames)
})

還有一種方式透過檔案描述子來讀取：

##fs.read(fd, buffer,offset,length,position,callback:(err,bytesLen,buffer)=>void)

//分配一块长度为10的缓存区
const buffer = Buffer.alloc(10);
//打开文件
fs.open(path,(err,fd)=>{
    //针对拿到的fd 进行操作：将fd对应的文件内容读取到buffer里
    //position为文件的起点
    //length为读取的长度
    //offset为缓存区起读的位置
    fs.read(fd,buffer,offset,length,position,(err,bytesLen,buffer)=>{
        //buffer为包含读到数据的原始buffer对象
        //bytesLen === length;// true
    })
    //关闭文件
    fs.close(fd, (err) => {
        if (err) throw err;
    });
})

寫入檔案

#將資料寫入文件，資料可以是

字串或buffer:fs.writeFile(path,data,callback:(err)=>void)#

fs.writeFile('message.txt', data, (err) => {
  if (err) throw err;
});

還有另一種方式，透過檔案描述子

fd來寫檔案:

fs.open(path,(err,fd)=>{
    //针对拿到的fd 进行操作：将buffer内容写如fd对应的文件里
    //position为文件的起点
    //length为待写的长度
    //offset为缓存区起写的位置
    fs.write(fd,buffer,offset,length,position,(err,bytesWrittenLen,buffer)=>{

    })
    //关闭文件
    fs.close(fd, (err) => {
        if (err) throw err;
    });
})

刪除檔案（目錄）

刪除檔案：

fs.unlink(path, callback:(err)=>void)

刪除目錄：

fs.rmdir(path,callback:(err)=> ;void)

同時支援刪除目錄與檔案：

fs.rm(path,callback:(err)=>void)

查看目錄（檔案）的狀態資訊

fs.stat(path,(err,stat)=>{
    //stat包含了该目录或文件的大小、创建时间、更新时间,是目录还是文件等
    //stats.isDirectory()
    //stats.isFile()
})

重命名

#已重新命名檔案和目錄

//文件
fs.rename('oldFile.txt', 'newFile.txt', (err) => {
  if (err) throw err;
  console.log('Rename complete!');
});
//目录
fs.rename('oldFileDir', 'newFileDir', (err) => {
  if (err) throw err;
  console.log('Rename complete!');
});

最後

感謝閱讀，如果有任何的問題歡迎留言討論，謝謝！

更多程式相關知識，請造訪：

程式設計入門！ ！

以上是分享一些Nodejs常用檔案fs模組API（總結）的詳細內容。更多資訊請關注PHP中文網其他相關文章！