Go Web 编程

第2章 ChitChat论坛

本章主要内容

  • 使用Go进行Web编程的方法
  • 设计一个典型的Go Web应用
  • 编写一个完整的Go Web应用
  • 了解Go Web应用的各个组成部分

上一章在末尾展示了一个非常简单的Go Web应用,但是因为该应用只是一个Hello World程序,所以它实际上并没有什么用处。在本章中,我们将会构建一个简单的网上论坛Web应用,这个应用同样非常基础,但是却有用得多:它允许用户登录到论坛里面,然后在论坛上发布新帖子,又或者回复其他用户发表的帖子。

虽然本章介绍的内容无法让你一下子就学会如何编写一个非常成熟的Web应用,但这些内容将教会你如何组织和开发一个Web应用。在阅读完这一章之后,你将进一步地了解到使用Go进行Web应用开发的相关方法。

如果你觉得本章介绍的内容难度较大,又或者你觉得本章展示的大量代码看起来让人觉得胆战心惊,那也不必过于担心:本章之后的几章将对本章介绍的内容做进一步的解释,在阅读完本章并继续阅读后续的章节时,你将会对本章介绍的内容有更加深入的了解。

2.1 ChitChat简介

网上论坛无处不在,它们是互联网上最受欢迎的应用之一,与旧式的电子公告栏(BBS)、新闻组(Usenet)和电子邮件一脉相承。雅虎公司和Google公司的群组(Groups)都非常流行,雅虎报告称,他们总共拥有1000万个群组以及1.15亿个群组成员,其中每个群组都拥有一个自己的论坛;而全球最具人气的网上论坛之一——Gaia在线——则拥有2300万注册用户以及接近230亿张帖子,并且这些帖子的数量还在以每天上百万张的速度持续增长中。尽管现在出现了诸如FaceBook这样的社交网站,但论坛仍然是人们在网上进行交流时最为常用的手段之一。作为例子,图2-1展示了Google Groups的样子。


../_images/2-1.png

图2-1 一个网上论坛示例:Google Groups里面的Go编程语言论坛


从本质上来说,网上论坛就相当于一个任何人都可以通过发帖来进行对话的公告板,公告板上面可以包含已注册用户以及未注册的匿名用户。论坛上的对话被称为帖子(thread),一个帖子通常包含了作者想要讨论的一个主题,而其他用户则可以通过回复这个帖子来参与对话。比较复杂的论坛一般都会按层级进行划分,在这些论坛里面,可能会有多个讨论特定类型主题的子论坛存在。大多数论坛都会由一个或多个拥有特殊权限的用户进行管理,这些拥有特殊权限的用户被称为版主(moderator)。

在本章中,我们将会开发一个名为ChitChat的简易网上论坛。为了让这个例子保持简单,我们只会为ChitChat实现网上论坛的关键特性:在这个论坛里面,用户可以注册账号,并在登录之后发表新帖子又或者回复已有的帖子;未注册用户可以查看帖子,但是无法发表帖子或是回复帖子。现在,让我们首先来思考一下如何设计ChitChat这个应用。

关于本章展示的代码 跟本书的其他章节不一样,因为篇幅的关系,本章并不会展示ChitCHat论坛的所有实现代码,但你可以在GitHub页面 https://github.com/sausheong/gwp 找到这些代码。如果你打算在阅读本章的同时实际地了解一下这个应用,那么这些完整的代码应该会对你有所帮助。

2.2 应用设计

正如第1章所说,Web应用的一般工作流程就是客户端向服务器发送请求,然后服务器对客户端进行响应(如图2-2所示),ChitChat应用的设计也遵循这一流程。


../_images/2-2.png

图2-2 Web应用的一般工作流程,客户端向服务器发送请求,然后等待接收响应


ChitChat的应用逻辑会被编码到服务器里面。服务器会向客户端提供HTML页面,并通过页面的超链接向客户端表明请求的格式以及被请求的数据,而客户端则会在发送请求时向服务器提供相应的数据,如图2-3所示。


../_images/2-3.png

图2-3 HTTP请求的URL格式


请求的格式通常是由应用自行决定的,比如ChitChat的请求使用的就是以下格式:http://<服务器名><处理器名>?<参数>

服务器名(server name)是ChitChat服务器的名字,而处理器名(handler name)则是被调用的处理器的名字。处理器的名字是按层级进行划分的:位于名字最开头的是被调用模块的名字,而之后跟着的则是被调用子模块的名字,以此类推,位于处理器名字最末尾的则是子模块中负责处理请求的处理器。比如,对/thread/read这个处理器名字来说,thread就是被调用的模块,而read则是这个模块中负责读取帖子内容的处理器。

