DIV CSS 佈局教程網

用 Node.js 批次轉換檔案編碼(GBK 轉 UTF-8)實作教學
編輯:關於JavaScript     

製作線上說明手冊時,很常遇到「一堆文件開啟後全是亂碼」的窘境。追根究柢,通常是檔案編碼不是 UTF-8。如果只有幾個檔案,用編輯器逐一「另存新檔」還能忍受;但數量破百時,手動處理就完全不現實了。與其硬撐,不如寫一支小程式把整批檔案一次轉碼。

需求與思路

Node.js 有完善的非同步檔案 API,搭配 iconv-lite 這個編碼轉換套件,就能輕鬆做到「讀檔 → 解碼 → 以新編碼寫回」。實作上需要處理三件事:

  • 遞迴走訪多層目錄,不能只處理第一層。
  • 只針對指定副檔名(例如 .html、.htm)處理,避免誤動圖片或其他資源。
  • 轉碼一次就夠,同一個檔案重複轉會造成二次亂碼。

參數設計

先把可變參數集中管理,日後要換目錄或編碼時只改一個地方即可:

/**
 * 修改檔案編碼格式,例如: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';

輔助函式:判斷元素是否在陣列中

為了判斷副檔名是否在允許清單裡,先擴充一個簡單的查詢方法。從尾端往前遞減迴圈,是為了少做一次 length 取值:

/**
 * 判斷元素是否在陣列內
 * @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;
};

主程式:遞迴轉碼

核心邏輯是 encodeFiles():用 fs.readdirSync() 取出目錄內容,遇到目錄就遞迴呼叫自己,遇到檔案就比對副檔名,符合條件的才做轉碼。

/**
 * 轉碼函式
 * @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);

這裡的關鍵是 iconv.decode():先用來源編碼把二進位內容解成正確的字元,再交給 fs.writeFile() 以目標編碼寫回,等於完成一次編碼遷移。

使用注意事項

這支腳本支援多層目錄遞迴,但有個絕對要牢記的限制:同一個檔案只能轉一次。若對已轉好的檔案再跑一次,反而會把正常內容弄成亂碼。實務上建議先備份原目錄,或先拿少量檔案試跑確認結果,再全量執行。

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