檔案操作

相關模組

Node核心提供了很多與檔案操作相關的模組，每個模組都提供了一些最基本的操作API，在NPM中也有社群提供的功能包

fs：

基礎的檔案操作 API

path：

提供和路徑相關的操作 API

readline：

用於讀取大文字檔案，一行一行讀

fs-extra（第三方）：

https://www.npmjs.com/package/fs-extra

同步或非同步呼叫

• fs模組對檔案的幾乎所有操作都有同步和非同步兩種形式
• 例如：readFile() 和 readFileSync()
• 區別：
  • 同步呼叫會阻塞程式碼的執行，非同步則不會
  • 非同步呼叫會將讀取任務下達到任務佇列，直到任務執行完成才會回撥
  • 異常處理方面，同步必須使用 try catch 方式，非同步可以通過回撥函式的第一個引數

路徑模組

在檔案操作的過程中，都必須使用物理路徑（絕對路徑），path模組提供了一系列與路徑相關的 API

console.log('join用於拼接多個路徑部分，並轉化為正常格式');
const temp = path.join(__dirname, '..', 'lyrics', './友誼之光.lrc');
console.log(temp);

console.log('獲取路徑中的檔名');
console.log(path.basename(temp));

console.log('獲取路徑中的檔名並排除副檔名');
console.log(path.basename(temp, '.lrc'));

console.log('====================================');

console.log('獲取不同作業系統的路徑分隔符');
console.log(process.platform + '的分隔符為 ' + path.delimiter);

console.log('一般用於分割環境變數');
console.log(process.env.PATH.split(path.delimiter));

console.log('====================================');

console.log('獲取一個路徑中的目錄部分');
console.log(path.dirname(temp));

console.log('====================================');

console.log('獲取一個路徑中最後的副檔名');
console.log(path.extname(temp));

console.log('====================================');

console.log('將一個路徑解析成一個物件的形式');
const pathObject = path.parse(temp);
console.log(pathObject);

console.log('====================================');

console.log('將一個路徑物件再轉換為一個字串的形式');
// pathObject.name = '我終於失去了你';
pathObject.base = '我終於失去了你.lrc';
console.log(pathObject);

console.log(path.format(pathObject));

console.log('====================================');

console.log('獲取一個路徑是不是絕對路徑');
console.log(path.isAbsolute(temp));
console.log(path.isAbsolute('../lyrics/愛的代價.lrc'));

console.log('====================================');

console.log('將一個路徑轉換為當前系統預設的標準格式，並解析其中的./和../');
console.log(path.normalize('c:/develop/demo\\hello/../world/./a.txt'));

console.log('====================================');

console.log('獲取第二個路徑相對第一個路徑的相對路徑');
console.log(path.relative(__dirname, temp));

console.log('====================================');

console.log('以類似命令列cd命令的方式拼接路徑');
console.log(path.resolve(temp, 'c:/', './develop', '../application'));

console.log('====================================');

console.log('獲取不同平臺中路徑的分隔符（預設）');
console.log(path.sep);

console.log('====================================');

console.log('允許在任意平臺下以WIN32的方法呼叫PATH物件');
// console.log(path.win32);
console.log(path === path.win32);

console.log('====================================');

console.log('允許在任意平臺下以POSIX的方法呼叫PATH物件');
console.log(path === path.posix);
 

原始碼地址：
https://github.com/nodejs/node/blob/master/lib/path.js

檔案讀取

Node中檔案讀取的方式主要有：

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

fs.readFile('c:\\demo\1.txt', 'utf8', (err, data) => {
  if (err) throw err;
  console.log(data);
});

fs.readFileSync(file[, options])

try {
  const data = fs.readFileSync('c:\\demo\1.txt', 'utf8');
  console.log(data);
} catch(e) {
  // 檔案不存在，或者許可權錯誤
  throw e;
}
 

fs.createReadStream(path[, options])

const stream = fs.createReadStream('c:\\demo\1.txt');
let data = ''
stream.on('data', (trunk) => {
  data += trunk;
});
stream.on('end', () => {
  console.log(data);
});

由於Windows平臺下預設檔案編碼是GBK，在Node中不支援，可以通過iconv-lite解決

Readline模組逐行讀取文字內容

const readline = require('readline');
const fs = require('fs');

const rl = readline.createInterface({
  input: fs.createReadStream('sample.txt')
});

