PHP-Parse 簡介以及在 Hyperf 中的應用

abyte發表於2020-11-16
PHP

介紹

PHP-Parse 是分析 PHP 程式碼生成 AST 的庫，分析出可讀性很高的物件資料結構，方便後續的更新和遍歷。
PHP-Parse 的主要作用是修改原有程式碼（比如插入自定義的程式碼片段），生成新的代理類 。框架內生成代理類，處理注入有用到，比如 Hyperf 的 DI 元件利用反射和 PHP-Parse 實現了注入。

AST 的簡單介紹 具體搜尋，資料很多，講得很好
比如下面 PHP 程式碼會被解析成

<?php
namespace NameSpace;
class SomeClass
{
    protected function echo()
    {
        echo 'Hello';
    }
}
array(
    0: Stmt_Namespace(
        name: Name(
            parts: array(
                0: NameSpace
            )
        )
        stmts: array(
            0: Stmt_Class(
                attrGroups: array(
                )
                flags: 0
                name: Identifier(
                    name: SomeClass
                )
                extends: null
                implements: array(
                )
                stmts: array(
                    0: Stmt_ClassMethod(
                        attrGroups: array(
                        )
                        flags: MODIFIER_PROTECTED (2)
                        byRef: false
                        name: Identifier(
                            name: echo
                        )
                        params: array(
                        )
                        returnType: null
                        stmts: array(
                            0: Stmt_Echo(
                                exprs: array(
                                    0: Scalar_String(
                                        value: World
                                    )
                                )
                            )
                        )
                    )
                )
            )
        )
    )
)

大致對照看一下，解析後的物件對照原始碼，很清晰。

其中 stmts 表示節點中包含的 PHP 語句。比如 Stmt_Namespace 物件（NameSpace 名稱空間） 的 stmts 陣列含有一個 Stmt_Class 物件（SomeClass 類名），Stmt_Class 物件的 stmts 陣列含有一個 Stmt_ClassMethod（echo 方法）

以上執行程式碼在 github.com/bytehello/PHP-Parse-dem...

節點型別

  1. statement node 沒有返回值，不會出現在別的語句當中，比如說類定義，不會出現func(class A {});
  2. expr node 有返回值，會出現在別的語句當中。比如func()、$foo
  3. scalar values 標量值，比如 ‘string’ (PhpParser\Node\Scalar\String_)
  4. 還有一些其他分類：名字（ PhpParser\Node\Name），呼叫引數（ PhpParser\Node\Arg）

其中
Node\Stmt\Expression 表示 expr;，Node\Expr 表示expr。
區別是一個帶分號，一個不帶分號

操作節點

節點修改

節點的遍歷和修改修改是通過新增 visitor，原理就是在遍歷 AST 的時候，會呼叫到 visitor 中的方法，我們想要修改節點只要實現 visitor 中的方法即可。具體的修改操作是在 visitor 這個物件內完成

打個實際的例子 別墅(AST)需要裝修,管家(NodeTraverser)帶著裝修隊(visitor)去到別墅的房間一間一間瀏覽，在進入房間後(呼叫visitor的enterNode方法)，裝修隊會記錄房間的內容(enterNode方法你自己的實現，當然也可以什麼都不做)，在離開房間後(呼叫visitor的leaveNode方法)，裝修隊開始施工(修改節點)

use PhpParser\NodeTraverser;
use PhpParser\ParserFactory;
use PhpParser\PrettyPrinter;

        $code = <<<'CODE'
<?php
echo 'Hello';
CODE;
        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
        $traverser = new NodeTraverser;
        // add your visitor
        $traverser->addVisitor(new MyNodeVisitor);
        $ast = $parser->parse($code);
        $traverser->traverse($ast);
        $prettyPrinter = new PrettyPrinter\Standard();
        echo $prettyPrinter->prettyPrintFile($ast);
use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;

class MyNodeVisitor extends NodeVisitorAbstract
{
    public function leaveNode(Node $node) {
        if ($node instanceof Node\Scalar\String_) {
            $node->value = 'World';
        }
    }
}

執行以上後會輸出

<?php
echo 'World';

在遍歷 AST 時，visitor 會呼叫多個方法：enterNode、leaveNode 等，修改節點的操作通常都是在 leaveNode 中完成（這句話是重點，下面會用到）。

以上執行程式碼在 github.com/bytehello/PHP-Parse-dem...

參考 github.com/nikic/PHP-Parser/blob/m...

程式碼構造

除了遍歷，還可以直接構造 PHP 程式碼，比如

