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开发打下坚实的基础。