node.js 17 文件操作

本文参考原文-http://bjbsair.com/2020-03-22/tech-info/2819.html
在讲完了模块概念后，这一篇我们看一下node.js中的文件操作。文件操作的API在fs模块中，fs全称为 "File System"。

绝大部分编程语言都会提供文件操作功能，node.js也不例外。下面我们主要看一下文件/目录的判断，文件的新增，删除，读取，写入，重命名和拷贝等。

node.js 文件操作

node.js有一个很大的特点，就是异步操作。这一点在文件操作中也一样。有些语言判断文件还是目录不会使用异步，但是node.js不一样，使用异步，通过回调函数进行处理。

所以学习node.js一定要有异步的概念，回调函数也是必须要理解的。后面会有关于异步处理的专门讲解。

如何判断传入路径为文件还是目录

首先需要引入fs模块，然后通过fs.stat方法中的回调函数进行判断对象是文件还是目录。

看一下示例代码，个人一直认为写代码不写注释就是拒绝团队合作，拒绝知识共享。

//1. 引入fs模块  
const fs = require('fs');  
  
//2. 调用fs.stat方法，传入文件，通过回调函数处理data对象  
fs.stat('./package.json', (err,data)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
      
    //3. 调用 isFile()方法判断是否为文件  
    console.log(`is file: ${data.isFile()}`)  
    //4. 调用 isDirectory()方法判断是否为目录  
    console.log(`is directory: ${data.isDirectory()}`)  
})

由于package.json是一个文件，所以打印输出时isFile:true。输出结果如下：

D:Projects
odejsNodeDemo>node app.js  
  
is file: true  
  
is directory: false

创建目录

同样需要引入"fs"模块。由于所有的文件操作都需要引入"fs"模块，后面的示例将不再强调。然后调用fs.mkdir()方法进行创建。

//1. 引入fs模块  
const fs = require('fs');  
//2. 调用mkdir()方法创建目录  
fs.mkdir('./testDir', (err)=>{  
    if(err){  
        console.log(err);  
        return;  
    }  
    console.log('创建目录完成')  
})

创建文件并写入文件

在创建文件时可以通过方法fs.writeFile()直接创建，并写入内容。

//1. 引入fs模块  
const fs = require('fs');  
//2. 创建并写入文件  
fs.writeFile('./test.txt','Hello, node.js', (err)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('创建写入文件成功')  
})

上面的代码示例创建了文件test.txt,并在文件中写入了"Hello, node.js"。

添加文件内容

如果只是在创建的时候写入文件内容肯定是不够的，任何处理文件的语言都需要提供添加文件内容的方法。node.js提供了fs.appendFile()方法。

//1. 引入fs模块  
const fs = require('fs');  
//2. 添加文件内容  
fs.appendFile('./test.txt', '
Hello Vincent', (err)=>{  
    if(err){  
        console.log(err)  
        return;  
    }  
    console.log('appendFile 成功')  
})

这时，如果我们打开test.txt文件，就会看到创建时写入的"Hello, node.js"以及这次我们添加的"Hello Vincent"。其中的" "是回车和换行。

Hello, node.js

Hello Vincent

读取文件内容

方法：fs.readFile(), 是一个异步方法。

示例如下。

//1. 引入fs模块  
const fs = require('fs');  
//2. 读取文件内容  
fs.readFile('./test.txt', (err, data)=>{  
    if(err){  
        consolog.log(err)  
        return  
    }  
    console.log(data.toString())  
})

读取目录

调用方法：fs.readdir(),读取后输出该目录下的子目录和文件。

示例代码

//1. 引入fs模块  
const fs = require('fs');  
//2. 读取  
fs.readdir('.', (err, data)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log(data)  
})

输出如下

D:Projects
odejsNodeDemo>node app.js  
[ 'app.js', 'testDir', 'package.json', 'test.txt' ]

重命名

调用方法fs.rename()。这个方法要注意的是，一方面是重命名，另一方面如果如果目标文件不在同一个目录，那么这个方法其实是移动文件到目标目录。