应用的参数(parameter)会以URL查询的形式传递给处理器,而处理器则会根据这些参数对请求进行处理。比如说,假设客户端要向处理器传递帖子的唯一ID,那么它可以将URL的参数部分设置成id=123,其中123就是帖子的唯一ID。

如果chitchat就是ChitChat服务器的名字,那么根据上面介绍的URL格式规则,客户端发送给ChitChat服务器的URL可能会是这样的: http://chitchat/thread/read?id=123

当请求到达服务器时,多路复用器(multiplexer)会对请求进行检查,并将请求重定向至正确的处理器进行处理。处理器在接收到多路复用器转发的请求之后,就会从请求中取出相应的信息,并根据这些信息对请求进行处理。在请求处理完毕之后,处理器会将所得的数据传递给模板引擎,而模板引擎则会根据这些数据生成出将要返回给客户端的HTML,整个过程如图2-4所示。


../_images/2-4.png

图2-4 服务器在典型Web应用中的运作流程

2.3 数据模型

绝大多数应用都需要以某种方式与数据打交道。对ChitChat来说,它的数据将被存储到关系式数据库PostgreSQL里面,并通过SQL与之进行交互。

ChitChat的数据模型非常简单,只包含4种数据结构,它们分别是:

  • User——表示论坛的用户信息;
  • Session——表示论坛用户当前的登录会话;
  • Thread——表示论坛里面的帖子,每一张帖子都记录了多个论坛用户之间的对话;
  • Post——表示用户在帖子里面添加的回复。

以上这4种数据结构都会被映射到关系数据库里面,图2-5展示了这4种数据结构是如何与数据库进行交互的。

ChitChat论坛允许用户在登录之后发布新帖子或者回复已有的帖子,未登录的用户可以阅读帖子,但是不能发布新帖子或者回复帖子。为了对应用进行简化,ChitChat论坛没有设置版主这一职位,因此用户在发布新帖子或者添加新回复的时候不需要经过审核。


../_images/2-5.png

图2-5 Web应用访问数据存储系统的流程


在了解了ChitChat的设计方案之后,现在可以开始考虑具体的实现代码了。在开始学习ChitChat的实现代码之前,请注意,如果你在阅读本章展示的代码时遇到了困难,又或者你是刚开始学习Go语言,那么为了更好地理解本章介绍的内容,你可以考虑先花些时间阅读一本Go语言的编程入门书,比如由William Kennedy、Brian Ketelsen和Erik St. Martin撰写的《Go语言实战》就是一个很不错的选择。

除此之外,在阅读本章时也请尽量保持耐性:本章只是从宏观的角度展示了Go Web应用的样子,但是并没有对Web应用的细节方面作过多的解释,而是将这些细节留到之后的章节再作进一步说明。在有需要的情况下,本章也会在介绍某种技术的同时,说明在哪一章可以找到这一技术的更多相关信息。

2.4 请求的接收与处理

请求的接收和处理是所有Web应用的核心。正如之前所说,Web应用的工作流程如下。

  1. 客户端会将请求发送到服务器的一个URL上面。
  2. 服务器的多路复用器会将接收到的请求重定向到正确的处理器,然后由该处理器对请求进行处理。
  3. 处理器处理请求并执行必要的动作。
  4. 处理器调用模板引擎,生成相应的HTML并将其返回给客户端。

让我们先从最基本的根URL(/)来考虑Web应用是如何处理请求的:当我们在浏览器上输入地址 http://localhost 的时候,浏览器访问的就是应用的根URL。在接下来的几个小节里面,我们将会看到ChitChat是如何处理发送至根URL的请求的,以及它又是如何通过动态地生成HTML来对请求进行响应的。

2.4.1 多路复用器

因为编译后的二进制Go应用总是以main函数作为执行的起点,所以我们在对Go应用进行介绍的时候也总是以包含main函数的主源码文件(main source code file)为开始。ChitChat应用的主源码文件为main.go,代码清单2-1展示了它的一个简化版本。


代码清单2-1 main.go文件中的main函数,函数中的代码经过了简化

package main

import (
  "net/http"
)

func main() {

  mux := http.NewServeMux()
  files := http.FileServer(http.Dir("/public"))
  mux.Handle("/static/", http.StripPrefix("/static/", files))

    mux.HandleFunc("/", index)

  server := &http.Server{
    Addr: "0.0.0.0:8080",
    Handler: mux,
  }
  server.ListenAndServe()
}

