Node.js はファイル システム モジュールをどのように使用しますか?一般的に使用される fs モジュールメソッドの紹介

この記事では、Node.js のファイル システム モジュールについて説明し、ファイル システム モジュール (fs モジュール) の使用方法を紹介し、最も一般的で便利な fs メソッドのいくつかを紹介します。

ファイル システム モジュール (略して fs) を使用すると、コンピュータ上のファイル システムにアクセスして対話することができます。 [推奨される学習: 「nodejs チュートリアル 」]

fs モジュールを使用すると、次の操作を実行できます:

• ファイルの作成
• ファイルとディレクトリの変更
• ファイルとディレクトリの削除
• ファイルとディレクトリの内容の読み取り
• ...

提案: ファイル システム モジュールは比較的複雑です。公式ドキュメントを確認することをお勧めします。すべてのメソッドが確認できます。

この記事では、最も一般的で便利な fs メソッドを紹介します。早速、これらのメソッドが何であるかを見てみましょう。

使用方法 fs

ファイルシステム モジュールは、コア Node.js モジュールです。つまり、インストールする必要はありません。必要なのは、fs モジュールを独自のファイルにインポートすることだけです。

したがって、ファイルの先頭に次のコードを追加します:

const fs = require('fs')

これで、プレフィックス fs を使用してファイル システム モジュールから任意のメソッドを呼び出すことができます。

または、次のように fs API から必要なメソッドをインポートすることもできます:

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

Note: 便宜上、安全のためそのため、path モジュールもインポートする必要があります。これは、ファイルとディレクトリのパスを操作できるようにするもう 1 つのコア 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鈍感な少年! というテキストを追加しました。エラーがある場合、コールバック関数はそのエラーをスローします。それ以外の場合は、ファイルが正常に作成されたことがコンソールに出力されます。

writeFile 他にも次のようなバリエーションがあります。

• fs.writeFileSync — ファイルを同期的に書き込みます
• fsPromises.writeFile — Promise ベースの API を使用してファイルを書き込みます

この要点を確認してください: https://gist.github.com/catalinpit/571ba06c06214b5c8744036c6500af92

ファイルからの読み取り

ファイルを読み取る前に、ファイルへのパスを作成して保存する必要があります。

path ここでモジュールのパスを指定すると便利です。 join

モジュールの

path メソッドを使用すると、次のようなファイル パスを作成できます:

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

最初のパラメータプロセス。 cwd()

現在の作業ディレクトリを返します。ファイル パスがわかったので、ファイルの内容を読み取ることができます。

次のコードをファイルに記述します:

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

  process.stdout.write(content)
})

readFile

このメソッドは少なくとも 2 つのパラメータを受け入れます:

ファイルへのパス

Callback
• エラーがある場合は、エラーがスローされます。それ以外の場合は、ファイルの内容が端末に表示されます。

readFile

他にも次のようなバリエーションがあります。

fs.readFileSync

— ファイルを同期的に書き込みます
• fsPromises.readFile
— Promise ベースの API を使用してファイルを書き込む
この要点を確認してください: https://gist.github.com/catalinpit/badc2a539a44412892a0e05a9575d54d

读取目录的内容

在目录中显示文件与读取文件内容非常相似。但是，不是传递文件路径，而是传递当前工作目录（我们可以传递任何其他目录）。

然后，传递一个回调函数来处理响应。在文件中编写以下代码：

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

  console.log(files)
})

到目前为止，我们只使用 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 中国語 Web サイトの他の関連記事を参照してください。