//1. 引入fs模块  
const fs = require('fs');  
//2. 重命名，移动文件（本例为移动文件）  
fs.rename('./test.txt', './testDir/test.txt', (err) => {  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('移动文件成功')  
})

上述示例把当前目录下的test.txt文件移动到了./testDir目录下。

删除文件

调用方法：fs.unlink()

示例代码

//1. 引入fs模块  
const fs = require('fs');  
//2. 删除文件  
fs.unlink('./test.txt', (err)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('删除文件成功')  
})

删除目录

调用方法： fs.rmdir().需要注意的是只有当目录是一个空目录时，才能被删除，否则会报错。所以需要先遍历目录，将目录下的文件或者子目录删除后，才能删除当前目录。如果子目录下还有子目录，就需要递归了。通过npm也可以下载另外的文件处理模块，可以直接删除目录，当然里面已经封装好了删除文件和子目录的代码。

下面是一个空目录删除的示例

//1. 引入fs模块  
const fs = require('fs');  
//2. 删除目录  
fs.rmdir('./testDir', (err)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('删除目录成功')  
})

字节流

在进入文件拷贝之前，我们有必要了解一下字节流。对于大文件的读取和写入，此时通过字节流来进行。

• 使用字节流读取文件：fs.createReadStream()
• 使用字节流写入文件：fs.createWriteStream()

拷贝文件

首先需要使用字节流读取源文件，然后创建写入文件流，最后通过pipe()方法进行拷贝。

const fs = require('fs')  
var readStream = fs.createReadStream('./test.MOV')  
  
var writeStream = fs.createWriteStream('./data/copied.MOV')  
readStream.pipe(writeStream)

代码量很少，简单方便，整个文件的拷贝就成功了。

总结

node.js对于文件的处理总体来说是简单便捷的，代码量少。异步操作贯穿真个fs模块，在实际编码工作中也是有一点挑战的。上面也讲过，实际工作中可以通过封装fs模块，写自己的文件操作模块，封装目录删除等。npm管理中也有一些文件操作模块可以借鉴。

欢迎朋友们留言交流。

node.js会不断更新，后续包括http, url, 数据库操作等内容。本文参考原文-http://bjbsair.com/2020-03-22/tech-info/2819/
在讲完了模块概念后，这一篇我们看一下node.js中的文件操作。文件操作的API在fs模块中，fs全称为 "File System"。

绝大部分编程语言都会提供文件操作功能，node.js也不例外。下面我们主要看一下文件/目录的判断，文件的新增，删除，读取，写入，重命名和拷贝等。

node.js 文件操作

node.js有一个很大的特点，就是异步操作。这一点在文件操作中也一样。有些语言判断文件还是目录不会使用异步，但是node.js不一样，使用异步，通过回调函数进行处理。

所以学习node.js一定要有异步的概念，回调函数也是必须要理解的。后面会有关于异步处理的专门讲解。

如何判断传入路径为文件还是目录

首先需要引入fs模块，然后通过fs.stat方法中的回调函数进行判断对象是文件还是目录。

看一下示例代码，个人一直认为写代码不写注释就是拒绝团队合作，拒绝知识共享。

//1. 引入fs模块  
const fs = require('fs');  
  
//2. 调用fs.stat方法，传入文件，通过回调函数处理data对象  
fs.stat('./package.json', (err,data)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
      
    //3. 调用 isFile()方法判断是否为文件  
    console.log(`is file: ${data.isFile()}`)  
    //4. 调用 isDirectory()方法判断是否为目录  
    console.log(`is directory: ${data.isDirectory()}`)  
})

由于package.json是一个文件，所以打印输出时isFile:true。输出结果如下：

D:Projects
odejsNodeDemo>node app.js  
  
is file: true  
  
is directory: false

创建目录

同样需要引入"fs"模块。由于所有的文件操作都需要引入"fs"模块，后面的示例将不再强调。然后调用fs.mkdir()方法进行创建。

//1. 引入fs模块  
const fs = require('fs');  
//2. 调用mkdir()方法创建目录  
fs.mkdir('./testDir', (err)=>{  
    if(err){  
        console.log(err);  
        return;  
    }  
    console.log('创建目录完成')  
})

创建文件并写入文件

