[PHP源码阅读]strpos、strstr和stripos、stristr函数 - hoohack

strpos

<span style="color: #0000ff;">mixed</span> <span style="color: #008080;">strpos</span> ( <span style="color: #0000ff;">string</span> <span style="color: #800080;">$haystack</span>, <span style="color: #0000ff;">mixed</span> <span style="color: #800080;">$needle</span> [, int <span style="color: #800080;">$offset</span> = 0 ] )

如果offset指定了，查找会从offset的位置开始。offset不能为负数。

返回needle第一次出现在haystack的位置。如果在haystack中找不到needle，则返回FALSE。

needle，如果needle不是字符串，它会被转换成整型数值并赋值为该数值的ASCII字符。请看下面例子。

例子

<span style="color: #800080;">$str</span> = "hello"<span style="color: #000000;">;
</span><span style="color: #800080;">$pos</span> = <span style="color: #008080;">strpos</span>(<span style="color: #800080;">$str</span>, 111<span style="color: #000000;">);
</span><span style="color: #008000;">//</span><span style="color: #008000;"> 111的ASCII值是o，因此$pos = 4</span>

strpos核心源码

<span style="color: #0000ff;">if</span> (Z_TYPE_P(needle) ==<span style="color: #000000;"> IS_STRING) {
     </span><span style="color: #0000ff;">if</span> (!<span style="color: #000000;">Z_STRLEN_P(needle)) {
          php_error_docref(NULL TSRMLS_CC, E_WARNING, </span><span style="color: #800000;">"</span><span style="color: #800000;">Empty needle</span><span style="color: #800000;">"</span><span style="color: #000000;">);
          RETURN_FALSE;
     }

     </span><span style="color: #008000;">//</span><span style="color: #008000;"> 调用php_memnstr函数查找needle</span>
     found = php_memnstr(haystack +<span style="color: #000000;"> offset,
                            Z_STRVAL_P(needle),
                            Z_STRLEN_P(needle),
                            haystack </span>+<span style="color: #000000;"> haystack_len);
     } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {
          </span><span style="color: #008000;">//</span><span style="color: #008000;"> 如果不是字符串，转换成数字并赋值为该数字的ASCII字符。</span>
          <span style="color: #0000ff;">if</span> (php_needle_char(needle, needle_char TSRMLS_CC) !=<span style="color: #000000;"> SUCCESS) {
               RETURN_FALSE;
          }
          </span><span style="color: #008000;">//</span><span style="color: #008000;">设置结束字符</span>
          needle_char[<span style="color: #800080;">1</span>] = <span style="color: #800080;">0</span><span style="color: #000000;">;
          found </span>= php_memnstr(haystack +<span style="color: #000000;"> offset,
                            needle_char,
                            </span><span style="color: #800080;">1</span><span style="color: #000000;">,
                            haystack </span>+<span style="color: #000000;"> haystack_len);<br>　　  }
}</span>

有一点要注意的是，如果needle不是字符串的话，会调用php_needle_char函数将needle转成整型数字并转换为其ASCII值。

查找函数

函数最后返回的是found，php_memnstr函数实现了查找的方法。那么再继续看看php_memnstr函数做了什么：

<span style="color: #0000ff;">#define</span> php_memnstr zend_memnstr

php_memnstr是函数zend_memnstr的宏定义，查看zend_memnstr函数如下：

