深入理解PHP之strpos

蔣建勇發表於2019-02-16

概述

在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_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)

#define php_memnstr zend_memnstr /* 338 line*/

zend_memnstr(Zend/zend_operators.h)

/*
 * 此函式的作用是在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)

/*
標頭檔案:#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)

/* 字串函式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函式對大小寫敏感。

參考

相關文章