深刻理解PHP之strpos

概述

在php中常常用 strpos 判斷字符串是否在另外一個字符串中存在, 本文介紹 strpos 函數及其實現。

strpos應用

<?php
/* strpos示例 */

// test
echo 'match:', strpos('xasfsdfbk', 'xasfsdfbk') !== false ? 'true' : 'false', ';', PHP_EOL;
echo 'match:', strpos('xasfsdfbk', 'fbk') !== false ? 'true' : 'false', ';', PHP_EOL;
echo 'match:', strpos('xasfsdfbk', 'xs') != false ? 'true' : 'false', ';', PHP_EOL;
echo 'match:', strpos('xasfsdfbk', 'sfs') !== false ? 'true' : 'false', ';', PHP_EOL;

// code
strpos('xasfsdfbk', 'sfs');

Warning: strpos 函數可能返回布爾值 FALSE，但也可能返回等同於 FALSE 的非布爾值。請閱讀 布爾類型章節以獲取更多信息。應使用 === 運算符來測試此函數的返回值。

strpos系列函數

函數	描述	版本
strpos	查找字符串首次出現的位置	PHP 4, PHP 5, PHP 7
stripos	查找字符串首次出現的位置（不區分大小寫）	PHP 5, PHP 7
strrpos	計算指定字符串在目標字符串中最後一次出現的位置	PHP 4, PHP 5, PHP 7
strripos	計算指定字符串在目標字符串中最後一次出現的位置（不區分大小寫）	PHP 5, PHP 7
mb_strpos	查找字符串在另外一個字符串中首次出現的位置	PHP 4 >= 4.0.6, PHP 5, PHP 7
strstr	查找字符串的首次出現	PHP 4, PHP 5, PHP 7
stristr	strstr() 函數的忽略大小寫版本	PHP 4, PHP 5, PHP 7
substr_count	計算字串出現的次數	PHP 4, PHP 5, PHP 7

mb* 相關的函數也可, 好比說mb_strpos是基於字符數執行一個多字節安全的 strpos() 操做。

PHP(strpos)源碼

strpos(ext/standard/string.c)

• PHP源碼地址

PHP_FUNCTION(strpos)
{
    zval *needle;
    zend_string *haystack;
    char *found = NULL;
    char  needle_char[2];
    zend_long  offset = 0;

#ifndef FAST_ZPP
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "Sz|l", &haystack, &needle, &offset) == FAILURE) {
        return;
    }
#else
    ZEND_PARSE_PARAMETERS_START(2, 3)
        Z_PARAM_STR(haystack)
        Z_PARAM_ZVAL(needle)
        Z_PARAM_OPTIONAL
        Z_PARAM_LONG(offset)
    ZEND_PARSE_PARAMETERS_END();
#endif

    if (offset < 0) {
        offset += (zend_long)ZSTR_LEN(haystack);
    }
    if (offset < 0 || (size_t)offset > ZSTR_LEN(haystack)) {
        php_error_docref(NULL, E_WARNING, "Offset not contained in string");
        RETURN_FALSE;
    }

    if (Z_TYPE_P(needle) == IS_STRING) {
        if (!Z_STRLEN_P(needle)) {
            php_error_docref(NULL, E_WARNING, "Empty needle");
            RETURN_FALSE;
        }

        found = (char*)php_memnstr(ZSTR_VAL(haystack) + offset,
                            Z_STRVAL_P(needle),
                            Z_STRLEN_P(needle),
                            ZSTR_VAL(haystack) + ZSTR_LEN(haystack));
    } else {
        if (php_needle_char(needle, needle_char) != SUCCESS) {
            RETURN_FALSE;
        }
        needle_char[1] = 0;

        found = (char*)php_memnstr(ZSTR_VAL(haystack) + offset,
                            needle_char,
                            1,
                            ZSTR_VAL(haystack) + ZSTR_LEN(haystack));
    }

    if (found) {
        RETURN_LONG(found - ZSTR_VAL(haystack));
    } else {
        RETURN_FALSE;
    }
}

php_memnstr(main/php.h)

• PHP源碼地址

#define php_memnstr zend_memnstr /* 338 line*/

zend_memnstr(Zend/zend_operators.h)

• PHP源碼地址

/*
 * 此函數的做用是在haystack中查找needle,若是不存在返回null,若是存在，返回指向haystack中needle頭字符的指針
 */
zend_memnstr(const char *haystack, const char *needle, size_t needle_len, const char *end)
{
    const char *p = haystack;
    const char ne = needle[needle_len-1];
    ptrdiff_t off_p;
    size_t off_s;

    if (needle_len == 1) {
        return (const char *)memchr(p, *needle, (end-p));
    }

    off_p = end - haystack;
    off_s = (off_p > 0) ? (size_t)off_p : 0;

    if (needle_len > off_s) {
        return NULL;
    }

    if (EXPECTED(off_s < 1024 || needle_len < 3)) {
        // 第一個優化，只查找end - needle_len次
        end -= needle_len;

        while (p <= end) {
            // 第二個優化，先判斷字符串的開頭和結尾是否同樣再判斷整個字符串
            if ((p = (const char *)memchr(p, *needle, (end-p+1))) && ne == p[needle_len-1]) {
                if (!memcmp(needle, p, needle_len-1)) {
                    return p;
                }
            }

            if (p == NULL) {
                return NULL;
            }

            p++;
        }

        return NULL;
    } else {
        return zend_memnstr_ex(haystack, needle, needle_len, end);
    }
}

memchr(string.h)

• Linux內核版-源碼地址

/*
頭文件：#include <string.h>

定義函數：void * memchr(const void *s, char c, size_t n);

函數說明：memchr()從頭開始搜尋s 所指的內存內容前n 個字節，直到發現第一個值爲c 的字節，則返回指向該字節的指針。

返回值：若是找到指定的字節則返回該字節的指針，不然返回0。
*/

#ifndef __HAVE_ARCH_MEMCHR
void *memchr(const void *s, int c, size_t n)
{
    const unsigned char *p = s;
    while (n-- != 0) {
            if ((unsigned char)c == *p++) {
            return (void *)(p - 1);
        }
    }
    return NULL;
}
EXPORT_SYMBOL(memchr);
#endif

memcmp(string.h)

• Linux內核版-源碼地址

/* 字符串函數memcmp
   原型：extern int memcmp(void *buf1, void *buf2, unsigned int count); 
   功能：比較內存區域buf1和buf2的前count個字節
   說明：當buf1<buf2時，返回值<0 　
   　     當buf1=buf2時，返回值=0 　　
         當buf1>buf2時，返回值>0                                        
*/
#ifndef __HAVE_ARCH_MEMCMP
#undef memcmp
__visible int memcmp(const void *cs, const void *ct, size_t count)
{
    const unsigned char *su1, *su2;
    int res = 0;

    for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
        if ((res = *su1 - *su2) != 0)
            break;
    return res;
}
EXPORT_SYMBOL(memcmp);
#endif

提示

strpos函數對大小寫敏感。

參考

• php strpos官方文檔
• 字符串查找算法