NodeJS-fs文件系统底层操作

JavaScript014

NodeJS-fs文件系统底层操作,第1张

  文件 I/O 是由简单封装的标准 POSIX 函数提供的。 通过 require('fs') 使用该模块,所有的方法都有异步和同步的形式。

异步形式始终以完成回调作为它最后一个参数,传给完成回调的参数取决于具体方法,但第一个参数总是留给异常,如果操作成功完成,则第一个参数会是 null 或 undefined。

  当使用同步形式时,任何异常都会被立即抛出。 可以使用 try/catch 来处理异常,或让它们往上冒泡。

  异步方法不保证执行顺序。 所以下面的例子容易出错:

fs.stat 可能在 fs.rename 之前执行,正确的方法是把回调链起来。

  推荐开发者使用这些函数的异步版本。 同步版本会阻塞整个进程,直到它们完成(停止所有连接)。

【fs.open(path, flags[, mode], callback)】参数如下:

flags可以是:

[注意]使用'rs+'模式不会使fs.open()进入同步阻塞调用。如果那是你想要的,则应该使用fs.openSync()。

  文件的回调函数中的第二个参数fd代表文件标识,与定时器标识类似,用于标识文件,且随着文件的打开顺序递增。

【fs.openSync(path, flags[, mode])】

fs.open() 的同步版本。 返回一个表示文件描述符的整数。

【fs.read(fd, buffer, offset, length, position, callback)】参数如下:

  由于使用read()方法,会将文件内容读取buffer对象中,所以需要提前先准备一个buffer对象。

【fs.readSync(fd, buffer, offset, length, position)】

fs.read() 的同步版本,返回 bytesRead 的数量

【fs.write(fd, buffer, offset, length[, position], callback)】参数如下:

  [注意]多次对同一文件使用fs.write且不等待回调,是不安全的。对于这种情况,强烈推荐使用 fs.createWriteStream。

当我们要对打开的文件进行写操作的时候,打开文件的模式应该是读写模式。

【fs.write(fd, data[, position[, encoding]], callback)】

该方法写入data到fd指定的文件。如果data不是一个Buffer实例,则该值将被强制转换为一个字符串。

不同于写入 buffer,该方法整个字符串必须被写入。不能指定子字符串,这是因为结果数据的字节偏移量可能与字符串的偏移量不同。

【fs.writeSync()】

fs.write() 的同步版本,返回写入的字节数。

【fs.close(fd, callback)】参数如下:

一个文件被操作后,要及时将该文件关闭

【fs.closeSync(fd)】

fs.close(fd, callback)的同步版本,返回undefined

看nodejs的官方文档,有以下内容:

File SystemBuffer API

Class: fs.FSWatcher

Event: 'change'

Event: 'error'

watcher.close()

Class: fs.ReadStream

Event: 'open'

Event: 'close'

readStream.bytesRead

readStream.path

Class: fs.Stats

Stat Time Values

Class: fs.WriteStream

Event: 'open'

Event: 'close'

writeStream.bytesWritten

writeStream.path

fs.access(path[, mode], callback)

fs.accessSync(path[, mode])

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

fs.appendFileSync(file, data[, options])

fs.chmod(path, mode, callback)

fs.chmodSync(path, mode)

fs.chown(path, uid, gid, callback)

fs.chownSync(path, uid, gid)

fs.close(fd, callback)

fs.closeSync(fd)

fs.constants

fs.createReadStream(path[, options])

fs.createWriteStream(path[, options])

fs.exists(path, callback)

fs.existsSync(path)

fs.fchmod(fd, mode, callback)

fs.fchmodSync(fd, mode)

fs.fchown(fd, uid, gid, callback)

fs.fchownSync(fd, uid, gid)

fs.fdatasync(fd, callback)

fs.fdatasyncSync(fd)

fs.fstat(fd, callback)

fs.fstatSync(fd)

fs.fsync(fd, callback)

fs.fsyncSync(fd)

fs.ftruncate(fd, len, callback)

fs.ftruncateSync(fd, len)

fs.futimes(fd, atime, mtime, callback)

fs.futimesSync(fd, atime, mtime)

fs.lchmod(path, mode, callback)

fs.lchmodSync(path, mode)

fs.lchown(path, uid, gid, callback)

fs.lchownSync(path, uid, gid)

fs.link(srcpath, dstpath, callback)

fs.linkSync(srcpath, dstpath)

fs.lstat(path, callback)

fs.lstatSync(path)

fs.mkdir(path[, mode], callback)

fs.mkdirSync(path[, mode])

fs.mkdtemp(prefix[, options], callback)

fs.mkdtempSync(prefix[, options])

fs.open(path, flags[, mode], callback)

fs.openSync(path, flags[, mode])

fs.read(fd, buffer, offset, length, position, callback)

fs.readdir(path[, options], callback)

fs.readdirSync(path[, options])

fs.readFile(file[, options], callback)

fs.readFileSync(file[, options])

fs.readlink(path[, options], callback)

fs.readlinkSync(path[, options])

fs.readSync(fd, buffer, offset, length, position)

fs.realpath(path[, options], callback)

fs.realpathSync(path[, options])

fs.rename(oldPath, newPath, callback)

fs.renameSync(oldPath, newPath)

fs.rmdir(path, callback)

fs.rmdirSync(path)

fs.stat(path, callback)

fs.statSync(path)

fs.symlink(target, path[, type], callback)

fs.symlinkSync(target, path[, type])

fs.truncate(path, len, callback)

fs.truncateSync(path, len)

fs.unlink(path, callback)

fs.unlinkSync(path)

fs.unwatchFile(filename[, listener])

fs.utimes(path, atime, mtime, callback)

fs.utimesSync(path, atime, mtime)

fs.watch(filename[, options][, listener])

Availability

Inodes

Filename Argument

Caveats

fs.watchFile(filename[, options], listener)

fs.write(fd, buffer, offset, length[, position], callback)

fs.write(fd, data[, position[, encoding]], callback)

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

fs.writeFileSync(file, data[, options])

fs.writeSync(fd, buffer, offset, length[, position])

fs.writeSync(fd, data[, position[, encoding]])

FS Constants

File Access Constants

File Open Constants

File Type Constants

File Mode Constants

1、读取JSON文件,进行反序列化

// source 对象即为JSON对象

var source = require('./source.json')

// 假定数据如下

var _source = {

    list: ['a', 'b', 'c'],

    length: 3

}

2、修改或者添加数据

// 添加一个属性

source.key = 'key'

3、序列化并写入文件

// 序列化

var destString = JSON.stringify(source)

// 写入文件

fs.writeFile('./source.json', destString)