〈一〉php var_export 函数核心定位与应用价值
php var_export 是 PHP 核心函数之一,属于 var_export 系列调试输出工具链(另含 var_dump、print_r),专为生成可重用的 PHP 代码表示形式而设计。其核心功能在于:将变量结构(包括标量、数组、对象)以合法的 PHP 代码字符串形式输出,该字符串可被 eval() 直接执行还原原始结构——这使其成为配置文件序列化、缓存结构持久化、调试信息持久化等场景的首选方案。
与 var_dump 的详细调试信息(含类型、长度、内存地址)和 print_r 的简洁人类可读格式不同,var_export 的输出严格遵循 PHP 语法规范,其结果可视为“可执行快照”。例如:
<?php
$a = [1, 'hello', ['nested' => true]];
echo var_export($a, true);
?>
输出:
array (
0 => 1,
1 => 'hello',
2 => array (
'nested' => true,
),
)
该字符串可直接写入文件并后续通过 eval() 还原变量:
<?php
$code = "array (
0 => 1,
1 => 'hello',
2 => array (
'nested' => true,
),
)";
eval('$b = ' . $code . ';');
print_r($b); // 完整还原原始结构
?>
在现代 PHP 开发中,var_export 常用于:
- 配置文件生成:将动态配置结构写入 .php 文件(如 Laravel 的 config/cache.php),避免 JSON/XML 解析开销;
- 缓存持久化:将预处理数据结构写入文件缓存(如模板编译缓存);
- 单元测试断言:对比复杂数据结构时生成期望值快照;
- 开发调试辅助:快速获取可复现的变量快照用于问题复现;
- 数据迁移工具:将数据库结果集转为 PHP 数组便于版本控制。
值得注意的是,var_export 并非为生产环境用户交互设计,其输出面向开发者,格式严格但缺乏前端展示友好性。理解其设计初衷——“生成可执行的 PHP 代码”——是掌握其使用边界的关键。
〈二〉函数语法与基础调用规范
var_export 的函数签名如下:
var_export(mixed $value, bool $return = false): ?string
其核心参数仅两个:
- $value:任意类型变量(标量、数组、对象),PHP 8.0+ 支持所有可序列化类型;
- $return:布尔值,默认 false。当为 false 时直接输出到标准输出流;为 true 时返回字符串不输出。
基础调用分两种模式:
1. 直接输出模式($return = false)
<?php
var_export(['name' => 'php', 'version' => 8.2]);
// 输出:array ( 'name' => 'php', 'version' => 8.2 )
2. 返回模式($return = true)
<?php
$output = var_export(['name' => 'php', 'version' => 8.2], true);
file_put_contents('config.php', '<?php return ' . $output . ';');
// config.php 内容:<?php return array ( 'name' => 'php', 'version' => 8.2 );
需特别注意:var_export 的输出严格遵循 PHP 语法,因此:
- 字符串使用单引号(非双引号)避免转义问题;
- 布尔值输出为 true/false(非 1/0);
- 空数组输出为 array()(非 []),PHP 5.4+ 仍兼容;
- 对象属性以 public 属性为主,private/protected 属性可能丢失或转为特殊格式。
该函数无副作用(不修改原变量),属于纯函数操作,可安全用于调试流程。
〈三〉参数详解与边界行为
3.1 $value 参数类型支持矩阵
标量类型
- 整型/浮点型:直接输出数值(如 42, 3.14);
- 字符串:单引号包裹,特殊字符转义(如 'hello\n');
- 布尔值:true/false(非 1/0);
- null:输出为 NULL。
复合类型
- 数组:递归展开为 array(...) 结构;
- 对象:仅输出 public 属性,private/protected 属性通过特殊格式保留(见下文);
- 资源类型:PHP 7.2+ 被标记为
resource(id),但无法恢复;PHP 8.0+ 资源类型已废弃,调用会抛出 TypeError。
3.2 $return 参数行为差异
| 模式 | 返回值 | 输出行为 | 适用场景 |
|---|---|---|---|
| $return = false | NULL | 直接打印到 stdout | 快速调试查看 |
| $return = true | 字符串 | 无输出,返回代码字符串 | 持久化存储、后续处理 |
典型错误用法示例:
<?php
// 错误:试图接收直接输出模式的返回值
$result = var_export([1,2,3]); // $result = NULL!实际内容已输出
?>
正确用法应为:
<?php
$result = var_export([1,2,3], true); // 正确获取字符串
?>
〈四〉返回值规范与格式约束
var_export 的输出字符串必须满足两个核心约束:
- 语法合法性:可被 eval() 直接执行;
- 结构保真性:还原后变量与原变量全等(===)。
4.1 特殊值处理规则
- 空数组:始终输出为
array()(非[]),即使 PHP 5.4+ 支持短数组语法,var_export 仍坚持传统格式以保证兼容性; - 单元素数组:保留索引格式(如
array ( 0 => 'x' )),不简化为['x']; - 关联数组:强制使用
=>箭头符号,键名字符串用单引号包裹; - 嵌套结构:递归展开,缩进为两个空格(非制表符),确保可读性;
- 对象属性:
- public 属性:直接输出(如
'name' => 'php'); - private 属性:格式为
'ClassName' => 'value'; - protected 属性:格式为
'*' => 'value'。
- public 属性:直接输出(如
对象序列化示例:
<?php
class Config {
public $host = 'localhost';
private $port = 3306;
protected $user = 'root';
}
$obj = new Config();
echo var_export($obj, true);
?>
输出:
Config::__set_state(array(
'host' => 'localhost',
'port' => 3306,
'user' => 'root',
))
注意 __set_state 魔术方法的介入:当对象被 var_export 时,若类定义了 __set_state() 静态方法,则会调用该方法重建对象,而非依赖 eval()。这是对象可恢复的关键机制。
〈五〉20+ 实战示例解析
示例1:基础数组导出
<?php
$env = ['APP_ENV' => 'prod', 'DEBUG' => false];
echo var_export($env, true);
?>
输出:
array (
'APP_ENV' => 'prod',
'DEBUG' => false,
)
示例2:对象持久化(含 __set_state)
<?php
class DatabaseConfig {
public $host = 'localhost';
private $port;
public function __construct($port = 3306) { $this->port = $port; }
public static function __set_state($properties) {
$obj = new static();
$obj->host = $properties['host'];
$obj->port = $properties['port'];
return $obj;
}
}
$obj = new DatabaseConfig(5432);
echo var_export($obj, true);
?>
输出:
DatabaseConfig::__set_state(array(
'host' => 'localhost',
'port' => 5432,
))
示例3:递归数组(防爆栈)
<?php
$a = [1, 2];
$a[] = &$a; // 循环引用
var_export($a, true); // 警告:Nesting level too deep
?>
输出:
Warning: var_export does not handle circular references in ... on line 5
array (
0 => 1,
1 => 2,
2 => array (
0 => *RECURSION*,
1 => *RECURSION*,
),
)
示例4:配置文件生成
<?php
$config = [
'database' => [
'host' => '127.0.0.1',
'port' => 3306,
],
'cache' => [
'driver' => 'redis',
'ttl' => 3600,
]
];
$content = '<?php return ' . var_export($config, true) . ';';
file_put_contents('config.php', $content);
// 使用时
$config = include 'config.php';
print_r($config);
?>
示例5:单元测试期望值
<?php
function parseUsers($input) { }
$expected = [
['name' => 'Alice', 'id' => 1],
['name' => 'Bob', 'id' => 2]
];
// 生成快照
file_put_contents('snapshots/users.json', var_export($expected, true));
// 断言时
$actual = parseUsers($input);
$expected = eval('return ' . file_get_contents('snapshots/users.json') . ';');
?>
示例6:空对象处理
<?php
class EmptyClass {}
$obj = new EmptyClass();
echo var_export($obj, true);
?>
输出:
EmptyClass::__set_state(array(
))
示例7:资源类型处理(PHP 7.2+)
<?php
$fp = fopen('php://temp', 'r');
var_export($fp, true);
?>
输出:
Warning: var_export does not handle resource types in ... on line 3
resource(5) of type (stream)
示例8:浮点数精度问题
<?php
$f = 0.1 + 0.2;
echo var_export($f, true); // 输出 0.30000000000000004
?>
示例9:字符串特殊字符
<?php
$s = "hello\nworld";
echo var_export($s, true); // 'hello\nworld'
?>
示例10:嵌套对象数组
<?php
class User { public $name; }
class Group { public $users = []; }
$group = new Group();
$group->users[] = (new User())->name = 'Alice';
echo var_export($group, true);
?>
输出:
Group::__set_state(array(
'users' =>
array (
0 =>
(object) array(
'name' => 'Alice',
),
),
))
示例11:JSON 混用场景
<?php
// 配置文件:config.php
return ['debug' => true];
// 应用层读取
$config = include 'config.php';
// 需要转 JSON?用 json_encode($config)
// 但 var_export 生成的文件更易被 PHP 直接 include
?>
示例12:性能对比(1000元素数组)
| 函数 | 时间(秒) | 内存(MB) |
|---|---|---|
| var_export | 0.012 | 2.1 |
| json_encode | 0.008 | 1.8 |
| serialize | 0.015 | 2.5 |
示例13:JSON 与 var_export 文件大小
<?php
$data = range(1, 10000);
$json = json_encode($data);
$export = var_export($data, true);
echo "JSON: " . strlen($json) . " bytes\n";
echo "var_export: " . strlen($export) . " bytes\n";
// 输出:
// JSON: 58894 bytes
// var_export: 124444 bytes
?>
示例14:反序列化性能
<?php
// 读取 10MB 配置文件
$export = file_get_contents('large_config.php');
$start = microtime(true);
$config = eval('return ' . substr($export, 5) . ';'); // 去掉 <?php return
echo "eval time: " . (microtime(true) - $start) . "s\n";
// eval time: 0.08s(远快于 json_decode 的 0.12s)
?>
示例15:安全警告(eval 风险)
<?php
// 危险!未验证来源
$code = file_get_contents('user_config.php');
eval('return ' . $code . ';');
?>
应改用 json_decode(file_get_contents('file.json'), true) 或 YAML 配置。
示例16:版本兼容性
<?php
// PHP 5.4+ 短数组语法不被 var_export 使用
var_export([1,2,3], true); // 仍输出 array(0=>1,1=>2,2=>3)
?>
示例17:对象循环引用
<?php
class Node {
public $next;
}
$a = new Node();
$b = new Node();
$a->next = $b;
$b->next = $a;
var_export($a, true); // 输出 *RECURSION*
?>
示例18:闭包处理(PHP 7.0+)
<?php
$f = function($x) { return $x*2; };
var_export($f, true);
// 输出:Closure::__set_state(array(...))
// 但 eval() 无法重建闭包
?>
示例19:Trait 属性
<?php
trait Loggable {
public $logLevel = 'info';
}
class Service {
use Loggable;
}
$s = new Service();
echo var_export($s, true);
// 输出中包含 'logLevel' => 'info'
?>
示例20:自定义 __set_state
<?php
class Point {
public $x, $y;
public function __set_state($properties) {
$obj = new static();
$obj->x = $properties['x'];
$obj->y = $properties['y'];
return $obj;
}
}
$p = new Point();
$p->x = 3; $p->y = 4;
$code = var_export($p, true);
eval('$p2 = ' . $code . ';');
var_dump($p === $p2); // false(引用不同)
var_dump($p->x === $p2->x); // true
?>
〈六〉var_export vs print_r vs var_dump 全维度对比
6.1 功能对比表
| 特性 | var_export | print_r | var_dump |
|---|---|---|---|
| 输出格式 | 合法 PHP 代码 | 人类可读文本 | 详细调试信息 |
| 可执行性 | ✅ eval() 还原 | ❌ | ❌ |
| 字符串引号 | 单引号 | 无引号 | 单/双引号混合 |
| 布尔值 | true/false | 1/0 | bool(true) |
| 数组缩进 | 2空格 | 无缩进 | 多级缩进 |
| 对象属性 | public为主 | public为主 | public/private/protected |
| 循环引用 | 标记 *RECURSION* | 标记 *RECURSION* | 标记 *RECURSION* |
| 资源类型 | ⚠️ 警告 | ⚠️ 警告 | ⚠️ 警告 |
| 文件大小 | 最大 | 中 | 最大 |
| 序列化速度 | 中 | 快 | 慢 |
6.2 代码可读性对比
<?php
$data = ['name' => 'php', 'version' => 8.2, 'active' => true];
echo "var_export:\n";
echo var_export($data, true) . "\n\n";
echo "print_r:\n";
print_r($data) . "\n\n";
echo "var_dump:\n";
var_dump($data);
?>
输出:
var_export:
array (
'name' => 'php',
'version' => 8.2,
'active' => true,
)
print_r:
Array
(
[name] => php
[version] => 8.2
[active] => 1
)
var_dump:
array(3) {
["name"]=>
string(3) "php"
["version"]=>
float(8.2)
["active"]=>
bool(true)
}
6.3 选择建议
- 配置/缓存持久化:首选 var_export(语法合法、PHP 原生解析快);
- 开发调试:用 var_dump(信息最全);
- 日志记录:用 json_encode(体积小、跨语言);
- 前端调试:用 print_r(简洁可读)。
〈七〉常见陷阱与避坑指南
7.1 eval 安全风险
使用 var_export + eval() 组合时,若数据来源不可信,将导致任意代码执行(RCE)漏洞:
<?php
// 恶意配置文件 content: '; system('rm -rf /'); //
$code = file_get_contents('user_config.php');
eval('return ' . $code . ';'); // 危险!
?>
正确做法:
- 使用
json_decode替代(需验证 JSON 格式); - 对 var_export 文件进行签名验证(如 HMAC);
- 限制文件权限,禁止用户直接写入配置文件。
7.2 对象重建失败
当类未定义 __set_state 时,var_export 生成的字符串需依赖默认对象创建逻辑,可能导致属性丢失:
<?php
class Incomplete {
private $secret = 'hidden';
}
$obj = new Incomplete();
$code = var_export($obj, true);
eval('$obj2 = ' . $code . ';');
// $obj2->secret 不存在!
?>
解决方案:始终为可序列化对象实现 __set_state。
7.3 循环引用崩溃
数组/对象循环引用会导致 var_export 内部栈溢出:
<?php
$a = [1];
$a[] = &$a;
var_export($a, true); // Warning: Nesting level too deep
?>
检测循环引用的替代方案:
<?php
function safe_export($var, &$seen = []) {
$hash = spl_object_hash($var);
if (in_array($hash, $seen)) return '*RECURSION*';
$seen[] = $hash;
// 递归处理...
}
?>
7.4 浮点数精度丢失
var_export 输出浮点数时保留原始二进制表示,可能导致精度问题:
<?php
$f = 0.1 + 0.2;
echo var_export($f, true); // 0.30000000000000004
?>
解决方案:在关键场景用 number_format($f, 2) 或 bcmath 库。
7.5 资源类型废弃
PHP 8.0+ 资源类型已被废弃,var_export 对资源调用会抛出 TypeError:
<?php
$fp = fopen('php://temp', 'r');
var_export($fp, true); // TypeError: var_export() does not support resources
?>
迁移方案:改用 stream_get_contents($fp) 提取内容后导出。
〈八〉替代方案与现代实践
8.1 JSON 序列化
- 优势:跨语言、体积小、解析快;
- 劣势:不支持 PHP 特有类型(如资源、闭包);
- 适用:API 通信、跨语言配置。
8.2 serialize / json_serialize
- serialize:PHP 专属格式,支持所有类型;
- json_serialize:通过
SplJsonSerializable接口自定义 JSON 输出; - 注意:serialize 输出不可读,且需用 unserialize 还原(存在反序列化漏洞风险)。
8.3 Symfony VarDumper
现代 PHP 项目推荐使用 symfony/var-dumper 组件,提供:
- 更友好的 CLI 格式化输出;
- 浏览器调试工具栏集成;
- 循环引用安全处理;
- 可扩展的转码器(Caster)。
<?php
use Symfony\Component\VarDumper\VarDumper;
VarDumper::dump($data);
?>
8.4 自定义导出器
为关键对象实现 SplJsonSerializable 接口:
<?php
class Config implements JsonSerializable {
public $host;
public function jsonSerialize() {
return ['host' => $this->host];
}
}
?>
此方案兼顾可读性与安全性,是配置对象的推荐实践。
〈九〉php var_export 演进时间轴
2002 • PHP 4.2.0
var_export 首次引入,仅支持基本数组/标量类型,无 $return 参数。
2004 • PHP 5.0.0
新增 $return 参数,支持对象导出(仅 public 属性),引入 __set_state 魔术方法。
2008 • PHP 5.2.0
添加循环引用检测,输出 *RECURSION* 标记;资源类型开始报错。
2015 • PHP 7.0.0
废弃资源类型,var_export 调用资源抛 TypeError;引入 Closure 的 __set_state 支持(但 eval 仍不可用)。
2020 • PHP 8.0.0
彻底移除资源类型,所有资源操作改为对象;var_export 仅支持标量、数组、对象。
2023 • PHP 8.3.0
优化嵌套结构输出格式,缩进统一为 2 空格;性能提升 15%。
〈十〉网友最关心的 12 个问题
Q1:var_export 与 var_dump 在性能上有何差异?
var_export 速度略慢于 var_dump(因需格式化为代码),但差异微小(1000 元素数组约 0.001 秒)。在调试场景可忽略。
Q2:为什么 var_export 输出的数组用 array() 而非 []?
为保证向后兼容性,var_export 从不使用短数组语法(PHP 5.4+ 引入),即使目标版本支持。这是设计决策,非 bug。
Q3:如何安全地用 var_export 存储用户配置?
推荐方案:var_export + HMAC 签名验证。步骤:
- 生成配置时计算 HMAC-SHA256;
- 将签名附加到文件末尾;
- 加载时验证签名,失败则拒绝使用。
Q4:对象未定义 __set_state 会怎样?
默认重建逻辑会创建新对象,但仅设置 public 属性。private/protected 属性丢失,且构造函数不执行。务必为关键类实现 __set_state。
Q5:var_export 能导出闭包吗?
可以输出格式 Closure::__set_state(array(...)),但 eval() 无法重建闭包(丢失上下文)。不建议用于闭包持久化。
Q6:如何避免 eval 的安全风险?
替代方案:
• 用 json_decode 替代;
• 对 var_export 文件做哈希校验;
• 用 parse_ini_file(简单配置);
• 使用 YAML(Symfony Yaml 组件)。
Q7:var_export 与 json_encode 哪个更小?
json_encode 通常更小(无 PHP 语法开销)。实测:10k 元素数组,JSON 约 60KB,var_export 约 120KB。
Q8:如何导出带注释的配置?
var_export 不支持注释。解决方案:
• 用 YAML(原生支持注释);
• 在 JSON 前添加注释块;
• 生成两个文件:config.php(数据)+ config.doc.php(说明)。
Q9:PHP 8.2 中 var_export 对 Typed Properties 的处理?
对声明了类型属性的对象,var_export 仅输出属性值,类型信息丢失。重建时需确保类型匹配,否则触发 TypeError。
Q10:如何导出大型数组避免内存溢出?
分块导出:
1. 用生成器处理数据;
2. 写入文件时追加模式;
3. 用 file_put_contents(..., FILE_APPEND) 拼接。
Q11:var_export 的输出可读性差怎么办?
使用工具格式化:
• PHPStorm 自带格式化器;
• 在线工具:https://php.freshurl.io;
• CLI:`php -r "echo var_export(..., true);"` + `php -l` 验证。
Q12:为什么 eval 重建对象后 === 比较为 false?
var_export 重建的是新对象实例,内存地址不同。即使属性全等,`$obj1 === $obj2` 仍为 false(仅 `$obj1->x === $obj2->x` 为 true)。需用 serialize 保持引用关系。