main.go首先创建了一个多路复用器,然后通过一些代码将接收到的请求重定向到处理器。net/http标准库提供了一个默认的多路复用器,这个多路复用器可以通过调用NewServeMux函数来创建:

mux := http.NewServeMux()

为了将发送至根URL的请求重定向到处理器,程序使用了HandleFunc函数:

mux.HandleFunc("/", index)

HandleFunc函数接受一个URL以及一个处理器的名字作为参数,并将针对给定URL的请求转发至指定的处理器进行处理,因此对上述调用来说,当有针对根URL的请求到达时,该请求就会被重定向到名为index的处理器函数。此外,因为所有处理器都接受一个ResponseWriter以及一个指向Request结构的指针作为参数,并且所有请求参数都可以通过访问Request结构得到,所以程序并不需要向处理器显式地传入任何请求参数。

需要注意的是,前面的介绍模糊了处理器以及处理器函数之间的区别:我们刚开始谈论的是处理器,而现在谈论的却是处理器函数。这是有意而为之的——尽管处理器和处理器函数提供的最终结果是一样的,但它们实际上并不相同。本书的第3章将对处理器和处理器函数之间的区别做进一步的说明,但是现在让我们暂时先忘掉这事,继续研究ChitChat应用的代码实现。

2.4.2 服务静态文件

除了负责将请求重定向到相应的处理器之外,多路复用器还需要为静态文件提供服务。为了做到这一点,程序使用FileServer函数创建了一个能够为指定目录中的静态文件服务的处理器,并将这个处理器传递给了多路复用器的Handle函数。除此之外,程序还使用StripPrefix函数去移除请求URL中的指定前缀:

files := http.FileServer(http.Dir("/public"))
mux.Handle("/static/", http.StripPrefix("/static/", files))

当服务器接收到一个以/static/开头的URL请求时,以上两行代码就会移除URL中的/static/字符串,然后在public目录中查找被请求的文件。比如说,当服务器接收到一个针对文件 http://localhost/static/css/bootstrap.min.css 的请求时,它将会在public目录中查找以下文件:

/css/bootstrap.min.css

当服务器成功地找到这个文件之后,就会把它返回给客户端。

2.4.3 创建处理器函数

正如之前的小节所说,ChitChat应用会通过HandleFunc函数把请求重定向到处理器函数。正如代码清单2-2所示,处理器函数实际上就是一个接受ResponseWriter以及Request指针作为参数的Go函数。


代码清单2-2 main.go文件中的index处理器函数

func index(w http.ResponseWriter, r *http.Request) {
  files := []string{"templates/layout.html",
                    "templates/navbar.html",
                    "templates/index.html",}
  templates := template.Must(template.ParseFiles(files...))
  threads, err := data.Threads(); if err == nil {
    templates.ExecuteTemplate(w, "layout", threads)
  }
}

index函数负责生成HTML并将其写入到ResponseWriter里面。因为这个处理器函数会用到html/template标准库中的Template结构,所以包含这个函数的文件需要在文件的开头引入html/template库。之后的小节将对生成HTML的方法做进一步的介绍。

除了前面提到过的,负责处理根URL请求的index处理器函数之外,main.go文件实际上还包含了很多其他的处理器函数,正如代码清单2-3所示。


代码清单2-3 ChitChat应用的main.go源文件

package main

import (
  "net/http"
)

func main() {

  mux := http.NewServeMux()
  files := http.FileServer(http.Dir(config.Static))
  mux.Handle("/static/", http.StripPrefix("/static/", files))

  mux.HandleFunc("/", index)
  mux.HandleFunc("/err", err)

  mux.HandleFunc("/login", login)
  mux.HandleFunc("/logout", logout)
  mux.HandleFunc("/signup", signup)
  mux.HandleFunc("/signup_account", signupAccount)
  mux.HandleFunc("/authenticate", authenticate)

  mux.HandleFunc("/thread/new", newThread)
  mux.HandleFunc("/thread/create", createThread)
  mux.HandleFunc("/thread/post", postThread)
  mux.HandleFunc("/thread/read", readThread)

  server := &http.Server{
    Addr: "0.0.0.0:8080",
    Handler: mux,
  }
  server.ListenAndServe()
}

main函数中使用的这些处理器函数并没有在main.go文件中进行定义,它们的定义位于其他文件里面,具体请参考ChitChat项目的完整源码。

为了在一个文件里面引用另一个文件中定义的函数,诸如PHP、Ruby和Python这样的语言要求用户编写代码去包含(include)被引用函数所在的文件,而另一些语言则要求用户在编译程序时使用特殊的链接(link)命令。

