使用 Gin 框架加载 HTML 模板：`LoadHTMLGlob` 和 `LoadHTMLFiles` 的比较与优化

PS:在使用gin框架渲染前端模板时遇到了问题，关于这俩方法的一个区别，记录下来备忘一下。

在使用 Gin 框架开发 Web 应用时，模板渲染是一个常见的需求。Gin 提供了 LoadHTMLGlob 和 LoadHTMLFiles 两个函数来加载 HTML 模板。本文将详细介绍这两个函数的用法，并结合实际项目需求，探讨如何更灵活地加载模板文件，特别是当模板文件分布在多个子文件夹中时。

1. LoadHTMLGlob 函数

LoadHTMLGlob 函数用于根据通配符模式加载模板文件。它的签名如下：

func (engine *Engine) LoadHTMLGlob(pattern string)

用法示例

r := gin.Default()
r.LoadHTMLGlob("templates/*")

特点

• 一次调用 ：LoadHTMLGlob 只能调用一次，多次调用时只有最后一次调用生效。
• 通配符模式：支持通配符模式，可以一次性加载多个文件。
• 灵活性：适用于模板文件位于同一目录下的情况。

示例

假设模板文件结构如下：

web/
└── templates/
    ├── index.html
    └── user/
        └── profile.html

使用 LoadHTMLGlob 加载模板文件：

r.LoadHTMLGlob("web/templates/**/*")

注意事项

• 通配符模式需要正确设置，否则可能无法加载所有模板文件。
• 只能调用一次，多次调用时只有最后一次生效。

2. LoadHTMLFiles 函数

LoadHTMLFiles 函数用于加载指定的模板文件。它的签名如下：

func (engine *Engine) LoadHTMLFiles(files ...string)

用法示例

r := gin.Default()
r.LoadHTMLFiles("templates/index.html", "templates/user/profile.html")

特点

• 多次调用：可以多次调用，每次调用都会加载新的模板文件。
• 指定文件：需要明确指定每个模板文件的路径。
• 灵活性：适用于模板文件分布在多个目录下的情况。

示例

假设模板文件结构如下：

web/
└── templates/
    ├── index.html
    └── user/
        └── profile.html

使用 LoadHTMLFiles 加载模板文件：

var tplFiles []string
filepath.WalkDir("./web/templates", func(path string, d fs.DirEntry, err error) error {
    if d.IsDir() {
        return nil
    }
    tplFiles = append(tplFiles, path)
    return nil
})
r.LoadHTMLFiles(tplFiles...)

注意事项

• 需要手动遍历目录并收集所有模板文件路径。
• 每次调用都会加载新的模板文件，可能会导致性能问题。

优化方案

在实际项目中，模板文件可能会分布在多个子文件夹中，使用 LoadHTMLGlob 可能无法满足需求。LoadHTMLFiles 提供了更大的灵活性，但需要手动收集模板文件路径。下面是一个优化方案，结合 filepath.WalkDir 和 LoadHTMLFiles 来灵活加载模板文件。

步骤

1. 遍历目录 ：使用 filepath.WalkDir 遍历模板目录，收集所有模板文件路径。
2. 加载模板 ：使用 LoadHTMLFiles 加载收集到的模板文件路径。

实现代码

package main

import (
    "embed"
    "fmt"
    "log"
    "net/http"
    "path/filepath"

    "github.com/gin-gonic/gin"
)

//go:embed web/templates
var templates embed.FS

func main() {
    r := gin.Default()

    // 收集所有模板文件路径
    var tplFiles []string
    err := filepath.WalkDir("./web/templates", func(path string, d fs.DirEntry, err error) error {
        if d.IsDir() {
            return nil
        }
        tplFiles = append(tplFiles, path)
        return nil
    })
    if err != nil {
        log.Fatalf("Failed to walk templates directory: %v", err)
    }

    // 加载模板文件
    r.LoadHTMLFiles(tplFiles...)

    // 定义路由
    r.GET("/", func(c *gin.Context) {
        c.HTML(http.StatusOK, "index.html", gin.H{
            "title": "Home Page",
        })
    })

    r.GET("/user/profile", func(c *gin.Context) {
        c.HTML(http.StatusOK, "user/profile.html", gin.H{
            "title": "User Profile",
        })
    })

    // 启动服务器
    if err := r.Run(":8080"); err != nil {
        log.Fatalf("Failed to start server: %v", err)
    }
}

详细说明

1. 遍历目录：

   • 使用 filepath.WalkDir 遍历 web/templates 目录，收集所有文件路径。
   • filepath.WalkDir 会递归地遍历目录，确保所有子目录中的文件都被收集。

2. 加载模板：

   • 使用 r.LoadHTMLFiles(tplFiles...) 加载所有收集到的模板文件路径。
   • LoadHTMLFiles 可以多次调用，但这里只调用一次，确保所有模板文件都被加载。

3. 定义路由：

   • 定义路由并渲染模板。

优点

• 灵活性：可以加载分布在多个子文件夹中的模板文件。
• 可维护性：模板文件路径自动收集，无需手动指定。

注意事项

• 确保模板文件路径正确。
• 大量模板文件时，遍历和加载可能会影响性能，可以考虑缓存模板文件。

总结

LoadHTMLGlob 和 LoadHTMLFiles 都是 Gin 框架中用于加载 HTML 模板的函数，各有优缺点。LoadHTMLGlob 适用于模板文件位于同一目录下的情况，而 LoadHTMLFiles 提供了更大的灵活性，适用于模板文件分布在多个目录中的情况。通过结合 filepath.WalkDir 和 LoadHTMLFiles，可以更灵活地加载模板文件，满足复杂项目的需求。