<span style="color: #0000ff;">static</span> inline <span style="color: #0000ff;">char</span> *<span style="color: #000000;">
zend_memnstr(</span><span style="color: #0000ff;">char</span> *haystack, <span style="color: #0000ff;">char</span> *needle, <span style="color: #0000ff;">int</span> needle_len, <span style="color: #0000ff;">char</span> *<span style="color: #000000;">end)
{
    </span><span style="color: #0000ff;">char</span> *p =<span style="color: #000000;"> haystack;
    </span><span style="color: #0000ff;">char</span> ne = needle[needle_len-<span style="color: #800080;">1</span><span style="color: #000000;">];
    </span><span style="color: #0000ff;">if</span> (needle_len == <span style="color: #800080;">1</span><span style="color: #000000;">) {
        </span><span style="color: #0000ff;">return</span> (<span style="color: #0000ff;">char</span> *)memchr(p, *needle, (end-<span style="color: #000000;">p));
    }

    </span><span style="color: #0000ff;">if</span> (needle_len > end-<span style="color: #000000;">haystack) {
        </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> NULL;
    }

    </span><span style="color: #008000;">//</span><span style="color: #008000;"> 第一个优化，只查找end - needle_len次</span>
    end -=<span style="color: #000000;"> needle_len;

    </span><span style="color: #0000ff;">while</span> (p  end) {
        <span style="color: #008000;">//</span><span style="color: #008000;"> 第二个优化，先判断字符串的开头和结尾是否一样再判断整个字符串</span>
        <span style="color: #0000ff;">if</span> ((p = (<span style="color: #0000ff;">char</span> *)memchr(p, *needle, (end-p+<span style="color: #800080;">1</span>))) && ne == p[needle_len-<span style="color: #800080;">1</span><span style="color: #000000;">]) {
            </span><span style="color: #0000ff;">if</span> (!memcmp(needle, p, needle_len-<span style="color: #800080;">1</span><span style="color: #000000;">)) {
                </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> p;
            }
        }

        </span><span style="color: #0000ff;">if</span> (p ==<span style="color: #000000;"> NULL) {
            </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> NULL;
        }

        p</span>++<span style="color: #000000;">;
    }

    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> NULL;
}</span>

