Node.js實現(xiàn)修改文件字符集功能的具體過程

更新時間：2024年08月15日 09:12:05 作者：子洋

在日常生活、工作中,我們經(jīng)常會遇到需要處理不同編碼格式的文件,有時,在嘗試打開這些文件時會遇到亂碼,原因通常是文件的編碼與我們使用的文本編輯器或編程語言的默認編碼不匹配,這篇文章將介紹Node.js修改文件字符集的實現(xiàn)思路和具體實現(xiàn)過程

前言

在日常生活、工作中，我們經(jīng)常會遇到需要處理不同編碼格式的文件。有時，在嘗試打開這些文件時會遇到亂碼，原因通常是文件的編碼與我們使用的文本編輯器或編程語言的默認編碼不匹配。這種情況尤其常見于一些歷史遺留的文件或從不同系統(tǒng)中導出的數(shù)據(jù)。

手動處理這種問題不僅耗時，而且容易出錯。如果文件數(shù)量較多，更是令人頭疼。為了解決這個問題，我編寫了一個腳本，自動化地將大量文件的編碼格式轉換為常用的 UTF-8。這篇文章將介紹該腳本的實現(xiàn)思路和具體實現(xiàn)過程，希望對遇到類似問題的朋友有所幫助。

實現(xiàn)思路

實現(xiàn)的思路其實非常簡單：遞歸讀取指定文件夾下的所有文件，然后檢測每個文件的編碼格式，將其轉換為 UTF-8 并寫回文件。通過這種方式，我們能夠確保所有文件都統(tǒng)一為 UTF-8 編碼，從而避免亂碼問題。

具體實現(xiàn)

我們使用 Node.js 來實現(xiàn)這個功能。Node.js 提供了豐富的文件系統(tǒng)操作 API，以及強大的第三方庫來簡化編碼轉換等操作。下面是具體的實現(xiàn)過程。

遞歸讀取文件

首先，我們需要遞歸讀取指定目錄下的所有文件。這可以通過 Node.js 提供的 fs.readdir 方法來實現(xiàn)。這里有兩個很有用的配置屬性：

withFileTypes - 當設置為 true 時，readdir 方法返回的將是 fs.Dirent 對象數(shù)組。這個對象提供了關于文件類型的信息，比如是否為目錄等。
recursive - 當設置為 true 時，可以遞歸讀取目錄及其子目錄下的所有文件。

通過這兩個屬性，我們可以輕松地獲取指定目錄下的所有文件路徑，并判斷它們是否是文件夾。下面是具體代碼實現(xiàn)：

/**
 * 遞歸獲取文件夾下所有文件
 * @param {string} path 
 * @returns 
 */
async function readAllBook(path) {
  let filesList = [];

  const files = await readdir(path, { withFileTypes: true, recursive: true });
  for (const file of files) {
    if (file.isDirectory()) continue
    const filePath = join(file.path, file.name);
    filesList.push(filePath);
  }

  return filesList;
}

調用這個函數(shù)后，我們可以獲得指定目錄下所有文件的路徑，方便后續(xù)處理。

獲取字符集編碼

嘗試讀取文件內容

通常在使用 Node.js 讀取文件時，我們會指定編碼方式，比如 utf-8。然而，如果文件的編碼格式與我們指定的不一致，就會出現(xiàn)亂碼。

await readFile('book/book1.txt', { encoding: 'utf-8' }).then(async (data) => {
	console.log(data);
})

如果文件本身并不是 utf-8 編碼的，讀取時就可能會出現(xiàn)亂碼。為了正確讀取文件，我們需要首先檢測它的編碼格式。

Node 支持的字符編碼

在處理文件編碼的時候，了解 Node.js 支持的字符編碼對我們來說還是挺重要的。Node.js 提供了一系列的編碼選項，可以在 Buffer 和字符串之間進行轉換，以下是 Node.js 支持的主要字符編碼和它們的用途。

常用字符編碼

utf8（別名：utf-8）: 這是最常用的編碼格式，支持多字節(jié)編碼的 Unicode 字符。它能很好地處理包含各種字符的文本文件，是我們轉換目標的首選編碼。
utf16le（別名：utf-16le）: 這個編碼格式也支持多字節(jié)編碼的 Unicode 字符，但與 utf8 不同，utf16le 使用 2 或 4 個字節(jié)來編碼每個字符。它常用于處理東亞字符集。
latin1: 這個編碼代表 ISO-8859-1，只支持 U+0000 到 U+00FF 范圍內的 Unicode 字符。它使用單字節(jié)編碼，對于某些老舊系統(tǒng)或文件，這種編碼可能依然常見。