在创建文件时可以通过方法fs.writeFile()直接创建，并写入内容。

//1. 引入fs模块  
const fs = require('fs');  
//2. 创建并写入文件  
fs.writeFile('./test.txt','Hello, node.js', (err)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('创建写入文件成功')  
})

上面的代码示例创建了文件test.txt,并在文件中写入了"Hello, node.js"。

添加文件内容

如果只是在创建的时候写入文件内容肯定是不够的，任何处理文件的语言都需要提供添加文件内容的方法。node.js提供了fs.appendFile()方法。

//1. 引入fs模块  
const fs = require('fs');  
//2. 添加文件内容  
fs.appendFile('./test.txt', '
Hello Vincent', (err)=>{  
    if(err){  
        console.log(err)  
        return;  
    }  
    console.log('appendFile 成功')  
})

这时，如果我们打开test.txt文件，就会看到创建时写入的"Hello, node.js"以及这次我们添加的"Hello Vincent"。其中的" "是回车和换行。

Hello, node.js

Hello Vincent

读取文件内容

方法：fs.readFile(), 是一个异步方法。

示例如下。

//1. 引入fs模块  
const fs = require('fs');  
//2. 读取文件内容  
fs.readFile('./test.txt', (err, data)=>{  
    if(err){  
        consolog.log(err)  
        return  
    }  
    console.log(data.toString())  
})

读取目录

调用方法：fs.readdir(),读取后输出该目录下的子目录和文件。

示例代码

//1. 引入fs模块  
const fs = require('fs');  
//2. 读取  
fs.readdir('.', (err, data)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log(data)  
})

输出如下

D:Projects
odejsNodeDemo>node app.js  
[ 'app.js', 'testDir', 'package.json', 'test.txt' ]

重命名

调用方法fs.rename()。这个方法要注意的是，一方面是重命名，另一方面如果如果目标文件不在同一个目录，那么这个方法其实是移动文件到目标目录。

//1. 引入fs模块  
const fs = require('fs');  
//2. 重命名，移动文件（本例为移动文件）  
fs.rename('./test.txt', './testDir/test.txt', (err) => {  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('移动文件成功')  
})

上述示例把当前目录下的test.txt文件移动到了./testDir目录下。

删除文件

调用方法：fs.unlink()

示例代码

//1. 引入fs模块  
const fs = require('fs');  
//2. 删除文件  
fs.unlink('./test.txt', (err)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('删除文件成功')  
})

删除目录

调用方法： fs.rmdir().需要注意的是只有当目录是一个空目录时，才能被删除，否则会报错。所以需要先遍历目录，将目录下的文件或者子目录删除后，才能删除当前目录。如果子目录下还有子目录，就需要递归了。通过npm也可以下载另外的文件处理模块，可以直接删除目录，当然里面已经封装好了删除文件和子目录的代码。

下面是一个空目录删除的示例

//1. 引入fs模块  
const fs = require('fs');  
//2. 删除目录  
fs.rmdir('./testDir', (err)=>{  
    if(err){  
        console.log(err)  
        return  
    }  
    console.log('删除目录成功')  
})

字节流

在进入文件拷贝之前，我们有必要了解一下字节流。对于大文件的读取和写入，此时通过字节流来进行。

• 使用字节流读取文件：fs.createReadStream()
• 使用字节流写入文件：fs.createWriteStream()

拷贝文件

首先需要使用字节流读取源文件，然后创建写入文件流，最后通过pipe()方法进行拷贝。

const fs = require('fs')  
var readStream = fs.createReadStream('./test.MOV')  
  
var writeStream = fs.createWriteStream('./data/copied.MOV')  
readStream.pipe(writeStream)

代码量很少，简单方便，整个文件的拷贝就成功了。

总结

node.js对于文件的处理总体来说是简单便捷的，代码量少。异步操作贯穿真个fs模块，在实际编码工作中也是有一点挑战的。上面也讲过，实际工作中可以通过封装fs模块，写自己的文件操作模块，封装目录删除等。npm管理中也有一些文件操作模块可以借鉴。

欢迎朋友们留言交流。

node.js会不断更新，后续包括http, url, 数据库操作等内容。