GoAST Viewer 项目使用教程
1. 项目的目录结构及介绍
GoAST Viewer 是一个用于可视化 Go 语言抽象语法树（AST）的工具。项目的目录结构如下：
goast-viewer/
├── README.md
├── assets/
│ ├── css/
│ ├── js/
│ └── templates/
├── cmd/
│ └── server/
│ └── main.go
├── go.mod
├── go.sum
├── internal/
│ ├── app/
│ └── handler/
└── web/
├── index.html
└── static/
目录结构介绍
README.md: 项目说明文件。assets/: 包含项目的静态资源，如 CSS、JavaScript 和模板文件。cmd/: 包含项目的可执行文件的入口点。
server/: 服务器启动文件所在的目录。
main.go: 服务器启动文件。
go.mod 和 go.sum: Go 模块文件，用于管理项目依赖。internal/: 包含项目的内部包，如应用逻辑和处理程序。web/: 包含 Web 界面的相关文件，如 HTML 和静态资源。
2. 项目的启动文件介绍
项目的启动文件位于 cmd/server/main.go。这个文件是整个应用的入口点，负责启动服务器并初始化应用。
package main
import (
"log"
"net/http"
"github.com/yuroyoro/goast-viewer/internal/app"
)
func main() {
// 初始化应用
app := app.NewApp()
// 设置路由
http.HandleFunc("/", app.HandleRequest)
// 启动服务器
log.Println("Starting server on :8080")
if err := http.ListenAndServe(":8080", nil); err != nil {
log.Fatal(err)
}
}
启动文件介绍
main.go: 包含 main 函数，负责初始化应用、设置路由并启动服务器。app.NewApp(): 初始化应用实例。http.HandleFunc("/", app.HandleRequest): 设置根路径的路由处理函数。http.ListenAndServe(":8080", nil): 启动 HTTP 服务器，监听 8080 端口。
3. 项目的配置文件介绍
GoAST Viewer 项目没有显式的配置文件，所有的配置都是通过代码中的常量或环境变量来完成的。例如，服务器的监听端口在 main.go 中通过 http.ListenAndServe(":8080", nil) 指定。
如果需要自定义配置，可以通过修改代码中的常量或使用环境变量来实现。
配置示例
// 在 main.go 中
const (
DefaultPort = "8080"
)
func main() {
port := os.Getenv("PORT")
if port == "" {
port = DefaultPort
}
log.Println("Starting server on :" + port)
if err := http.ListenAndServe(":"+port, nil); err != nil {
log.Fatal(err)
}
}
通过这种方式，可以通过设置环境变量 PORT 来动态配置服务器的监听端口。
以上是 GoAST Viewer 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。