Node js文件系统

/*
Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API。 Node 导入文件系统模块(fs)语法如下所示：
var fs = require("fs");

异步和同步
Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。
异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。
建议使用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。

例
先创建 input.txt 文件，内容如下：
*/

//===============================以下代码为input.txt文件中内容==========================================
这是一段测试内容
//===============================以上代码为input.txt文件中内容==========================================



//创建 main.js 文件, 代码如下：
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");

// 异步读取
fs.readFile('input.txt', function (err, data) {
    if (err) {
        return console.error(err);
    }
    console.log("异步读取: " + data.toString());
});

// 同步读取
var data = fs.readFileSync('input.txt');
console.log("同步读取: " + data.toString());

console.log("程序执行完毕。");

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
同步读取: 这是一段测试内容
程序执行完毕。
异步读取: 这是一段测试内容
*/










//=========================================获取文件信息
/*
以下为通过异步模式获取文件信息的语法格式：
fs.stat(path, callback)
参数使用说明如下：
path     - 文件路径。
callback - 回调函数，带有两个参数如：(err, stats), 其中 stats 是 fs.Stats 对象。

fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件：

例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require('fs');

fs.stat('input.txt', function (err, stats) {
    console.log(stats);
    console.log(stats.isFile());    //true
    /*
    stats对象中的方法有：
    方法    描述
    stats.isFile()            如果是文件返回 true，否则返回 false。
    stats.isDirectory()       如果是目录返回 true，否则返回 false。
    stats.isBlockDevice()     如果是块设备返回 true，否则返回 false。
    stats.isCharacterDevice() 如果是字符设备返回 true，否则返回 false。
    stats.isSymbolicLink()    如果是软链接返回 true，否则返回 false。
    stats.isFIFO()            如果是FIFO，返回true，否则返回 false。FIFO是UNIX中的一种特殊类型的命令管道。
    stats.isSocket()          如果是 Socket 返回 true，否则返回 false。
    */
})

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
Stats{
    dev: 979730941,
    mode: 33206,
    nlink: 1,
    uid: 0,
    gid: 0,
    rdev: 0,
    blksize: undefined,
    ino: 281474976730238,
    size: 24,
    blocks: undefined,
    atimeMs: 1519968169846.188,
    mtimeMs: 1516774912000,
    ctimeMs: 1519968169846.188,
    birthtimeMs: 1519968169846.188,
    atime: 2018-03-02T05:22:49.846Z
    mtime: 2018-01-24T06:21:52.000Z,
    ctime: 2018-03-02T05:22:49.846Z,
    birthtime: 2018-03-02T05:22:49.846Z }
true
*/










//=========================================写入文件
/*
以下为异步模式下写入文件的语法格式：
fs.writeFile(file, data[, options], callback)
writeFile 直接打开文件默认是 w 模式，所以如果文件存在，该方法写入的内容会覆盖旧的文件内容。

参数使用说明如下：
file     - 文件名或文件描述符。
data     - 要写入文件的数据，可以是 String(字符串) 或 Buffer(流) 对象。
options  - 该参数是一个对象，可写可不写，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 'w'
callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回。

例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");

console.log("准备写入文件");
fs.writeFile('input.txt', '通过 fs.writeFile 写入文件的内容',  function(err) {
    if (err) {
        return console.error(err);
    }
    console.log("数据写入成功！");
    console.log("--------分割线-------------")
    console.log("读取写入的数据！");
    fs.readFile('input.txt', function (err, data) {
        if (err) {
            return console.error(err);
        }
        console.log("异步读取文件数据: " + data.toString());
    });
});

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
准备写入文件
数据写入成功！
--------分割线-------------
读取写入的数据！
异步读取文件数据: 通过 fs.writeFile 写入文件的内容
*/










