PHP `Reflection Extension` 结合 `Attribute` (PHP 8.0+) 实现编译时元编程

咳咳，各位观众老爷们，今天咱们聊点高级玩意儿，保证让你们眼前一亮，晚上做梦都在敲代码！咱们今天要讲的是PHP的 Reflection Extension 结合 Attribute，玩转编译时元编程！

开场白：元编程是啥玩意？

啥叫元编程？说白了，就是“编写能够编写代码的代码”。听着有点绕？没关系，想象一下，你写一个程序，这个程序能根据你的指示，自动生成其他的程序。是不是感觉自己像个代码界的造物主？

在传统编程里，代码写死在那里，运行的时候该干啥就干啥。但元编程就不一样了，它可以在编译时（或者运行时）动态地修改或生成代码。

PHP与元编程：以前的痛

以前的PHP，想搞元编程，那叫一个费劲。各种字符串拼接、eval()函数满天飞，代码丑陋不说，还容易出安全问题。就像用绣花针缝补航空母舰，费力不讨好。

救星驾到：Reflection + Attribute

PHP 8.0之后，情况就不一样了。Reflection Extension 配合 Attribute，简直是元编程界的黄金搭档。

• Reflection： 让你像X光一样透视代码，获取类、方法、属性的各种信息。
• Attribute： 给代码贴标签，告诉编译器或者运行时，这段代码有特殊的含义。

这两个家伙联手，就能在编译时或者运行时，根据 Attribute 的信息，利用 Reflection 去修改或生成代码。这感觉，就像拥有了魔法棒，想变啥就变啥！

Attribute：给代码贴标签

首先，咱们来认识一下 Attribute。这玩意儿就像给代码贴标签，给类、方法、属性打上标记，说明它们有特殊的含义。

<?php

#[Attribute]
class MyAttribute
{
    public function __construct(public string $message) {}
}

#[MyAttribute("Hello, world!")]
class MyClass
{
    public function myMethod()
    {
        echo "Original method.n";
    }
}

这里，我们定义了一个名为 MyAttribute 的 Attribute 类，它可以接收一个字符串参数 message。然后，我们用 #[MyAttribute("Hello, world!")] 给 MyClass 打上了标签。

注意：Attribute 类必须使用 #[Attribute] 标记。

Reflection：代码的透视眼

接下来，咱们看看 Reflection。这玩意儿就像X光，能穿透代码，获取各种信息。

<?php

#[Attribute]
class MyAttribute
{
    public function __construct(public string $message) {}
}

#[MyAttribute("Hello, world!")]
class MyClass
{
    public function myMethod()
    {
        echo "Original method.n";
    }
}

$reflectionClass = new ReflectionClass(MyClass::class);
$attributes = $reflectionClass->getAttributes(MyAttribute::class);

foreach ($attributes as $attribute) {
    $instance = $attribute->newInstance();
    echo $instance->message . "n"; // 输出：Hello, world!
}

这里，我们使用 ReflectionClass 获取了 MyClass 的反射信息。然后，通过 getAttributes() 方法获取了 MyClass 上所有类型为 MyAttribute 的 Attribute。最后，我们实例化了 Attribute 类，并输出了它的 message 属性。

实战演练：方法拦截器

光说不练假把式，咱们来个实战演练。假设我们需要实现一个方法拦截器，在方法执行前后做一些事情，比如记录日志、检查权限等。

<?php

#[Attribute]
class Loggable
{
    public function __construct(public string $logMessage) {}
}

class Logger
{
    public function log(string $message): void
    {
        echo "[LOG] " . $message . "n";
    }
}

trait LoggableTrait
{
    public function __call(string $name, array $arguments)
    {
        $reflectionMethod = new ReflectionMethod($this, $name);
        $attributes = $reflectionMethod->getAttributes(Loggable::class);

        if (!empty($attributes)) {
            $logger = new Logger();
            $loggableAttribute = $attributes[0]->newInstance(); //assume only one Loggable attribute
            $logger->log($loggableAttribute->logMessage . " - Before method: " . $name);

            $result = $reflectionMethod->invokeArgs($this, $arguments);

            $logger->log($loggableAttribute->logMessage . " - After method: " . $name);

            return $result;

        } else {
            throw new BadMethodCallException("Method {$name} does not exist or is not loggable.");
        }
    }
}

class MyService
{
    use LoggableTrait;

    #[Loggable("MyService::doSomething")]
    public function doSomething(string $input): string
    {
        echo "Doing something with: " . $input . "n";
        return "Result: " . strtoupper($input);
    }

    public function anotherMethod(string $input): string
    {
        echo "Doing something else with: " . $input . "n";
        return "Another Result: " . strtolower($input);
    }
}

$service = new MyService();
$result = $service->doSomething("example");
echo "Result: " . $result . "n";

// 会输出:
// [LOG] MyService::doSomething - Before method: doSomething
// Doing something with: example
// [LOG] MyService::doSomething - After method: doSomething
// Result: RESULT: EXAMPLE

$service->anotherMethod("EXAMPLE"); //调用正常方法，不会触发拦截器

