node中的fs模塊、path模塊怎么用

Node中的fs模塊、path模塊怎么用

在Node.js中，fs模塊和path模塊是兩個非常核心的模塊，它們分別用于文件系統操作和路徑處理。本文將詳細介紹這兩個模塊的使用方法，并通過示例代碼幫助讀者更好地理解它們的功能。

1. fs模塊

fs模塊是Node.js中用于與文件系統進行交互的核心模塊。它提供了同步和異步兩種操作方式，允許開發者讀取、寫入、刪除文件，以及操作目錄等。

1.1 引入fs模塊

在使用fs模塊之前，首先需要引入它：

const fs = require('fs');

1.2 讀取文件

fs模塊提供了多種讀取文件的方法，最常用的是fs.readFile和fs.readFileSync。

1.2.1 異步讀取文件

fs.readFile方法用于異步讀取文件內容：

fs.readFile('example.txt', 'utf8', (err, data) => {
    if (err) {
        console.error('讀取文件出錯:', err);
        return;
    }
    console.log('文件內容:', data);
});

• 第一個參數是文件路徑。
• 第二個參數是編碼格式，通常使用utf8。
• 第三個參數是回調函數，當文件讀取完成后調用?；卣{函數的第一個參數是錯誤對象，第二個參數是文件內容。

1.2.2 同步讀取文件

fs.readFileSync方法用于同步讀取文件內容：

try {
    const data = fs.readFileSync('example.txt', 'utf8');
    console.log('文件內容:', data);
} catch (err) {
    console.error('讀取文件出錯:', err);
}

• 該方法直接返回文件內容，如果讀取失敗則拋出異常。

1.3 寫入文件

fs模塊提供了fs.writeFile和fs.writeFileSync方法用于寫入文件。

1.3.1 異步寫入文件

fs.writeFile方法用于異步寫入文件：

fs.writeFile('example.txt', 'Hello, Node.js!', 'utf8', (err) => {
    if (err) {
        console.error('寫入文件出錯:', err);
        return;
    }
    console.log('文件寫入成功');
});

• 第一個參數是文件路徑。
• 第二個參數是要寫入的內容。
• 第三個參數是編碼格式。
• 第四個參數是回調函數，當文件寫入完成后調用。

1.3.2 同步寫入文件

fs.writeFileSync方法用于同步寫入文件：

try {
    fs.writeFileSync('example.txt', 'Hello, Node.js!', 'utf8');
    console.log('文件寫入成功');
} catch (err) {
    console.error('寫入文件出錯:', err);
}

• 該方法直接寫入文件內容，如果寫入失敗則拋出異常。

1.4 追加文件內容

fs模塊提供了fs.appendFile和fs.appendFileSync方法用于追加文件內容。

1.4.1 異步追加文件內容

fs.appendFile方法用于異步追加文件內容：

fs.appendFile('example.txt', '\n追加的內容', 'utf8', (err) => {
    if (err) {
        console.error('追加文件內容出錯:', err);
        return;
    }
    console.log('文件內容追加成功');
});

• 第一個參數是文件路徑。
• 第二個參數是要追加的內容。
• 第三個參數是編碼格式。
• 第四個參數是回調函數，當文件內容追加完成后調用。

1.4.2 同步追加文件內容

fs.appendFileSync方法用于同步追加文件內容：

try {
    fs.appendFileSync('example.txt', '\n追加的內容', 'utf8');
    console.log('文件內容追加成功');
} catch (err) {
    console.error('追加文件內容出錯:', err);
}

• 該方法直接追加文件內容，如果追加失敗則拋出異常。

1.5 刪除文件

fs模塊提供了fs.unlink和fs.unlinkSync方法用于刪除文件。

1.5.1 異步刪除文件

fs.unlink方法用于異步刪除文件：

fs.unlink('example.txt', (err) => {
    if (err) {
        console.error('刪除文件出錯:', err);
        return;
    }
    console.log('文件刪除成功');
});

• 第一個參數是文件路徑。
• 第二個參數是回調函數，當文件刪除完成后調用。

1.5.2 同步刪除文件

fs.unlinkSync方法用于同步刪除文件：

try {
    fs.unlinkSync('example.txt');
    console.log('文件刪除成功');
} catch (err) {
    console.error('刪除文件出錯:', err);
}

• 該方法直接刪除文件，如果刪除失敗則拋出異常。

1.6 操作目錄

fs模塊還提供了操作目錄的方法，如創建目錄、讀取目錄內容等。

1.6.1 創建目錄

fs.mkdir方法用于異步創建目錄：

fs.mkdir('newDir', (err) => {
    if (err) {
        console.error('創建目錄出錯:', err);
        return;
    }
    console.log('目錄創建成功');
});

• 第一個參數是目錄路徑。
• 第二個參數是回調函數，當目錄創建完成后調用。

1.6.2 讀取目錄內容

fs.readdir方法用于異步讀取目錄內容：

fs.readdir('newDir', (err, files) => {
    if (err) {
        console.error('讀取目錄內容出錯:', err);
        return;
    }
    console.log('目錄內容:', files);
});

• 第一個參數是目錄路徑。
• 第二個參數是回調函數，當目錄內容讀取完成后調用?；卣{函數的第一個參數是錯誤對象，第二個參數是目錄中的文件列表。

1.6.3 刪除目錄

fs.rmdir方法用于異步刪除目錄：

fs.rmdir('newDir', (err) => {
    if (err) {
        console.error('刪除目錄出錯:', err);
        return;
    }
    console.log('目錄刪除成功');
});

• 第一個參數是目錄路徑。
• 第二個參數是回調函數，當目錄刪除完成后調用。

2. path模塊

path模塊是Node.js中用于處理文件路徑的核心模塊。它提供了一系列方法，用于解析、拼接、規范化路徑等操作。

2.1 引入path模塊

在使用path模塊之前，首先需要引入它：

const path = require('path');

2.2 路徑拼接

path.join方法用于將多個路徑片段拼接成一個完整的路徑：

const fullPath = path.join(__dirname, 'newDir', 'example.txt');
console.log('完整路徑:', fullPath);

• __dirname是當前模塊文件所在的目錄路徑。
• path.join方法會自動處理路徑分隔符，確保生成的路徑在不同操作系統上都能正確工作。

2.3 路徑解析

path.parse方法用于解析路徑，返回一個包含路徑各個部分的對象：

const pathObj = path.parse('/home/user/dir/file.txt');
console.log('路徑對象:', pathObj);

• 返回的對象包含以下屬性：
  • root：根目錄。
  • dir：文件所在的目錄。
  • base：文件名（包含擴展名）。
  • ext：文件擴展名。
  • name：文件名（不包含擴展名）。

2.4 路徑規范化

path.normalize方法用于規范化路徑，處理路徑中的.和..：

const normalizedPath = path.normalize('/home/user/../dir/./file.txt');
console.log('規范化路徑:', normalizedPath);

• 該方法會解析路徑中的.和..，生成一個規范化的路徑。

2.5 獲取相對路徑

path.relative方法用于獲取從一個路徑到另一個路徑的相對路徑：

const relativePath = path.relative('/home/user', '/home/user/dir/file.txt');
console.log('相對路徑:', relativePath);

• 第一個參數是起始路徑。
• 第二個參數是目標路徑。
• 返回的是從起始路徑到目標路徑的相對路徑。

2.6 獲取絕對路徑

path.resolve方法用于將路徑或路徑片段解析為絕對路徑：

const absolutePath = path.resolve('newDir', 'example.txt');
console.log('絕對路徑:', absolutePath);

• 該方法會將路徑片段解析為絕對路徑，類似于cd命令的效果。

2.7 獲取路徑的擴展名

path.extname方法用于獲取路徑的擴展名：

const ext = path.extname('/home/user/file.txt');
console.log('擴展名:', ext);

• 返回的是路徑的擴展名，包括.。

2.8 獲取路徑的目錄名

path.dirname方法用于獲取路徑的目錄名：

const dir = path.dirname('/home/user/file.txt');
console.log('目錄名:', dir);

• 返回的是路徑的目錄部分。

2.9 獲取路徑的文件名

path.basename方法用于獲取路徑的文件名：

const fileName = path.basename('/home/user/file.txt');
console.log('文件名:', fileName);

• 返回的是路徑的文件名部分，包含擴展名。

2.10 獲取路徑的文件名（不包含擴展名）

path.basename方法還可以通過第二個參數指定擴展名，返回不包含擴展名的文件名：

const fileNameWithoutExt = path.basename('/home/user/file.txt', '.txt');
console.log('文件名（不包含擴展名）:', fileNameWithoutExt);

• 第二個參數是要去除的擴展名。

3. 綜合示例

下面是一個綜合使用fs模塊和path模塊的示例，展示了如何讀取一個目錄中的所有文件，并將它們的路徑和內容輸出到控制臺：

const fs = require('fs');
const path = require('path');

const dirPath = path.join(__dirname, 'newDir');

fs.readdir(dirPath, (err, files) => {
    if (err) {
        console.error('讀取目錄內容出錯:', err);
        return;
    }

    files.forEach(file => {
        const filePath = path.join(dirPath, file);
        fs.readFile(filePath, 'utf8', (err, data) => {
            if (err) {
                console.error('讀取文件出錯:', err);
                return;
            }
            console.log(`文件路徑: ${filePath}`);
            console.log(`文件內容: ${data}`);
        });
    });
});

• 該示例首先使用path.join方法拼接目錄路徑，然后使用fs.readdir方法讀取目錄內容，最后使用fs.readFile方法讀取每個文件的內容并輸出到控制臺。

4. 總結

fs模塊和path模塊是Node.js中非常重要的兩個模塊，它們分別用于文件系統操作和路徑處理。通過本文的介紹和示例代碼，讀者應該能夠掌握這兩個模塊的基本使用方法，并能夠在實際項目中靈活運用它們。

在實際開發中，fs模塊和path模塊經常與其他模塊（如http模塊、stream模塊等）結合使用，以實現更復雜的功能。希望本文能夠幫助讀者更好地理解和使用這兩個模塊，為Node.js開發打下堅實的基礎。