總結Node.js中9種fs模塊文件操作方法(文件夾遞歸刪除知識)
本文主要介紹瞭Node.js常用的文件操作方法，以及常見的處理場景，文件追加，文件夾遞歸刪除等。
一、前言
- fs.mkdir()
- fs.writeFile()
- fs.appendFile()
- fs.stat()fs.readFile()
- fs.readdir()
- fs.rename()
- fs.unlink()
- fs.rmdir()
二、fs.mkdir()創建文件夾
異步的創建一個文件夾：
語法：
fs.mkdir(path[,options],callback) /** * path <string> | <Buffer> | <URL> * options <Object> | <integer> * recursive <boolean> 默認值: false * mode <string> | <integer> Windows 上不支持。 默認值: 0o777。 * callback <Function> * err <Error> * path <string> | <undefined> 僅當創建目錄時將 recursive 設置為 true。 */
2.1 最簡單的案例
最簡單的案例，在當前目錄下創建一個temp文件夾：
const fs = require('fs')
fs.mkdir('./temp',(err)=>{
if(err){
console.log(err.message)
return
}
console.log('創建文件夾成功')
})
代碼執行結果：
2.2 遞歸創建文件夾
使用參數{recursive:true}創建多層次的文件夾。
fs.mkdir('./parent/son/grandson',{recursive:true},(err,path)=>{
if(err){
console.log(err.message)
return
}
console.log('遞歸創建文件夾成功',path)
})
代碼執行結果：
註意： 在使用{recursive:true}參數時，回調對應的會增加一個path參數，其他情況下沒有。
三、fs.wirteFile()創建、寫文件
當 file 是文件名時，將數據異步地寫入文件，如果文件已存在則替換該文件。 data 可以是字符串或緩沖區。
當 file 是文件描述符時，其行為類似於直接調用 fs.write()（本文不涉及這種情況）。
語法：
fs.writeFile(file, data[, options], callback) /** * file <string> | <Buffer> | <URL> | <integer> 文件名或文件描述符 * data <string> | <Buffer> | <TypedArray> | <DataView> | <Object> * options <Object> | <string> * encoding <string> | <null> 默認值: 'utf8' * mode <integer> 默認值: 0o666 * flag <string> 請參閱對文件系統 flags 的支持。 默認值: 'w'。 * signal <AbortSignal> 允許中止正在進行的寫入文件 * callback <Function> * err <Error> | <AggregateError> */
3.1 創建並寫入一個文件
創建一個名為index.html的文件，並寫入一行字符串。
fs.writeFile('./index.html',"<h1>你好，中國</h1>",(err)=>{
if(err){
console.log(err.message)
return
}
console.log("創建寫入文件成功")
})
代碼執行結果如下：
3.2 重寫文件並指定編碼
重寫index.html，並為文件指定編碼：
fs.writeFile('./index.html','<h2>面朝大海，春暖花開</h2>','utf-8',(err)=>{
if(err){
console.log(err.message)
return
}
console.log('寫入指定格式文件成功')
})
代碼執行效果如下：
原文件內容被覆蓋。
3.3 寫入GBK格式的文件
Node.js僅支持utf8 ucs2 ascii binary base64 hex這幾種格式，對於GBK，GB2312等特殊格式需要使用額外的庫（這裡使用iconv-lite）。
案例：
const iconv = require('iconv-lite')
fs.writeFile('./style.css',iconv.encode('面朝大海，春暖花開','gbk'),(err)=>{
if(err){
console.log(err.message)
return
}
console.log("以GBK格式寫入成功")
})
代碼執行結果：
註意底部的編碼格式，如果使用utf-8打開文件會亂碼的呦！
四、fs.appendFile()文件後追加內容
異步地將數據追加到文件，如果該文件尚不存在，則創建該文件。
語法：
fs.appendFile(path, data[, options], callback) /** * path <string> | <Buffer> | <URL> | <number> 文件名或文件描述符 * data <string> | <Buffer> * options <Object> | <string> * encoding <string> | <null> 默認值: 'utf8' * mode <integer> 默認值: 0o666 * flag <string> 請參閱對文件系統 flags 的支持。 默認值: 'a'。 * callback <Function> * err <Error> */
4.1 使用追加的方式創建並寫入內容
fs.appendFile('./test.txt', '測試寫入', (err) => {
if (err) {
console.log(err.message)
return
}
console.log("使用追加的方式創建並寫入文件")
})
代碼執行結果：
4.2 追加內容
fs.appendFile('./test.txt', "\n追加測試", (err) => {
if (err) {
console.log(err.message)
return
}
console.log('在已經存在的文件中追加內容')
})
代碼執行結果：
五、fs.stat()判斷路徑是目錄還是文件
判斷路徑是文件還是目錄。
語法：
fs.stat(path[, options], callback) /** * path <string> | <Buffer> | <URL> * options <Object> * bigint <boolean> 返回的 <fs.Stats> 對象中的數值是否應為 bigint。 默認值: false。 * callback <Function> * err <Error> * stats <fs.Stats> */
5.1 判斷文件案例
判斷index.html是文件還是目錄。
fs.stat('./index.html',(err,stats)=>{
if(err){
console.log(err.message)
return
}
console.log(`./index.html是文件：${stats.isFile()}`)
console.log(`./index.html是目錄：${stats.isDirectory()}`)
})
代碼執行效果：
六、fs.readFile()讀取文件內容
異步地讀取文件的全部內容。
語法：
fs.stat('./index.html',(err,stats)=>{
if(err){
console.log(err.message)
return
}
console.log(`./index.html是文件：${stats.isFile()}`)
console.log(`./index.html是目錄：${stats.isDirectory()}`)
})
6.1 以默認格式讀取文件
以默認的格式（utf-8）讀取文件內容：
fs.readFile('./index.html',(err,data)=>{
if(err){
console.log(err.message)
return
}
console.log(`讀取文件成功，文件內容是：\n${data}`)
})
代碼執行結果：
如果要讀取的文件不是utf-8格式，就會出現亂碼，這時就需要指定讀取格式。
6.2 以指定格式（這裡是GBK）讀取文件
遺憾的是，node.js不支持除瞭utf8 ucs2 ascii binary base64 hex之外的編碼，我們需要使用額外的包（iconv-lite）讀取GBK文件：
const iconv = require('iconv-lite')
fs.readFile('./index.html',(err,data)=>{
if(err){
console.log(err.message)
return
}
console.log(`讀取文件成功，文件內容是：\n${data}`)
console.log("讀取文件成功，文件內容是：\n",iconv.decode(data,'gbk'))
})
代碼執行結果如下：
七、fs.readdir()讀取文件夾中的內容
讀取目錄的內容。 回調有兩個參數 (err, files)，其中 files 是目錄中文件名的數組，不包括 '.' 和 '..'。
語法：
fs.readdir(path[, options], callback) /** * path <string> | <Buffer> | <URL> * options <string> | <Object> * encoding <string> 默認值: 'utf8' * withFileTypes <boolean> 默認值: false * callback <Function> * err <Error> * files <string[]> | <Buffer[]> | <fs.Dirent[]> */
7.1 讀取文件夾案例
讀取當前文件夾下所有的文件。
fs.readdir('./',(err,files)=>{
if(err){
console.log(err.message)
return
}
console.log(files)
})
代碼執行結果：
PS D:\Code\Study\Node\demos> node .\01-fs.js
[
'01-fs.js',
'index.html',
'node_modules',
'package-lock.json',
'package.json',
'style.css',
'temp'
]
7.2 獲取文件類型
我們可以在讀取文件列表的時候，獲取文件的類型。
fs.readdir('./',{withFileTypes:true},(err,files)=>{
if(err){
console.log(err.message)
return
}
console.log(files)
})
代碼執行結果：
PS D:\Code\Study\Node\demos> node .\01-fs.js
[
Dirent { name: '01-fs.js', [Symbol(type)]: 1 },
Dirent { name: 'index.html', [Symbol(type)]: 1 },
Dirent { name: 'node_modules', [Symbol(type)]: 2 },
Dirent { name: 'package-lock.json', [Symbol(type)]: 1 },
Dirent { name: 'package.json', [Symbol(type)]: 1 },
Dirent { name: 'style.css', [Symbol(type)]: 1 },
Dirent { name: 'temp', [Symbol(type)]: 2 }
]
八、fs.raname()重命名、移動文件
將 oldPath 處的文件異步重命名為作為 newPath 提供的路徑名。 如果 newPath 已經存在，則它將被覆蓋。 如果在 newPath 中有目錄，則會引發錯誤。 除瞭可能的異常之外，沒有為完成回調提供任何參數。
fs.rename(oldPath, newPath, callback) /** * oldPath <string> | <Buffer> | <URL> * newPath <string> | <Buffer> | <URL> * callback <Function> * err <Error> */
8.1 重命名文件
將index.html重命名為main.html。
fs.rename('./index.html', './main.html', (err) => {
if (err) {
console.log(err.message)
return
}
console.log('重命名成功')
})
代碼執行結果：
PS E:\Code\Node\demos> node .\01-fs.js
重命名成功
PS E:\Code\Node\demos> ls目錄: E:\Code\Node\demos
Mode LastWriteTime Length Name
—- ————- —— —-
d—– 2022/7/4 18:43 node_modules
da—- 2022/7/4 17:33 temp
-a—- 2022/7/4 19:48 6210 01-fs.js
-a—- 2022/7/4 16:23 27 main.html (*)
-a—- 2022/7/4 16:58 1455 package-lock.json
-a—- 2022/7/4 16:57 55 package.json
-a—- 2022/7/4 17:05 18 style.css
-a—- 2022/7/4 19:40 12 test.txt
8.2 移動文件
將./main.html移動到./temp/main.html。
fs.rename('./main.html', './temp/main.html', (err) => {
if (err) {
console.log(err.message)
return
}
console.log('移動文件成功')
})
代碼執行結果：
PS E:\Code\Node\demos> node .\01-fs.js
移動文件成功
PS E:\Code\Node\demos> ls .\temp\目錄: E:\Code\Node\demos\temp
Mode LastWriteTime Length Name
—- ————- —— —-
-a—- 2022/7/4 16:23 27 main.htmlPS E:\Code\Node\demos>
九、fs.unlink()刪除文件
異步地刪除文件或符號鏈接。 除瞭可能的異常之外，沒有為完成回調提供任何參數。
9.1 刪除文件案例
fs.unlink('./temp/main.html', (err) => {
if (err) {
console.log(err.message)
return
}
console.log("刪除文件成功")
})
代碼執行結果：
PS E:\Code\Node\demos> ls .\temp\
目錄: E:\Code\Node\demos\temp
Mode LastWriteTime Length Name
—- ————- —— —-
-a—- 2022/7/4 20:03 0 main.htmlPS E:\Code\Node\demos> node .\01-fs.js
刪除文件成功
PS E:\Code\Node\demos> ls .\temp\
PS E:\Code\Node\demos>
十、fs.rmdir()刪除文件夾
刪除指定路徑的文件夾。
語法：
fs.rmdir(path[, options], callback) /** * path <string> | <Buffer> | <URL> * options <Object> * maxRetries <integer> 如果遇到 EBUSY、EMFILE、ENFILE、ENOTEMPTY 或 EPERM 錯誤， * Node.js 將在每次嘗試時以 retryDelay 毫秒的線性退避等待時間重試該操作。 * 此選項表示重試次數。 如果 recursive 選項不為 true，則忽略此選項。 默認值: 0。 * recursive <boolean> 如果為 true，則執行遞歸目錄刪除。 在遞歸模式下，操作將在失敗時重試。 默認值: false。 已棄用。 * retryDelay <integer> 重試之間等待的時間（以毫秒為單位）。 如果 recursive 選項不為 true，則忽略此選項。 默認值: 100。 * callback <Function> * err <Error> */
10.1 刪除空的文件夾
刪除./temp文件夾。
fs.rmdir('./temp', (err) => {
if (err) {
console.log(err.message)
return
}
console.log('刪除空的文件夾')
})
代碼執行結果：
PS E:\Code\Node\demos> ls .
目錄: E:\Code\Node\demos
Mode LastWriteTime Length Name
—- ————- —— —-
d—– 2022/7/4 18:43 node_modules
da—- 2022/7/4 20:03 temp
-a—- 2022/7/4 20:09 7666 01-fs.js
-a—- 2022/7/4 16:58 1455 package-lock.json
-a—- 2022/7/4 16:57 55 package.json
-a—- 2022/7/4 17:05 18 style.css
-a—- 2022/7/4 19:40 12 test.txtPS E:\Code\Node\demos> node .\01-fs.js
刪除空的文件夾
PS E:\Code\Node\demos> ls目錄: E:\Code\Node\demos
Mode LastWriteTime Length Name
—- ————- —— —-
d—– 2022/7/4 18:43 node_modules
-a—- 2022/7/4 20:09 7666 01-fs.js
-a—- 2022/7/4 16:58 1455 package-lock.json
-a—- 2022/7/4 16:57 55 package.json
-a—- 2022/7/4 17:05 18 style.css
-a—- 2022/7/4 19:40 12 test.txt
10.2 刪除非空的文件夾
這裡使用的是同步的文件處理函數，用於遞歸的刪除文件夾。
function emptyDir(path) {
const files = fs.readdirSync(path); //同步讀取文件夾
files.forEach(file => { //刪除文件夾中的所有文件/夾
const filePath = `${path}/${file}`;
const stats = fs.statSync(filePath);
if (stats.isDirectory()) {
emptyDir(filePath);
} else {
fs.unlinkSync(filePath);
console.log(`刪除${file}文件成功`);
}
});
fs.rmdirSync(path) //刪除文件夾
}
emptyDir('./node_modules')
代碼執行結果：
PS E:\Code\Node\demos> node .\01-fs.js
刪除.package-lock.json文件成功
刪除dependabot.yml文件成功
刪除codeStyleConfig.xml文件成功
刪除Project.xml文件成功
刪除iconv-lite.iml文件成功
… …
十一、總結
本文總結瞭Node.js常用的文件操作方法，以及常見的文件處理場景。
主要包括：
- fs.mkdir()
- fs.writeFile()
- fs.appendFile()
- fs.stat()fs.readFile()
- fs.readdir()
- fs.rename()
- fs.unlink()
- fs.rmdir()
十二、本文源碼
/**
* fs.mkdir(path[,options],callback)
* path <string> | <Buffer> | <URL>
* options <Object> | <integer>
* recursive <boolean> 默認值: false
* mode <string> | <integer> Windows 上不支持。 默認值: 0o777。
* callback <Function>
* err <Error>
* path <string> | <undefined> 僅當創建目錄時將 recursive 設置為 true。
*/
const fs = require('fs')
// 1. 最簡單的測試案例
// fs.mkdir('./temp',(err)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log('創建文件夾成功')
// })
// 2. 遞歸創建文件夾
// fs.mkdir('./parent/son/grandson',{recursive:true},(err,path)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log('遞歸創建文件夾成功',path)
// })
/**-------------------------------------------------------------------------------------- */
/**-------------------------------------------------------------------------------------- */
/**-------------------------------------------------------------------------------------- */
/**
* fs.writeFile(file, data[, options], callback)
* file <string> | <Buffer> | <URL> | <integer> 文件名或文件描述符
* data <string> | <Buffer> | <TypedArray> | <DataView> | <Object>
* options <Object> | <string>
* encoding <string> | <null> 默認值: 'utf8'
* mode <integer> 默認值: 0o666
* flag <string> 請參閱對文件系統 flags 的支持。 默認值: 'w'。
* signal <AbortSignal> 允許中止正在進行的寫入文件
* callback <Function>
* err <Error> | <AggregateError>
*/
// 1. 創建並寫入一個文件
// fs.writeFile('./index.html',"<h1>你好，中國</h1>",(err)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log("創建寫入文件成功")
// })
// 2. 指定文件格式
// fs.writeFile('./index.html','<h2>面朝大海，春暖花開</h2>','utf-8',(err)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log('寫入指定格式文件成功')
// })
// 3. 寫gbk文件
// const iconv = require('iconv-lite')
// fs.writeFile('./style.css',iconv.encode('面朝大海，春暖花開','gbk'),(err)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log("以GBK格式寫入成功")
// })
/**
* fs.appendFile(path, data[, options], callback)
* path <string> | <Buffer> | <URL> | <number> 文件名或文件描述符
* data <string> | <Buffer>
* options <Object> | <string>
* encoding <string> | <null> 默認值: 'utf8'
* mode <integer> 默認值: 0o666
* flag <string> 請參閱對文件系統 flags 的支持。 默認值: 'a'。
* callback <Function>
* err <Error>
*/
// 1. 創建文件並寫入內容
// fs.appendFile('./test.txt', '測試寫入', (err) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log("使用追加的方式創建並寫入文件")
// })
// 2. 追加內容
// fs.appendFile('./test.txt', "\n追加測試", (err) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log('在已經存在的文件中追加內容')
// })
/** =============================================================================== */
/**
* fs.stat(path[, options], callback)
* path <string> | <Buffer> | <URL>
* options <Object>
* bigint <boolean> 返回的 <fs.Stats> 對象中的數值是否應為 bigint。 默認值: false。
* callback <Function>
* err <Error>
* stats <fs.Stats>
*/
// 1. 判斷路徑是目錄還是文件
// fs.stat('./index.html',(err,stats)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log(`./index.html是文件：${stats.isFile()}`)
// console.log(`./index.html是目錄：${stats.isDirectory()}`)
// })
/**
* fs.readFile(path[, options], callback)
* path <string> | <Buffer> | <URL> | <integer> 文件名或文件描述符
* options <Object> | <string>
* encoding <string> | <null> 默認值: null
* flag <string> 請參閱對文件系統 flags 的支持。 默認值: 'r'。
* signal <AbortSignal> 允許中止正在進行的讀取文件
* callback <Function>
* err <Error> | <AggregateError>
* data <string> | <Buffer>
*/
// 1. 讀取文件內容
// fs.readFile('./index.html',(err,data)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log(`讀取文件成功，文件內容是：\n${data}`)
// })
// 2. 以指定格式讀取文件
// const iconv = require('iconv-lite')
// fs.readFile('./index.html',(err,data)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log(`讀取文件成功，文件內容是：\n${data}`)
// console.log("讀取文件成功，文件內容是：\n",iconv.decode(data,'gbk'))
// })
/**================================================================================ */
/**
* fs.readdir(path[, options], callback)
* path <string> | <Buffer> | <URL>
* options <string> | <Object>
* encoding <string> 默認值: 'utf8'
* withFileTypes <boolean> 默認值: false
* callback <Function>
* err <Error>
* files <string[]> | <Buffer[]> | <fs.Dirent[]>
*
*/
// 1. 讀取當前目錄下所有的文件
// fs.readdir('./',(err,files)=>{
// if(err){
// console.log(err.message)
// return
// }
// console.log(files)
// })
// 2. 獲取文件類型
// fs.readdir('./', { withFileTypes: true }, (err, files) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log(files)
// })
/**
* fs.rename(oldPath, newPath, callback)
* oldPath <string> | <Buffer> | <URL>
* newPath <string> | <Buffer> | <URL>
* callback <Function>
* err <Error>
*/
// fs.rename('./index.html', './main.html', (err) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log('重命名成功')
// })
// fs.rename('./main.html', './temp/main.html', (err) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log('移動文件成功')
// })
/**
* fs.unlink(path, callback)
* path <string> | <Buffer> | <URL>
* callback <Function>
* err <Error>
*/
// fs.unlink('./temp/main.html', (err) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log("刪除文件成功")
// })
/**
* fs.rmdir(path[, options], callback)
* path <string> | <Buffer> | <URL>
* options <Object>
* maxRetries <integer> 如果遇到 EBUSY、EMFILE、ENFILE、ENOTEMPTY 或 EPERM 錯誤，
* Node.js 將在每次嘗試時以 retryDelay 毫秒的線性退避等待時間重試該操作。
* 此選項表示重試次數。 如果 recursive 選項不為 true，則忽略此選項。 默認值: 0。
* recursive <boolean> 如果為 true，則執行遞歸目錄刪除。 在遞歸模式下，操作將在失敗時重試。 默認值: false。 已棄用。
* retryDelay <integer> 重試之間等待的時間（以毫秒為單位）。 如果 recursive 選項不為 true，則忽略此選項。 默認值: 100。
* callback <Function>
* err <Error>
*/
// fs.rmdir('./temp', (err) => {
// if (err) {
// console.log(err.message)
// return
// }
// console.log('刪除空的文件夾')
// })
function emptyDir(path) {
const files = fs.readdirSync(path); //同步讀取文件夾
files.forEach(file => { //刪除文件夾中的所有文件/夾
const filePath = `${path}/${file}`;
const stats = fs.statSync(filePath);
if (stats.isDirectory()) {
emptyDir(filePath);
} else {
fs.unlinkSync(filePath);
console.log(`刪除${file}文件成功`);
}
});
fs.rmdirSync(path) //刪除文件夾
}
emptyDir('./node_modules')
到此這篇關於總結Node.js中9種fs模塊文件操作方法(文件夾遞歸刪除知識)的文章就介紹到這瞭,更多相關Node.js fs模塊內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- JavaScript中異步與回調的基本概念及回調地獄現象
- nodejs中的讀取文件fs與文件路徑path解析
- Node的文件系統你瞭解多少
- Node.js中fs模塊的使用方法
- nodejs 中的讀取文件fs模塊示例詳解