blog icon indicating copy to clipboard operation
blog copied to clipboard

记一次php的bug:返回的图片总是显示不出来,怎么回事,原因竟然是 BOM

Open diamont1001 opened this issue 4 years ago • 0 comments

记一次php上的一个bug,明明服务器上的图片都是没问题的,但是通过 imagepng 返回后,就是显示不出来。

检查了好多遍,代码逻辑肯定是没问题的了,因为在最后返回之前,debug 到图片都是没问题的,就是最后返回到前端的时候,总是显示错误。

查了好久,最后把返回的图片通过 base_64 来看看图片内容,竟然发现里面多了个 77u/ 字符串,如下:

data:image/png;base64,77u/iVBORw0KGgoAAAANSUhEUgAAAMYAAADGBAMAAAB7teJuAAAAJqE...........

要知道,base64_decode('77u/') 就是 utf-8 文件的 BOM头 efbbbf,这回知道是怎么回事了,查找下代码,看看是哪个文件然后去掉即可。

本项目查到是一个语言包 zh_cn/common.php 的问题,应该是之前这个语言包发给翻译的同事翻译的时候,用 windows 机器打开编辑过的原因。

用 phpstorm 的同学,可以这样去掉:https://blog.csdn.net/coco1118/article/details/86552410

BOM 科普(网上资料)

BOM: Byte Order Mark

UTF-8 BOM又叫UTF-8 签名,其实UTF-8 的BOM对UFT-8没有作用,是为了支援UTF-16,UTF-32才加上的BOM,BOM签名的意思就是告诉编辑器当前文件采用何种编码,方便编辑器识别,但是BOM虽然在编辑器中不显示,但是会产生输出,就像多了一个空行,

如果您在修改任何PHP文件後发生:

  • 不能登入或者不能登出; * 页顶出现一条空白; * 页顶出现错误警告; * 其它不正常的情况。

则多半是编辑器的问题。

现在几乎所有的文本编辑软件都可以显示并编辑UTF-8编码的文件。但是很遗憾,其中很多软件的表现并不理想。

类似WINDOWS自带的记事本等软件,在保存一个以UTF-8编码的文件时,会在文件开始的地方插入三个不可见的字符(0xEF 0xBB 0xBF,即BOM)。它是一串隐藏的字符,用于让记事本等编辑器识别这个文件是否以UTF-8编码。对于一般的文件,这样并不会产生什么麻烦。

但对于 PHP来说,BOM是个大麻烦。

PHP并不会忽略BOM,所以在读取、包含或者引用这些文件时,会把BOM作为该文件开头正文的一部分。根据嵌入式语言的特点,这串字符将被直接执行(显示)出来。由此造成即使页面的 top padding 设置为0,也无法让整个网页紧贴浏览器顶部,因为在html一开头有这3个字符呢!

最大的麻烦还不是这个。受COOKIE送出机制的限制,在这些文件开头已经有BOM的文件中,COOKIE无法送出(因为在COOKIE送出前PHP已经送出了文件头),所以登入和登出功能失效。一切依赖COOKIE、SESSION实现的功能全部无效。

因此,在编辑、更改任何文本文件时,请务必使用不会乱加BOM的编辑器。Linux下的编辑器应该都没有这个问题。WINDOWS下,请勿使用记事本等编辑器。推荐的编辑器是: Editplus 2.12版本以上; EmEditor; UltraEdit(需要取消‘添加BOM’的相关选项); Dreamweaver(需要取消‘添加BOM’的相关选项) 等。

对于已经添加了BOM的文件,要取消的话,可以用以上编辑器另存一次。

diamont1001 avatar Oct 28 '20 23:10 diamont1001