使用Go语言的PHP语法解析插件库php-parser

php-parser是一个用Go语言编写的PHP语法解析库，它可以将PHP代码解析为抽象语法树(AST)。下面我将介绍如何使用这个库以及提供一些示例代码。

安装php-parser

首先，你需要安装这个库：

go get github.com/z7zmey/php-parser

基本使用方法

解析PHP代码

package main

import (
	"fmt"
	"github.com/z7zmey/php-parser/pkg/ast"
	"github.com/z7zmey/php-parser/pkg/conf"
	"github.com/z7zmey/php-parser/pkg/parser"
	"github.com/z7zmey/php-parser/pkg/version"
	"github.com/z7zmey/php-parser/pkg/visitor"
)

func main() {
	// 要解析的PHP代码
	src := `<?php
		function hello($name) {
			echo "Hello, " . $name;
		}
	?>`

	// 创建配置
	config := conf.Config{
		Version: &version.Version{
			Major: 7,
			Minor: 4,
		},
	}

	// 创建解析器
	parser := parser.NewParser([]byte(src), config)

	// 解析代码
	parser.Parse()

	// 获取根节点
	rootNode := parser.GetRootNode()

	// 打印AST
	fmt.Printf("%+v\n", rootNode)
}

遍历AST

// 自定义访问者结构体
type MyVisitor struct {
	visitor.Null
}

// 重写EnterNode方法
func (v *MyVisitor) EnterNode(node ast.Vertex) bool {
	switch n := node.(type) {
	case *ast.StmtFunction:
		fmt.Printf("Found function: %s\n", n.Name)
	case *ast.ExprVariable:
		fmt.Printf("Found variable: %s\n", n.Name)
	}
	return true
}

func main() {
	src := `<?php
		function hello($name) {
			echo "Hello, " . $name;
			$age = 25;
		}
	?>`

	config := conf.Config{Version: &version.Version{Major: 7, Minor: 4}}
	parser := parser.NewParser([]byte(src), config)
	parser.Parse()
	rootNode := parser.GetRootNode()

	// 使用自定义访问者遍历AST
	visitor := &MyVisitor{}
	rootNode.Accept(visitor)
}

高级用法

修改AST

type FunctionRenamer struct {
	visitor.Null
}

func (v *FunctionRenamer) EnterNode(node ast.Vertex) bool {
	if n, ok := node.(*ast.StmtFunction); ok {
		n.Name = "new_" + n.Name
	}
	return true
}

func main() {
	src := `<?php function old_name() {} ?>`
	
	config := conf.Config{Version: &version.Version{Major: 7, Minor: 4}}
	parser := parser.NewParser([]byte(src), config)
	parser.Parse()
	rootNode := parser.GetRootNode()

	// 重命名函数
	renamer := &FunctionRenamer{}
	rootNode.Accept(renamer)

	// 打印修改后的AST
	fmt.Printf("%+v\n", rootNode)
}

生成PHP代码

import "github.com/z7zmey/php-parser/pkg/printer"

func main() {
	src := `<?php function test() { return 1+2; } ?>`
	
	config := conf.Config{Version: &version.Version{Major: 7, Minor: 4}}
	parser := parser.NewParser([]byte(src), config)
	parser.Parse()
	rootNode := parser.GetRootNode()

	// 创建打印机
	p := printer.NewPrinter(os.Stdout)
	
	// 打印PHP代码
	p.Print(rootNode)
}

实际应用示例

提取所有函数调用

type FunctionCallCollector struct {
	visitor.Null
	Calls []string
}

func (v *FunctionCallCollector) EnterNode(node ast.Vertex) bool {
	if n, ok := node.(*ast.ExprFunctionCall); ok {
		if name, ok := n.Function.(*ast.Name); ok {
			v.Calls = append(v.Calls, name.Parts[0].(*ast.NamePart).Value)
		}
	}
	return true
}

func main() {
	src := `<?php
		foo();
		bar();
		namespace\baz();
	?>`

	config := conf.Config{Version: &version.Version{Major: 7, Minor: 4}}
	parser := parser.NewParser([]byte(src), config)
	parser.Parse()
	rootNode := parser.GetRootNode()

	collector := &FunctionCallCollector{}
	rootNode.Accept(collector)

	fmt.Println("Function calls found:")
	for _, call := range collector.Calls {
		fmt.Println("-", call)
	}
}

注意事项

1. php-parser支持PHP 5.4到PHP 8.0的语法，可以通过配置指定PHP版本
2. 解析大型PHP文件时可能需要较多内存
3. AST节点类型丰富，需要熟悉库提供的各种节点类型
4. 错误处理需要检查parser.Errors()获取解析错误

php-parser是一个功能强大的PHP解析库，适合用于静态分析、代码转换、代码生成等场景。通过组合不同的访问者，可以实现复杂的代码分析逻辑。