如何利用php-ast检查PHP子类重写方法是否存在返回语句？

核心检测维度 #

要满足核心功能更新的要求，需同时验证两个关键点：

• 租户自定义类的myMethod签名匹配核心类（返回类型声明为array）
• 方法体内存在有效的数组返回语句

具体实现步骤 #

基于你已实现的AST遍历逻辑，针对PhpParser\Node\Stmt\ClassMethod节点做以下处理：

1. 筛选目标方法与父类验证 #

首先锁定需要检查的方法，并确认所在类继承自MyLibrary：

• 判断$classMethod->name->name是否等于'myMethod'
• 从方法的父节点（类节点）中获取extends属性，校验父类完整名称是否为MyLibrary（注意处理命名空间场景，需用toString()获取完整类名）

2. 校验方法返回类型签名 #

检查方法的返回类型声明是否为array：

• 若$classMethod->returnType是PhpParser\Node\Identifier类型，直接判断$node->returnType->name === 'array'
• 若为PhpParser\Node\Name类型，通过$node->returnType->toString()获取完整类型名后判断是否等于'array'（兼容不同PHP版本的AST节点差异）

3. 递归检测方法体内的返回语句 #

由于return语句可能嵌套在if、foreach等代码块中，必须递归遍历方法体的所有子节点：

• 遍历$classMethod->stmts（方法体的语句集合），识别PhpParser\Node\Stmt\Return_类型节点
• 对每个return节点，检查其expr属性：
  • 若expr是PhpParser\Node\Expr\Array_（字面量数组），则判定为有效返回
  • 若需要覆盖变量、函数调用返回数组的场景，可扩展类型推断逻辑（比如检查变量的类型声明、函数的返回类型）

代码示例片段 #

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;

class MyMethodReturnChecker extends NodeVisitorAbstract
{
    private $invalidEntries = [];

    public function enterNode(Node $node)
    {
        if (!$node instanceof Node\Stmt\ClassMethod) {
            return;
        }

        // 筛选目标方法
        if ($node->name->name !== 'myMethod') {
            return;
        }

        // 验证父类为MyLibrary
        $classNode = $node->getAttribute('parent');
        if (!$classNode instanceof Node\Stmt\Class_ || !$classNode->extends) {
            return;
        }
        if ($classNode->extends->toString() !== 'MyLibrary') {
            return;
        }

        // 检查返回类型签名
        $returnTypeValid = false;
        if ($node->returnType) {
            if ($node->returnType instanceof Node\Identifier) {
                $returnTypeValid = $node->returnType->name === 'array';
            } elseif ($node->returnType instanceof Node\Name) {
                $returnTypeValid = $node->returnType->toString() === 'array';
            }
        }
        if (!$returnTypeValid) {
            $this->invalidEntries[] = [
                'class' => $classNode->name->name,
                'reason' => '未声明array类型的返回值'
            ];
            return;
        }

        // 递归检查有效返回语句
        $hasValidReturn = false;
        $this->scanReturnStatements($node->stmts, $hasValidReturn);
        
        if (!$hasValidReturn) {
            $this->invalidEntries[] = [
                'class' => $classNode->name->name,
                'reason' => '方法体内无有效数组返回语句'
            ];
        }
    }

    private function scanReturnStatements(array $stmts, bool &$hasValidReturn)
    {
        foreach ($stmts as $stmt) {
            if ($hasValidReturn) break;

            if ($stmt instanceof Node\Stmt\Return_) {
                // 检测字面量数组返回，可扩展其他数组场景
                if ($stmt->expr instanceof Node\Expr\Array_) {
                    $hasValidReturn = true;
                }
            }

            // 递归遍历嵌套代码块
            if (property_exists($stmt, 'stmts') && is_array($stmt->stmts)) {
                $this->scanReturnStatements($stmt->stmts, $hasValidReturn);
            }
        }
    }

    public function getInvalidMethods()
    {
        return $this->invalidEntries;
    }
}

批量处理建议 #

遍历所有租户的代码文件，使用php-ast的parse_file()方法解析每个文件，再通过上述MyMethodReturnChecker遍历AST节点，最终收集所有不符合要求的租户类信息。

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