PHP中的gzcompress、gzdeflate、gzencode函数详解

这篇文章主要介绍了PHP中的gzcompress、gzdeflate、gzencode函数详解,本文深入分析了它们的相同点和不同点,需要的朋友可以参考下

PHP中存在一组看起来很像的压缩解压函数:

压缩函数:gzcompress gzdeflate gzencode

解压函数:gzuncompress gzinflate gzdecode

gzdecode是PHP 5.4.0之后才加入的,使用的时候要注意兼容性问题。

这几个函数都以gz开头,让人想到gzip压缩,而光看函数名却又看不出它们之间的区别,只能查文档。

gzcompress gzdeflate gzencode函数的区别在于它们压缩的数据格式不同:

gzcompress使用的是ZLIB格式;

gzdeflate使用的是纯粹的DEFLATE格式;

gzencode使用的是GZIP格式;

但是有一点是相同的,它们压缩数据时都使用了DEFLATE压缩算法(理论上ZLIB和GZIP格式可以使用其他的压缩算法,但是目前实践中只使用DEFLATE算法),ZLIB和GZIP只不过是在DEFLATE的基础之上加了一些头部和尾部而已。

顺便提一下,HTTP协议中的Content-Encoding: deflate使用的是ZLIB格式而不是纯DEFLATE格式。

从PHP 5.4.0开始,gzcompress和gzdeflate函数加入了第三个参数$encoding,可以是三个常量:

ZLIB_ENCODING_RAW 对应于纯DEFLATE格式;

ZLIB_ENCODING_GZIP 对应于GZIP格式;

ZLIB_ENCODING_DEFLATE 对应于ZLIB格式(注意不是纯DEFLATE格式);

虽然文档没有提及,但是这三个常量也可以用在gzencode函数的第三个参数$encoding_mode中。

其实从PHP 5.4.0开始,这三个函数是一样的,只不过第三个参数的默认值不同;如果调用时传入第三个参数,那么这三个函数返回的数据相同。可以写一个简单的脚本测试:

  1. <?php
  2. $url = 'http://www.phpfensi.com';
  3. $s1 = gzdeflate($url, 1);
  4. $s2 = gzencode($url, 1, ZLIB_ENCODING_RAW);
  5. if (strcmp($s1, $s2) == 0) echo 'the same';
  6. ?>

运行可以看到$s1和$s2是相同的,为什么会这样呢?可以从PHP源码中找到答案,打开php-5.5.4\ext\zip\zlib.c,可以找到这样的代码:

  1. #define PHP_ZLIB_ENCODE_FUNC(name, default_encoding) \
  2. static PHP_FUNCTION(name) \
  3. { \
  4. char *in_buf, *out_buf; \
  5. int in_len; \
  6. size_t out_len; \
  7. long level = -1; \
  8. long encoding = default_encoding; \
  9. if (default_encoding) { \
  10. if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ll", &in_buf, &in_len, &level, &encoding)) { \
  11. return; \
  12. } \
  13. } else { \
  14. if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl|l", &in_buf, &in_len, &encoding, &level)) { \
  15. return; \
  16. } \
  17. } \
  18. if (level < -1 || level > 9) { \
  19. php_error_docref(NULL TSRMLS_CC, E_WARNING, "compression level (%ld) must be within -1..9", level); \
  20. RETURN_FALSE; \
  21. } \
  22. switch (encoding) { \
  23. case PHP_ZLIB_ENCODING_RAW: \
  24. case PHP_ZLIB_ENCODING_GZIP: \
  25. case PHP_ZLIB_ENCODING_DEFLATE: \
  26. break; \
  27. default: \
  28. php_error_docref(NULL TSRMLS_CC, E_WARNING, "encoding mode must be either ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP or ZLIB_ENCODING_DEFLATE"); \
  29. RETURN_FALSE; \
  30. } \
  31. if (SUCCESS != php_zlib_encode(in_buf, in_len, &out_buf, &out_len, encoding, level TSRMLS_CC)) { \
  32. RETURN_FALSE; \
  33. } \
  34. RETURN_STRINGL(out_buf, out_len, 0); \
  35. }
  36. /* NOTE: The naming of these userland functions was quite unlucky */
  37. /* {{{ proto binary gzdeflate(binary data[, int level = -1[, int encoding = ZLIB_ENCODING_RAW])
  38. Encode data with the raw deflate encoding */
  39. PHP_ZLIB_ENCODE_FUNC(gzdeflate, PHP_ZLIB_ENCODING_RAW);
  40. /* }}} */
  41. /* {{{ proto binary gzencode(binary data[, int level = -1[, int encoding = ZLIB_ENCODING_GZIP])
  42. Encode data with the gzip encoding */
  43. PHP_ZLIB_ENCODE_FUNC(gzencode, PHP_ZLIB_ENCODING_GZIP);
  44. /* }}} */
  45. /* {{{ proto binary gzcompress(binary data[, int level = -1[, int encoding = ZLIB_ENCODING_DEFLATE])
  46. Encode data with the zlib encoding */
  47. PHP_ZLIB_ENCODE_FUNC(gzcompress, PHP_ZLIB_ENCODING_DEFLATE);
  48. /* }}} */

可以看到,gzdeflate gzencode gzcompress三个函数都是用相同的PHP_ZLIB_ENCODE_FUNC宏定义的(是不是有些泛型的意味?),所以它们当然是相同的。

代码中的注释也承认这几个函数的名字起得不好,至于为什么会用这样的名字就不得而知了。