GO语言（十三）：使用 Go 和 Gin 开发 RESTful API（下）

2023-02-27 00:08:02Python014

GO语言（十三）：使用 Go 和 Gin 开发 RESTful API（下）,第1张

当客户端在发出POST请求时/albums，您希望将请求正文中描述的专辑添加到现有专辑数据中。

为此，您将编写以下内容：

1、编写代码

a.添加代码以将专辑数据添加到专辑列表。

在此代码中：

1）用于Context.BindJSON 将请求正文绑定到newAlbum。

2） album将从 JSON 初始化的结构附加到albums 切片。

3）向响应添加201状态代码，以及表示您添加的专辑的 JSON。

b.更改您的main函数，使其包含该router.POST函数，如下所示。

在此代码中：

1）将路径中的POST方法与 /albumspostAlbums函数相关联。

使用 Gin，您可以将处理程序与 HTTP 方法和路径组合相关联。这样，您可以根据客户端使用的方法将发送到单个路径的请求单独路由。

a.如果服务器从上一节开始仍在运行，请停止它。

b.从包含 main.go 的目录中的命令行，运行代码。

c.从不同的命令行窗口，用于curl向正在运行的 Web 服务发出请求。

该命令应显示添加专辑的标题和 JSON。

d.与上一节一样，使用curl检索完整的专辑列表，您可以使用它来确认添加了新专辑。

该命令应显示专辑列表。

当客户端向发出请求时GET /albums/[id]，您希望返回 ID 与id路径参数匹配的专辑。

为此，您将：

a.在您在上一节中添加的函数下方postAlbums，粘贴以下代码以检索特定专辑。

此getAlbumByID函数将提取请求路径中的 ID，然后找到匹配的专辑。

在此代码中：

（1）Context.Param用于从 URL 中检索id路径参数。当您将此处理程序映射到路径时，您将在路径中包含参数的占位符。

（2）循环album切片中的结构，寻找其ID 字段值与id参数值匹配的结构。如果找到，则将该album结构序列化为 JSON，并将其作为带有200 OK HTTP 代码的响应返回。

如上所述，实际使用中的服务可能会使用数据库查询来执行此查找。

（3）如果找不到专辑，则返回 HTTP 404错误。

b.最后，更改您的main，使其包含对router.GET的新调用，路径现在为/albums/:id ，如以下示例所示。

在此代码中：

（1）将/albums/:id路径与getAlbumByID功能相关联。在 Gin 中，路径中项目前面的冒号表示该项目是路径参数。

a.如果服务器从上一节开始仍在运行，请停止它。

b.在包含 main.go 的目录中的命令行中，运行代码以启动服务器。

c.从不同的命令行窗口，用于curl向正在运行的 Web 服务发出请求。

该命令应显示您使用其 ID 的专辑的 JSON。如果找不到专辑，您将收到带有错误消息的 JSON。

恭喜！您刚刚使用 Go 和 Gin 编写了一个简单的 RESTful Web 服务。

本节包含您使用本教程构建的应用程序的代码。

不是为了与众不同。而是为了更加清晰易懂。

Rob Pike 曾经在 Go 官方博客解释过这个问题（原文地址：http://blog.golang.org/gos-declaration-syntax），简略翻译如下（水平有限翻译的不对的地方见谅）：

引言

Go语言新人常常会很疑惑为什么这门语言的声明语法（declaration syntax）会和传统的C家族语言不同。在这篇博文里，我们会进行一个比较，并做出解答。

C 的语法

首先，先看看 C 的语法。C 采用了一种聪明而不同寻常的声明语法。声明变量时，只需写出一个带有目标变量名的表达式，然后在表达式里指明该表达式本身的类型即可。比如：

int x

上面的代码声明了 x 变量，并且其类型为 int——即，表达式 x 为 int 类型。一般而言，为了指明新变量的类型，我们得写出一个表达式，其中含有我们要声明的变量，这个表达式运算的结果值属于某种基本类型，我们把这种基本类型写到表达式的左边。所以，下述声明：

int *p

int a[3]

指明了 p 是一个int类型的指针，因为 *p 的类型为 int。而 a 是一个 int 数组，因为 a[3] 的类型为 int（别管这里出现的索引值，它只是用于指明数组的长度）。

