PHP如何通过反射获取接口方法的返回类型与参数类型

报错根因 #

你遇到的「Function xxx does not exist」错误核心原因是反射类使用错误：

• ReflectionFunction仅能反射全局作用域下定义的独立函数，无法识别类、接口、Trait 中定义的方法
• 类内的getId()、setId()是类方法，必须使用ReflectionMethod进行反射，同时需要绑定方法所属的类或实例才能正常读取

注：即使方法实际定义在你引入的BuilderFoo Trait中，只要被类use引入，就可以直接通过类反射读取到方法信息，不需要单独反射Trait。

涉及的原有接口定义 #

interface FooInterface
{
    /**
     * @return int
     */
    public function getId(): int;
    /**
     * @param int $id
     */
    public function setId(int $id);
}

核心需求 #

• 获取getter方法的返回类型，用于动态格式化值
• 获取setter方法的参数类型，用于动态初始化参数

正确实现代码 #

class Foo extends FooAbstract implements FooInterface
{
    use BuilderFoo; // 该Trait中包含FooInterface的方法实现

    /**
     * 获取类方法第一个参数的类型
     * @param string $functionName 方法名
     * @return \ReflectionType|null
     * @throws \ReflectionException
     */
    protected function getParamTypeValue(string $functionName)
    {
        // 传入当前实例和方法名，反射类方法
        $reflectionMethod = new \ReflectionMethod($this, $functionName);
        $params = $reflectionMethod->getParameters();
        // 增加空判断，避免无参方法调用时下标越界
        if (empty($params)) {
            return null;
        }
        return $params[0]->getType();
    }

    /**
     * 获取类方法的返回值类型
     * @param string $functionName 方法名
     * @return \ReflectionType|null
     * @throws \ReflectionException
     */
    protected function getReturnTypeValue(string $functionName)
    {
        $reflectionMethod = new \ReflectionMethod($this, $functionName);
        return $reflectionMethod->getReturnType();
    }

    // 调用测试
    public function testDemo()
    {
        // 输出ReflectionNamedType实例，调用getName()可拿到字符串"int"
        var_dump($this->getParamTypeValue('setId'));
        var_dump($this->getReturnTypeValue('getId'));
    }
}

使用补充 #

• 如果需要直接拿到类型的字符串值（比如int、string），可以在拿到返回的ReflectionType对象后调用getName()方法，例如$this->getParamTypeValue('setId')->getName()
• 如果需要强制读取接口层面定义的类型、忽略实现类的重写修改，可以把反射实例化代码改为new \ReflectionMethod(FooInterface::class, $functionName)
• 对于PHP 7.0以下没有声明参数/返回类型的场景，可以配合反射读取方法注释的@param、@return标签做兼容解析

内容的提问来源于stack exchange，提问作者Mechprogra