GO语言案例—在线词典案例笔记 | 青训营

112 阅读5分钟

1 项目要求

在控制台获取用户输入的单词,随后在控制台打印出单词、音标以及释义

2 需求分析

我们实现这个项目主要分为以下步骤:

  • 从控制台获取用户输入单词
  • 封装一个http请求进行查询,之后返回请求响应
  • 解析收到的响应,封装成函数对象
  • 实现控制查询,输出结果以及退出程序的逻辑

3 实现过程

image.png 我们可以通过获取词典网页进行翻译的请求信息来构造用Go语言实现的http请求。直接进行编写很复杂,可以通过借助Convert curl to Go (curlconverter.com)来实现。(实现步骤:复制上述请求dict as cURL,然后把所得信息粘贴到网址,就能得到对应请求代码)

例如参考项目v1:

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"trans_type":"en2zh","source":"good"}`)
	req, err := http.NewRequest("POST", "https://api.interpreter.caiyunai.com/v1/dict", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Connection", "keep-alive")
	req.Header.Set("DNT", "1")
	req.Header.Set("os-version", "")
	req.Header.Set("sec-ch-ua-mobile", "?0")
	req.Header.Set("User-Agent", "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.4844.51 Safari/537.36")
	req.Header.Set("app-name", "xy")
	req.Header.Set("Content-Type", "application/json;charset=UTF-8")
	req.Header.Set("Accept", "application/json, text/plain, */*")
	req.Header.Set("device-id", "")
	req.Header.Set("os-type", "web")
	req.Header.Set("X-Authorization", "token:qgemv4jr1y38jyq6vhvi")
	req.Header.Set("Origin", "https://fanyi.caiyunapp.com")
	req.Header.Set("Sec-Fetch-Site", "cross-site")
	req.Header.Set("Sec-Fetch-Mode", "cors")
	req.Header.Set("Sec-Fetch-Dest", "empty")
	req.Header.Set("Referer", "https://fanyi.caiyunapp.com/")
	req.Header.Set("Accept-Language", "zh-CN,zh;q=0.9")
	req.Header.Set("Cookie", "_ym_uid=16456948721020430059; _ym_d=1645694872")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

下面对程序代码进行解释:

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

对于引入包,其中“io/ioutil”用于读取HTTP响应体;net/http用于进行HTTP请求。

- 构造HTTP客户端和请求

client := &http.Client{}
	var data = strings.NewReader(`{"trans_type":"en2zh","source":"good"}`)
	req, err := http.NewRequest("POST", "https://api.interpreter.caiyunai.com/v1/dict", data)
	if err != nil {
		log.Fatal(err)
	}

这段代码构造了一个HTTP客户端client,和一个http post请求,请求对象是api.interpreter.caiyunai.com/v1/dict

client就是一个指向http.Client的指针,http.Client 是 Go 标准库中用于发送 HTTP 请求的类型。 data是一个io.Reader接口类型。strings.NewReader() 函数用于将给定的字符串转换为 io.Reader。 使用 http.NewRequest() 函数创建一个新的 HTTP 请求。该函数接受三个参数:

  1. 第一个参数是 HTTP 方法,表示我们将发送一个 POST 请求。
  2. 第二个参数是请求的目标 URL。
  3. 第三个参数是请求体的数据,它是一个包含 JSON 数据的 io.Reader

- 设置请求头,模拟来自浏览器的各种行为。

- 发送HTTP请求并获取响应

resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)

使用client.Do发送构造的http请求获取返回的响应resp。然后使用ioutil.ReadAll读取响应体中的数据,并将其存储在bodyText中。通过defer resp.Body.Close()语句确保在函数返回前关闭响应体,以防止资源泄漏。

在参考项目v2中,代码进行改进,主要有以下代码不同:

type DictRequest struct {
	TransType string `json:"trans_type"`
	Source    string `json:"source"`
	UserID    string `json:"user_id"`
}

request := DictRequest{TransType: "en2zh", Source: "good"}
buf, err := json.Marshal(request) 
if err != nil { 
    log.Fatal(err) 
} 
var data = bytes.NewReader(buf) 
req, err := http.NewRequest("POST", "https://api.interpreter.caiyunai.com/v1/dict", data) 
if err != nil { 
    log.Fatal(err) 
}

定义了一个结构体DictRequest,用于构造发送给网页的请求数据。其中:TransType是翻译类型;Source是查询单词;UserID是用户ID。

创建一个request的变量,并用DictRequest结构体初始化它。接着,通过json.Marshal函数将request对象转换为JSON格式的字节数组buf。 bytes.NewReader(buf) 将这个字节切片转换为 bytes.Reader 对象。

bytes.Reader 对象赋值给名为 data 的变量后,该变量就持有了一个可以从中读取 JSON 数据的 bytes.Reader 对象。(实现了 io.Reader 接口的类型)

项目v3中主要改进了对于响应结果的处理方式。使用了结构体DictResponse来解析和存储返回的JSON数据。

type DictResponse struct {
	Rc   int `json:"rc"`
	Wiki struct {
		KnownInLaguages int `json:"known_in_laguages"`
		Description     struct {
			Source string      `json:"source"`
			Target interface{} `json:"target"`
		} `json:"description"`
		ID   string `json:"id"`
		Item struct {
			Source string `json:"source"`
			Target string `json:"target"`
		} `json:"item"`
		ImageURL  string `json:"image_url"`
		IsSubject string `json:"is_subject"`
		Sitelink  string `json:"sitelink"`
	} `json:"wiki"`
	Dictionary struct {
		Prons struct {
			EnUs string `json:"en-us"`
			En   string `json:"en"`
		} `json:"prons"`
		Explanations []string      `json:"explanations"`
		Synonym      []string      `json:"synonym"`
		Antonym      []string      `json:"antonym"`
		WqxExample   [][]string    `json:"wqx_example"`
		Entry        string        `json:"entry"`
		Type         string        `json:"type"`
		Related      []interface{} `json:"related"`
		Source       string        `json:"source"`
	} `json:"dictionary"`
}

var dictResponse DictResponse
err = json.Unmarshal(bodyText, &dictResponse)

使用json.Unmarshal函数将API返回的JSON数据bodyText解析为DictResponse结构体,并存储在dictResponse变量中。

解析过程中,json.Unmarshal() 会根据 DictResponse 结构体的字段标签(json 标签)来匹配 JSON 数据的字段,然后将对应的值赋给 dictResponse 结构体的字段。

项目v4主要实现了支持命令行参数,使得可以输入自定义单词。

func main() {
	if len(os.Args) != 2 {
		fmt.Fprintf(os.Stderr, `usage: simpleDict WORD
example: simpleDict hello
		`)
		os.Exit(1)
	}
	word := os.Args[1]
	query(word)
}

首先通过os.Args获取命令行参数,来进行判断。如果参数数量不等于2,则输出简单的使用提示信息,并退出程序。否则将用户输入的要查询的单词存储在word变量中,然后调用query函数进行查询。(之前的主体代码被改成一个query函数)

4 心得体会

花费了几个小时把这个案例理解清楚。理解了之后发现确实原理很简单,主要是对于相关原理逻辑,代码实现不了解,导致感觉很理解起来很困难。通过这个项目对于GO语言构造HTTP响应请求方法有所了解,感觉主要是在对于json数据进行序列化反序列化处理的相关内容。