介紹
PHP-Parse 是分析 PHP 代碼生成 AST 的庫凡蚜，分析出可讀性很高的對象數(shù)據(jù)結(jié)構(gòu)，方便后續(xù)的更新和遍歷恳谎。
PHP-Parse 的主要作用是修改原有代碼（比如插入自定義的代碼片段）肥荔，生成新的代理類 骇两〖咏停框架內(nèi)生成代理類拳喻，處理注入有用到哭当，比如 Hyperf 的 DI 組件利用反射和 PHP-Parse 實現(xiàn)了注入。
AST 的簡單介紹 具體搜索冗澈，資料很多钦勘，講得很好
比如下面 PHP 代碼會被解析成
// 04020b0b-ce35-4b4c-a688-d40a3c7dc4e2
<?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 表示節(jié)點中包含的 PHP 語句。比如 Stmt_Namespace 對象（NameSpace 命名空間） 的 stmts 數(shù)組含有一個 Stmt_Class 對象（SomeClass 類名）捌归，Stmt_Class 對象的 stmts 數(shù)組含有一個 Stmt_ClassMethod（echo 方法）
以上執(zhí)行代碼在 https://github.com/bytehello/PHP-Parse-demo/blob/main/example1.php
節(jié)點類型
- statement node 沒有返回值肛响，不會出現(xiàn)在別的語句當中，比如說類定義陨溅，不會出現(xiàn)func(class A {});
- expr node 有返回值终惑，會出現(xiàn)在別的語句當中绍在。比如func()门扇、$foo
- scalar values 標量值，比如 'string' (PhpParser\Node\Scalar\String_)
- 還有一些其他分類：名字（ PhpParser\Node\Name）偿渡，調(diào)用參數(shù)（ PhpParser\Node\Arg）
其中
Node\Stmt\Expression 表示 expr;臼寄，Node\Expr 表示expr。
區(qū)別是一個帶分號溜宽，一個不帶分號
操作節(jié)點
節(jié)點修改
節(jié)點的遍歷和修改修改是通過添加 visitor吉拳，原理就是在遍歷 AST 的時候，會調(diào)用到 visitor 中的方法适揉，我們想要修改節(jié)點只要實現(xiàn) visitor 中的方法即可留攒。具體的修改操作是在 visitor 這個對象內(nèi)完成
打個實際的例子 別墅(AST)需要裝修,管家(NodeTraverser)帶著裝修隊(visitor)去到別墅的房間一間一間瀏覽，在進入房間后(調(diào)用visitor的enterNode方法)嫉嘀，裝修隊會記錄房間的內(nèi)容(enterNode方法你自己的實現(xiàn)炼邀，當然也可以什么都不做)，在離開房間后(調(diào)用visitor的leaveNode方法)剪侮，裝修隊開始施工(修改節(jié)點)
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';
}
}
}
執(zhí)行以上后會輸出
<?php
echo 'World';
在遍歷 AST 時拭宁，visitor 會調(diào)用多個方法：enterNode、leaveNode 等瓣俯，修改節(jié)點的操作通常都是在 leaveNode 中完成（這句話是重點杰标，下面會用到）。
以上執(zhí)行代碼在 https://github.com/bytehello/PHP-Parse-demo/blob/main/example2.php
參考 https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
代碼構(gòu)造
除了遍歷彩匕，還可以直接構(gòu)造 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);
執(zhí)行上述代碼生成
<?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
以上執(zhí)行代碼在 https://github.com/bytehello/PHP-Parse-demo/blob/main/example3.php
參考 https://github.com/nikic/PHP-Parser/blob/master/doc/component/AST_builders.markdown
實例講解
以 https://github.com/hyperf/hyperf-skeleton 的骨架講解
項目啟動會在runtime下利用 AST 生成代理文件
代理文件內(nèi)容的部分如下
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() 開始 依次調(diào)用
2.vendor\hyperf\di\src\ClassLoader.php 的 __construct
3.vendor\hyperf\di\src\Aop\ProxyManager.php 的__construct驻仅，此構(gòu)造方法內(nèi)有生成代理類方法 generateProxyFiles
4.generateProxyFiles 內(nèi)調(diào)用 putProxyFile 生成代理文件
5.putProxyFile 方法內(nèi)部 其實調(diào)用了vendor\hyperf\di\src\Aop\Ast.php 的 proxy 方法，添加了若干的visitor登渣，比如"Hyperf\Di\Aop\PropertyHandlerVisitor"噪服、"Hyperf\Di\Aop\ProxyCallVisitor"
具體看 PropertyHandlerVisitor
public function leaveNode(Node $node)
{
// 僅提取了關(guān)鍵代碼
$constructor = $this->buildConstructor();
$constructor->stmts[] = $this->buildStaticCallStatement();
$node->stmts = array_merge(/* 構(gòu)造了 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 數(shù)組胜茧。vendor\hyperf\di\src\Aop\PropertyHandlerVisitor.php buildStaticCallStatement 方法就是添加 __handlePropertyHandler 的地方
注：vendor\hyperf\di\src\Aop\PropertyHandlerVisitor.php 在 Hyperf 的 v2.0.19 的代碼與上述有出入粘优，具體看本人提的PR： https://github.com/hyperf/hyperf/pull/2788
總結(jié)：
了解了PHP-Parse的基本用法：解析、遍歷呻顽、修改
了解了PHP-Parse在Hyperf中的應(yīng)用場景
作為實踐雹顺，本人也寫了個小工具用戶生成 PHP 條件語句的代碼片段，有興趣的同學(xué)可以看看哈 https://github.com/bytehello/condition-builder