二進制編碼

在處理一些需要編碼二進制數(shù)據(jù)為字符串，或從字符串解碼二進制數(shù)據(jù)的場景時，以下編碼格式也可能會用到：

base64: 這是最常見的二進制到文本的編碼方式，常用于編碼圖像、音頻文件等。
hex: 將每個字節(jié)編碼為兩個十六進制字符，常用于處理加密數(shù)據(jù)。

舊版字符編碼

ascii: 這個編碼僅適用于 7 位 ASCII 數(shù)據(jù)。在現(xiàn)代應用中通常很少用到，因為它無法處理非英語字符。
binary: 這是 latin1 的別名，用于處理簡單的二進制數(shù)據(jù)。
ucs2 和 ucs-2: 這些是 utf16le 的別名，曾經(jīng)用于處理不支持 U+FFFF 以上字符的場景。

jschardet

jschardet 是一個字符編碼的檢測器，可以用來檢測文本文件或數(shù)據(jù)流的字符編碼的工具。它的工作原理就是通過分析文本中的字節(jié)模式，嘗試匹配已知的編碼方式。支持 20 多種字符編碼，但要注意的是檢測出來的結果不能保證百分之百的準確。

我們使用 npm i jschardet 安裝 jschardet 之后，就可以使用 detect 方法獲取字符編碼

import jschardet from 'jschardet';

await readFile('book/book1.txt').then(async (data) => {
  console.log(jschardet.detect(data));
})

這個方法會返回一個對象：encoding 和 confidence， encoding 是檢測的編碼，confidence 是這個檢測結果的置信度。

每個檢測器都會根據(jù)它的分析給出一個置信度（Confidence Level），置信度最高的編碼就會被選中。就像我們之前說的，因為很多編碼很相似，所以這個檢測并不是百分之百準確，但 chardet 設計得比較聰明，通常能給出一個比較靠譜的結果。

轉換字符集編碼

現(xiàn)在我們拿到了文件內容的字符編碼，需要一個轉換器將內容轉換為 utf-8, 這時我們需要引入一個新的庫 iconv-lite

iconv-lite 是一個用于 Node.js 的輕量級字符編碼轉換庫。它允許你在 Node.js 應用程序中進行字符編碼的轉換和處理，特別是處理非 UTF-8 編碼的數(shù)據(jù)。與其他類似的庫相比，iconv-lite 更加輕便，因為它不依賴外部的 C 庫或者原生模塊，完全用純 JavaScript 實現(xiàn)。

import iconv from 'iconv-lite';

await readFile('book/book1.txt').then(async (data) => {
  const { encoding } = jschardet.detect(data);
  console.log(iconv.decode(data, encoding));
})

通過以上代碼，我們可以將文件內容正確地解碼為 UTF-8 格式，并輸出到控制臺。

獲取到轉碼內容的后，我們就可以遍歷之前獲取的文件列表，全部進行轉碼重新寫入文件了，這個步驟很簡單，不單獨進行講解了，可以直接參考下面的完整代碼。

完整代碼

import { readdir, readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';

import iconv from 'iconv-lite';
import jschardet from 'jschardet';

/**
 * 遞歸獲取文件夾下所有文件
 * @param {string} path 
 * @returns 
 */
async function readAllBook(path) {
  let filesList = [];

  const files = await readdir(path, { withFileTypes: true, recursive: true });
  for (const file of files) {
    if (file.isDirectory()) continue
    const filePath = join(file.path, file.name);
    filesList.push(filePath);
  }

  return filesList;
}

readAllBook('./book').then(async (files) => {
  console.log('文件重寫開始，請稍候...');
  for (const file of files) {
    await readFile(file).then(async (data) => {
      // 獲取讀取的內容編碼
      const charset = jschardet.detect(data)
      // 轉換內容編碼
      const fileContent = iconv.decode(data, charset.encoding || 'GB2312')
      // 重新寫回文件
      await writeFile(file, fileContent, { encoding: 'utf-8' }).catch((err) => {
        console.log(file + '文件寫入失敗', err);
      });
    });
  }
  console.log('文件重寫完成！');
});