use PhpParser\NodeDumper;
use PhpParser\BuilderFactory;
use PhpParser\PrettyPrinter;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Stmt\If_;
$factor = new BuilderFactory;
        $node = $factor->namespace('Name\Space')
            ->addStmt($factor->use('Tools'))
            ->addStmt($factor->class('SomeClass')
                ->addStmt($factor->method('check')
                    ->makeProtected()
                    ->addParam($factor->param('orderData')->setDefault(null))
                    ->addStmt(
                        new Node\Expr\Assign($factor->var('ttt'), new Expr\MethodCall(new Expr\Variable('this'),'check', [
                            new Node\Arg(new Node\Scalar\MagicConst\Class_())
                        ]))
                    )
                    ->addStmt(
                        new Node\Stmt\If_($factor->var('ttt'), [
                            'stmts' => array(
                                new Node\Stmt\Expression(new Node\Expr\Print_(new Node\Expr\Variable('someParam'))) // 1.
                            )
                        ])
                    )
                    )
                    )
            ->getNode();;
        $stmts = array($node);
        $prettyPrinter = new PrettyPrinter\Standard();
        echo $prettyPrinter->prettyPrintFile($stmts);

執行上述程式碼生成

<?php

namespace Name\Space;

use Tools;
class SomeClass
{
    protected function check($orderData = null)
    {
        $ttt = $this->check(__CLASS__);
        if ($ttt) {
            print $someParam;
        }
    }
}

試一試：大家可以試試 上述程式碼標記為1的地方去掉new Node\Stmt\Expression()的包裹，試試看輸出，就能理解

Node\Stmt\Expression 表示 expr;Node\Expr 表示 expr

以上執行程式碼在 github.com/bytehello/PHP-Parse-dem...

參考 github.com/nikic/PHP-Parser/blob/m...

例項講解

以 github.com/hyperf/hyperf-skeleton 的骨架講解

專案啟動會在runtime下利用 AST 生成代理檔案

Hyperf 生成的代理類

代理檔案內容的部分如下

abstract class AbstractController
{
    use \Hyperf\Di\Aop\ProxyTrait;
    use \Hyperf\Di\Aop\PropertyHandlerTrait;
    function __construct()
    {
        self::__handlePropertyHandler(__CLASS__);
    }

新增的方法是 __handlePropertyHandler 方法，同時還新增了use \Hyperf\Di\Aop\ProxyTrait 和 use \Hyperf\Di\Aop\PropertyHandlerTrait

下面詳解是如何新增的
1.從入口檔案bin/hyperf.php中Hyperf\Di\ClassLoader::init() 開始 依次呼叫

2.vendor\hyperf\di\src\ClassLoader.php 的 __construct

3.vendor\hyperf\di\src\Aop\ProxyManager.php 的__construct，此構造方法內有生成代理類方法 generateProxyFiles

4.generateProxyFiles 內呼叫 putProxyFile 生成代理檔案

5.putProxyFile 方法內部 其實呼叫了vendor\hyperf\di\src\Aop\Ast.php 的 proxy 方法，新增了若干的visitor，比如”Hyperf\Di\Aop\PropertyHandlerVisitor”、”Hyperf\Di\Aop\ProxyCallVisitor”

具體看 PropertyHandlerVisitor

public function leaveNode(Node $node)
    {
         // 僅提取了關鍵程式碼
         $constructor = $this->buildConstructor(); 
         $constructor->stmts[] = $this->buildStaticCallStatement(); 
         $node->stmts = array_merge(/* 構造了 Trait */, [$constructor], $node->stmts);
    }

protected function buildStaticCallStatement(): Node\Stmt\Expression
    {
        return new Node\Stmt\Expression(new Node\Expr\StaticCall(new Name('self'), '__handlePropertyHandler', [
            new Node\Arg(new Node\Scalar\MagicConst\Class_()),
        ]));
    }

一目瞭然，就是操作 node 的 stmts 陣列。vendor\hyperf\di\src\Aop\PropertyHandlerVisitor.php buildStaticCallStatement 方法就是新增 __handlePropertyHandler 的地方
注：vendor\hyperf\di\src\Aop\PropertyHandlerVisitor.php 在 Hyperf 的 v2.0.19 的程式碼與上述有出入，具體看本人提的PR： github.com/hyperf/hyperf/pull/2788

總結：

  1. 瞭解了PHP-Parse的基本用法：解析、遍歷、修改

  2. 瞭解了PHP-Parse在Hyperf中的應用場景

作為實踐，本人也寫了個小工具使用者生成 PHP 條件語句的程式碼片段，有興趣的同學可以看看哈 github.com/bytehello/condition-bui...

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章