go-callvis 项目教程

go-callvis 项目教程

go-callvis 项目地址: https://gitcode.com/gh_mirrors/goca/go-callvis

1. 项目目录结构及介绍

go-callvis 项目的目录结构如下：

go-callvis/
├── examples/
├── images/
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── _config.yml
├── analysis.go
├── dot.go
├── dot_cgo.go
├── dot_nocgo.go
├── go.mod
├── go.sum
├── handler.go
├── main.go
├── output.go
└── version.go

目录结构介绍

• examples/: 包含一些示例代码，用于展示如何使用 go-callvis 工具。
• images/: 包含一些生成的可视化图像示例。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• Makefile: 用于编译和安装项目的 Makefile 文件。
• README.md: 项目介绍和使用说明。
• _config.yml: 项目配置文件（如果有）。
• analysis.go: 分析 Go 程序的调用图的代码。
• dot.go: 生成 Graphviz 的 dot 文件的代码。
• dot_cgo.go: 处理 CGO 调用的 dot 文件生成代码。
• dot_nocgo.go: 处理非 CGO 调用的 dot 文件生成代码。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块的校验和文件。
• handler.go: 处理 HTTP 请求的代码。
• main.go: 项目的主入口文件。
• output.go: 处理输出文件的代码。
• version.go: 版本信息相关的代码。

2. 项目启动文件介绍

项目的启动文件是 main.go，它是整个 go-callvis 工具的入口点。以下是 main.go 文件的简要介绍：

package main

import (
    "flag"
    "log"
    "os"
    "runtime/pprof"

    "github.com/ofabry/go-callvis/analysis"
    "github.com/ofabry/go-callvis/dot"
    "github.com/ofabry/go-callvis/handler"
    "github.com/ofabry/go-callvis/output"
)

func main() {
    // 解析命令行参数
    flag.Parse()

    // 初始化分析器
    analyzer := analysis.NewAnalyzer()

    // 生成调用图
    graph := analyzer.Analyze()

    // 生成 dot 文件
    dot.Generate(graph)

    // 启动 HTTP 服务器
    handler.StartServer()

    // 处理输出
    output.HandleOutput()
}

主要功能

• 命令行参数解析: 使用 flag 包解析命令行参数。
• 分析器初始化: 初始化 analysis.Analyzer 对象，用于分析 Go 程序的调用图。
• 生成调用图: 调用 analyzer.Analyze() 方法生成调用图。
• 生成 dot 文件: 调用 dot.Generate() 方法生成 Graphviz 的 dot 文件。
• 启动 HTTP 服务器: 调用 handler.StartServer() 方法启动 HTTP 服务器，提供交互式可视化界面。
• 处理输出: 调用 output.HandleOutput() 方法处理输出文件。

3. 项目的配置文件介绍

go-callvis 项目没有传统的配置文件，但可以通过命令行参数进行配置。以下是一些常用的命令行参数：

go-callvis [flags] <main package>

常用参数

• -focus: 聚焦特定的包，使用包名或导入路径。
• -group: 按包或类型分组函数。
• -ignore: 忽略包含指定前缀的包路径。
• -include: 包含包含指定前缀的包路径。
• -limit: 限制包路径到指定前缀。
• -minlen: 设置边的最小长度（用于更宽的输出）。
• -nodesep: 设置两个相邻节点之间的最小空间（用于更高的输出）。
• -nointer: 忽略对未导出函数的调用。
• -nostd: 忽略标准库的调用。
• -rankdir: 设置图布局的方向（LR、RL、TB、BT）。
• -skipbrowser: 跳过打开浏览器。
• -tags: 设置构建标签。
• -tests: 包含测试代码。
• -version: 显示版本并退出。

示例

go-callvis -focus=main -group=pkg,type -ignore=github.com/gin-gonic/gin -limit=github.com/your/package main

这个命令会生成一个聚焦于 main 包的调用图，按包和类型分组函数，忽略 github.com/gin-gonic/gin 包，并限制包路径到 github.com/your/package。

通过这些命令行参数，用户可以根据需要定制 go-callvis 的行为。

go-callvis 项目地址: https://gitcode.com/gh_mirrors/goca/go-callvis