第一个优化，因为(char *)memchr(p, *needle, (end-p+1)是在end - needle_len + 1（即haystack_len+1）中查找，如果p为空，说明needle的第一个字符在p中从未出现过。

strstr

<span style="color: #0000ff;">string</span> <span style="color: #008080;">strstr</span> ( <span style="color: #0000ff;">string</span> <span style="color: #800080;">$haystack</span>, <span style="color: #0000ff;">mixed</span> <span style="color: #800080;">$needle</span> [, bool <span style="color: #800080;">$before_needle</span> = <span style="color: #0000ff;">false</span> ] )

返回needle在haystack中第一次出现的位置到结束的字符串。

这个函数的区分大小写的。

如果needle在haystack中不存在，返回FALSE。

如果before_needle为true，则返回haystack中needle在haystack第一次出现的位置之前的字符串。

strstr核心源码

<span style="color: #0000ff;">if</span><span style="color: #000000;"> (found) {
        </span><span style="color: #008000;">//</span><span style="color: #008000;"> 计算出found的位置</span>
        found_offset = found -<span style="color: #000000;"> haystack;
        </span><span style="color: #0000ff;">if</span><span style="color: #000000;"> (part) {
            RETURN_STRINGL(haystack, found_offset, </span><span style="color: #800080;">1</span><span style="color: #000000;">);
        } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {
            RETURN_STRINGL(found, haystack_len </span>- found_offset, <span style="color: #800080;">1</span><span style="color: #000000;">);
        }
    }</span>

strstr函数的前半部分跟strpos类似，区别在于strstr函数在找到位置后，需要返回haystack部分的字符串。part变量就是调用strstr函数时传递的before_needle变量。

stripos

<span style="color: #0000ff;">mixed</span> <span style="color: #008080;">stripos</span> ( <span style="color: #0000ff;">string</span> <span style="color: #800080;">$haystack</span>, <span style="color: #0000ff;">string</span> <span style="color: #800080;">$needle</span> [, int <span style="color: #800080;">$offset</span> = 0 ] )

不区分大小写的strpos。实现方式跟下面的类似，主要是使用一份拷贝然后将需要比较的字符串转换成小写字符后进行再进行查找。

stristr

<span style="color: #0000ff;">string</span> <span style="color: #008080;">stristr</span> ( <span style="color: #0000ff;">string</span> <span style="color: #800080;">$haystack</span>, <span style="color: #0000ff;">mixed</span> <span style="color: #800080;">$needle</span> [, bool <span style="color: #800080;">$before_needle</span> = <span style="color: #0000ff;">false</span> ] )

不区分大小写的strstr。

核心源码

<span style="color: #008000;">//</span><span style="color: #008000;"> 拷贝一份haystack</span>
     haystack_dup =<span style="color: #000000;"> estrndup(haystack, haystack_len);

    </span><span style="color: #0000ff;">if</span> (Z_TYPE_P(needle) ==<span style="color: #000000;"> IS_STRING) {
        </span><span style="color: #0000ff;">char</span> *<span style="color: #000000;">orig_needle;
        </span><span style="color: #0000ff;">if</span> (!<span style="color: #000000;">Z_STRLEN_P(needle)) {
            php_error_docref(NULL TSRMLS_CC, E_WARNING, </span><span style="color: #800000;">"</span><span style="color: #800000;">Empty needle</span><span style="color: #800000;">"</span><span style="color: #000000;">);
            efree(haystack_dup);
            RETURN_FALSE;
        }
        orig_needle </span>=<span style="color: #000000;"> estrndup(Z_STRVAL_P(needle), Z_STRLEN_P(needle));
        </span><span style="color: #008000;">//</span><span style="color: #008000;"> 调用php_stristr函数找出orig_needle的值。</span>
        found =<span style="color: #000000;"> php_stristr(haystack_dup, orig_needle,    haystack_len, Z_STRLEN_P(needle));
        efree(orig_needle);
    } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {
        </span><span style="color: #0000ff;">if</span> (php_needle_char(needle, needle_char TSRMLS_CC) !=<span style="color: #000000;"> SUCCESS) {
            efree(haystack_dup);
            RETURN_FALSE;
        }
        needle_char[</span><span style="color: #800080;">1</span>] = <span style="color: #800080;">0</span><span style="color: #000000;">;

        found </span>= php_stristr(haystack_dup, needle_char,    haystack_len, <span style="color: #800080;">1</span><span style="color: #000000;">);
    }

    </span><span style="color: #0000ff;">if</span><span style="color: #000000;"> (found) {
        found_offset </span>= found -<span style="color: #000000;"> haystack_dup;
        </span><span style="color: #0000ff;">if</span><span style="color: #000000;"> (part) {
            RETVAL_STRINGL(haystack, found_offset, </span><span style="color: #800080;">1</span><span style="color: #000000;">);
        } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {
            RETVAL_STRINGL(haystack </span>+ found_offset, haystack_len - found_offset, <span style="color: #800080;">1</span><span style="color: #000000;">);
        }
    } </span><span style="color: #0000ff;">else</span><span style="color: #000000;"> {
        RETVAL_FALSE;
    }
    
    </span><span style="color: #008000;">//</span><span style="color: #008000;"> 释放变量</span>
    efree(haystack_dup);

可以知道，found是从php_stristr中得到的，继续查看php_stristr函数：

PHPAPI <span style="color: #0000ff;">char</span> *php_stristr(<span style="color: #0000ff;">char</span> *s, <span style="color: #0000ff;">char</span> *<span style="color: #000000;">t, size_t s_len, size_t t_len)
{
    php_strtolower(s, s_len);
    php_strtolower(t, t_len);
    </span><span style="color: #0000ff;">return</span> php_memnstr(s, t, t_len, s +<span style="color: #000000;"> s_len);
}</span>

这个函数的功能就是将字符串都转成小写之后调用php_mennstr函数来查找needle在haystack第一次出现的位置。

总结

因为strpos/stripos返回的是位置，位置从0开始计算，所以判断查找失败都用  === FALSE 更适合。

阅读PHP的源码收获挺多，一方面可以知道某个函数的具体实现原理是怎样的，另一方面可以学习到一些编程优化方案。

 

到此本文结束，如果还有什么疑问或者建议，可以多多交流，原创文章，文笔有限，才疏学浅，文中若有不正之处，万望告知。

如果本文对你有帮助，望点下推荐，谢谢^_^