FS 方法介绍

概述

FS（File System）模块是 Node.js 的核心模块之一，用于处理文件和目录的读写操作。它提供了一些常用的方法，使程序员能够轻松地访问和操作文件系统。

引入模块

在使用 FS 模块之前，需要先引入该模块：

const fs = require('fs');

常用方法

1. 读取文件内容

/**
 * 异步方式读取文件内容
 * @param {string} path - 文件路径
 * @param {string} encoding - 文件编码格式（可选，默认为 'utf-8'）
 * @param {function} callback - 回调函数，用于处理读取结果
 */
fs.readFile(path, encoding, callback);

/**
 * 同步方式读取文件内容
 * @param {string} path - 文件路径
 * @param {string} encoding - 文件编码格式（可选，默认为 'utf-8'）
 * @returns {string} - 文件内容
 */
fs.readFileSync(path, encoding);

2. 写入文件内容

/**
 * 异步方式将数据写入文件
 * @param {string} path - 文件路径
 * @param {string|Buffer} data - 要写入的数据
 * @param {object} options - 可选参数对象，用于设置写入选项（如编码格式、写入方式等）
 * @param {function} callback - 回调函数，用于处理写入结果
 */
fs.writeFile(path, data, options, callback);

/**
 * 同步方式将数据写入文件
 * @param {string} path - 文件路径
 * @param {string|Buffer} data - 要写入的数据
 * @param {object} options - 可选参数对象，用于设置写入选项（如编码格式、写入方式等）
 */
fs.writeFileSync(path, data, options);

3. 检查文件/目录是否存在

/**
 * 检查文件或目录是否存在
 * @param {string} path - 文件或目录路径
 * @param {function} callback - 回调函数，用于处理检查结果
 */
fs.exists(path, callback);

/**
 * 同步方式检查文件或目录是否存在
 * @param {string} path - 文件或目录路径
 * @returns {boolean} - true 表示存在，false 表示不存在
 */
fs.existsSync(path);

4. 创建目录

/**
 * 异步方式创建目录
 * @param {string} path - 目录路径
 * @param {object|number} options - 可选参数对象（如权限等），或数字（如 0o777）
 * @param {function} callback - 回调函数，用于处理创建结果
 */
fs.mkdir(path, options, callback);

/**
 * 同步方式创建目录
 * @param {string} path - 目录路径
 * @param {object|number} options - 可选参数对象（如权限等），或数字（如 0o777）
 */
fs.mkdirSync(path, options);

5. 删除文件/目录

/**
 * 异步方式删除文件或目录
 * @param {string} path - 文件或目录路径
 * @param {function} callback - 回调函数，用于处理删除结果
 */
fs.unlink(path, callback);

/**
 * 同步方式删除文件或目录
 * @param {string} path - 文件或目录路径
 */
fs.unlinkSync(path);

总结

以上是 FS 模块的一些常用方法，可以帮助程序员在 Node.js 环境中进行文件和目录的读写操作。更多详细的方法和用法可以参考 Node.js 官方文档（https://nodejs.org/api/fs.html）。

注：所有的异步方法都接受一个回调函数作为最后一个参数，用于处理操作结果。回调函数的第一个参数通常是错误对象，后续参数是操作的结果。同步方法则直接返回结果或抛出异常。