Go 语言 Web 开发很简单：使用模板将视图与逻辑分离

2022 年 2 月 14 日
本文字数：1774 字
阅读完需：约 6 分钟

前言

在上一篇文章《Go 语言快速入门指南：Go 实现简易Web应用》中，我们动手写了一个简易的 Web 版 HelloWorld 程序。

我们的 Web 服务器由两部分构成：

为在用户浏览器中运行的 HTML 和 JavaScript 前端代码提供服务
接受 Web socket 连接以允许客户端进行通信

使用 HTML 文件来改进我们的代码

改进 main.go 代码，如下：

package main
import (  "log"  "net/http")
func main() {  http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {    w.Write([]byte(`    <html>      <head>        <title>Hello</title>      </head>      <body>        Hello, World!      </body>    </html>    `))  })
  // web 服务器开始  if err := http.ListenAndServe(":8800", nil); err != nil {    log.Fatal("ListenAndServe:", err)  }}

复制代码

然后，像上一篇文章一样，使用命令 go run main.go 运行该代码。

打开浏览器，输入地址 http://localhost:8800/ ，就可以看到如下的进阶版 HelloWorld。

像这样将 HTML 代码嵌入到我们的 Go 代码中虽然是可行的，但它非常不合理、耦合度太高。

而且随着我们项目的增长，只会变得更糟。接下来，我们将看看 HTML 模板如何帮助我们解决这个问题。

使用模板将视图与逻辑分离

模板允许我们将通用文本与特定文本混合，例如，加入用户名并对用户说 Hello。考虑以下模板：

Hello, {{userName}}!

复制代码

然后，我们可以将 {{name}} 文本替换为真正的用户名。如果是用户“张三”登录了这个系统，就可能看到如下内容：

Hello, 张三！

复制代码

Go 标准库有两个主要的模板包：一个称为 text/template 用于文本，另一个称为 html/template 用于 HTML。

html/template 包的作用与文本版本相同，只是它了解将数据注入模板的上下文。这很有用，因为它避免了脚本注入攻击并解决了常见问题，例如必须为 URL 编码特殊字符。

最初，我们只想将 HTML 代码从 Go 代码中移动到它自己的文件中，但目前还不会混合任何文本。 template 包使加载外部文件变得非常容易，因此对我们来说是一个不错的选择。

在当前项目中新建一个 templates 文件夹，然后创建 hello.html 文件，把上一段 main.go 代码中 HTML 部分写入，但是需要做一点小小的改动才能生效：

<html>    <head>        <title>Hello</title>    </head>    <body>        Hello, 张三!    </body></html>

复制代码

我们将编写自己的结构类型，负责加载、编译和交付我们的模板。我们将定义一个接受文件名字符串的新类型，编译一次模板（使用 sync.Once 类型），保留对已编译模板的引用，然后响应 HTTP 请求。您需要导入文本/模板、路径/文件路径和同步包以构建您的代码。sync.Once 类型保证我们作为参数传递的函数只会执行一次。

代码结构如下图：

templateHandler 结构是一个有效的 http.Handler 类型，因此我们可以将它直接传递给 http.Handle 函数并要求它处理与指定模式匹配的请求。在前面的代码中，我们创建了一个 templateHandler 类型的新对象，将文件名指定为 hello.html，然后我们将其地址（使用运算符的 & 地址）传递给 http.Handle 函数。我们不存储对新创建的 templateHandler 类型的引用，但这没关系，因为我们不需要再次引用它。

改进后的整体代码如下：

package main
import (  "html/template"  "log"  "net/http"  "path/filepath"  "sync")
type templateHandler struct {  once     sync.Once  filename string  templ    *template.Template}
func (t *templateHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {  t.once.Do(func() {    t.templ = template.Must(template.ParseFiles(filepath.Join("templates", t.filename)))  })  t.templ.Execute(w, nil)}
func main() {  http.Handle("/", &templateHandler{filename: "hello.html"})
  // web 服务器开始  if err := http.ListenAndServe(":8800", nil); err != nil {    log.Fatal("ListenAndServe:", err)  }}