但是对Go语言来说,用户只需要把位于相同目录下的所有文件都设置成同一个包,那么这些文件就会与包中的其他文件分享彼此的定义。又或者,用户也可以把文件放到其他独立的包里面,然后通过导入(import)这些包来使用它们。比如,ChitChat论坛就把连接数据库的代码放到了独立的包里面,我们很快就会看见这一点。

2.5 使用模板生成HTML响应

index处理器函数里面的大部分代码都是用来为客户端生成HTML的。首先,函数把每个需要用到的模板文件都放到了Go切片里面(这里展示的是私有页面的模板文件,公开页面的模板文件也是以同样方式进行组织的):

private_tmpl_files := []string{"templates/layout.html",
                               "templates/private.navbar.html",
                               "templates/index.html"}

跟Mustache和CTemplate等其他模板引擎一样,切片指定的这3个HTML文件都包含了特定的嵌入命令,这些命令被称为动作(action),动作在HTML文件里面会被{{符号和}}符号包围。

接着,程序会调用ParseFiles函数对这些模板文件进行语法分析,并创建出相应的模板。 为了捕捉语法分析过程中可能会产生的错误,程序使用了Must函数去包围ParseFiles函数的执行结果,这样当ParseFiles返回错误的时候,Must函数就会向用户返回相应的错误报告:

templates := template.Must(template.ParseFiles(private_tmpl_files...))

好的,关于模板文件的介绍已经足够多了,现在是时候来看看它们的庐山真面目了。

ChitChat论坛的每个模板文件都定义了一个模板,这种做法并不是强制的,用户也可以在一个模板文件里面定义多个模板,但模板文件和模板一一对应的做法可以给开发带来方便,我们在之后就会看到这一点。代码清单2-7展示了layout.html模板文件的源代码,源码中使用了define动作,这个动作通过文件开头的{{ define "layout" }}和文件末尾的{{ end }},把被包围的文本块定义成了layout模板的一部分。


代码清单2-7 layout.html模板文件

{{ define "layout" }}

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=9">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>ChitChat</title>
    <link href="/static/css/bootstrap.min.css" rel="stylesheet">
    <link href="/static/css/font-awesome.min.css" rel="stylesheet">
  </head>
  <body>
    {{ template "navbar" . }}

    <div class="container">

      {{ template "content" . }}

    </div> <!-- /container -->

    <script src="/static/js/jquery-2.1.1.min.js"></script>
    <script src="/static/js/bootstrap.min.js"></script>
  </body>
</html>

{{ end }}

除了define动作之外,layout.html模板文件里面还包含了两个用于引用其他模板文件的template动作。跟在被引用模板名字之后的.代表了传递给被引用模板的数据,比如{{ template "navbar" . }}语句除了会在语句出现的位置引入navbar模板之外,还会将传递给layout模板的数据传递给navbar模板。

代码清单2-8展示了public.navbar.html模板文件中的navbar模板,除了定义模板自身的define动作之外,这个模板没有包含其他动作(严格来说,模板也可以不包含任何动作)。


代码清单2-8 public.navbar.html模板文件

{{ define "navbar" }}

<div class="navbar navbar-default navbar-static-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed"
       data-toggle="collapse" data-target=".navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="/">
        <i class="fa fa-comments-o"></i>
        ChitChat
      </a>
    </div>
    <div class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li><a href="/">Home</a></li>
      </ul>
      <ul class="nav navbar-nav navbar-right">
        <li><a href="/login">Login</a></li>
      </ul>
    </div>
  </div>
</div>

{{ end }}

最后,让我们来看看定义在index.html模板文件中的content模板,代码清单2-9展示了这个模板的源代码。 注意,尽管之前展示的两个模板都与模板文件拥有相同的名字,但实际上模板和模板文件分别拥有不同的名字也是可行的。


代码清单2-9 index.html模板文件

{{ define "content" }}

<p class="lead">
  <a href="/thread/new">Start a thread</a> or join one below!
</p>

{{ range . }}
  <div class="panel panel-default">
    <div class="panel-heading">
      <span class="lead"> <i class="fa fa-comment-o"></i> {{ .Topic }}</span>
    </div>
    <div class="panel-body">
      Started by {{ .User.Name }} - {{ .CreatedAtDate }} - {{ .NumReplies }}
  posts.
      <div class="pull-right">
        <a href="/thread/read?id={{.Uuid }}">Read more</a>
      </div>
    </div>
  </div>
{{ end }}

{{ end }}

index.html文件里面的代码非常有趣,特别值得一提的是文件里面包含了几个以点号(.)开头的动作,比如{{ .User.Name }}{{ .CreatedAtDate }},这些动作的作用和之前展示过的index处理器函数有关:

