在當代 Node.js 開發中，fsPromises API 比傳統的 fs 模組越來越受到青睞。這種偏好源於其與現代 JavaScript 功能的卓越集成，特別是 async/await，這增強了程式碼的可讀性和可維護性，尤其是在複雜的場景中。

為什麼 fsPromises 是首選

1. 非同步/等待相容性

fsPromises 與 async/await 無縫集成，允許以更同步、直觀的方式建立非同步程式碼。

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

async function readAndProcessFile() {
    try {
        const data = await fs.readFile('input.txt', 'utf8');
        const processedData = data.toUpperCase();
        await fs.writeFile('output.txt', processedData);
        console.log('File processed successfully');
    } catch (err) {
        console.error('Error processing file:', err);
    }
}

readAndProcessFile();

2. 簡化的錯誤處理

借助 async/await 和 fsPromises，使用 try/catch 區塊、鏡像同步程式碼結構，錯誤處理變得更加簡單。

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

async function copyFile(source, destination) {
    try {
        await fs.copyFile(source, destination);
        console.log(`${source} was copied to ${destination}`);
    } catch (err) {
        console.error('Error copying file:', err);
    }
}

copyFile('source.txt', 'destination.txt');

3. 避免回調地獄

傳統的 fs 方法依賴回調，這在處理多個非同步操作時可能會導致深度嵌套、難以閱讀的程式碼。 fsPromises 透過返回 Promises 解決了這個問題，Promises 可以透過 async/await 連結或管理。

// Traditional fs (callback hell)
fs.readdir('directory', (err, files) => {
    if (err) throw err;
    files.forEach((file) => {
        fs.readFile(`directory/${file}`, 'utf8', (err, content) => {
            if (err) throw err;
            fs.writeFile(`processed/${file}`, content.toUpperCase(), (err) => {
                if (err) throw err;
                console.log(`Processed ${file}`);
            });
        });
    });
});

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

async function processDirectory() {
    try {
        const files = await fs.readdir('directory');
        for (const file of files) {
            const content = await fs.readFile(`directory/${file}`, 'utf8');
            await fs.writeFile(`processed/${file}`, content.toUpperCase());
            console.log(`Processed ${file}`);
        }
    } catch (err) {
        console.error('Error processing directory:', err);
    }
}

processDirectory();

4. 提高程式碼一致性

利用 fsPromises 可以提高程式碼庫的一致性，特別是在廣泛使用 Promise 或 async/await 進行其他非同步操作的專案中。

5. 部分場景表現更佳

雖然效能差異通常可以忽略不計，但 fsPromises 可以在涉及多個非同步操作的場景中提高程式碼執行效率，因為它避免了管理大量回呼的開銷。

fs 什麼時候仍然相關？

儘管 fsPromises 具有優勢，但在某些情況下傳統 fs 模組仍然適用：

1. 遺留程式碼庫：尚未更新的舊專案可能仍依賴基於回呼的 fs 方法。

2. 簡單腳本：對於不需要額外抽象承諾的快速一次性腳本，fs 可能更簡單。

3. 具體流操作：一些高級流操作仍然主要透過傳統的fs模組支援。

4. 性能關鍵的低階操作：在極少數需要絕對最小開銷的情況下，傳統的 fs 方法可能是首選。

5. 與舊版 Node.js 版本的兼容性：如果需要支援舊版 Node.js 版本，傳統的 fs 模組可確保更廣泛的兼容性。

最佳實踐

1. 一致的 API 用法：為專案選擇 fsPromises 或 fs 並始終堅持使用它以保持程式碼一致性。

2. 錯誤處理：無論您使用哪個 API，請始終實施正確的錯誤處理。

3. 非同步操作：優先使用非同步方法而不是同步方法，以避免阻塞事件循環，特別是在伺服器環境中。

4. Promisification：如果需要使用傳統的 fs 模組，可以考慮使用 util.promisify() 將基於回調的方法轉換為基於 Promise 的方法。
   

const fs = require('fs');
const util = require('util');
const readFile = util.promisify(fs.readFile);

async function readFileContent() {
    try {
        const content = await readFile('example.txt', 'utf8');
        console.log(content);
    } catch (err) {
        console.error('Error reading file:', err);
    }
}

結論

對於大多數現代 Node.js 應用程序，fsPromises 是建議的選擇，因為它與 async/await 兼容、提高了可讀性並且更容易處理錯誤。然而，傳統的 fs 模組仍然佔有一席之地，特別是在遺留系統、簡單腳本或需要低階控制的特定用例中。當開始一個新專案或重構現有專案時，請考慮採用 fsPromises 在檔案系統操作中充分利用現代 JavaScript 功能的強大功能。