Hero 项目使用教程

Hero 项目使用教程

hero A handy, fast and powerful go template engine. 项目地址: https://gitcode.com/gh_mirrors/hero/hero

1. 项目目录结构及介绍

Hero 项目的目录结构如下：

hero/
├── examples/
│   └── app/
│       ├── index.html
│       ├── userlist.html
│       └── user.html
├── hero/
│   ├── bufferpool.go
│   ├── bufferpool_test.go
│   ├── doc.go
│   ├── generator.go
│   ├── generator_test.go
│   ├── parser.go
│   ├── parser_test.go
│   ├── sort.go
│   ├── sort_test.go
│   ├── util.go
│   └── util_test.go
├── .travis.yml
├── LICENSE
├── README.md
├── README_CN.md
└── main.go

目录结构介绍

• examples/: 包含示例应用的模板文件，如 index.html, userlist.html, user.html。
• hero/: 包含 Hero 模板引擎的核心代码，如 bufferpool.go, generator.go, parser.go 等。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目的英文介绍文档。
• README_CN.md: 项目的中文介绍文档。
• main.go: 项目的启动文件。

2. 项目启动文件介绍

main.go 是 Hero 项目的启动文件，负责启动一个简单的 HTTP 服务器并渲染模板。以下是 main.go 的代码示例：

package main

import (
    "bytes"
    "net/http"
    "app/template"
)

func main() {
    http.HandleFunc("/users", func(w http.ResponseWriter, req *http.Request) {
        var userList = []string{"Alice", "Bob", "Tom"}
        buffer := new(bytes.Buffer)
        template.UserList(userList, buffer)
        w.Write(buffer.Bytes())
    })
    http.ListenAndServe(":8080", nil)
}

启动文件介绍

• main 函数: 定义了 HTTP 服务器的路由和处理函数。
• template.UserList: 调用生成的模板函数 UserList 来渲染用户列表。
• http.ListenAndServe: 启动 HTTP 服务器，监听端口 8080。

3. 项目的配置文件介绍

Hero 项目没有传统的配置文件，但可以通过命令行参数来配置模板编译的行为。以下是常用的命令行参数：

hero [options] -source string -dest string -extensions string -pkgname string -watch

配置参数介绍

• -source: 指定 HTML 模板文件或目录的路径。
• -dest: 指定生成的 Go 文件的输出目录。
• -extensions: 指定源文件的扩展名，多个扩展名用逗号分隔。
• -pkgname: 指定生成的模板包的名称。
• -watch: 是否在源文件更改时自动重新编译。

示例

hero -source="$GOPATH/src/app/template" -dest="$GOPATH/src/app/template" -extensions="html,htm" -pkgname="t" -watch

以上命令将监视 $GOPATH/src/app/template 目录下的所有 .html 和 .htm 文件，并在文件更改时自动编译生成 Go 文件。

hero A handy, fast and powerful go template engine. 项目地址: https://gitcode.com/gh_mirrors/hero/hero