threads, err := data.Threads(); if err == nil {
    templates.ExecuteTemplate(writer, "layout", threads)
}

在以下这行代码中:

templates.ExecuteTemplate(writer, "layout", threads)

程序通过调用ExecuteTemplate函数,执行(execute)已经经过语法分析的layout模板。执行模板意味着把模板文件中的内容和来自其他渠道的数据进行合并,然后生成出最终的HTML内容,具体过程如图2-6所示。


../_images/2-6.png

图2-6 模板引擎通过合并数据和模板来生成HTML


程序之所以对layout模板而不是navbar模板或者content模板进行处理,是因为layout模板已经引用了其他两个模板,所以执行layout模板就会导致其他两个模板也被执行,由此产生出预期的HTML。但是,如果程序只对navbar模板或者content模板进行处理,那么程序最终只会产生出预期的HTML的其中一部分。

现在,你应该已经明白了,点号(.)代表的就是传入到模板里面的数据(实际上还不仅如此,接下来的小节会对这方面做进一步的说明)。图2-7展示了程序根据模板生成的ChitChat论坛的样子。


../_images/2-7.png

图2-7 ChitChat Web应用示例的主页


整理代码

因为生成HTML的代码会被重复执行很多次,所以我们决定对这些代码进行一些整理,并将它们移动到代码清单2-10所示的generateHTML函数里面。


代码清单2-10 generateHTML函数

func generateHTML(w http.ResponseWriter, data interface{}, fn ...string) {
  var files []string
  for _, file := range fn {
    files = append(files, fmt.Sprintf("templates/%s.html", file))
  }
  templates := template.Must(template.ParseFiles(files...))
  templates.ExecuteTemplate(writer, "layout", data)
}

generateHTML函数接受一个ResponseWriter、一些数据以及一系列模板文件作为参数,然后对给定的模板文件进行语法分析。data参数的类型为空接口类型(empty interface type),这意味着该参数可以接受任何类型的值作为输入。刚开始接触Go语言的人可能会觉得奇怪——Go不是静态编程语言吗,它为什么能够使用没有类型限制的参数?

但实际上,Go程序可以通过接口(interface)机制,巧妙地绕过静态编程语言的限制,并藉此获得接受多种不同类型输入的能力。Go语言中的接口由一系列方法构成,并且每个接口就是一种类型。一个空接口就是一个空集合,这意味着任何类型都可以成为一个空接口,也即是说任何类型的值都可以传递给函数作为参数。

generateHTML函数的最后一个参数以3个点(...)为开头,它表示generateHTML函数是一个可变参数函数(variadic function),这意味着这个函数可以在最后的可变参数中接受零个或任意多个值作为参数。generateHTML函数对可变参数的支持使我们可以同时将任意多个模板文件传递给该函数。在Go语言里面,可变参数必须是可变参数函数的最后一个参数。

在实现了generateHTML函数之后,让我们回过头来,继续对index处理器函数进行整理。代码清单2-11展示了经过整理之后的index处理器函数,现在它看上去更整洁了。


代码清单2-11 index处理器函数的最终版本

func index(writer http.ResponseWriter, request *http.Request) {
  threads, err := data.Threads(); if err == nil {
    _, err := session(writer, request)
    if err != nil {
      generateHTML(writer, threads, "layout", "public.navbar", "index")
    } else {
      generateHTML(writer, threads, "layout", "private.navbar", "index")
    }
  }
}

在这一节,我们学习了很多关于模板的基础知识,之后的第5章将对模板做更详细的介绍。但是在此之前,让我们先来了解一下ChitChat应用使用的数据源(data source),并藉此了解一下ChitChat应用的数据是如何与模板一同生成出最终的HTML的。

2.6 安装PostgreSQL

在本章以及后续几章中,每当遇到需要访问关系数据库的场景,我们都会使用PostgreSQL。在开始使用PostgreSQL之前,我们首先需要学习的是如何安装并运行PostgreSQL,以及如何创建本章所需的数据库。

2.6.1 在Linux或FreeBSD系统上进行安装

www.postgresql.org/download为各种不同版本的Linux和FreeBSD都提供了预编译的二进制安装包,用户只需要下载其中一个安装包,然后根据指示进行安装就可以了。比如说,通过执行以下命令,我们可以在Ubuntu发行版上安装Postgres:

sudo apt-get install postgresql postgresql-contrib

这条命令除了会安装postgres包之外,还会安装附加的工具包,并在安装完毕之后启动PostgreSQL数据库系统。