这个例子中，我们定义了一个 Loggable 的 Attribute，用于标记需要记录日志的方法。然后，我们定义了一个 Logger 类，用于记录日志。LoggableTrait 使用了魔术方法__call，当调用不存在或者访问权限不允许的方法时，会调用该方法。在__call中，判断是否存在Loggable的Attribute，存在的话就调用logger，记录日志，并执行原方法。如果不存在对应的Attribute，则直接抛出异常。

更高级的玩法：自动验证

再来一个更高级的玩法：自动验证。假设我们需要对方法的参数进行验证，比如检查参数是否为空、是否符合特定的格式等。

<?php

use Attribute;
use ReflectionMethod;
use ReflectionParameter;
use TypeError;

#[Attribute(Attribute::TARGET_PARAMETER)]
class NotEmpty
{
    public function __construct(public string $message = 'This value should not be empty.') {}
}

#[Attribute(Attribute::TARGET_PARAMETER)]
class Email
{
    public function __construct(public string $message = 'This value should be a valid email address.') {}
}

class Validator
{
    public static function validate(object $object, string $methodName, array $arguments): void
    {
        $reflectionMethod = new ReflectionMethod($object, $methodName);
        $parameters = $reflectionMethod->getParameters();

        foreach ($parameters as $index => $parameter) {
            foreach ($parameter->getAttributes() as $attribute) {
                $attributeInstance = $attribute->newInstance();

                if ($attributeInstance instanceof NotEmpty && empty($arguments[$index])) {
                    throw new InvalidArgumentException($parameter->getName() . ': ' . $attributeInstance->message);
                }

                if ($attributeInstance instanceof Email && !filter_var($arguments[$index], FILTER_VALIDATE_EMAIL)) {
                    throw new InvalidArgumentException($parameter->getName() . ': ' . $attributeInstance->message);
                }
            }
        }
    }
}

class User
{
    public function createUser(#[NotEmpty] string $username, #[Email] string $email): void
    {
        echo "Creating user: " . $username . " (" . $email . ")n";
    }
}

try {
    $user = new User();
    //Validator::validate($user, 'createUser', ['', 'invalid-email']);
    $user->createUser("john.doe", "[email protected]");
    // 会输出: Creating user: john.doe ([email protected])
    $user->createUser("", "[email protected]"); //会抛出异常
} catch (InvalidArgumentException $e) {
    echo "Validation error: " . $e->getMessage() . "n";
}

这个例子中，我们定义了 NotEmpty 和 Email 两个 Attribute，分别用于标记不能为空的参数和必须是邮箱格式的参数。然后，我们定义了一个 Validator 类，用于验证方法的参数。最后，我们在 User 类的 createUser 方法中使用了这两个 Attribute。

编译时元编程的可能性（PHP 8.1+）

虽然 PHP 的元编程主要集中在运行时，但 PHP 8.1 引入了 fibers，为编译时元编程带来了一些可能性。 通过结合 Reflection 和 Attribute，以及自定义的编译过程（例如，通过扩展），我们可以在编译时生成或修改代码。 这方面的实践还比较少，但潜力巨大。

元编程的注意事项

元编程虽然强大，但也需要谨慎使用，否则容易掉进坑里。

• 过度使用： 不要为了元编程而元编程。如果简单的代码就能解决问题，就不要引入复杂的元编程逻辑。
• 可读性： 元编程可能会降低代码的可读性。确保你的代码足够清晰，方便他人理解和维护。
• 性能： 元编程可能会影响代码的性能。在性能敏感的场景下，需要仔细评估。
• 调试： 元编程可能会增加代码的调试难度。确保你有足够的调试工具和技巧。

总结

Reflection Extension 结合 Attribute，为PHP的元编程打开了一扇新的大门。我们可以利用它们，在编译时或者运行时动态地修改或生成代码，实现各种各样的功能，比如方法拦截、自动验证、依赖注入等等。

当然，元编程是一把双刃剑，需要谨慎使用。只有在合适的场景下，才能发挥它的最大威力。

Q&A环节

好了，今天的讲座就到这里。大家有什么问题吗？可以提出来，咱们一起讨论讨论。

附录：常用 Reflection 类和方法

为了方便大家查阅，我整理了一些常用的 Reflection 类和方法，供大家参考。

类/方法	描述
ReflectionClass	用于获取类的反射信息。
ReflectionMethod	用于获取方法的反射信息。
ReflectionProperty	用于获取属性的反射信息。
ReflectionParameter	用于获取方法参数的反射信息。
getAttributes()	获取类、方法、属性或参数上的所有 Attribute。
newInstance()	实例化一个类。
invoke()	调用一个方法。
getValue()	获取一个属性的值。
setValue()	设置一个属性的值。
isPublic()	判断一个方法或属性是否是 public 的。
isProtected()	判断一个方法或属性是否是 protected 的。
isPrivate()	判断一个方法或属性是否是 private 的。
isStatic()	判断一个方法或属性是否是 static 的。
getDefaultValue()	获取一个参数的默认值。
getType()	获取一个参数的类型。
hasType()	判断一个参数是否有类型声明。
getName()	获取类、方法、属性或参数的名称。
getParameters()	获取一个方法的所有参数。
getProperties()	获取一个类的所有属性。
getMethods()	获取一个类的所有方法。

希望这些信息对大家有所帮助。 记住，学无止境，多敲代码，多思考，才能成为真正的编程高手！ 散会！