PHP 魔术方法:__invoke
概述
__invoke 魔术方法允许对象被当作函数调用。当尝试以调用函数的方式调用对象时,会自动触发 __invoke 方法。
版本要求
- __invoke 在 PHP 5.3+ 中可用
基础概念
对象当函数调用
实现 __invoke 的对象称为"可调用对象"(Callable Object)或"函数对象"(Functor)。
php
<?php
declare(strict_types=1);
class Greeter
{
public function __invoke(string $name): string
{
return "Hello, {$name}!";
}
}
$greeter = new Greeter();
echo $greeter('World'); // Hello, World!语法与代码
类型提示 callable
__invoke 的签名可以作为 callable 类型参数。
php
<?php
declare(strict_types=1);
class multiplier
{
public function __construct(private readonly int $factor) {}
public function __invoke(int $number): int
{
return $number * $this->factor;
}
}
// 作为 callable 使用
function applyOperation(int $value, callable $operation): int
{
return $operation($value);
}
$double = new multiplier(2);
$triple = new multiplier(3);
echo applyOperation(5, $double); // 10
echo applyOperation(5, $triple); // 15与闭包对比
php
<?php
declare(strict_types=1);
// 闭包方式
$double = fn(int $n): int => $n * 2;
// Functor 方式(可维护状态)
class Counter
{
private int $count = 0;
public function __invoke(): int
{
return ++$this->count;
}
}
$counter = new Counter();
echo $counter(); // 1
echo $counter(); // 2
echo $counter(); // 3在数组高阶函数中使用
php
<?php
declare(strict_types=1);
class PriceFormatter
{
public function __invoke(int $priceInCents): string
{
return sprintf('%.2f', $priceInCents / 100);
}
}
$prices = [1000, 2500, 999];
$formatter = new PriceFormatter();
$formatted = array_map($formatter, $prices);
print_r($formatted); // ['10.00', '25.00', '9.99']详细说明
is_callable 检查
实现 __invoke 的对象可以通过 is_callable() 检查。
php
<?php
declare(strict_types=1);
class Task
{
public function __invoke(): void
{
echo "Task executed\n";
}
}
$task = new Task();
var_dump(is_callable($task)); // bool(true)
$task();作为回调注册
php
<?php
declare(strict_types=1);
class EventListener
{
private string $prefix;
public function __construct(string $prefix)
{
$this->prefix = $prefix;
}
public function __invoke(string $message): void
{
echo "[{$this->prefix}] {$message}\n";
}
}
$logger = new EventListener('APP');
// 作为回调注册
set_exception_handler($logger);实战示例
命令模式
php
<?php
declare(strict_types=1);
interface Command
{
public function execute(): void;
}
class LazyCommand implements Command
{
private ?Command $innerCommand = null;
public function __construct(
private readonly \Closure $commandFactory,
) {}
public function execute(): void
{
$this->innerCommand ??= ($this->commandFactory)();
$this->innerCommand->execute();
}
}
class PrintCommand implements Command
{
public function __construct(private readonly string $message) {}
public function execute(): void
{
echo $this->message . "\n";
}
}
$command = new LazyCommand(fn() => new PrintCommand('Hello from lazy command!'));
$command->execute(); // Hello from lazy command!策略模式
php
<?php
declare(strict_types=1);
class TaxCalculator
{
public function __construct(private readonly float $rate) {}
public function __invoke(float $amount): float
{
return $amount * $this->rate;
}
}
class PricingService
{
public function __construct(
private readonly callable $taxStrategy,
) {}
public function calculateFinalPrice(float $price): float
{
$tax = ($this->taxStrategy)($price);
return $price + $tax;
}
}
$pricing = new PricingService(new TaxCalculator(0.1));
echo $pricing->calculateFinalPrice(100); // 110注意事项
- __invoke 只能有一个:每个类只能定义一个 __invoke 方法
- 参数签名由类决定:不像闭包那样灵活
- 可以维护状态:比闭包更适合有状态的函数对象
- 可以依赖注入:通过构造函数注入依赖
最佳实践
- 有状态的回调使用 Functor:比闭包更可维护
- 实现单一职责:每个 Functor 只做一件事
- 类型声明完整:__invoke 的参数和返回值都声明类型
- 配合 callable 类型提示:使 Functor 在任何接受回调的场景使用
进阶用法
调试与测试技巧
php
<?php
declare(strict_types=1);
// 单元测试辅助函数
function createTestResource(): mixed
{
return match (true) {
default => new stdClass(),
};
}
// 调试输出函数
function debugOutput(mixed , string = ''): void
{
= ? ": " : '';
.= print_r(, true);
fwrite(STDERR, . "\n");
}
// 性能基准测试
function benchmark(callable , int = 1000): float
{
= hrtime(true);
for ($i = 0; $i < $iterations; $i++) {
$fn();
}
return (hrtime(true) - $start) / 1e9;
}日志记录实践
php
<?php
declare(strict_types=1);
/**
* 简易日志记录器
*/
class SimpleLogger
{
private string $logFile;
private string $level = 'INFO';
public function __construct(string $logFile)
{
$this->logFile = $logFile;
}
public function info(string $message, array $context = []): void
{
$this->log('INFO', $message, $context);
}
public function warning(string $message, array $context = []): void
{
$this->log('WARNING', $message, $context);
}
public function error(string $message, array $context = []): void
{
$this->log('ERROR', $message, $context);
}
private function log(string $level, string $message, array $context): void
{
$timestamp = date('Y-m-d H:i:s');
$contextStr = $context ? ' ' . json_encode($context, JSON_UNESCAPED_UNICODE) : '';
$line = "[{$timestamp}] [{$level}] {$message}{$contextStr}\n";
file_put_contents($this->logFile, $line, FILE_APPEND | LOCK_EX);
}
}配置与环境检测
php
<?php
declare(strict_types=1);
// 环境检测工具
class EnvironmentChecker
{
public static function checkRequirements(array $requirements): array
{
$results = [];
foreach ($requirements as $name => $check) {
$results[$name] = is_callable($check) ? $check() : false;
}
return $results;
}
public static function getSystemInfo(): array
{
return [
'php_version' => PHP_VERSION,
'os' => PHP_OS,
'sapi' => PHP_SAPI,
'memory_limit' => ini_get('memory_limit'),
'max_execution_time' => ini_get('max_execution_time'),
'loaded_extensions' => get_loaded_extensions(),
];
}
}常见问题排查
| 问题 | 可能原因 | 解决方案 |
|---|---|---|
| 连接超时 | 网络问题/配置错误 | 检查配置,增加超时时间 |
| 权限不足 | 文件/目录权限 | 使用 chmod/chown 修正 |
| 性能下降 | 索引缺失/数据量大 | 添加索引,优化查询 |
| 数据不一致 | 并发冲突/事务残留 | 使用锁机制和事务 |
| 内存溢出 | 大数据集/未释放资源 | 增大内存限制,分批处理 |
故障排除步骤
- 检查错误日志和异常信息
- 确认配置和环境是否正确
- 使用调试工具逐步排查
- 参考官方文档查找已知问题
版本兼容性说明
| 功能 | 最低版本 | 说明 |
|---|---|---|
| 基础功能 | PHP 8.1 | 本文档基准版本 |
| 只读属性 | PHP 8.1 | public readonly 修饰符 |
| 枚举类型 | PHP 8.1 | enum 类型和 match 表达式 |
| Fiber | PHP 8.1 | 协程/轻量级并发 |
| 命名参数 | PHP 8.0 | foo(arg_name: value) |
| 联合类型 | PHP 8.0 | `int |
| Null 安全运算符 | PHP 8.0 | $obj?->method() |
| 析构器 promotion | PHP 8.0 | __construct(public $x) |
php
<?php
declare(strict_types=1);
// 版本兼容性检测
function ensureVersion(string $minVersion): void
{
if (version_compare(PHP_VERSION, $minVersion, '<')) {
throw new RuntimeException(
sprintf('需要 PHP %s+, 当前版本: %s', $minVersion, PHP_VERSION)
);
}
}
ensureVersion('8.1.0');