在默认情况下,Postgres会创建一个名为postgres的用户,并将其用于连接服务器。为了操作方便,你也可以使用自己的名字创建一个Postgres账号。要做到这一点,首先需要登入Postgres账号:

sudo su postgres

接着使用createuser命令创建一个PostgreSQL账号:

createuser –interactive

最后,还需要使用createdb命令去创建以你的账号名字命名的数据库:

createdb <YOUR ACCOUNT NAME>

2.6.2 在Mac OS X系统上进行安装

要在Mac OS X上面安装PostgreSQL,最简单的方法就是使用 PostgresApp.com 提供的Postgres应用:你只需要把网站上提供的zip压缩包下载下来,解压它,然后把Postgres.app文件拖曳到自己的Applications文件夹里面就可以了。启动Postgres.app的方法跟启动其他Mac OS X应用的方法完全一样。 Postgres.app在初次启动的时候会初始化一个新的数据库集群,并为自己创建一个数据库。 因为命令行工具psql也包含在了Postgres.app里面,所以在设置好正确的路径之后,你就可以使用psql访问数据库了。 设置路径的工作可以通过在你的~/.profile文件或者~/.bashrc文件中添加以下代码行来完成:

export PATH=$PATH:/Applications/Postgres.app/Contents/Versions/9.4/bin

注解

根据安装的Postgres应用的版本不同在安装Postgres.app时,你可能需要根据Postgres.app的版本对路径的版本部分做相应的修改,,你可能需要对路径的版本部分做相应的修改,比如,将其中的9.4修改为9.5或者9.6,诸如此类。——译者注

2.6.3 在Windows系统上进行安装

因为Windows系统上面的很多PostgreSQL图形安装程序都会把一切安装步骤布置妥当,用户只需要进行相应的设置就可以了,所以在Windows系统上安装PostgreSQL也是非常简单和直接的。其中一个流行的安装程序是由Enterprise DB提供的: www.enterprisedb.com/products-services-training/pgdownload

除了PostgreSQL数据库本身之外,安装包还会附带诸如pgAdmin等工具,以便用户通过这些工具进行后续的配置。

2.7 连接数据库

本章前面在展示ChitChat应用的设计方案时,曾经提到过ChitChat应用包含了4种数据结构。虽然把这4种数据结构放到主源码文件里面也是可以的,但更好的办法是把所有与数据相关的代码都放到另一个包里面——ChitChat应用的data包也因此应运而生。

为了创建data包,我们首先需要创建一个名为data的子目录,并创建一个用于保存所有帖子相关代码的thread.go文件(在之后的小节里面,我们还会创建一个用于保存所有用户相关代码的user.go文件)。在此之后,每当程序需要用到data包的时候——比如处理器需要对数据库进行访问的时候——程序都需要通过import语句导入这个包:

import (
  "github.com/sausheong/gwp/Chapter_2_Go_ChitChat/chitchat/data"
)

代码清单2-12展示了定义在thread.go文件里面的Thread结构,这个结构存储了与帖子有关的各种信息。


代码清单2-12 定义在thread.go文件里面的Thread结构

package data

import(
  "time"
)
type Thread struct {
  Id        int
  Uuid      string
  Topic     string
  UserId    int
  CreatedAt time.Time
}

正如代码清单中加粗显示的代码行所示,文件的包名现在是data而不再是main了,这个包就是前面小节中我们曾经见到过的data包。 data包除了包含与数据库进行交互的结构和代码,还包含了一些与数据处理密切相关的函数。 隶属于其他包的程序在引用data包中定义的函数、结构或者其他东西时,必须在被引用元素的名字前面显式地加上data这个包名。 比如说,引用Thread结构就需要使用data.Thread这个名字,而不能仅仅使用Thread这个名字。

Thread结构应该与创建关系数据库表threads时使用的DDL(Data Definition Language,数据定义语言)保持一致。 因为threads表目前尚未存在,所以我们必须创建这个表以及容纳该表的数据库。创建chitchat数据库的工作可以通过执行以下命令来完成:

createdb chitchat

在创建数据库之后,我们就可以通过代码清单2-13展示的setup.sql文件,为ChitChat论坛创建相应的数据库表了:


代码清单2-13 用于在PostgreSQL里面创建数据库表的setup.sql文件

create table users (
  id         serial primary key,
  uuid       varchar(64) not null unique,
  name       varchar(255),
  email      varchar(255) not null unique,
  password   varchar(255) not null,
  created_at timestamp not null
);

create table sessions (
  id         serial primary key,
  uuid       varchar(64) not null unique,
  email      varchar(255),
  user_id    integer references users(id),
  created_at timestamp not null
);

