使用Node.js处理前端代码文件的编码问题


Posted in Javascript onFebruary 16, 2016

使用 NodeJS 编写前端工具时,操作得最多的是文本文件,因此也就涉及到了文件编码的处理问题。我们常用的文本编码有 UTF8 和 GBK 两种,并且 UTF8 文件还可能带有 BOM。在读取不同编码的文本文件时,需要将文件内容转换为 JS 使用的 UTF8 编码字符串后才能正常处理。

BOM 的移除
BOM 用于标记一个文本文件使用 Unicode 编码,其本身是一个 Unicode 字符("\uFEFF"),位于文本文件头部。在不同的 Unicode 编码下,BOM 字符对应的二进制字节如下:

Bytes   Encoding
----------------------------
  FE FF    UTF16BE
  FF FE    UTF16LE
  EF BB BF  UTF8

因此,我们可以根据文本文件头几个字节等于啥来判断文件是否包含 BOM,以及使用哪种 Unicode 编码。但是,BOM 字符虽然起到了标记文件编码的作用,其本身却不属于文件内容的一部分,如果读取文本文件时不去掉 BOM,在某些使用场景下就会有问题。例如我们把几个 JS 文件合并成一个文件后,如果文件中间含有 BOM 字符,就会导致浏览器 JS 语法错误。因此,使用 NodeJS 读取文本文件时,一般需要去掉 BOM。例如,以下代码实现了识别和去除 UTF8 BOM 的功能。

function readText(pathname) {
  var bin = fs.readFileSync(pathname);

  if (bin[0] === 0xEF && bin[1] === 0xBB && bin[2] === 0xBF) {
    bin = bin.slice(3);
  }

  return bin.toString('utf-8');
}

GBK 转 UTF8
NodeJS 支持在读取文本文件时,或者在 Buffer 转换为字符串时指定文本编码,但遗憾的是,GBK 编码不在NodeJS自身支持范围内。因此,一般我们借助 iconv-lite 这个三方包来转换编码。使用 NPM 下载该包后,我们可以按下边方式编写一个读取 GBK 文本文件的函数。

var iconv = require('iconv-lite');

function readGBKText(pathname) {
  var bin = fs.readFileSync(pathname);

  return iconv.decode(bin, 'gbk');
}

单字节编码
有时候,我们无法预知需要读取的文件采用哪种编码,因此也就无法指定正确的编码。比如我们要处理的某些 CSS 文件中,有的用 GBK 编码,有的用 UTF8 编码。虽然可以一定程度可以根据文件的字节内容猜测出文本编码,但这里要介绍的是有些局限,但是要简单得多的一种技术。

首先我们知道,如果一个文本文件只包含英文字符,比如 Hello World,那无论用 GBK 编码或是 UTF8 编码读取这个文件都是没问题的。这是因为在这些编码下,ASCII0~128 范围内字符都使用相同的单字节编码。

反过来讲,即使一个文本文件中有中文等字符,如果我们需要处理的字符仅在 ASCII0~128 范围内,比如除了注释和字符串以外的JS代码,我们就可以统一使用单字节编码来读取文件,不用关心文件的实际编码是 GBK 还是 UTF8。以下示例说明了这种方法。

1. GBK编码源文件内容:

var foo = '中文';

2. 对应字节:

76 61 72 20 66 6F 6F 20 3D 20 27 D6 D0 CE C4 27 3B

3. 使用单字节编码读取后得到的内容:

var foo = '{乱码}{乱码}{乱码}{乱码}';

4. 替换内容:

var bar = '{乱码}{乱码}{乱码}{乱码}';

5. 使用单字节编码保存后对应字节:

76 61 72 20 62 61 72 20 3D 20 27 D6 D0 CE C4 27 3B

6. 使用 GBK 编码读取后得到内容:

var bar = '中文';

这里的诀窍在于,不管大于 0xEF 的单个字节在单字节编码下被解析成什么乱码字符,使用同样的单字节编码保存这些乱码字符时,背后对应的字节保持不变。

NodeJS 中自带了一种 binary 编码可以用来实现这个方法,因此在下例中,我们使用这种编码来演示上例对应的代码该怎么写。

