使用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 相关文章推荐
QQ登录简单实现代码
Mar 09 Javascript
探索Emberjs制作一个简单的Todo应用
Nov 07 Javascript
js onclick事件传参讲解
Nov 06 Javascript
七个很有意思的PHP函数
May 12 Javascript
js中document.write的那点事
Dec 12 Javascript
jQuery中:radio选择器用法实例
Jan 03 Javascript
js简单实现表单中点击按钮动态增加输入框数量的方法
Aug 18 Javascript
一篇文章掌握RequireJS常用知识
Jan 26 Javascript
JavaScript提高网站性能优化的建议(二)
Jul 24 Javascript
jQuery简单实现iframe的高度根据页面内容自适应的方法
Aug 01 Javascript
javascript ASCII和Hex互转的实现方法
Dec 27 Javascript
结合axios对项目中的api请求进行封装操作
Sep 21 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中的日期加减方法示例
2014/08/21 PHP
PHP中使用file_get_contents抓取网页中文乱码问题解决方法
2014/12/17 PHP
PHP随机生成信用卡卡号的方法
2015/03/23 PHP
修改Laravel自带的认证系统的User类的命名空间的步骤
2019/10/15 PHP
JQuery jsonp 使用示例代码
2009/08/12 Javascript
JQUBAR1.1 jQuery 柱状图插件发布
2010/11/28 Javascript
刷新页面的几种方法小结(JS,ASP.NET)
2014/01/07 Javascript
JS修改iframe页面背景颜色的方法
2015/04/01 Javascript
JavaScript实现弹出DIV层同时页面背景渐变成半透明效果
2016/03/25 Javascript
React.js入门实例教程之创建hello world 的5种方式
2016/05/11 Javascript
JavaScript操作选择对象的简单实例
2016/05/16 Javascript
JS 拼凑字符串的简单实例
2016/09/02 Javascript
Bootstrap分页插件之Bootstrap Paginator实例详解
2016/10/15 Javascript
原生JS查找元素的方法(推荐)
2016/11/22 Javascript
分享一道关于闭包、bind和this的面试题
2017/02/20 Javascript
vue实现点击图片放大效果
2017/08/15 Javascript
vue+vue-validator 表单验证功能的实现代码
2017/11/13 Javascript
vue项目中使用tinymce编辑器的步骤详解
2018/09/11 Javascript
Next.js实现react服务器端渲染的方法示例
2019/01/06 Javascript
python 自动化将markdown文件转成html文件的方法
2016/09/23 Python
Django+zTree构建组织架构树的方法
2019/08/21 Python
关于Python-faker的函数效果一览
2019/11/28 Python
BeautifulSoup获取指定class样式的div的实现
2020/12/07 Python
Python OpenCV中的numpy与图像类型转换操作
2020/12/11 Python
CSS3圆角和渐变2种常用功能详解
2016/01/06 HTML / CSS
印度最大的酒店品牌网络:OYO Rooms
2016/07/24 全球购物
美国汽车交易网站:Edmunds
2016/08/17 全球购物
比利时买床:Beter Bed
2017/12/06 全球购物
英国最受欢迎的在线隐形眼镜商店:VisionDirect.co.uk
2018/12/06 全球购物
孝老爱亲模范事迹材料
2014/05/25 职场文书
元旦趣味活动方案
2014/08/22 职场文书
我的法兰西岁月观后感
2015/06/09 职场文书
呼啸山庄读书笔记
2015/06/29 职场文书
教你使用vscode 搭建react-native开发环境
2021/07/07 Javascript
Javascript中Microtask和Macrotask鲜为人知的知识点
2022/04/02 Javascript
python turtle绘图
2022/05/04 Python