create table threads (
  id         serial primary key,
  uuid       varchar(64) not null unique,
  topic      text,
  user_id    integer references users(id),
  created_at timestamp not null
);

create table posts (
  id         serial primary key,
  uuid       varchar(64) not null unique,
  body       text,
  user_id    integer references users(id),
  thread_id  integer references threads(id),
  created_at timestamp not null
);

运行这个脚本需要用到psql工具,正如上一节所说,这个工具通常会随着PostgreSQL一同被安装,所以你只需要在终端里面执行以下命令就可以了:

psql –f setup.sql –d chitchat

如果一切正常,那么以上命令将在chitchat数据库中创建出相应的表。在拥有了表之后,程序就必须考虑如何与数据库进行连接以及如何对表进行操作了。为此,程序创建了一个名为Db的全局变量,这个全局变量是一个指针,它指向的是代表数据库连接池的sql.DB,而后续的代码则会使用这个Db变量来执行数据库查询操作。代码清单2-14展示了Db变量在data.go文件中的定义,此外还展示了一个用于在Web应用启动时对Db变量进行初始化的init函数。


代码清单2-14 data.go文件中的Db全局变量以及init函数

Var Db *sql.DB

func init() {
  var err error
  Db, err = sql.Open("postgres", "dbname=chitchat sslmode=disable")
  if err != nil {
    log.Fatal(err)
  }
  return
}

现在程序已经拥有了结构、表以及一个指向数据库连接池的指针,接下来要考虑的就是如何连接(connect)Thread结构和threads表了,幸运的是,要做到这一点并不困难:跟ChitChat应用的其他部分一样,我们只需要创建出能够在结构和数据库之间进行互动的函数就可以了。例如,为了从数据库里面取出所有帖子并将其返回给index处理器函数,我们可以使用thread.go文件中定义的Threads函数,代码清单2-15给出了这个函数的定义。


代码清单2-15 threads.go文件中定义的Threads函数

