gitbook/Tony Bai · Go语言第一课/docs/434017.md
2022-09-03 22:05:03 +08:00

563 lines
26 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 09即学即练构建一个Web服务就是这么简单
你好我是Tony Bai。
在入门篇前面的几节课中我们已经从Go开发环境的安装一路讲到了Go包的初始化次序与Go入口函数。讲解这些不仅仅是因为它们是你学习Go语言的基础同时我也想为你建立“手勤”的意识打好基础。
作为Go语言学习的“过来人”学到这个阶段我深知你心里都在跃跃欲试想将前面学到的知识综合运用起来实现一个属于自己的Go程序。但到目前为止我们还没有开始Go基础语法的系统学习你肯定会有一种“无米下炊”的感觉。
不用担心我在这节课安排了一个实战小项目。在这个小项目里我希望你不要困在各种语法里而是先跟着我““照猫画虎”地写一遍、跑一次感受Go项目的结构体会Go语言的魅力。
## 预热最简单的HTTP服务
在想选择以什么类型的项目的时候,我还颇费了一番脑筋。我查阅了[Go官方用户2020调查报告](https://go.dev/blog/survey2020-results)找到Go应用最广泛的领域调查结果图如下所示
![图片](https://static001.geekbang.org/resource/image/9a/91/9ab73568ef659d75a313f3394a811491.png?wh=1194x1158)
我们看到Go应用的前4个领域中有两个都是Web服务相关的。一个是排在第一位的API/RPC服务另一个是排在第四位的Web服务返回html页面。考虑到后续你把Go应用于Web服务领域的机会比较大所以在这节课我们就选择一个Web服务项目作为实战小项目。
不过在真正开始我们的实战小项目前,我们先来预热一下,做一下技术铺垫。我先来给你演示一下**在Go中创建一个基于HTTP协议的Web服务是多么的简单**。
这种简单又要归功于Go“面向工程”特性。在02讲介绍Go的设计哲学时我们也说过Go“面向工程”的特性不仅体现在语言设计方面时刻考虑开发人员的体验而且它还提供了完善的工具链和“自带电池”的标准库这就使得Go程序大大减少了对外部第三方包的依赖。以开发Web服务为例我们可以基于Go标准库提供的net/http包轻松构建一个承载Web内容传输的HTTP服务。
下面我们就来构建一个最简单的HTTP服务这个服务的功能很简单就是当收到一个HTTP请求后给请求方返回包含“hello, world”数据的响应。
我们首先按下面步骤建立一个simple-http-server目录并创建一个名为simple-http-server的Go Module
```plain
$mkdir simple-http-server
$cd simple-http-server
$go mod init simple-http-server
```
由于这个HTTP服务比较简单我们采用最简项目布局也就是在simple-http-server目录下创建一个main.go源文件
```go
package main
import "net/http"
func main() {
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request){
w.Write([]byte("hello, world"))
})
http.ListenAndServe(":8080", nil)
}
```
这些代码就是一个最简单的HTTP服务的实现了。在这个实现中我们只使用了Go标准库的http包。可能你现在对http包还不熟悉但没有关系你现在只需要大致了解上面代码的结构与原理就可以了。
这段代码里你要注意两个重要的函数一个是ListenAndServe另一个是HandleFunc。
你会看到代码的第9行我们通过http包提供的ListenAndServe函数建立起一个HTTP服务这个服务监听本地的8080端口。客户端通过这个端口与服务建立连接发送HTTP请求就可以得到相应的响应结果。
那么服务端是如何处理客户端发送的请求的呢我们看上面代码中的第6行。在这一行中我们为这个服务设置了一个处理函数。这个函数的函数原型是这样的
```go
func(w http.ResponseWriter, r *http.Request)
```
这个函数里有两个参数w和r。第二个参数r代表来自客户端的HTTP请求第一个参数w则是用来操作返回给客户端的应答的基于http包实现的HTTP服务的处理函数都要符合这一原型。
你也发现了在这个例子中所有来自客户端的请求无论请求的URI路径RequestURI是什么请求都会被我们设置的处理函数处理。为什么会这样呢
这是因为我们通过http.HandleFunc设置这个处理函数时传入的模式字符串为“/”。HTTP服务器在收到请求后会将请求中的URI路径与设置的模式字符串进行**最长前缀匹配**,并执行匹配到的模式字符串所对应的处理函数。在这个例子中,我们仅设置了“/”这一个模式字符串并且所有请求的URI都能与之匹配自然所有请求都会被我们设置的处理函数处理。
接着我们再来编译运行一下这个程序直观感受一下HTTP服务处理请求的过程。我们首先按下面步骤来编译并运行这个程序
```go
$cd simple-http-server
$go build
$./simple-http-server
```
接下来我们用curl命令行工具模拟客户端向上述服务建立连接并发送http请求
```go
$curl localhost:8080/
hello, world
```
我们看到curl成功得到了http服务返回的“hello, world”响应数据。到此我们的HTTP服务就构建成功了。
当然了真实世界的Web服务不可能像上述例子这么简单这仅仅是一个“预热”。我想让你知道使用Go构建Web服务是非常容易的。并且这样的预热也能让你初步了解实现代码的结构先有一个技术铺垫。
下面我们就进入这节课的实战小项目,一个更接近于真实世界情况的**图书管理API服务**。
## 图书管理API服务
首先,我们先来明确一下我们的业务逻辑。
在这个实战小项目中我们模拟的是真实世界的一个书店的图书管理后端服务。这个服务为平台前端以及其他客户端提供针对图书的CRUD创建、检索、更新与删除的基于HTTP协议的API。API采用典型的RESTful风格设计这个服务提供的API集合如下
![](https://static001.geekbang.org/resource/image/99/51/99717b62f7553e1a5139edcf2ac03b51.jpg?wh=1980x788)
这个API服务的逻辑并不复杂。简单来说我们通过id来唯一标识一本书对于图书来说这个id通常是ISBN号。至于客户端和服务端中请求与响应的数据我们采用放在HTTP协议包体Body中的Json格式数据来承载。
业务逻辑是不是很简单啊?下面我们就直接开始创建这个项目。
### 项目建立与布局设计
我们按照下面步骤创建一个名为bookstore的Go项目并创建对应的Go Module
```go
$mkdir bookstore
$cd bookstore
$go mod init bookstore
go: creating new go.mod: module bookstore
```
通过上面的业务逻辑说明我们可以把这个服务大体拆分为两大部分一部分是HTTP服务器用来对外提供API服务另一部分是图书数据的存储模块所有的图书数据均存储在这里。
同时这是一个以构建可执行程序为目的的Go项目我们参考Go项目布局标准一讲中的项目布局把这个项目的结构布局设计成这样
```go
├── cmd/
   └── bookstore/ // 放置bookstore main包源码
   └── main.go
├── go.mod // module bookstore的go.mod
├── go.sum
├── internal/ // 存放项目内部包的目录
   └── store/
   └── memstore.go
├── server/ // HTTP服务器模块
   ├── middleware/
      └── middleware.go
   └── server.go
└── store/ // 图书数据存储模块
├── factory/
   └── factory.go
└── store.go
```
现在我们既给出了这个项目的结构布局也给出了这个项目最终实现的源码文件分布情况。下面我们就从main包开始自上而下逐一看看这个项目的模块设计与实现。
### 项目main包
main包是主要包为了搞清楚各个模块之间的关系我在这里给出了main包的实现逻辑图
![](https://static001.geekbang.org/resource/image/5e/19/5e8ee50b67a4229210b12afb94f55a19.jpg?wh=1980x1080)
同时我也列出了main包main.go的所有代码你可以先花几分钟看一下
```go
package main
import (
_ "bookstore/internal/store"
"bookstore/server"
"bookstore/store/factory"
"context"
"log"
"os"
"os/signal"
"syscall"
"time"
)
func main() {
s, err := factory.New("mem") // 创建图书数据存储模块实例
if err != nil {
panic(err)
}
srv := server.NewBookStoreServer(":8080", s) // 创建http服务实例
errChan, err := srv.ListenAndServe() // 运行http服务
if err != nil {
log.Println("web server start failed:", err)
return
}
log.Println("web server start ok")
c := make(chan os.Signal, 1)
signal.Notify(c, syscall.SIGINT, syscall.SIGTERM)
select { // 监视来自errChan以及c的事件
case err = <-errChan:
log.Println("web server run failed:", err)
return
case <-c:
log.Println("bookstore program is exiting...")
ctx, cf := context.WithTimeout(context.Background(), time.Second)
defer cf()
err = srv.Shutdown(ctx) // 优雅关闭http服务实例
}
if err != nil {
log.Println("bookstore program exit error:", err)
return
}
log.Println("bookstore program exit ok")
}
```
在Go中main包不仅包含了整个程序的入口它还是整个程序中主要模块初始化与组装的场所。那对应在我们这个程序中主要模块就是第16行的创建图书存储模块实例以及第21行创建HTTP服务模块实例。而且你还要注意的是第21行创建HTTP服务模块实例的时候我们把图书数据存储实例s作为参数传递给了NewBookStoreServer函数。这两个实例的创建原理我们等会再来细细探讨。
这里我们重点来看main函数的后半部分第30行~第42行这里表示的是我们通过监视系统信号实现了http服务实例的优雅退出。
所谓优雅退出指的就是程序有机会等待其他的事情处理完再退出。比如尚未完成的事务处理、清理资源比如关闭文件描述符、关闭socket、保存必要中间状态、内存数据持久化落盘等等。如果你经常用Go来编写http服务那么http服务如何优雅退出就是你经常要考虑的问题。
在这个问题的具体实现上我们通过signal包的Notify捕获了SIGINT、SIGTERM这两个系统信号。这样当这两个信号中的任何一个触发时我们的http服务实例都有机会在退出前做一些清理工作。
然后我们再使用http服务实例srv自身提供的Shutdown方法来实现http服务实例内部的退出清理工作包括立即关闭所有listener、关闭所有空闲的连接、等待处于活动状态的连接处理完毕等等。当http服务实例的清理工作完成后我们整个程序就可以正常退出了。
接下来我们再重点看看构成bookstore程序的两个主要模块图书数据存储模块与HTTP服务模块的实现。我们按照main函数中的初始化顺序先来看看图书数据存储模块。
### 图书数据存储模块store)
图书数据存储模块的职责很清晰,就是用来**存储整个bookstore的图书数据**的。图书数据存储有很多种实现方式最简单的方式莫过于在内存中创建一个map以图书id作为key来保存图书信息我们在这一讲中也会采用这种方式。但如果我们要考虑上生产环境数据要进行持久化那么最实际的方式就是通过Nosql数据库甚至是关系型数据库实现对图书数据的存储与管理。
考虑到对多种存储实现方式的支持我们将针对图书的有限种存储操作放置在一个接口类型Store中如下源码所示
```go
// store/store.go
type Book struct {
Id string `json:"id"` // 图书ISBN ID
Name string `json:"name"` // 图书名称
Authors []string `json:"authors"` // 图书作者
Press string `json:"press"` // 出版社
}
type Store interface {
Create(*Book) error // 创建一个新图书条目
Update(*Book) error // 更新某图书条目
Get(string) (Book, error) // 获取某图书信息
GetAll() ([]Book, error) // 获取所有图书信息
Delete(string) error // 删除某图书条目
}
```
这里我们建立了一个对应图书条目的抽象数据类型Book以及针对Book存取的接口类型Store。这样对于想要进行图书数据操作的一方来说他只需要得到一个满足Store接口的实例就可以实现对图书数据的存储操作了不用再关心图书数据究竟采用了何种存储方式。这就实现了图书存储操作与底层图书数据存储方式的解耦。而且这种面向接口编程也是Go组合设计哲学的一个重要体现。
那我们具体如何创建一个满足Store接口的实例呢我们可以参考《设计模式》提供的多种创建型模式选择一种Go风格的工厂模式创建型模式的一种来实现满足Store接口实例的创建。我们看一下store/factory包的源码
```go
// store/factory/factory.go
var (
providersMu sync.RWMutex
providers = make(map[string]store.Store)
)
func Register(name string, p store.Store) {
providersMu.Lock()
defer providersMu.Unlock()
if p == nil {
panic("store: Register provider is nil")
}
if _, dup := providers[name]; dup {
panic("store: Register called twice for provider " + name)
}
providers[name] = p
}
func New(providerName string) (store.Store, error) {
providersMu.RLock()
p, ok := providers[providerName]
providersMu.RUnlock()
if !ok {
return nil, fmt.Errorf("store: unknown provider %s", providerName)
}
return p, nil
}
```
这段代码实际上是效仿了Go标准库的database/sql包采用的方式factory包采用了一个map类型数据对工厂可以“生产”的、满足Store接口的实例类型进行管理。factory包还提供了Register函数让各个实现Store接口的类型可以把自己“注册”到工厂中来。
一旦注册成功factory包就可以“生产”出这种满足Store接口的类型实例。而依赖Store接口的使用方只需要调用factory包的New函数再传入期望使用的图书存储实现的名称就可以得到对应的类型实例了。
在项目的internal/store目录下我们还提供了一个基于内存map的Store接口的实现我们具体看一下这个实现是怎么自注册到factory包中的
```go
// internal/store/memstore.go
package store
import (
mystore "bookstore/store"
factory "bookstore/store/factory"
"sync"
)
func init() {
factory.Register("mem", &MemStore{
books: make(map[string]*mystore.Book),
})
}
type MemStore struct {
sync.RWMutex
books map[string]*mystore.Book
}
```
从memstore的代码来看它是在包的init函数中调用factory包提供的Register函数把自己的实例以“mem”的名称注册到factory中的。这样做有一个好处依赖Store接口进行图书数据管理的一方只要导入internal/store这个包就可以自动完成注册动作了。
理解了这个之后我们再看下面main包中创建图书数据存储模块实例时采用的代码是不是就豁然开朗了
```go
import (
... ...
_ "bookstore/internal/store" // internal/store将自身注册到factory中
)
func main() {
s, err := factory.New("mem") // 创建名为"mem"的图书数据存储模块实例
if err != nil {
panic(err)
}
... ...
}
```
至于memstore.go中图书数据存储的具体逻辑就比较简单了我这里就不详细分析了你课后自己阅读一下吧。
接着我们再来看看bookstore程序的另外一个重要模块HTTP服务模块。
### HTTP服务模块server
HTTP服务模块的职责是**对外提供HTTP API服务处理来自客户端的各种请求并通过Store接口实例执行针对图书数据的相关操作**。这里我们抽象处理一个server包这个包中定义了一个BookStoreServer类型如下
```go
// server/server.go
type BookStoreServer struct {
s store.Store
srv *http.Server
}
```
我们看到这个类型实质上就是一个标准库的http.Server并且组合了来自store.Store接口的能力。server包提供了NewBookStoreServer函数用来创建一个BookStoreServer类型实例
```go
// server/server.go
func NewBookStoreServer(addr string, s store.Store) *BookStoreServer {
srv := &BookStoreServer{
s: s,
srv: &http.Server{
Addr: addr,
},
}
router := mux.NewRouter()
router.HandleFunc("/book", srv.createBookHandler).Methods("POST")
router.HandleFunc("/book/{id}", srv.updateBookHandler).Methods("POST")
router.HandleFunc("/book/{id}", srv.getBookHandler).Methods("GET")
router.HandleFunc("/book", srv.getAllBooksHandler).Methods("GET")
router.HandleFunc("/book/{id}", srv.delBookHandler).Methods("DELETE")
srv.srv.Handler = middleware.Logging(middleware.Validating(router))
return srv
}
```
我们看到函数NewBookStoreServer接受两个参数一个是HTTP服务监听的服务地址另外一个是实现了store.Store接口的类型实例。这种函数原型的设计是Go语言的一种惯用设计方法也就是接受一个接口类型参数返回一个具体类型。返回的具体类型组合了传入的接口类型的能力。
这个时候和前面预热时实现的简单http服务一样我们还需为HTTP服务器设置请求的处理函数。
由于这个服务请求URI的模式字符串比较复杂标准库http包内置的URI路径模式匹配器ServeMux也称为路由管理器不能满足我们的需求因此在这里我们需要借助一个第三方包github.com/gorilla/mux来实现我们的需求。
在上面代码的第11行到第16行我们针对不同URI路径模式设置了不同的处理函数。我们以createBookHandler和getBookHandler为例来看看这些处理函数的实现
```go
// server/server.go
func (bs *BookStoreServer) createBookHandler(w http.ResponseWriter, req *http.Request) {
dec := json.NewDecoder(req.Body)
var book store.Book
if err := dec.Decode(&book); err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
if err := bs.s.Create(&book); err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
}
func (bs *BookStoreServer) getBookHandler(w http.ResponseWriter, req *http.Request) {
id, ok := mux.Vars(req)["id"]
if !ok {
http.Error(w, "no id found in request", http.StatusBadRequest)
return
}
book, err := bs.s.Get(id)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
response(w, book)
}
func response(w http.ResponseWriter, v interface{}) {
data, err := json.Marshal(v)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
w.Write(data)
}
```
这些处理函数的实现都大同小异都是先获取http请求包体数据然后通过标准库json包将这些数据解码decode为我们需要的store.Book结构体实例再通过Store接口对图书数据进行存储操作。如果我们是获取图书数据的请求那么处理函数将通过response函数把取出的图书数据编码到http响应的包体中并返回给客户端。
然后在NewBookStoreServer函数实现的尾部我们还看到了这样一行代码
```go
srv.srv.Handler = middleware.Logging(middleware.Validating(router))
```
这行代码的意思是说我们在router的外围包裹了两层middleware。什么是middleware呢对于我们的上下文来说这些middleware就是一些通用的http处理函数。我们看一下这里的两个middleware也就是Logging与Validating函数的实现
```go
// server/middleware/middleware.go
func Logging(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
log.Printf("recv a %s request from %s", req.Method, req.RemoteAddr)
next.ServeHTTP(w, req)
})
}
func Validating(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
contentType := req.Header.Get("Content-Type")
mediatype, _, err := mime.ParseMediaType(contentType)
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}
if mediatype != "application/json" {
http.Error(w, "invalid Content-Type", http.StatusUnsupportedMediaType)
return
}
next.ServeHTTP(w, req)
})
}
```
我们看到Logging函数主要用来输出每个到达的HTTP请求的一些概要信息而Validating则会对每个http请求的头部进行检查检查Content-Type头字段所表示的媒体类型是否为application/json。这些通用的middleware函数会被串联到每个真正的处理函数之前避免我们在每个处理函数中重复实现这些逻辑。
创建完BookStoreServer实例后我们就可以调用其ListenAndServe方法运行这个http服务了显然这个方法的名字是仿效http.Server类型的同名方法我们的实现是这样的
```go
// server/server.go
func (bs *BookStoreServer) ListenAndServe() (<-chan error, error) {
var err error
errChan := make(chan error)
go func() {
err = bs.srv.ListenAndServe()
errChan <- err
}()
select {
case err = <-errChan:
return nil, err
case <-time.After(time.Second):
return errChan, nil
}
}
```
我们看到这个函数把BookStoreServer内部的http.Server的运行放置到一个单独的轻量级线程Goroutine中。这是因为http.Server.ListenAndServe会阻塞代码的继续运行如果不把它放在单独的Goroutine中后面的代码将无法得到执行。
为了检测到http.Server.ListenAndServe的运行状态我们再通过一个channel位于第5行的errChan在新创建的Goroutine与主Goroutine之间建立的通信渠道。通过这个渠道这样我们能及时得到http server的运行状态。
### 编译、运行与验证
到这里bookstore项目的大部分重要代码我们都分析了一遍是时候将程序跑起来看看了。
不过因为我们在程序中引入了一个第三方依赖包所以在构建项目之前我们需要执行下面这个命令让Go命令自动分析依赖项和版本并更新go.mod
```go
$go mod tidy
go: finding module for package github.com/gorilla/mux
go: found github.com/gorilla/mux in github.com/gorilla/mux v1.8.0
```
完成后我们就可以按下面的步骤来构建并执行bookstore了
```go
$go build bookstore/cmd/bookstore
$./bookstore
2021/10/05 16:08:36 web server start ok
```
如果你看到上面这个输出的日志,说明我们的程序启动成功了。
现在我们就可以像前面一样使用curl命令行工具模仿客户端向bookstore服务发起请求了比如创建一个新书条目
```go
$curl -X POST -H "Content-Type:application/json" -d '{"id": "978-7-111-55842-2", "name": "The Go Programming Language", "authors":["Alan A.A.Donovan", "Brian W. Kergnighan"],"press": "Pearson Education"}' localhost:8080/book
```
此时服务端会输出如下日志表明我们的bookstore服务收到了客户端请求。
```go
2021/10/05 16:09:10 recv a POST request from [::1]:58021
```
接下来,我们再来获取一下这本书的信息:
```go
$curl -X GET -H "Content-Type:application/json" localhost:8080/book/978-7-111-55842-2
{"id":"978-7-111-55842-2","name":"The Go Programming Language","authors":["Alan A.A.Donovan","Brian W. Kergnighan"],"press":"Pearson Education"}
```
我们看到curl得到的响应与我们预期的是一致的。
好了,我们不再进一步验证了,你课后还可以自行编译、执行并验证。
## 小结
到这里,我们就完成了我们第一个实战小项目,不知道你感觉如何呢?
在这一讲中我们带你用Go语言构建了一个最简单的HTTP服务以及一个接近真实的图书管理API服务。在整个实战小项目的实现过程中你也能初步学习到Go编码时常用的一些惯用法比如基于接口的组合、类似database/sql所使用的惯用创建模式等等。
通过这节课的学习你是否体会到了Go语言的魅力了呢是否察觉到Go编码与其他主流语言不同的风格了呢其实不论你的理解程度有多少都不重要。只要你能“照猫画虎”地将上面的程序自己编写一遍构建、运行起来并验证一遍就算是完美达成这一讲的目标了。
你在这个过程肯定会有各种各样的问题但没关系这些问题会成为你继续向下学习Go的动力。毕竟**带着问题的学习,能让你的学习过程更有的放矢、更高效**。
## 思考题
如果你完成了今天的代码觉得自己学有余力可以再挑战一下不妨试试基于nosql数据库我们怎么实现一个新store.Store接口的实现吧
欢迎把这节课分享给更多对Go语言感兴趣的朋友。我是Tony Bai我们下节课见。
## 资源链接
[这节课的图书管理项目的完整源码在这里!](https://github.com/bigwhite/publication/tree/master/column/timegeek/go-first-course/09/bookstore)