【玩转Node.JS】=>(内置文件系统)fs模块-LMLPHP

【玩转Node.JS】=>(内置文件系统)fs模块-LMLPHP

概念:

【玩转Node.JS】=>(内置文件系统)fs模块-LMLPHP

文件写入

writeFile (异步写入)

  • 语法
fs.writeFile(file, data[, options], callback)

参数说明:

  • file 写入的文件路径名
  • data 写入的数据
  • options 配置对象设置 (可选)
  • callback 写入回调函数

  • 示例
const fs = require("fs");   /** @导入fs模块 **/

fs.writeFile('./异步创建文件.txt', '给文件中插入一条数据', err => {
    //如果写入失败,则回调函数调用时,会接收一个错误对象,如写入成功,会返回 null
    if (err) {
        console.log('写入失败');
        return;
    }
    console.log('写入成功');
});

writeFileSync(同步写入)

  • 语法
fs.writeFileSync(file, data[, options])

参数说明:

  • file 写入的文件路径名
  • data 待写入的数据
  • options 配置对象设置 (可选)
  • 注明:
    同步写入没有回调函数

  • 示例
const fs = require("fs");   /** @导入fs模块 **/
fs.writeFileSync('./同步创建文件.txt', '一段字符串')

appendFile (异步追加写入)

  • 语法
fs.appendFile(file, data[, options], callback)

参数说明:

  • file 追加写入的文件路径名
  • data 待追加写入的数据
  • options 配置对象设置 (可选)
  • callback 写入回调函数

  • 示例
const fs = require("fs");   /** @导入fs模块 **/

fs.appendFile('./异步创建文件.txt', '异步追加文字', err => {
    if (err) {
        console.log('写入失败');
        return;
    } else {
        console.log('写入成功');
    }
})

appendFileSync(同步追加写入)

  • 语法
fs.appendFileSync(file, data[, options])

参数说明:

  • file 文件名
  • data 待追加写入的数据
  • options 配置对象设置 (可选)
  • 注明:
    同步追加写入没有回调函数

  • 示例:
const fs = require("fs");   /** @导入fs模块 **/
fs.appendFileSync('./同步创建文件.txt', '同步追加一段字符串')

补充


createWriteStream (文件流式写入)

  • 语法
 fs.createWriteStream(path[, options])

参数说明:

  • path 文件路径
  • options 配置对象( 可选 )

返回值: Object

  • 示例
const fs = require('fs');
let ws = fs.createWriteStream('./观书有感.txt');
ws.write('第一段文字\r\n');
ws.write('第二段文字\r\n');
ws.write('第三段文字\r\n');
ws.write('第四段文字\r\n');
ws.close();   //关闭流式写入

【玩转Node.JS】=>(内置文件系统)fs模块-LMLPHP

文件写入概括:


文件读取

readFile (异步读取)

  • 语法
fs.readFile(path[, options], callback)

参数说明:

  • path 文件路径
  • options 选项配置
  • callback 回调函数

示例

const fs = require('fs');
fs.readFile('./新建文件.txt', (err, data) => {
    if (err) {
        console.log("读取失败");
        return;
    } else {
        console.log("读取成功");
        console.log(data.toString());
    }
})

fs.readFile('./新建文件.txt', 'utf-8', (err, data) => {
    if (err) {
        console.log("读取失败");
        return;
    } else {
        console.log("读取成功");
        console.log(data);
    }
})

readFileSync (同步读取)

  • 语法:
fs.readFileSync(path[, options])

参数说明:

  • path 文件路径
  • options 选项配置(可选)

返回值: string | Buffer

示例

const fs = require('fs');
let data = fs.readFileSync('./新建文件.txt');
let data2 = fs.readFileSync('./新建文件.txt', 'utf-8');

createReadStream (文件流式读取)

  • 语法:
fs.createReadStream(path[, options])

参数说明:

  • path 文件路径
  • options 选项配置

返回值: Object

示例:

const fs = require('fs');
//创建读取流对象
let rs = fs.createReadStream('./新建文件.txt');
//每次取出 64k 数据后执行一次 chunk 回调
//绑定 data 事件
rs.on('data', chunk => {
console.log(chunk);
console.log(chunk.length);
});
//读取完毕后, 执行 end 回调,关闭流式读取
rs.on('end', () => {
console.log('读取完成')
})

