Go 项目中模板文件路径的可靠解析策略

// App/Template/foo.go
package template

import "text/template"

var qTemplate *template.Template

func init() {
  // 这里的 "foo.tmpl" 是相对路径
  qTemplate = template.Must(template.New("temp").ParseFiles("foo.tmpl"))
}

// App/Template/foo.go
package template

import (
    "os"
    "path/filepath"
    "text/template"
)

var qTemplate *template.Template

func init() {
    // 获取当前执行时的绝对路径，这通常是你的项目根目录或go test的执行目录
    cwd, err := os.Getwd()
    if err != nil {
        panic(err) // 处理错误
    }

    // 假设模板文件总是相对于项目根目录的 "Template/foo.tmpl"
    // 这里的 "App" 应该是你的项目模块名，或者你需要找到一种方式获取项目根目录
    // 更通用的做法是，让 basePath 成为一个配置项或者通过其他方式确定
    // 为了演示，我们假设 foo.go 知道它自己相对于项目根目录的位置
    // 实际应用中，你可能需要一个全局的配置来指定模板目录
    // 例如：
    // projectRoot := findProjectRoot() // 自定义函数，例如通过模块名或环境变量
    // templatePath := filepath.Join(projectRoot, "Template", "foo.tmpl")

    // 一个更简单的假设是，所有代码都从项目根目录执行，或者我们知道相对于 CWD 的固定路径
    // 如果 foo.go 在 App/Template 目录下，并且 go test 从 App 目录执行
    // 那么 foo.tmpl 的相对路径是 "Template/foo.tmpl"
    // 如果 go test 从 App/Model 目录执行，那么相对路径就是 "../Template/foo.tmpl"
    // 这正是问题所在。

    // 解决办法：明确一个基准路径
    // 假设我们总能找到项目根目录，或者在编译时注入一个相对路径
    // 一个常见模式是，让模板路径相对于一个已知的、固定的应用程序数据目录。
    // 但如果必须基于当前文件，可以这样：
    _, filename, _, ok := runtime.Caller(0)
    if !ok {
        panic("Failed to get current file info")
    }
    currentDir := filepath.Dir(filename) // 获取 foo.go 所在的目录

    // 此时 currentDir 是 ~/go/src/github.com/App/Template
    templateFilePath := filepath.Join(currentDir, "foo.tmpl")

    qTemplate = template.Must(template.New("temp").ParseFiles(templateFilePath))
}

// showPath.go
package main

import (
    "fmt"
    "os"
    "path/filepath"
)

func main() {
    cwd, _ := os.Getwd()
    fmt.Println(filepath.Join(cwd, "./template/index.gtpl"))
}

// 定义一个常量或全局变量作为基准路径
// 假设项目根目录下有一个 public 文件夹存放静态资源和模板
var (
  basePath = "./public" // 相对于项目根目录
  templatePath = filepath.Join(basePath, "template")
  indexFile = filepath.Join(templatePath, "index.gtpl")
)

func loadTemplates() {
    // 假设 qTemplate 是全局变量
    qTemplate = template.Must(template.New("temp").ParseFiles(indexFile))
}

App/
  - main.go
  - Model/
    - bar.go
  - Another/
    - Directory/
      - baz.go
  - templates/          // 专门存放模板文件
    - foo.tmpl
    - header.tmpl
    - footer.tmpl
  - public/             // 存放静态资源
    - css/
    - js/

// main.go 或一个模板加载模块
package main

import (
    "path/filepath"
    "text/template"
)

var (
    // 假设 templatesDir 总是相对于项目根目录
    templatesDir = "./templates"
    fooTemplatePath = filepath.Join(templatesDir, "foo.tmpl")
    // 可以加载多个模板
    allTemplates = []string{
        filepath.Join(templatesDir, "header.tmpl"),
        filepath.Join(templatesDir, "foo.tmpl"),
        filepath.Join(templatesDir, "footer.tmpl"),
    }
)

func init() {
    // 加载单个模板
    // qTemplate = template.Must(template.New("temp").ParseFiles(fooTemplatePath))

    // 加载多个模板，通常用 ParseGlob 或 ParseFiles(files...)
    // 注意：ParseFiles 的第一个参数是主模板名
    qTemplate = template.Must(template.New("foo.tmpl").ParseFiles(allTemplates...))
}