Go语言实现在线词典 | 青训营笔记

210 阅读6分钟

Go语言实现在线词典

我们来实现一个命令行排版的词典,大概效果是长这样子。 image.png 用户可以在命令行里面查询一个单词。我们能通过调用第三方的 API 查询到单词的翻译并打印出来。

这个例子里面,我们会学习如何用 go 语言来、来发送 HTTP 请求、解析json 过来,还会学习如何使用代码生成来提高开发效率。

抓包

我们先来看一下我们要用到的 API,以彩云科技提供的在线翻译为例。

先请打开彩云翻译的网页,然后右键检查打开浏览器的开发者工具。 image.png

此时我们点一下翻译按钮,浏览器会发送一系列请求,我们能很轻松地找到那个用来查询单词的请求。

这是一个HTTP 的 post 的请求,请求的 header 的相当的复杂,有十来个,然后请求头是一个 json 里面有两个字段,一个是代表你是以什么语言转化成什么语言,source就是你要查询的单词。AP 的返回结果里面会有 Wiki 和 dictionary 两个字段,我们需要用的结果主要在dictionary.Explanations 字段里面。其他有些字段里面还包括音标等信息。 image.png

代码生成

我们需要在 Golang 里面去发送这个请求,因为这个请求比较复杂,用代码构造很麻烦,实际上我们有一种非常简单的方式来生成代码,我们可以右键浏测览器里面的copy as curl。 copy完成之后大家可以在终端粘贴一下 curl 命令,应该可以成功返回一大串 json。 image.png image.png 然后我们打开一个网站,粘贴curl 请求,在右边的语言里面选 Golang 就能够看到一串很长的代码,我们直接把它 copy 到我们的编辑器里面。有几个header比较复杂,生成代码有转义导致的编译错误,删掉这几行即可。 image.png

生成代码解读

我们来看一下生成的代码,首先第 12 行我们创建了一个HTTP client,创建的时可以指定很多参数,包括如请求的超时是否使用 cookie 等。接下来是构造一个HTTP请求,这是一个 post请求,然后会用到 HTTP.NewRequest,第一个参数是 http 方法 POST,第二个参数是 URL,最后一个参数是 body,body因为可能很大,为了支持流式发送,是一个只读流。我们用了 strings.NewReader 来把字符流转换成一个流,这样我们就成功构造了一个 HTTP reuest,接下来我们需要对这个 HTTP request 来设置一堆header.

接下来我们把我们调用 client do request,就能得到 response,如果请求失败的话,那么这个 error 会返回非nil ,会打印错误并退出进程,response 有它的 HTTP 状态码,response header和body。

body同样是一个流,在golang里面,为了避免资源泄露,你需要加一个 defer 来手动关闭这个流,这个defer 会在这个函数运行结束之后去执行,接下来我们使用 ioutil.ReadAll来读取这个流,能得到整个body。我们再用 print 打印出来 image.png 我们来运行生成的代码,能看到我们已经能够成功地发出请求,把返回的JSON 打印出来,但是现在个输入是固定的,我们是要从一个变量来输入,我们需要用到 JSON序列化 image.png

生成request body

在 Golang 里面。我们需要生成一段JSON,常用的方式是我们先构造出来一个结构体,这个结构体和我们需要生成的JSON 的结构是一一对应的。

image.png 在我们这个case里面,这个结构体会是这样子的,包含三个字段。

我们再来定义一个变量,初始化每个结构体成员,再调用JSON.marshaler 来得到这个序列化之后的字符串。

不同于之前这里是个字符串,我们这里是个字节数组,所以我们把 strings.newReader 改成 bytes 点 new ready 然后来构造那个 reuest 上的 body 接下来代码不变,然后我们就能成功地进入一个变量来发送 HTTP 请求。

这一步完成之后,大家可以再执行一遍,应该结果是完全不变的。

image.png

解析response body

接下来我们要做的是把这个 response body 来解析出来。

在js/Python 这些脚本语言里面,body是一个字典或者 map 的结构,可以直接从里面取值。但是golang是个强类型语言,这种做法并不是最佳实践。更常用的方式是和 reuest 的一样,写一个结构体,把返回的JSON反序列化到结构体里面。但是我们在浏览器里面可以看到这个API返回的结构非常复杂,如果要一一定义构体字段,非常繁琐并且容易出错。

image.png 此时有一个小技巧是,网上有对应的代码生成工具,我们可以打开这个网站,把json字符串粘贴进去,这样我们就能够生成对应结构体。

在某些时刻,我们如果不需要对这个返回结果,做很多精细的操作,我们可以选择转换嵌套,能让生成的代码更加紧凑。 image.png 这样我们就得到了一个 response 结构体,接下来我们修改代码,我们先定一个 response 结构体的对象,然后我们用JSON.unmarshal 把 body 反序列化到这个结构体里面,再试图打印出来

image.png

image.png 现在我们再运行一下,这里打印的时候使用了 %#v,这样可以让打印出来的结果比较容易读。我们现在离最终版本已经很近了,接下来我们需要修改代码为打印response 里面的特定字段。

image.png

打印结果

观察那个 json 可以看出我们需要的结果是在Dictionary.explanations.

我们用 for range 循环来迭代它,然后直接打印结构,参照一些词典的显示方式,我们可以在那个前面打印出这个单词和它的音标,这里有英式音标和美式音标 image.png

完善代码

现在我们的程序的输入还是写死的。我们把代码的主体改成一个query 函数,查的单词作为参数传递进来,然后我们写一个简单的 main 函数,这个 main 函数首先判断一下命令和参数的个数,如果它不是两个,那么我们就打印出错误信息,退出程序。否则就获取到用户输入的单词,然后执行 query 函数。 image.png

完成

现在命令行词典就算完成了 image.png