rl.on('line', (line) => {
  console.log('Line from file:', line);
});

檔案寫入

Node中檔案寫入的方式主要有：

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

fs.writeFile('c:\\demo\a.txt', new Date(), (error) => {
  console.log(error);
});

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

try {
  fs.writeFileSync('c:\\demo\a.txt', new Date());
} catch (error) {
  // 資料夾不存在，或者許可權錯誤
  console.log(error);
}

fs.createWriteStream(path[,option])

var streamWriter = fs.createWriteStream('c:\\demo\a.txt');
setInterval(() => {
  streamWriter.write(`${new Date}\n`, (error) => {
    console.log(error);
  });
}, 1000);

檔案寫入

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

// 相比較之前檔案流的方式，這種方式不會佔用檔案資源，append完成就會釋放
setInterval(() => {
  fs.appendFile('c:\\demo\a.txt',`${new Date}\n`, (error) => {
    console.log(error);
  });
}, 1000);

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

setInterval(() => {
  fs.appendFileSync('c:\\demo\a.txt',`${new Date}\n`);
}, 1000);

其他常見檔案操作

驗證路徑是否存在（過時的API）

• fs.exists(path,callback(exists))
• fs.existsSync(path) // => 返回布林型別 exists

獲取檔案資訊

• fs.stat(path,callback(err,stats))
• fs.statSync(path) // => 返回一個fs.Stats例項

移動檔案或重新命名檔案或目錄

與命令列相同，重新命名操作也可以實現檔案移動

• fs.rename(oldPath,newPath,callback)
• fs.renameSync(oldPath,newPath)

刪除檔案

• fs.unlink(path,callback(err))
• fs.unlinkSync(path)

其他常見資料夾操作

建立一個目錄

• fs.mkdir(path[,model],callback)
• fs.mkdirSync(path[,model])

刪除一個空目錄

• fs.rmdir(path,callback)
• fs.rmdirSync(path)

讀取一個目錄

• fs.readdir(path,callback(err,files))
• fs.readdirSync(path) // => 返回files

檔案監視

利用檔案監視實現自動 markdown 檔案轉換

• 相關連結：

  1. https://github.com/chjj/marked
  2. https://github.com/Browsersync/browser-sync
• 實現思路：
  1. 利用fs模組的檔案監視功能監視指定MD檔案
  2. 當檔案發生變化後，藉助marked包提供的markdown to html功能將改變後的MD檔案轉換為HTML
  3. 再將得到的HTML替換到模版中
  4. 最後利用BrowserSync模組實現瀏覽器自動重新整理

const fs = require('fs');
const path = require('path');
var marked = require('marked');
var bs = require('browser-sync').create();


var target = path.join(__dirname, process.argv[2] || './README.md');
var filename = path.basename(target, path.extname(target)) + '.html';
var targetHtml = path.join(path.dirname(target), filename);

bs.init({
  server: path.dirname(target),
  index: filename,
  notify: false
});

bs.reload(filename);

var template = `<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title></title>
  <style>{{{styles}}}</style>
</head>
<body>
  <article class="markdown">
    {{{body}}}
  </article>
</body>
</html>
`;

fs.readFile(path.join(__dirname, './markdown.css'), 'utf8', (error, css) => {
  if (error) throw error;
  template = template.replace('{{{styles}}}', css);
  var handler = (current, previous) => {
    fs.readFile(target, 'utf8', (error, content) => {
      var html = template.replace('{{{body}}}', marked(content));
      fs.writeFile(targetHtml, html, (error) => {
        if (!error) {
          console.log(`[email protected]${new Date()}`);
          bs.reload(filename);
        }
      });
    });
  };
  handler();
  fs.watchFile(target, { interval: 100 }, handler);
});

緩衝區處理

什麼是緩衝區

• 緩衝區就是記憶體中操作資料的容器
• 只是資料容器而已
• 通過緩衝區可以很方便的操作二進位制資料
• 而且在大檔案操作時必須有緩衝區

為什麼要有緩衝區

• JavaScript是比較擅長處理字串，但是早期的應用場景主要用於處理HTML文件，不會有太大篇幅的資料處理，也不會接觸到二進位制的資料。
• 而在Node中操作資料、網路通訊是沒辦法完全以字串的方式操作的，簡單來說
• 所以在Node中引入了一個二進位制的緩衝區的實現：Buffer

原文連結：http://blog.wedn.net/node-essential-file-system/