PHP中的gzcompress、gzdeflate、gzencode函數詳解_php執行個體

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開始，這三個函數是一樣的，只不過第三個參數的預設值不同；如果調用時傳入第三個參數，那麼這三個函數返回的資料相同。可以寫一個簡單的指令碼測試：

複製代碼 代碼如下:

<?php
$url = 'http://jb51.net';
$s1 = gzdeflate($url, 1);
$s2 = gzencode($url, 1, ZLIB_ENCODING_RAW);
if (strcmp($s1, $s2) == 0) echo 'the same';
?>

運行可以看到$s1和$s2是相同的，為什麼會這樣呢？可以從PHP源碼中找到答案，開啟php-5.5.4\ext\zip\zlib.c，可以找到這樣的代碼：

複製代碼 代碼如下:

#define PHP_ZLIB_ENCODE_FUNC(name, default_encoding) \
static PHP_FUNCTION(name) \
{ \
    char *in_buf, *out_buf; \
    int in_len; \
    size_t out_len; \
    long level = -1; \
    long encoding = default_encoding; \
    if (default_encoding) { \
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ll", &in_buf, &in_len, &level, &encoding)) { \
            return; \
        } \
    } else { \
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl|l", &in_buf, &in_len, &encoding, &level)) { \
            return; \
        } \
    } \
    if (level < -1 || level > 9) { \
        php_error_docref(NULL TSRMLS_CC, E_WARNING, "compression level (%ld) must be within -1..9", level); \
        RETURN_FALSE; \
    } \
    switch (encoding) { \
        case PHP_ZLIB_ENCODING_RAW: \
        case PHP_ZLIB_ENCODING_GZIP: \
        case PHP_ZLIB_ENCODING_DEFLATE: \
            break; \
        default: \
            php_error_docref(NULL TSRMLS_CC, E_WARNING, "encoding mode must be either ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP or ZLIB_ENCODING_DEFLATE"); \
            RETURN_FALSE; \
    } \
    if (SUCCESS != php_zlib_encode(in_buf, in_len, &out_buf, &out_len, encoding, level TSRMLS_CC)) { \
        RETURN_FALSE; \
    } \
    RETURN_STRINGL(out_buf, out_len, 0); \
}

/* NOTE: The naming of these userland functions was quite unlucky */
/* {{{ proto binary gzdeflate(binary data[, int level = -1[, int encoding = ZLIB_ENCODING_RAW])
   Encode data with the raw deflate encoding */
PHP_ZLIB_ENCODE_FUNC(gzdeflate, PHP_ZLIB_ENCODING_RAW);
/* }}} */

/* {{{ proto binary gzencode(binary data[, int level = -1[, int encoding = ZLIB_ENCODING_GZIP])
   Encode data with the gzip encoding */
PHP_ZLIB_ENCODE_FUNC(gzencode, PHP_ZLIB_ENCODING_GZIP);
/* }}} */

/* {{{ proto binary gzcompress(binary data[, int level = -1[, int encoding = ZLIB_ENCODING_DEFLATE])
   Encode data with the zlib encoding */
PHP_ZLIB_ENCODE_FUNC(gzcompress, PHP_ZLIB_ENCODING_DEFLATE);
/* }}} */

可以看到，gzdeflate gzencode gzcompress三個函數都是用相同的PHP_ZLIB_ENCODE_FUNC宏定義的（是不是有些泛型的意味？），所以它們當然是相同的。

代碼中的注釋也承認這幾個函數的名字起得不好，至於為什麼會用這樣的名字就不得而知了。