使用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 相关文章推荐
用jquery存取照片的具体实现方法
Jun 30 Javascript
用JavaScript实现动画效果的方法
Jul 20 Javascript
JavaScript版的TwoQueues缓存模型
Dec 29 Javascript
javascript文本模板用法实例
Jul 31 Javascript
Webpack 实现 Node.js 代码热替换
Oct 22 Javascript
vue数字类型过滤器的示例代码
Sep 07 Javascript
vue + webpack如何绕过QQ音乐接口对host的验证详解
Jul 01 Javascript
vue使用ElementUI时导航栏默认展开功能的实现
Jul 04 Javascript
JS实现可用滑块滑动的缓动图代码
Sep 01 Javascript
vue引用外部JS的两种种方法
Jan 28 Javascript
如何基于javascript实现贪吃蛇游戏
Feb 09 Javascript
如何手写简易的 Vue Router
Oct 10 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
《一拳超人》埼玉一拳下去,他们存在了800年毫无意义!
2020/03/02 日漫
php中使用Curl、socket、file_get_contents三种方法POST提交数据
2011/08/12 PHP
PHP基础之运算符的使用方法
2013/04/28 PHP
PHP实现简单的计算器
2020/08/28 PHP
JavaScript XML和string相互转化实现代码
2011/07/04 Javascript
对frameset、frame、iframe的js操作示例代码
2013/08/16 Javascript
javascript实现连续赋值
2015/08/10 Javascript
CSS或者JS实现鼠标悬停显示另一元素
2016/01/22 Javascript
javascript实现数字倒计时特效
2016/03/30 Javascript
javascript实现的左右无缝滚动效果
2016/09/19 Javascript
JavaScript中定义对象原型的两种使用方法
2016/12/15 Javascript
JS实现简易刻度时钟示例代码
2017/03/11 Javascript
详解Vue学习笔记进阶篇之列表过渡及其他
2017/07/17 Javascript
babel的使用及安装配置教程
2018/02/22 Javascript
vue实现element-ui对话框可拖拽功能
2018/08/17 Javascript
vue中nextTick用法实例
2019/09/11 Javascript
layui动态绑定事件的方法
2019/09/20 Javascript
[04:26]2014DOTA2国际邀请赛-Newbee顺利进入胜者组决赛 独家专访战神7
2014/07/19 DOTA
[50:15]VP vs Mineski 2018国际邀请赛淘汰赛BO3 第二场 8.22
2018/08/23 DOTA
Python对两个有序列表进行合并和排序的例子
2014/06/13 Python
Python实现查找系统盘中需要找的字符
2015/07/14 Python
Python正则表达式如何进行字符串替换实例
2016/12/28 Python
Python实现针对中文排序的方法
2017/05/09 Python
基于Python代码编辑器的选用(详解)
2017/09/13 Python
详解python深浅拷贝区别
2019/06/24 Python
python实现在多维数组中挑选符合条件的全部元素
2019/11/26 Python
django 扩展user用户字段inlines方式
2020/03/30 Python
如何利用python web框架做文件流下载的实现示例
2020/06/02 Python
浅析Python 中的 WSGI 接口和 WSGI 服务的运行
2020/12/09 Python
财务助理岗位职责
2013/11/10 职场文书
《春天来了》教学反思
2014/04/07 职场文书
父母寄语大全
2014/04/12 职场文书
新教师培训心得体会
2014/09/02 职场文书
员工离职感谢信
2015/01/22 职场文书
高校自主招生教师推荐信
2015/03/23 职场文书
基于nginx实现上游服务器动态自动上下线无需reload的实现方法
2021/03/31 Servers