方法說明
根據檔案描述符寫入資料。功能與 fs.writeFile() 類似,但屬於更底層的操作,能指定寫入位置與長度;一般應用情境下,建議優先使用 fs.writeFile()。
兩種呼叫形式
形式一:把 buffer 寫入檔案。
fs.write(fd, buffer, offset, length[, position], [callback(err, bytesWritten, buffer)])
形式二:把資料寫入檔案,若傳入的資料不是 Buffer 實例,會被強制轉為字串。
fs.write(fd, data[, position[, encoding]], [callback(err, written, string)])
此方式屬於 fs 模組,使用前必須先引入:var fs = require("fs")
參數說明
fd:檔案描述符。
buffer:要寫入的緩衝區,尺寸建議設為 8 的倍數,效率較高。
offset:在 buffer 中開始寫入的偏移量。
length:指定要寫入或讀取的字節數長度。
position:指定檔案寫入的起始位置;若為 null,則從目前檔案指針的位置開始。
callback:回調函式,接收 err、bytesWritten(已寫入字節數)與 buffer。
encoding:字元編碼(第二種形式)。
第二種形式的 callback 接收 err、written(已寫入的字元數)與 string。
範例
寫入 Buffer:
// fs.write(fd, buffer, offset, length[, position], [callback(err, bytesWritten, buffer)])
// 執行結果:bytesWritten = 8 , buffer = <Buffer 00 00 00 01 00 00 00 00>
var fs = require('fs');
fs.open('content.txt', 'a', function(err, fd){
if (err) {
throw err;
}
var buf = new Buffer(8);
fs.write(fd, buf, 0, 8, 0, function(err, bytesWritten, buffer){
if (err) {
throw err;
}
console.log(bytesWritten);
console.log(buffer);
fs.close(fd, function(err){
if (err) {
throw err;
}
console.log('file closed');
});
});
});
寫入字串:
// fs.write(fd, data[, position[, encoding]], [callback(err, written, string)])
// 執行結果:written = 21 , string = <Buffer 31 32 33 ... >
var fs = require('fs');
fs.open('content.txt', 'a', function(err, fd){
if (err) {
throw err;
}
var data = '123123123 hello world';
fs.write(fd, data, 0, 'utf-8', function(err, written, string){
if (err) {
throw err;
}
console.log(written);
console.log(string);
fs.close(fd, function(err){
if (err) {
throw err;
}
console.log('file closed');
});
});
});
原始碼
可以清楚看到它是如何依傳入型別分流到 writeBuffer 與 writeString 的:
fs.write = function(fd, buffer, offset, length, position, callback) {
if (util.isBuffer(buffer)) {
// 若未傳入 position,預設為 null
if (util.isFunction(position)) {
callback = position;
position = null;
}
callback = maybeCallback(callback);
var wrapper = function(err, written) {
// 保留 buffer 參考,避免被過早回收
callback(err, written || 0, buffer);
};
return binding.writeBuffer(fd, buffer, offset, length, position, wrapper);
}
if (util.isString(buffer))
buffer += '';
if (!util.isFunction(position)) {
if (util.isFunction(offset)) {
position = offset;
offset = null;
} else {
position = length;
}
length = 'utf8';
}
callback = maybeCallback(position);
position = function(err, written) {
callback(err, written || 0, buffer);
};
return binding.writeString(fd, buffer, offset, length, position);
};