Vestigo 开源项目使用教程

Vestigo 开源项目使用教程

vestigoEcho Inspired Stand Alone URL Router项目地址:https://gitcode.com/gh_mirrors/ve/vestigo

1. 项目的目录结构及介绍

Vestigo 项目的目录结构如下：

vestigo/
├── LICENSE
├── README.md
├── examples/
│   ├── basic/
│   │   ├── main.go
│   │   └── routes.go
│   └── middleware/
│       ├── main.go
│       └── routes.go
├── godoc.org/
│   └── ...
├── vestigo/
│   ├── binder.go
│   ├── cors.go
│   ├── doc.go
│   ├── echo.go
│   ├── echo_test.go
│   ├── middleware.go
│   ├── middleware_test.go
│   ├── router.go
│   ├── router_test.go
│   ├── trace.go
│   └── util.go
└── vendor/
    └── ...

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• examples/: 示例代码目录，包含基本示例和中间件示例。
  • basic/: 基本示例目录，包含 main.go 和 routes.go。
  • middleware/: 中间件示例目录，包含 main.go 和 routes.go。
• vestigo/: 核心代码目录，包含路由、中间件等相关代码。
  • binder.go: 绑定器相关代码。
  • cors.go: CORS 相关代码。
  • doc.go: 文档注释。
  • echo.go: 回显相关代码。
  • echo_test.go: 回显测试代码。
  • middleware.go: 中间件相关代码。
  • middleware_test.go: 中间件测试代码。
  • router.go: 路由相关代码。
  • router_test.go: 路由测试代码。
  • trace.go: 追踪相关代码。
  • util.go: 工具类代码。
• vendor/: 第三方依赖包目录。

2. 项目的启动文件介绍

项目的启动文件通常位于 examples/ 目录下的 main.go 文件。以下是一个基本示例的启动文件内容：

package main

import (
    "log"
    "net/http"
    "github.com/husobee/vestigo"
)

func main() {
    router := vestigo.NewRouter()
    router.Get("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello, World!"))
    })
    log.Fatal(http.ListenAndServe(":8080", router))
}

启动文件介绍

• package main: 定义主包。
• import: 导入所需的包。
• main(): 主函数，程序入口。
  • vestigo.NewRouter(): 创建一个新的路由器实例。
  • router.Get("/", ...): 定义一个 GET 请求的路由处理函数。
  • http.ListenAndServe(":8080", router): 启动 HTTP 服务器并监听 8080 端口。

3. 项目的配置文件介绍

Vestigo 项目本身没有特定的配置文件，配置主要通过代码进行。例如，可以通过代码配置路由、中间件等。

配置示例

package main

import (
    "log"
    "net/http"
    "github.com/husobee/vestigo"
)

func main() {
    router := vestigo.NewRouter()
    router.SetGlobalCors(&vestigo.CorsAccessControl{
        AllowOrigin:      []string{"*"},
        AllowCredentials: true,
    })
    router.Get("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello, World!"))
    })
    log.Fatal(http.ListenAndServe(":8080", router))
}

配置文件介绍

• SetGlobalCors(&vestigo.CorsAccessControl{...}): 设置全局 CORS 配置。
  • AllowOrigin: 允许的

vestigoEcho Inspired Stand Alone URL Router项目地址:https://gitcode.com/gh_mirrors/ve/vestigo