Node.js는 파일 시스템 모듈을 어떻게 사용합니까? 일반적으로 사용되는 fs 모듈 방법 소개

이 글에서는 Node.js의 파일 시스템 모듈을 살펴보고, 파일 시스템 모듈(fs 모듈) 사용 방법을 소개하고, 가장 일반적이고 유용한 fs 메소드 중 일부를 소개합니다.

파일 시스템 모듈(줄여서 fs)을 사용하면 컴퓨터의 파일 시스템에 액세스하고 상호 작용할 수 있습니다. [추천 학습: "nodejs tutorialfs）允许我们访问计算机上的文件系统并与之交互。【推荐学习：《nodejs 教程》】

使用 fs 模块，我们可以执行以下操作：

• 创建文件和目录
• 修改文件和目录
• 删除文件和目录
• 读取文件和目录的内容
• ...

建议：文件系统模块比较复杂，建议查看官方文档，你可以看到所有的方法。

本文将向您介绍最常见和最有用的 fs 方法。事不宜迟，让我们看看这些方法是什么。

如何使用 fs

文件系统模块是一个核心的 Node.js 模块。这意味着我们不必安装它。我们唯一需要做的就是将 fs 模块导入到自己的文件中。

因此，在文件顶部添加：

const fs = require('fs')

现在，我们可以使用前缀 fs 从文件系统模块调用任何方法。

或者，我们可以只从 fs API 导入所需的方法，如下所示：

const { writeFile, readFile } = require('fs')

注意：为了方便起见，我们还需要导入 path 模块。它是另一个核心 Node.js 模块，它允许我们使用文件和目录路径。

导入 fs 模块后，在文件中添加：

const path = require('path')

使用文件系统模块时，path 模块不是必需的。但它对我们有很大的帮助！

同步与异步

需要注意的是，默认情况下，所有 fs 方法都是异步的。但是，我们可以通过在方法末尾添加 Sync 来使用同步版本。

例如，writeFile 方法的同步版本为 writeFileSync。同步方法将同步的完成代码，因此它们阻塞了主线程。阻塞 Node.js 中的主线程被认为是不好的做法，我们不应该这么做。

因此，以下我们都将使用文件系统模块中的异步方法。

写入文件

要从 Node.js 应用程序写入文件，请使用 writeFile 方法。

writeFile 方法至少接受以下参数：

• 文件名
• 内容
• 回调

如果指定的文件已经存在，它会将旧内容替换为您作为参数提供的内容。如果指定的文件不存在，则创建一个新文件。

导入 fs 和 path 模块后，在文件中编写以下代码：

fs.writeFile('content.txt', 'All work and no play makes Jack a dull boy!', err => {
  if (err) throw err

  process.stdout.write('创建成功!')
})

上面的代码将创建了一个名为 content.txt 的新文件，并添加了文本 All work and no play makes Jack a dull boy! 作为内容。如果存在任何错误，回调函数将抛出该错误。否则，它将向控制台输出文件创建成功。

writeFile 还有其他变体，例如：

• fs.writeFileSync — 同步写入文件
• fsPromises.writeFile — 使用基于 Promise 的 API 写入文件

查看此要点：https://gist.github.com/catalinpit/571ba06c06214b5c8744036c6500af92

从文件中读取

在读取文件之前，需要创建并存储文件的路径。path 模块的路径在这里很方便。

使用 join 模块中的 path 方法，您可以创建文件路径，如下所示：

const filePath = path.join(process.cwd(), 'content.txt')

第一个参数 process.cwd() 返回当前工作目录。现在您已经有了文件路径，可以读取文件的内容了。

在文件中编写以下代码：

fs.readFile(filePath, (error, content) => {
  if (error) throw error

  process.stdout.write(content)
})

readFile 方法至少接受两个参数：

• 文件的路径
• 回调

如果有错误，它会抛出一个错误。否则，它会在终端中输出文件内容。

readFile 还有其他变体，例如：

• fs.readFileSync — 同步写入文件
• fsPromises.readFile"]

fs 모듈을 사용하면 다음 작업을 수행할 수 있습니다:

• 파일 및 디렉터리 생성

• 파일 및 디렉터리 수정

• 파일 및 디렉터리 삭제 🎜
• 파일 및 디렉터리 읽기 🎜
• ...🎜🎜🎜🎜제안의 내용: 파일 시스템 모듈은 비교적 복잡하므로 공식 문서 🎜, 모든 방법을 볼 수 있습니다. 🎜

🎜이 글에서는 가장 일반적이고 유용한 fs 방법을 소개합니다. 더 이상 고민하지 말고 이러한 방법이 무엇인지 살펴보겠습니다. 🎜

fs

사용 방법🎜파일 시스템 모듈은 Node.js의 핵심 모듈입니다. 즉, 설치할 필요가 없습니다. 우리가 해야 할 유일한 일은 fs 모듈을 자체 파일로 가져오는 것입니다. 🎜🎜그러므로 파일 상단에 다음을 추가하세요: 🎜

fs.readdir(process.cwd(), (error, files) => {
  if (error) throw error

  console.log(files)
})

🎜 이제 접두사 fs를 사용하여 파일 시스템 모듈에서 모든 메서드를 호출할 수 있습니다. 🎜🎜또는 다음과 같이 fs API에서 필요한 메서드를 가져올 수 있습니다. 🎜

fs.unlink(filePath, error => {
  if (error) throw error

  console.log('文件已删除!')
})

🎜🎜참고: 편의를 위해 path도 가져와야 합니다. 모듈. 이는 파일 및 디렉터리 경로 작업을 가능하게 하는 또 다른 핵심 Node.js 모듈입니다. 🎜🎜fs 모듈을 가져온 후 다음 파일을 추가하세요. 🎜

fs.mkdir(`${process.cwd()}/myFolder/secondFolder`, { recursive: true }, (err) => {
  if (err) throw err

  console.log('已成功创建文件夹!')
})

🎜파일 시스템 모듈을 사용할 때는 path 모듈이 필요하지 않습니다. 하지만 그것은 우리에게 많은 도움이 됩니다! 🎜

동기화 및 비동기

🎜주의해야 할 점은 기본적으로 모든 fs 메소드는 비동기식입니다. . 하지만 메서드 끝에 Sync를 추가하면 동기화된 버전을 사용할 수 있습니다. 🎜🎜예를 들어 writeFile 메서드의 동기 버전은 writeFileSync입니다. 동기 메서드는 코드를 동기적으로 완료하므로 기본 스레드를 차단합니다. Node.js에서 메인 스레드를 차단하는 것은 나쁜 습관으로 간주되므로 그렇게 해서는 안 됩니다. 🎜🎜그래서 아래에서는 모두 파일 시스템 모듈에서 비동기 방식을 사용하겠습니다. 🎜

파일 쓰기

🎜Node.js 애플리케이션에서 파일을 쓰려면 writeFile 메서드를 사용하세요. 🎜🎜writeFile 메소드는 최소한 다음 매개변수를 허용합니다: 🎜

• 파일 이름 🎜
• 콘텐츠 🎜
• 콜백 🎜🎜🎜지정된 파일이 이미 존재하는 경우 쓰기 작업을 수행합니다. 이전 콘텐츠를 인수로 제공한 내용으로 바꿉니다. 지정한 파일이 없으면 새 파일이 생성됩니다. 🎜🎜fs 및 path 모듈을 가져온 후 파일에 다음 코드를 작성합니다. 🎜

  fs.mkdir(`${process.cwd()}/myFolder`, err => {
    if (err) throw err
  
    console.log('已成功创建文件夹!')
  });

  🎜위 코드는 content.txt<라는 파일을 생성합니다. / code>를 입력하고 <code>모든 일을 하고 놀지 않으면 Jack을 둔한 소년으로 만듭니다!라는 텍스트를 콘텐츠로 추가했습니다. 오류가 있으면 콜백 함수에서 해당 오류가 발생합니다. 그렇지 않으면 파일이 성공적으로 생성되었다는 메시지가 콘솔에 출력됩니다. 🎜🎜writeFile 다음과 같은 다른 변형도 있습니다: 🎜
  • fs.writeFileSync — 동기식으로 파일 쓰기 🎜
  • fsPromises.writeFile < /code> — Promise 기반 API를 사용하여 파일에 쓰기 🎜🎜🎜🎜 이 요점을 확인하세요: https://gist.github.com/catalinpit/571ba06c06214b5c8744036c6500af92🎜</blockquote><h2 data-id="heading-3" >파일에서 읽기</h2>🎜파일을 읽기 전에 파일 경로를 생성하고 저장해야 합니다. <code>path 여기서는 모듈 경로가 편리합니다. 🎜🎜join 모듈의 path 메소드를 사용하면 다음과 같이 파일 경로를 생성할 수 있습니다: 🎜

    fs.rmdir(`${process.cwd()}/myFolder/`, { recursive: true }, err => {
      if (err) throw err
    
      console.log('已成功删除文件夹!')
    })

    🎜첫 번째 매개변수 process.cwd()< /code > 현재 작업 디렉터리를 반환합니다. 이제 파일 경로가 있으므로 파일 내용을 읽을 수 있습니다. 🎜🎜파일에 다음 코드를 작성하세요: 🎜<div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:js;toolbar:false;">fs.rmdir(`${process.cwd()}/myFolder/`, err =&gt; { if (err) throw err console.log(&amp;#39;已成功删除文件夹!&amp;#39;) })</pre><div class="contentsignin">로그인 후 복사</div></div><div class="contentsignin">로그인 후 복사</div></div>🎜 <code>readFile 메서드는 최소한 두 개의 매개 변수를 허용합니다: 🎜
    • 파일 경로 🎜
    • 콜백 🎜🎜🎜If 오류가 있으면 오류가 발생합니다. 그렇지 않으면 터미널에 파일 내용이 인쇄됩니다. 🎜🎜readFile 다음과 같은 다른 변형도 있습니다: 🎜
      • fs.readFileSync — 동기식으로 파일 쓰기 🎜
      • fsPromises.readFile < /code> — Promise 기반 API를 사용하여 파일에 쓰기 🎜🎜🎜🎜 이 요점을 확인하세요: https://gist.github.com/catalinpit/badc2a539a44412892a0e05a9575d54d🎜</blockquote><h2 data-id="heading-4">读取目录的内容</h2><p>在目录中显示文件与读取文件内容非常相似。但是，不是传递文件路径，而是传递当前工作目录（我们可以传递任何其他目录）。</p><p>然后，传递一个回调函数来处理响应。在文件中编写以下代码：</p><div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:js;toolbar:false;">fs.readdir(process.cwd(), (error, files) =&gt; { if (error) throw error console.log(files) })</pre><div class="contentsignin">로그인 후 복사</div></div><div class="contentsignin">로그인 후 복사</div></div><p>到目前为止，我们只使用 <code>process.stdout.write 将内容输出到终端。但是，您可以简单地使用 console.log，就像上面的代码片段一样。

        如果运行该应用程序，我们应该会得到一个包含目录中所有文件的数组。

        查看此要点：https://gist.github.com/catalinpit/f82c4e6ae3acd5d97efdecb0bc67979e

        删除文件

        文件系统模块有一种方法，允许您删除文件。但是，需要注意的是，它只适用于文件，不适用于目录。

        当以文件路径作为参数调用 unlink 方法时，它将删除该文件。将以下代码段添加到文件中：

        fs.unlink(filePath, error => {
          if (error) throw error
        
          console.log('文件已删除!')
        })

        如果您重新运行代码，您的文件将被删除！

        查看此要点：https://gist.github.com/catalinpit/b1201434218c400f77e042109bfce99e

        创建目录

        我们可以使用 mkdir 方法异步创建目录。在文件中编写以下代码：

        fs.mkdir(`${process.cwd()}/myFolder/secondFolder`, { recursive: true }, (err) => {
          if (err) throw err
        
          console.log('已成功创建文件夹!')
        })

        首先，要在当前工作目录中创建一个新文件夹。如前所述，您可以使用 cwd() 方法从 process 对象获取当前工作目录。

        然后，传递要创建的一个或多个文件夹。但是，这并不意味着您必须在当前工作目录中创建新文件夹。你可以在任何地方创建它们。

        现在，第二个参数是递归选项。如果未将其设置为 true，则无法创建多个文件夹。如果将 recursive 选项设置为 false，上述代码将给出一个错误。试试看！

        但是，如果您只想创建一个文件夹，则无需将 recursive 选项设置为 true。

        以下代码可以正常工作！

        fs.mkdir(`${process.cwd()}/myFolder`, err => {
          if (err) throw err
        
          console.log('已成功创建文件夹!')
        });

        因此，我想强调使用 recursive。如果要在文件夹中创建文件夹，则需要将其设置为 true。它将创建所有文件夹，即使它们不存在。

        另一方面，如果您只想创建一个文件夹，可以将其保留为 false。

        查看此要点：https://gist.github.com/catalinpit/09bad802541102c0cce2a2e4c3985066

        删除目录

        删除目录的逻辑类似于创建目录。如果您查看为创建目录而编写的代码和下面的代码，您会发现相似之处。

        因此，在文件中编写以下代码：

        fs.rmdir(`${process.cwd()}/myFolder/`, { recursive: true }, err => {
          if (err) throw err
        
          console.log('已成功删除文件夹!')
        })

        使用文件系统模块中的 rmdir 方法，并传递以下参数：

        • 要删除的目录
        • 递归属性
        • 回调

        如果将 recursive 属性设置为 true，它将删除文件夹及其内容。请务必注意，如果文件夹中包含内容，则需要将其设置为 true。否则，您将得到一个错误。

        以下代码段仅在文件夹为空时有效：

        fs.rmdir(`${process.cwd()}/myFolder/`, err => {
          if (err) throw err
        
          console.log('已成功删除文件夹!')
        })

        如果 myFolder 中有其他文件和/或文件夹，如果未传递 { recursive: true }，则会出现错误。

        知道何时使用 recursive 选项以及何时不避免问题是很重要的。

        查看此要点：https://gist.github.com/catalinpit/a8cb6aca75cef8d6ac5043eae9ba22ce

        目录/文件重命名

        使用 fs 模块，您可以重命名目录和文件。下面的代码片段显示了如何使用 rename 方法进行此操作。

        // 重命名一个目录fs.rename(`${process.cwd()}/myFolder/secondFolder`, `${process.cwd()}/myFolder/newFolder`, err => {
          if (err) throw err
        
          console.log('目录重命名!')
        });// 重命名一个文件fs.rename(`${process.cwd()}/content.txt`, `${process.cwd()}/newFile.txt`, err => {
          if (err) throw err
        
          console.log('文件重命名!')
        });

        rename 方法包含三个参数：

        • 第一个参数是现有的文件夹/文件
        • 第二个参数是新名称
        • 回调

        因此，要重命名文件或目录，我们需要传递当前文件/目录的名称和新名称。运行应用程序后，应更新目录/文件的名称。

        需要注意的是，如果新路径已经存在（例如，文件/文件夹的新名称），它将被覆盖。因此，请确保不要错误地覆盖现有文件/文件夹。

        查看此要点：https://gist.github.com/catalinpit/5c3e7c6ae39d09996ff67175a719122e

        向文件中添加内容

        我们还可以使用 appendFile 方法向现有文件添加新内容。

        如果比较 writeFile 和 appendFile 这两种方法，我们可以发现它们是相似的。传递文件路径、内容和回调。

        fs.appendFile(filePath, '\nAll work and no play makes Jack a dull boy!', err => {
          if (err) throw err
          
          console.log('All work and no play makes Jack a dull boy!')
        })

        上面的代码片段演示了如何向现有文件添加新内容。如果运行应用程序并打开文件，您应该会看到其中的新内容。

        查看此要点：https://gist.github.com/catalinpit/7c8d40db53dea9e6831f9ee89d92475c

        原文地址：https://juejin.cn/post/6991848361527607327

        作者：lio_zero

        更多编程相关知识，请访问：编程视频！！

        위 내용은 Node.js는 파일 시스템 모듈을 어떻게 사용합니까? 일반적으로 사용되는 fs 모듈 방법 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!