Golang实现AST与JSON互转的插件库asty的使用

asty是一个将Golang抽象语法树(AST)与JSON互相转换的工具库。它可以将Golang代码转换为JSON格式的AST表示，也可以将JSON格式的AST转换回Golang代码。

示例

输入Golang源代码

package main

import "fmt"

func main() {
    fmt.Println("hello world")
}

输出AST的JSON表示

{
  "NodeType": "File",
  "Name": {
    "NodeType": "Ident",
    "Name": "main"
  },
  "Decls": [
    {
      "NodeType": "GenDecl",
      "Tok": "import",
      "Specs": [
        {
          "NodeType": "ImportSpec",
          "Name": null,
          "Path": {
            "NodeType": "BasicLit",
            "Kind": "STRING",
            "Value": "\"fmt\""
          }
        }
      ]
    },
    {
      "NodeType": "FuncDecl",
      "Recv": null,
      "Name": {
        "NodeType": "Ident",
        "Name": "main"
      },
      "Type": {
        "NodeType": "FuncType",
        "TypeParams": null,
        "Params": {
          "NodeType": "FieldList",
          "List": null
        },
        "Results": null
      },
      "Body": {
        "NodeType": "BlockStmt",
        "List": [
          {
            "NodeType": "ExprStmt",
            "X": {
              "NodeType": "CallExpr",
              "Fun": {
                "NodeType": "SelectorExpr",
                "X": {
                  "NodeType": "Ident",
                  "Name": "fmt"
                },
                "Sel": {
                  "NodeType": "Ident",
                  "Name": "Println"
                }
              },
              "Args": [
                {
                  "NodeType": "BasicLit",
                  "Kind": "STRING",
                  "Value": "\"hello world\""
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

安装

将asty安装到$GOPATH/bin目录：

go install github.com/asty-org/asty

asty -h

使用

将AST转换为JSON

asty go2json -input <input.go> -output <output.json>

将JSON转换为AST

asty json2go -input <input.json> -output <output.go>

使用asty help获取更多帮助信息。

使用Docker运行

docker run astyorg/asty go2json -input <input.go> -output <output.json>

开发原则

1. 保持JSON输出尽可能接近真实的Golang结构，不引入额外逻辑，不做规范化或重新解释
2. 保持高度明确性，不使用反射或字段列表，便于未来维护
3. 在JSON结构中保持多态性，通过对象类型名称字段区分具体类型

完整示例

package main

import (
	"fmt"
	"github.com/asty-org/asty"
	"go/ast"
	"go/parser"
	"go/token"
)

func main() {
	// 示例1: 将Go代码转换为AST JSON
	fset := token.NewFileSet()
	node, err := parser.ParseFile(fset, "example.go", `
	package main

	import "fmt"

	func main() {
		fmt.Println("hello world")
	}
	`, parser.ParseComments)
	if err != nil {
		fmt.Printf("Error parsing file: %v\n", err)
		return
	}

	// 将AST转换为JSON
	jsonData, err := asty.Marshal(node)
	if err != nil {
		fmt.Printf("Error marshaling AST to JSON: %v\n", err)
		return
	}
	fmt.Printf("AST JSON:\n%s\n", jsonData)

	// 示例2: 将JSON转换回AST
	var astFile ast.File
	err = asty.Unmarshal(jsonData, &astFile)
	if err != nil {
		fmt.Printf("Error unmarshaling JSON to AST: %v\n", err)
		return
	}
	fmt.Printf("Successfully converted JSON back to AST\n")

	// 示例3: 使用asty命令行工具的功能
	fmt.Println("To convert a Go file to JSON AST:")
	fmt.Println("  asty go2json -input input.go -output output.json")
	fmt.Println("To convert a JSON AST back to Go:")
	fmt.Println("  asty json2go -input input.json -output output.go")
}

这个示例展示了如何使用asty库在代码中将Go源文件解析为AST，然后将其转换为JSON格式，以及如何将JSON格式的AST转换回Go的AST结构。同时提供了使用命令行工具的示例。