我们接下来看看函数声明的情况。C 的函数声明中关于参数的类型是写在括号外的，像下面这样：

int main(argc, argv)

int argc

char *argv[]

{ /* ... */ }

如前所述，我们可以看到 main 之所以是函数，是因为表达式 main(argc, argv) 返回 int。在现代记法中我们是这么写的：

int main(int argc, char *argv[]) { /* ... */ }

尽管看起来有些不同，但是基本的结构是一样的。

总的来看，当类型比较简单时，C的语法显得很聪明。但是遗憾的是一旦类型开始复杂，C的这套语法很快就能让人迷糊了。著名的例子如函数指针，我们得按下面这样来写：

int (*fp)(int a, int b)

在这儿，fp 之所以是一个指针是因为如果你写出 (*fp)(a, b) 这样的表达式将会调用一个函数，其返回 int 类型的值。如果当 fp 的某个参数本身又是一个函数，情况会怎样呢？

int (*fp)(int (*ff)(int x, int y), int b)

这读起来可就点难了。

当然了，我们声明函数时是可以不写明参数的名称的，因此 main 函数可以声明为：

int main(int, char *[])

回想一下，之前 argv 是下面这样的

char *argv[]

你有没有发现你是从声明的「中间」去掉变量名而后构造出其变量类型的？尽管这不是很明显，但你声明某个 char *[] 类型的变量的时候，竟然需要把名字插入到变量类型的中间。

我们再来看看，如果我们不命名 fp 的参数会怎样：

int (*fp)(int (*)(int, int), int)

这东西难懂的地方可不仅仅是要记得参数名原本是放这中间的

int (*)(int, int)

它更让人混淆的地方还在于甚至可能都搞不清这竟然是个函数指针声明。我们接着看看，如果返回值也是个函数指针类型又会怎么样

int (*(*fp)(int (*)(int, int), int))(int, int)

这已经很难看出是关于 fp 的声明了。

你自己还可以构建出比这更复杂的例子，但这已经足以解释 C 的声明语法引入的某些复杂性了。

还有一点需要指出，由于类型语法和声明语法是一样的，要解析中间带有类型的表达式可能会有些难度。这也就是为什么，C 在做类型转换的时候总是要把类型用括号括起来的原因，像这样

(int)M_PI

Go 的语法

非C家族的语言通常在声明时使用一种不同的类型语法。一般是名字先出现，然后常常跟着一个冒号。按照这样来写，我们上面所举的例子就会变成下面这样：

x: int

p: pointer to int

a: array[3] of int

这样的声明即便有些冗长，当至少是清晰的——你只需从左向右读就行。Go 语言所采用的方案就是以此为基础的，但为了追求简洁性，Go 语言丢掉了冒号并去掉了部分关键词，成了下面这样：

x int

p *int

a [3]int

在 [3]int 和表达式中 a 的用法没有直接的对应关系（我们在下一节会回过头来探讨指针的问题）。至此，你获得了代码清晰性方面的提升，但付出的代价是语法上需要区别对待。

下面我们来考虑函数的问题。虽然在 Go 语言里，main 函数实际上没有参数，但是我们先誊抄一下之前的 main 函数的声明：

func main(argc int, argv *[]byte) int

粗略一看和 C 没什么不同，不过自左向右读的话还不错。

main 函数接受一个 int 和一个指针并返回一个 int。

如果此时把参数名去掉，它还是很清楚——因为参数名总在类型的前面，所以不会引起混淆。

func main(int, *[]byte) int

这种自左向右风格的声明的一个价值在于，当类型变得更复杂时，它依然相对简单。下面是一个函数变量的声明（相当于 C 语言里的函数指针）

f func(func(int,int) int, int) int

或者当它返回一个函数时：

f func(func(int,int) int, int) func(int, int) int

上面的声明读起来还是很清晰，自左向右，而且究竟哪一个变量名是当前被声明的也容易看懂——因为变量名永远在首位。

类型语法和表达式语法带来的差别使得在 Go 语言里调用闭包也变得更简单：

sum := func(a, b int) int { return a+b } (3, 4)

指针