func Threads() (threads []Thread, err error){
  rows, err := Db.Query("SELECT id, uuid, topic, user_id, created_at FROM
  threads ORDER BY created_at DESC")
  if err != nil {
    return
  }
  for rows.Next() {
    th := Thread{}
    if err = rows.Scan(&th.Id, &th.Uuid, &th.Topic, &th.UserId,
    &th.CreatedAt); err != nil {
      return
    }
    threads = append(threads, th)
  }
  rows.Close()
  return
}

简单来讲, Threads函数执行了以下工作:

  1. 通过数据库连接池与数据库进行连接;
  2. 向数据库发送一个SQL查询,这个查询将返回一个或多个行作为结果;
  3. 遍历行,为每个行分别创建一个Thread结构,首先使用这个结构去存储中记录的帖子数据,然后将存储了帖子数据的Thread结构追加到传入的threads切片里面;
  4. 重复执行步骤3,直到查询返回的所有行都被遍历完毕为止。

本书的第6章将对数据库操作的细节做进一步的介绍。

在了解了如何将数据库表存储的帖子数据提取到Thread结构里面之后,我们接下来要考虑的就是如何在模板里面展示Thread结构存储的数据了。在之前展示过的代码清单2-9里面,有这样一段代码:

{{ range . }}
  <div class="panel panel-default">
    <div class="panel-heading">
      <span class="lead"> <i class="fa fa-comment-o"></i> {{ .Topic }}</span>
    </div>
    <div class="panel-body">
      Started by {{ .User.Name }} - {{ .CreatedAtDate }} - {{ .NumReplies }}
  posts.
      <div class="pull-right">
        <a href="/thread/read?id={{.Uuid }}">Read more</a>
      </div>
    </div>
  </div>
{{ end }}

正如之前所说,模板动作中的点号(.)代表传入模板的数据,它们会和模板一起生成最终的结果,而{{ range . }}中的.号代表的就是程序在稍早之前通过Threads函数取得的threads变量,也即是一个由Thread结构组成的切片。

range动作假设传入的数据要么就是一个由结构组成的切片,要么就是一个由结构组成的数组,这个动作会遍历传入的每个结构,而用户则可以通过字段名对结构里面的字段进行访问,比如动作{{ .Topic }}访问的就是Thread结构的Topic字段。 注意,在访问字段时必须在字段名的前面加上点号,并且字段名的首字母必须大写。

用户除了可以在字段名的前面加上点号来访问结构中的字段以外,还可以通过相同的方法,调用一种名为方法(method)的特殊函数。比如在上面展示的代码中, {{ .User.Name }}{{ .CreatedAtDate }}{{ .NumReplies }}这些动作的作用就是调用结构中的同名方法,而不是访问结构中的字段。

方法是隶属于特定类型的函数,指针、接口以及包括结构在内的所有具名类型都可以拥有自己的方法。比如说,通过将函数与指向Thread结构的指针进行绑定,可以创建出一个针对Thread结构的方法,而传入到方法里面的Thread结构则被称为接收者(receiver):方法可以对接收者进行访问,也可以对它进行修改。

作为例子,代码清单2-16展示了NumReplies方法的实现代码。


代码清单2-16 thread.go文件中的NumReplies方法

func (thread *Thread) NumReplies() (count int) {
  rows, err := Db.Query("SELECT count(*) FROM posts where thread_id = $1",
  thread.Id)
  if err != nil {
    return
  }
  for rows.Next() {
    if err = rows.Scan(&count); err != nil {
      return
    }
  }
  rows.Close()
  return
}

NumReplies方法首先会打开一个指向数据库的连接,接着会通过执行一条SQL查询来取得帖子的数量,并使用传入到方法里面的count参数来记录这个值。最后,NumReplies方法会返回帖子的数量作为方法的执行结果,而模板引擎则会使用这个值去代替模板文件中出现的{{ .NumReplies }}动作。

通过为UserSessionThreadPost这4种数据结构创建相应的函数和方法,ChitChat最终在处理器函数和数据库之间构建起了一个数据层,以此来防止处理器函数直接对数据库进行访问,图2-8展示了这个数据层和数据库以及处理器函数之间的关系。虽然有很多库都可以达到同样的效果,但亲自构建数据层能够帮助我们学习如何对数据库进行基本的访问,并藉此了解到实现这种访问并不困难,只需要用到一些简单直接的代码,这一点是非常有益的。


../_images/2-8.png

图2-8 通过结构模型连接数据库和处理器

2.9 启动服务器

在本章的最后,让我们来看一下ChitChat应用是如何启动服务器并将多路复用器与服务器进行绑定的。执行这一工作的代码是在main.go文件里面定义的:

server := &http.Server{
  Addr:     "0.0.0.0:8080",
  Handler:  mux,
}
server.ListenAndServe()

这段代码非常简单,它所做的就是创建一个Server结构,然后对这个结构调用ListenAndServe方法,这样服务器就能够启动了。 现在,我们可以通过执行以下命令来编译并运行ChitChat应用:

go build

这个命令会在当前目录以及$GOPATH/bin目录创建一个名为chitchat的二进制可执行文件,它就是ChitChat应用的服务器。接着,我们可以通过执行以下命令来启动这个服务器:

./chitchat

如果你已经按照之前所说的方法,在数据库里面创建了ChitChat应用所需的数据库表,那么现在你只需要访问 http://localhost:8080/ 并注册一个新账号,然后就可以使用自己的账号在论坛上面发布新帖子了。

2.9 Web应用运作流程回顾

在本章的各节,我们对一个Go Web应用的不同组成部分进行了初步的了解和观察。图2-9对整个应用的运作流程进行了介绍,其中包括:

  1. 客户端向服务器发送请求。
  2. 多路复用器接收到请求,并将其重定向到正确的处理器。
  3. 处理器对请求进行处理。
  4. 在需要访问数据库的情况下,处理器会使用一个或多个数据结构,这些数据结构都是根据数据库中的数据建模而来的。
  5. 当处理器调用与数据结构有关的函数或者方法时,这些数据结构背后的模型就会与数据库进行连接,并执行相应的操作。
  6. 当请求处理完毕时,处理器会调用模板引擎,有时候还会向模板引擎传递一些通过模型获取到的数据。
  7. 模板引擎会对模板文件进行语法分析并创建出相应的模板,而这些模板又会与处理器传递的数据一起合并生成出最终的HTML。
  8. 生成的HTML会作为响应的一部分被回传至客户端。

图2-9 Web应用工作流程概览

主要的步骤大概就是这些。在接下来的几章,我们会更加深入地学习这一工作流程,并进一步地了解该流程涉及的各个组件。

2.10 小结

  • 请求的接收和处理是所有Web应用的核心。
  • 多路复用器会将HTTP请求重定向到正确的处理器进行处理,针对静态文件的请求也是如此。
  • 处理器函数是一种接受ResponseWriterRequeest指针作为参数的Go函数。
  • cookie可以用作一种访问控制机制。
  • 对模板文件以及数据进行语法分析会产生相应的HTML,这些HTML会被用作返回给浏览器的响应数据。
  • 通过使用sql包以及相应的SQL语句,用户可以将数据持久地保存在关系数据库里面。