檔案系統：Node.js `fs` 模組-js教程-PHP中文網

檔案系統：Node.js `fs` 模組

WBOY

發布： 2024-08-24 15:01:33

原創

462 人瀏覽過

File System: Node.js `fs` Module

Node.js 中的 fs（檔案系統）模組是一個用於處理檔案系統的強大工具，可讓您與伺服器上的檔案和目錄進行互動。它內建於 Node.js 中，因此您無需安裝任何額外的東西即可使用它。讓我們來探討一下 fs 的工作原理及其關鍵功能。

1.什麼是fs模組？

fs 模組提供了一個 API，用於以緊密圍繞標準 POSIX 函數建模的方式與檔案系統進行互動。此模組用於讀取和寫入檔案、建立目錄等任務。

2. 基本設定

要使用 fs 模組，您需要在 Node.js 腳本的開頭引入它：

const fs = require('fs');

登入後複製

3. 讀取文件

讀取檔案有兩種主要方式：非同步和同步。

非同步讀取

此方法是非阻塞的，這表示它在讀取檔案時不會停止程式的執行。

fs.readFile('example.txt', 'utf8', (err, data) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log(data);
});

登入後複製

'example.txt'：您要讀取的檔案。
'utf8'：指定要使用的編碼。
回呼函數：處理錯誤和檔案資料。

同步讀取

此方法是阻塞的，這表示它將停止執行程序，直到讀取檔案。

try {
    const data = fs.readFileSync('example.txt', 'utf8');
    console.log(data);
} catch (err) {
    console.error(err);
}

登入後複製

4. 寫入文件

與讀取檔案類似，寫入也可以非同步或同步進行。

非同步寫入

fs.writeFile('example.txt', 'Hello, World!', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('File has been saved!');
});

登入後複製

同步寫入

try {
    fs.writeFileSync('example.txt', 'Hello, World!');
    console.log('File has been saved!');
} catch (err) {
    console.error(err);
}

登入後複製

5. 附加到文件

如果您想為現有文件添加內容而不覆蓋它，請使用appendFile 方法。

非同步追加

fs.appendFile('example.txt', '\nAppended Content', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Content has been appended!');
});

登入後複製

同步追加

try {
    fs.appendFileSync('example.txt', '\nAppended Content');
    console.log('Content has been appended!');
} catch (err) {
    console.error(err);
}

登入後複製

6. 刪除文件

要刪除文件，請使用 unlink 方法。

非同步刪除

fs.unlink('example.txt', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('File deleted!');
});

登入後複製

同步刪除

try {
    fs.unlinkSync('example.txt');
    console.log('File deleted!');
} catch (err) {
    console.error(err);
}

登入後複製

7. 使用目錄

建立目錄

fs.mkdir('newDir', { recursive: true }, (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Directory created!');
});

登入後複製

讀取目錄

fs.readdir('newDir', (err, files) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Files in directory:', files);
});

登入後複製

刪除目錄

fs.rmdir('newDir', { recursive: true }, (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Directory deleted!');
});

登入後複製

8.查看文件

您可以使用 fs.watch 方法監視檔案中的變更：

fs.watch('example.txt', (eventType, filename) => {
    if (filename) {
        console.log(`${filename} file Changed!`);
    }
});

登入後複製

9. 使用流

Node.js 提供 fs 流來處理可能無法放入記憶體的大檔案。

使用串流閱讀

const readStream = fs.createReadStream('example.txt', 'utf8');
readStream.on('data', (chunk) => {
    console.log(chunk);
});

登入後複製

用流寫作

const writeStream = fs.createWriteStream('example.txt');
writeStream.write('Hello, ');
writeStream.write('World!');
writeStream.end();

登入後複製

10. 複製文件

Node.js 提供了一個簡單的複製檔案的方法：

fs.copyFile('source.txt', 'destination.txt', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('File copied successfully!');
});

登入後複製

11.承諾的fs

fs 模組還具有基於 Promise 的方法，可以更輕鬆地使用 async/await 等現代 JavaScript 功能。

const fsPromises = require('fs').promises;

async function readFile() {
    try {
        const data = await fsPromises.readFile('example.txt', 'utf8');
        console.log(data);
    } catch (err) {
        console.error(err);
    }
}

readFile();

登入後複製