//=========================================打开 截取 读取 关闭文件
/*
//==================打开文件
以下为在异步模式下打开文件的语法格式：
fs.open(path, flags[, mode], callback)

参数使用说明如下：
path     - 文件的路径。
flags    - 文件打开的行为。具体值详见下文。
mode     - 设置文件模式(权限)，该参数可写可不写，文件创建默认权限为 0666(可读，可写)。
callback - 回调函数，带有两个参数如：callback(err, fd)。

flags 参数可以是以下值：
r    以读取模式打开文件。如果文件不存在抛出异常。
r+    以读写模式打开文件。如果文件不存在抛出异常。
rs    以同步的方式读取文件。
rs+    以同步的方式读取和写入文件。
w    以写入模式打开文件，如果文件不存在则创建。
wx    类似 'w'，但是如果文件路径存在，则文件写入失败。
w+    以读写模式打开文件，如果文件不存在则创建。
wx+    类似 'w+'， 但是如果文件路径存在，则文件读写失败。
a    以追加模式打开文件，如果文件不存在则创建。
ax    类似 'a'， 但是如果文件路径存在，则文件追加失败。
a+    以读取追加模式打开文件，如果文件不存在则创建。
ax+    类似 'a+'， 但是如果文件路径存在，则文件读取追加失败。




//==================截取文件
以下为异步模式下截取文件的语法格式：
fs.ftruncate(fd, len, callback)
该方法使用了文件描述符来读取文件。

参数使用说明如下：
fd       - 通过 fs.open() 方法返回的文件描述符。
len      - 文件内容截取的长度。
callback - 回调函数，没有参数。




//==================读取文件
以下为异步模式下读取文件的语法格式：
fs.read(fd, buffer, offset, length, position, callback)
该方法使用了文件描述符来读取文件。

参数使用说明如下：
fd       - 通过 fs.open() 方法返回的文件描述符。
buffer   - 数据写入的缓冲区。
offset   - 缓冲区写入的写入偏移量。
length   - 要从文件中读取的字节数。
position - 文件读取的起始位置，如果 position 的值为 null，则会从当前文件指针的位置读取。
callback - 回调函数，有三个参数err, bytesRead, buffer，err 为错误信息， bytesRead 表示读取的字节数，buffer 为缓冲区对象。




//==================关闭文件
以下为异步模式下关闭文件的语法格式：
fs.close(fd, callback)

参数使用说明如下：
fd       - 通过 fs.open() 方法返回的文件描述符。
callback - 回调函数，没有参数。

例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");
var buf = new Buffer(1024);

console.log("准备打开文件！");
fs.open('input.txt', 'r+', function(err, fd) {
    if (err) {
        return console.error(err);
    }
    console.log("文件打开成功！");
    console.log("截取了10字节后的文件内容。");
    
    // 截取文件
    fs.ftruncate(fd, 10, function(err){
        if (err){
            console.log(err);
        }
        console.log("文件截取成功。");
        console.log("准备读取文件！");
        fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
            if (err){
                console.log(err);
            }
    
            console.log(bytes + "  字节被读取");
            
            // 仅输出读取的字节
            if(bytes > 0){
                console.log(buf.slice(0, bytes).toString());
            }
    
            // 关闭文件
            fs.close(fd, function(err){
                if (err){
                    console.log(err);
                } 
                console.log("文件关闭成功");
            });
        });
    });
});

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
准备打开文件！
文件打开成功！
截取了10字节后的文件内容。
文件截取成功。
准备读取文件！
10  字节被读取
通过 fs.
文件关闭成功
*/










//=========================================删除文件
/*
以下为删除文件的语法格式：
fs.unlink(path, callback)

参数使用说明如下：
path     - 文件路径。
callback - 回调函数，没有参数。

例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");

console.log("准备删除文件！");
fs.unlink('input.txt', function(err) {
    if (err) {
        return console.error(err);
    }
    console.log("文件删除成功！");
});

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
准备删除文件！
文件删除成功！
*/










//=========================================创建目录
/*
以下为创建目录的语法格式：
fs.mkdir(path[, mode], callback)

参数使用说明如下：

path     - 文件路径。路径要一级一级创建，不能一次同时创建父级子级目录，./ 开头目录表示在当前目录下创建，/ 开头目录表示在当前硬盘根目录下创建
mode     - 设置目录权限，默认为 0777。
callback - 回调函数，没有参数。

例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");

console.log("创建目录 ./tmp/");
fs.mkdir("./tmp/",function(err){ //如果路径写成 /tmp/ 则是在当前硬盘 D: 下创建tmp文件夹
    if (err) {
        return console.error(err);
    }
    console.log("目录创建成功。");
});

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
创建目录 ./tmp/
目录创建成功。
*/










//=========================================读取目录
/*
以下为读取目录的语法格式：
fs.readdir(path, callback)
参数使用说明如下：

path     - 文件路径。./ 开头目录表示在当前目录下读取，/ 开头目录表示在当前硬盘根目录下读取
callback - 回调函数，回调函数带有两个参数err, files，err 为错误信息，files 为 目录下的文件数组列表。
例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");

console.log("查看 ./tmp 目录");
fs.readdir("./tmp/",function(err, files){ //如果路径写成 /tmp/ 则是在当前硬盘 D: 下查看tmp文件夹
    if (err) {
        return console.error(err);
    }
    files.forEach( function (file){
        console.log( file );
    });
});

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
查看 ./tmp 目录
*/










//=========================================删除目录
/*
以下为删除目录的语法格式：
fs.rmdir(path, callback)
参数使用说明如下：

path     - 文件路径。./ 开头目录表示在当前目录下删除，/ 开头目录表示在当前硬盘根目录下删除
callback - 回调函数，没有参数。
例
*/
//===============================以下代码为main.js文件中内容==========================================

var fs = require("fs");
// 执行前创建一个空的 /tmp 目录
console.log("准备删除目录 ./tmp");
fs.rmdir("./tmp",function(err){ //如果路径写成 /tmp/ 则是在当前硬盘 D: 下删除tmp文件夹
    if (err) {
        return console.error(err);
    }
    console.log("读取 ./tmp 目录");
    fs.readdir("./tmp/",function(err, files){
        if (err) {
            return console.error(err);
        }
        files.forEach( function (file){
            console.log( file );
        });
    });
});

//===============================以上代码为main.js文件中内容==========================================
/*
执行main.js
node main.js
输出内容:
准备删除目录 ./tmp
读取 ./tmp 目录
{ Error: ENOENT: no such file or directory ...
*/