概述


复制文件

copyFile (异步复制文件)

fs.copyFile('./散文集.txt', './文件.txt', err => {
    if (err) throw err;
    console.log('复制成功');
});

语法

fs.copyFile(src, dest[, options ], callback)

参数说明:

  • src复制源文件当前的路径
  • newPath 复制创建新文件的路径
  • options 配置参数(可选)
  • callback 操作后的回调

copyFileSync (同步复制文件)

fs.copyFileSync('./散文集.txt', './文件.txt');

参数同异步方法,只是没有回调函数

概述


文件(夹)移动与重命名

rename(异步/同步重命名/移动)

  • 语法
fs.rename(oldPath, newPath, callback);  //异步更改

fs.renameSync(oldPath, newPath);   //同步更改

参数说明:

  • oldPath 文件当前的路径
  • newPath 文件新的路径
  • callback 操作后的回调

示例:

const fs = require('fs');
fs.rename('./新建文件.txt', './资料/新建文件.txt', (err) => {
    if (err) throw err;
    console.log('移动完成')
});
fs.renameSync('./新建文件.txt', './资料/新建文件.txt');

补充当更改地址相对于原地址,处于同一目录,则为重命名,反之修改后不在同一目录,则为移动

概述


文件删除

unlink 或 rm(同步/异步)

参数说明:

  • path 文件路径
  • callback 操作后的回调
fs.rm('./同步创建文件.txt', (err) => {
    if (err) {
        console.log("删除失败");
        return;
    } else {
        console.log("删除成功");
        return;
    }
})

fs.rmSync('./同步创建文件.txt');



fs.unlink('./同步创建文件.txt', (err) => {
    if (err) {
        console.log("删除失败");
        return;
    } else {
        console.log("删除成功");
        return;
    }
})

fs.unlinkSync('./同步创建文件.txt');

概述


文件夹操作

创建文件夹

  • 语法
fs.mkdir(path[, options], callback); //异步创建
fs.mkdirSync(path[, options]);   //同步创建

参数说明:

  • path 文件夹路径
  • options 选项配置( 可选 )
  • callback 操作后的回调

示例

fs.mkdir('./page', err => {
    if (err) throw err;
    console.log('创建成功');
});


//递归层级异步创建
fs.mkdir('./1/2/3', {recursive: true}, err => {
if(err) throw err;
console.log('递归创建成功');
});
//递归同步创建文件夹
fs.mkdirSync('./x/y/z', {recursive: true});

读取文件夹

  • 语法
fs.readdir(path[, options], callback); //异步读取
fs.readdirSync(path[, options]); //同步读取

参数说明:

  • path 文件夹路径
  • options 选项配置( 可选 )
  • callback 操作后的回调

示例

//异步读取
fs.readdir('./page', (err, data) => {
if(err) throw err;
console.log(data);
});
//同步读取
let data = fs.readdirSync('page');
console.log(data);

删除文件夹

示例

//异步删除文件夹
fs.rmdir('./page', err => {
	if(err) throw err;
	console.log('删除成功');
});

//异步递归删除文件夹
fs.rmdir('./1', {recursive: true}, err => {
	if(err) {
	console.log(err);
}
console.log('递归删除')
});

//同步递归删除文件夹
fs.rmdirSync('./x', {recursive: true})


//rm异步删除文件夹
fs.rm('./page', err => {
	if(err) throw err;
	console.log('删除成功');
});
//异步递归删除文件夹
fs.rm('./1', {recursive: true}, err => {
	if(err) {
	console.log(err);
}
console.log('递归删除')
});
//同步递归删除文件夹
fs.rmSync('./x', {recursive: true})

注明: 推荐使用 rmrmdir 后续可能将被移除

文件夹操作概括


查看资源状态

示例:

//异步获取状态
fs.stat('./data.txt', (err, data) => {
	if(err) throw err;
	console.log(data);
});
//同步获取状态
let data = fs.statSync('./data.txt');

结果值对象结构:

  • size 文件体积
  • birthtime 创建时间
  • mtime 最后修改时间
  • sFile 检测是否为文件
  • isDirectory 检测是否为文件夹

__dirname

【玩转Node.JS】=>(内置文件系统)fs模块-LMLPHP

【玩转Node.JS】=>(内置文件系统)fs模块-LMLPHP


01-26 06:15