function replace(pathname) {
  var str = fs.readFileSync(pathname, 'binary');
  str = str.replace('foo', 'bar');
  fs.writeFileSync(pathname, str, 'binary');
}
Javascript 相关文章推荐
javascript RadioButtonList获取选中值
Apr 09 Javascript
jquery的相对父元素和相对文档定位示例代码
Aug 02 Javascript
node.js中的http.response.writeHead方法使用说明
Dec 14 Javascript
JScript中的条件注释详解
Apr 24 Javascript
vue移动端裁剪图片结合插件Cropper的使用实例代码
Jul 10 Javascript
用JS编写一个函数,返回数组中重复出现过的元素(实例)
Sep 14 Javascript
Vue.set()实现数据动态响应的方法
Feb 07 Javascript
浅析vue 函数配置项watch及函数 $watch 源码分享
Nov 22 Javascript
微信小程序实现授权登录
May 15 Javascript
VUE 组件转换为微信小程序组件的方法
Nov 06 Javascript
解决微信授权成功后点击按返回键出现空白页和报错的问题
Jun 08 Javascript
vue单应用在ios系统中实现微信分享功能操作
Sep 07 Javascript
让图片跳跃起来  javascript图片轮播特效
Feb 16 #Javascript
Node.js本地文件操作之文件拷贝与目录遍历的方法
Feb 16 #Javascript
详解Node.js包的工程目录与NPM包管理器的使用
Feb 16 #Javascript
javascript每日必学之运算符
Feb 16 #Javascript
解析Node.js基于模块和包的代码部署方式
Feb 16 #Javascript
javascript每日必学之基础入门
Feb 16 #Javascript
快速掌握Node.js环境的安装与运行方法
Feb 16 #Javascript
You might like
PHP读取MySQL数据代码
2008/06/05 PHP
php魔术函数__call()用法实例分析
2015/02/13 PHP
百度工程师讲PHP函数的实现原理及性能分析(二)
2015/05/13 PHP
php实现图片上传、剪切功能
2016/05/07 PHP
Laravel框架文件上传功能实现方法示例
2019/04/16 PHP
javascript实现二分查找法实现代码
2007/11/12 Javascript
JS保留小数点(四舍五入、四舍六入)实现思路及实例
2013/04/25 Javascript
Jquery each方法跳出循环,并获取返回值(实例讲解)
2013/12/12 Javascript
jquery插件jTimer(jquery定时器)使用方法
2013/12/23 Javascript
AngularJS入门教程之Hello World!
2014/12/06 Javascript
深入理解JavaScript系列(42):设计模式之原型模式详解
2015/03/04 Javascript
11种ASP连接数据库的方法
2015/09/18 Javascript
JavaScript实现使用Canvas绘制图形的基本教程
2016/10/27 Javascript
详解vue-router数据加载与缓存使用总结
2018/10/29 Javascript
JS判断两个数组或对象是否相同的方法示例
2019/02/28 Javascript
在layui框架中select下拉框监听更改事件的例子
2019/09/20 Javascript
在vue中使用axios实现post方式获取二进制流下载文件(实例代码)
2019/12/16 Javascript
深入理解webpack process.env.NODE_ENV配置
2020/02/23 Javascript
jQuery弹框插件使用方法详解
2020/05/26 jQuery
ant design vue 表格table 默认勾选几项的操作
2020/10/31 Javascript
Python httplib模块使用实例
2015/04/11 Python
TensorFlow实现随机训练和批量训练的方法
2018/04/28 Python
Python实现的本地文件搜索功能示例【测试可用】
2018/05/30 Python
TensorFlow 模型载入方法汇总(小结)
2018/06/19 Python
基于Python在MacOS上安装robotframework-ride
2018/12/28 Python
Python Json数据文件操作原理解析
2020/05/09 Python
pycharm 实现光标快速移动到括号外或行尾的操作
2021/02/05 Python
CSS3 icon font完全指南(CSS3 font 会取代icon图标)
2013/01/06 HTML / CSS
意大利领先的线上奢侈品销售电商:Eleonora Bonucci
2017/10/17 全球购物
韩国流行时尚女装网站:Dintchina(中文)
2018/07/19 全球购物
入党申请人的自我鉴定
2013/12/01 职场文书
幼儿园教师的考核评语
2014/04/18 职场文书
文案策划专业自荐信
2014/07/07 职场文书
运动会演讲稿300字
2014/08/25 职场文书
小学毕业感言200字
2015/07/30 职场文书
初中军训感言
2015/08/01 职场文书