指针有些例外。注意在数组 (array )和切片 (slice) 中，Go 的类型语法把方括号放在了类型的左边，但是在表达式语法中却又把方括号放到了右边：

var a []int

x = a[1]

类似的，Go 的指针沿用了 C 的 * 记法，但是我们写的时候也是声明时 * 在变量名右边，但在表达式中却又得把 * 放到左左边：

var p *int

x = *p

不能写成下面这样

var p *int

x = p*

因为后缀的 * 可能会和乘法运算混淆，也许我们可以改用 Pascal 的 ^ 标记，像这样

var p ^int

x = p^

我们也许还真的应该把 * 像上面这样改成 ^ （当然这么一改 xor 运算的符号也得改），因为在类型和表达式中的 * 前缀确实把好些事儿都搞得有点复杂，举个例子来说，虽然我们可以像下面这样写

[]int("hi")

但在转换时，如果类型是以 * 开头的，就得加上括号：

(*int)(nil)

如果有一天我们愿意放弃用 * 作为指针语法的话，那么上面的括号就可以省略了。

可见，Go 的指针语法是和 C 相似的。但这种相似也意味着我们无法彻底避免在文法中有时为了避免类型和表达式的歧义需要补充括号的情况。

总而言之，尽管存在不足，但我们相信 Go 的类型语法要比 C 的容易懂。特别是当类型比较复杂时。

• 何为框架：

框架一直是敏捷开发中的利器，能让开发者很快的上手并做出应用，甚至有的时候，脱离了框架，一些开发者都不会写程序了。成长总不会一蹴而就，从写出程序获取成就感，再到精通框架，快速构造应用，当这些方面都得心应手的时候，可以尝试改造一些框架，或是自己创造一个。

Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比较明确，已经发布了1.0版本。具有快速灵活，容错方便等特点。其实对于golang而言，web框架的依赖要远比Python，Java之类的要小。自身的net/http足够简单，性能也非常不错。框架更像是一些常用函数或者工具的集合。借助框架开发，不仅可以省去很多常用的封装带来的时间，也有助于团队的编码风格和形成规范。

（1）首先需要安装，安装比较简单，使用go get即可

go get github.com/gin-gonic/gin

如果安装失败，直接去Github clone下来，放置到对应的目录即可。

（2）代码中使用：

下面是一个使用Gin的简单例子：

package main

import (

"github.com/gin-gonic/gin"

)

func main() {

router := gin.Default()

router.GET("/ping", func(c *gin.Context) {

c.JSON(200, gin.H{

"message": "pong",

})

router.Run(":8080") // listen and serve on 0.0.0.0:8080

}

简单几行代码，就能实现一个web服务。使用gin的Default方法创建一个路由handler。然后通过HTTP方法绑定路由规则和路由函数。不同于net/http库的路由函数，gin进行了封装，把request和response都封装到gin.Context的上下文环境。最后是启动路由的Run方法监听端口。麻雀虽小，五脏俱全。当然，除了GET方法，gin也支持POST,PUT,DELETE,OPTION等常用的restful方法。

Gin可以很方便的支持各种HTTP请求方法以及返回各种类型的数据，详情可以前往https://github.com/gin-gonic/gin查看。

2.1 匹配参数

我们可以使用Gin框架快速的匹配参数，如下代码所示：

冒号:加上一个参数名组成路由参数。可以使用c.Param的方法读取其值。当然这个值是字串string。诸如/user/rsj217，和/user/hello都可以匹配，而/user/和/user/rsj217/不会被匹配。

浏览器输入以下测试：

返回结果为：

其中c.String是gin.Context下提供的方法，用来返回字符串。

其中c.Json是gin.Context下提供的方法，用来返回Json。

下面我们使用以下gin提供的Group函数，方便的为不同的API进行分类。

我们创建了一个gin的默认路由，并为其分配了一个组 v1，监听hello请求并将其路由到视图函数HelloPage，最后绑定到 0.0.0.0:8000

C.JSON是Gin实现的返回json数据的内置方法，包含了2个参数，状态码和返回的内容。http.StatusOK代表返回状态码为200，正文为{"message": “welcome"}。

注：Gin还包含更多的返回方法如c.String, c.HTML, c.XML等，请自行了解。可以方便的返回HTML数据