DIV CSS 佈局教程網

Node.js 批次修改檔案編碼格式(含 GitHub 範例)
編輯:關於JavaScript     

摘要:最近在製作手冊時遇到「文檔亂碼」的問題,檢查後發現檔案編碼不對。總共一百多個檔案,若用編輯器一個個另存為 UTF-8 就太折磨人了。於是自己寫了一支小程式,批次把檔案編碼一次改到位。

實作步驟

整體流程不複雜,靠 Node.js 的檔案系統模組 fs 搭配編碼轉換套件 iconv-lite 即可完成。腳本設計成支援多層目錄遞迴,並可指定要處理的副檔名。

完整程式碼

/**
 * 修改檔案編碼格式,例如:GBK 轉 UTF8
 * 支援多層目錄
 * @param {String} [root_path] [需要進行轉碼的檔案路徑]
 * @param {Array}  [file_type] [需要進行轉碼的檔案格式,比如 html 檔]
 * @param {String} [from_code] [檔案的編碼]
 * @param {String} [to_code]   [檔案的目標編碼]
 */

// 引入套件
var fs = require('fs'),
  iconv = require('iconv-lite');

// 全域變數
var root_path = './html',
    file_type = ['html', 'htm'],
    from_code = 'GBK',
    to_code   = 'UTF8';

/**
 * 判斷元素是否在陣列內
 * @param {[String]} elem [被查找的元素]
 * @return {[bool]} [是否存在]
 */
Array.prototype.inarray = function(elem) {
  "use strict";
  var l = this.length;
  while (l--) {
    if (this[l] === elem) {
      return true;
    }
  }
  return false;
};

/**
 * 轉碼函式
 * @param {[String]} root [編碼檔案目錄]
 */
function encodeFiles(root) {
  "use strict";
  var files = fs.readdirSync(root);
  files.forEach(function(file) {
    var pathname = root + '/' + file,
        stat = fs.lstatSync(pathname);

    if (!stat.isDirectory()) {
        var name = file.toString();
        if (!file_type.inarray(name.substring(name.lastIndexOf('.') + 1))) {
            return;
        }
        fs.writeFile(pathname, iconv.decode(fs.readFileSync(pathname), from_code), {
            encoding: to_code
        }, function(err) {
            if (err) {
                throw err;
            }
        });
    } else {
        encodeFiles(pathname);
    }
  });
}

encodeFiles(root_path);

幾個設計上的選擇

為什麼用 lstatSync?它能取得不解析符號連結的檔案資訊,配合 isDirectory() 判斷是目錄還是檔案,是遞迴走訪目錄樹的標準做法。

為什麼要過濾副檔名?目錄裡通常混有圖片、CSS、字型等資源,若無差別轉碼,二進位檔會直接壞掉。用 file_type 白名單把範圍限縮在文字檔,是必要的安全設計。

為什麼要擴充 inarray?這是判斷副檔名是否在允許清單中的輔助方法。從尾端往前遞減迴圈,可少做一次 length 取值,是個微優化的小技巧。(不過如上一篇所提到的,擴充原生原型要謹慎;用 file_type.indexOf(ext) > -1 會更安全。)

小結與注意事項

上面的程式支援多層目錄遞迴,但有個重要限制:同一個檔案不能重複操作,否則又會出現亂碼。建議執行前先備份,或先在小範圍目錄試跑確認無誤。

完整程式碼放在 GitHub:https://github.com/baixuexiyang/coding,歡迎 fork 到自己的帳號下,若發現 bug 請在 issue 中提出。

另外補充一個現代寫法的建議:如今可以直接用 fs.promises 或 fs.readdirSync(root, { withFileTypes: true }) 搭配 await 改寫成非同步版本,處理大量檔案時不會阻塞事件迴圈;並建議加上 try/catch 統一記錄失敗清單,方便重跑。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved