您的位置:

深入解析parse_str函数

一、parsestring

parse_str函数是PHP自带的一个函数,主要作用是将一个字符串解析成多个变量。

语法格式:

void parse_str ( string $encoded_string , array &$result )

其中,encoded_string是需要解析的字符串,result是可选的输出变量数组,如果不设置,则会自动创建一个数组。

二、parsestrategy

parse_str函数的解析策略如下:

首先按照&将字符串分割成多个键值对,然后再按照=将每个键值对分割成键和值。此时,一般情况下,键和值会被URL编码(使用rawurlencode函数),也就是将一些特殊字符转换成%XX的形式(其中XX表示转换后的字符ASCII码的十六进制表示)。

如果一个键值对中出现了数组形式,例如a[]=1&a[]=2,那么结果数组中,a键对应的值就是一个数组。

三、parsestream

parse_str函数同样支持从输入流中解析字符串,使用方式如下:

parse_str(file_get_contents("php://input"), $data);  // 获取POST请求的body中字符串,并解析成数组

这个特性在AJAX请求中特别有用,当请求参数中包含数组或者嵌套的数组时,可以通过json_encode和json_decode来方便地处理。

四、parsestring命令

parse_str函数同样可以与命令行结合使用,解析命令行传参的字符串,使用方式如下:

parse_str(implode('&', array_slice($argv, 1)), $_GET);  // 获取运行脚本时传递的参数,并解析成数组

这在写命令行工具时非常有用,可以方便地获取传递参数。

五、parsestring函数

parse_str函数的API非常简单,实际上可以通过下面的代码来实现基本相同的功能:

function parse_string($str){
    parse_str($str, $output);
    return $output;
}

这样做的意义在于,我们常常需要将一个字符串解析成数组,并在某些地方使用,如果在每个需要解析的地方都写一遍parse_str,会十分麻烦。我们可以封装一个函数,以后只需要调用这个函数,就可以方便地获得解析后的数组了。

六、parsestringitem

parse_str函数有一个细节,就是它可以用于解析一个用于URL传参的查询字符串,例如a=1&b=2。然而,它不会对数组中的键做进一步的解析,例如a[b]=2,会被解析成一个"a"键,对应一个数组,其元素为"b"键和对应的值。对于这种情况,我们可以通过手动解析字符串来实现。例如:

function parse_string_item($str) {
    $result = array();
    $pairs = explode("&", $str);
    foreach($pairs as $pair) {
        $kvp = explode("=", $pair);
        $k = urldecode($kvp[0]);
        $v = urldecode($kvp[1]);
        preg_match('/^[^\[]+/i', $k, $matches);
        $key = $matches[0];
        if (preg_match_all('/\[([^\]]*)\]/i', $k, $matches)) {
            $levels = $matches[1];
            array_push($levels, $v);
            $walk = &$result;
            foreach ($levels as $level) {
                if ($level == "") {
                    $walk = &$walk[];
                } else {
                    if (!isset($walk[$level])) {
                        $walk[$level] = array();
                    }
                    $walk = &$walk[$level];
                }
            }
            unset($walk);
        } else {
            $result[$key] = $v;
        }
    }
    return $result;
}

这个代码使用正则表达式解析了类似a[b][c]=1这样的字符串格式,能够方便地得到一个嵌套的数组。

七、parsestring skill

最后,我们给出一个根据特定的键名获取一个数组的某个值的技巧:

$url = "https://www.example.com?a=1&b[c]=2";
$params = parse_str($url);

// 假设我们需要获取b[c]这个键对应的值
$key = "b[c]";
$value = $params;
foreach (explode('[', $key) as $chunk) {
    $chunk = rtrim($chunk, ']');
    if (isset($value[$chunk])) {
        $value = $value[$chunk];
    } else {
        $value = null;
        break;
    }
}
echo $value;

这段代码的输出为2。

总结

通过本文的介绍,我们可以了解到parse_str函数的基本用法以及一些应用技巧,其中包括从字符串、输入流、命令行解析参数、手动解析包含嵌套数组的查询字符串,以及根据键名获取嵌套数组的值等。parse_str非常实用,可以极大地简化代码编写的难度,提高开发效率。