完整指南：如何使用 Node.js 复制文件

男娘i 2024-02-28 06:41 17阅读 0赞

文件拷贝指的是将一个文件的数据复制到另一个文件中，使目标文件与源文件内容一致。**[Node.js][]** 提供了文件系统模块 fs，通过该模块可以访问文件系统，实现文件操作，包括拷贝文件。

![79e8799857dd2791a0a62ea450419b78.png][]

### Node.js 中文件拷贝方法 ###

在 Node.js 中，有几种常用的方法可以用来实现文件拷贝：

**1.使用 fs.copyFile()** Node.js v8.5.0 版本引入了 `fs.copyFile()` 方法，可以更简单地拷贝文件:

const fs = require('fs');
    fs.copyFile('source.txt', 'target.txt', (err) => {
      if (err) throw err;
      console.log('文件拷贝成功!');  
    });

`fs.copyFile()` 会根据操作系统的支持，尽可能使用零拷贝的方式复制文件，效率很高。

**2.使用 fs.createReadStream() 和 fs.createWriteStream()** 可以使用文件流将源文件流式传输到目标文件:

const fs = require('fs');
    const readStream = fs.createReadStream('source.txt');
    const writeStream = fs.createWriteStream('target.txt');
    readStream.pipe(writeStream);
    writeStream.on('finish', () => {
      console.log('文件拷贝完成');
    });

这种方法适合处理大文件，可以分多次将文件流传输。

**3.同步方法 fs.readFileSync() 和 fs.writeFileSync()** 使用 `fs.readFileSync()` 和 `fs.writeFileSync()` 可以实现同步文件拷贝:

const fs = require('fs');
    let data = fs.readFileSync('source.txt');
    fs.writeFileSync('target.txt', data);

但同步方法的性能并不如上面两种异步方法高。

### 基本概念 ###

在文件拷贝过程中，需要注意以下几个基本概念：

*  **源文件路径和目标文件路径：** 拷贝文件需要明确指定源文件的路径和目标文件的路径。
 *  **同步和异步操作：** Node.js 提供了同步和异步的文件操作方法。同步方法会阻塞代码执行，直到操作完成，而异步方法则不会阻塞代码，适合于处理大量文件或网络操作。

### 实践案例 ###

下面是一个使用 Express 框架的简单实践案例，演示如何在 Node.js 中拷贝文件：

1.首先，确保你已经安装了 Node.js 和 Express。

2.创建一个新的 Express 项目，并在项目目录下创建两个文件夹：`source` 和 `destination`。

3.在 `source` 文件夹中放入要拷贝的源文件，例如 `source.txt`。

4.在 Express 应用的主文件（例如：index.js）中，引入必要的模块（需安装 express）并添加以下代码：

在浏览器或 API 工具（如：[Apifox][]）中访问 `http://localhost:3000/copy`，将会触发文件拷贝操作。

![f3bffae3bc42a33b77f69dc84e9d8031.png][]

![63de230ee1b0492cf9a98295b8ceb153.png][]

### 提示、技巧和注意事项 ###

*  对于大型文件，使用流（stream）的方式可以提高性能和效率，避免一次性加载整个文件到内存中。
 *  在实际开发中，可以考虑使用 `fs-extra` 等第三方库，它们提供了更多便捷的文件操作方法，避免手动处理一些错误和边界情况。
 *  在进行文件操作时，要注意处理可能出现的异常情况，如文件不存在、读写权限等。

### 通过 Apifox 调试后端接口 ###

Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter， 支持调试 **[http][]**(s)、WebSocket、Socket、**[gRPC][]**、Dubbo 等协议的接口，并且集成了 **[IDEA 插件][IDEA]**。在后端人员写完服务接口时，测试阶段可以通过 Apifox 来校验接口的正确性，图形化界面极大的方便了项目的上线效率。

![c775b7cbcf5e7de85515cdc03d3c8639.png][]

### 总结 ###

文件拷贝是在 Node.js 开发中常见的任务之一。本文介绍了几种常用的文件拷贝方法，包括基于回调的方式、使用流的方式以及第三方库。在进行文件操作时，要注意异常处理和性能优化，以确保代码的稳定性和效率。

***知识扩展：***

*  **[如何在线建一个 JAVA 的 Spring Boot 项目？Spring Boot 快速入门 Helloworld 示例][JAVA _ Spring Boot _Spring Boot _ Helloworld]**
 *  **[FastAPI 中怎么设置超时时间？FastAPI 中设置超时时间的几种方法][FastAPI _FastAPI]**

***参考链接:***

*  *Node.js 官方文档: [Node.js][Node.js 1]*
 *  *`fs` 模块文档: [File system | Node.js v20.7.0 Documentation][File system _ Node.js v20.7.0 Documentation]*
 *  *`fs-extra` 模块文档: [https://github.com/jprichardson/node-fs-extra][https_github.com_jprichardson_node-fs-extra]*

[Node.js]: https://apifox.com/apiskills/how-to-install-nodejs/
[79e8799857dd2791a0a62ea450419b78.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/28/f82f9749d7644a93b40d7a0ead3b2bbc.png
[Apifox]: https://app.apifox.com/
[f3bffae3bc42a33b77f69dc84e9d8031.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/28/f13814ddd74d4d489e3a0f4beebbf570.png
[63de230ee1b0492cf9a98295b8ceb153.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/28/9ede74bff157416cb1170112e6c3b4e1.png
[http]: https://apifox.com/apiskills/the-5-pillars-of-every-http-request/
[gRPC]: https://apifox.com/apiskills/introduction-to-grpc/
[IDEA]: https://apifox.com/apiskills/apifox-auto-generates-api-docs/
[c775b7cbcf5e7de85515cdc03d3c8639.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/28/b15fb6a1ac7f4a08a124096a156dd7cf.png
[JAVA _ Spring Boot _Spring Boot _ Helloworld]: https://apifox.com/apiskills/java-springboot-online/
[FastAPI _FastAPI]: https://apifox.com/apiskills/fastapi-setup-timeout/
[Node.js 1]: https://nodejs.org/
[File system _ Node.js v20.7.0 Documentation]: https://nodejs.org/api/fs.html
[https_github.com_jprichardson_node-fs-extra]: https://github.com/jprichardson/node-fs-extra