提供了编程的基础技术教程

zl程序教程

您现在的位置是：首页 >  后端

当前栏目

Go 语言怎么处理三方接口返回数据？

Go接口语言数据 处理 怎么 返回 三方
2023-06-13 09:14:09 时间

01

介绍

在使用 Go 语言调用三方RESTful接口时，因为无法直接操作 json 字符串，所以我们需要先将 json 字符串转换为 map 或 struct。

本文我们介绍一下怎么处理三方接口返回数据。

02

普通 json

我们先看一下三方接口返回的普通 json。

func main() {
 // 三方返回普通 json 字符串
 jsonRes := `{
  "Id": 1001,
  "Name": "frank"
 }`
 data := new(User)
 err := json.Unmarshal([]byte(jsonRes), &data)
 if err != nil {
  log.Printf("json Unmarshal err:%v\n", err)
  return
 }
 fmt.Printf("data=%+v", data)
}

type User struct {
 Id   int
 Name string
}

输出结果：

data=&{Id:1001 Name:frank}

阅读上面这段代码，我们构造一个简单的 json 字符串，模拟三方接口返回数据。

我们使用 Go 标准库 encoding/json 的 Unmarshal 函数，可以很容易将 json 数据解码到 struct，从而方便我们读取返回数据。

但是，需要读者朋友们注意的是，假如三方接口返回数据的字段类型随机变化（比如示例中的 Id 字段，可能是整型或字符串随机返回），我们使用 Unmarshal 函数解码时，就有可能会返回错误，如下所示：

2022/08/15 14:07:41 json Unmarshal err:json: cannot unmarshal string into Go struct field User.Id of type int

阅读到这里，我相信已经有读者朋友们想到，可以把返回数据解码到 map[string]interface{} 类型的变量中。

示例代码：

func main() {
 // 三方返回普通 json 字符串
 jsonRes := `{
  "Id": 1001,
  "Name": "frank"
 }`
 data2 := make(map[string]interface{})
 err := json.Unmarshal([]byte(jsonRes), &data2)
 if err != nil {
  log.Printf("json Unmarshal err:%v\n", err)
  return
 }
 fmt.Printf("data2=%+v", data2)
}

输出结果：

data2=map[Id:1001 Name:frank]

阅读上面示例代码，我们可以通过将返回数据解码到 map[string]interface{} 类型的变量中，从而解决三方接口返回数据的字段类型不固定的问题。

普通 json 使用该方式处理确实可行，但是如果嵌套 json，也可以这么处理，但是读取嵌套 json 的子字段就不那么方便了。

03

嵌套 json

我们再构造一个三方接口返回数据是嵌套 json 的变量。

func main() {
 // 三方返回嵌套 json 字符串
 jsonRes := `{
 "Id": 1001,
 "Name": "frank",
 "Details": {
 "Gender": "man",
 "Age": 18,
 "Phone": "13800138000",
 "address": "Beijing"
 }
 }`
 data := new(User)
 err := json.Unmarshal([]byte(jsonRes), &data)
 if err != nil {
  log.Printf("json Unmarshal err:%v\n", err)
  return
 }
 fmt.Printf("data=%+v", data)
}

type User struct {
 Id      int
 Name    string
 Details Details
}

type Details struct {
 Gender  string
 Age     int
 Phone   string
 Address string
}

输出结果：

data=&{Id:1001 Name:frank Details:{Gender:man Age:18 Phone:13800138000 Address:Beijing}}

阅读上面这段代码，我们构造一个嵌套 json，使用 Unmarshal 函数解码到 struct 中。

但是，如果返回数据中的 Age 字段是字符串类型，我们使用 Unmarshal 函数解码时，就会返回以下错误：

2022/08/15 17:33:08 json Unmarshal err:json: cannot unmarshal string into Go struct field Details.Details.Age of type int

虽然，我们可以使用普通 json 中的处理方式，将返回数据解码到 map[string]interface{} 类型的变量中。但是，如果我们想要读取内嵌 json 中的子字段，就读取不到了。

怎么解决这个问题呢？我们可以借助三方库 mapstructure，使用该三方库的 Decode 函数替代 Go 标准库 encoding/json 的 Unmarshal 函数。

示例代码：

func main() {
 // 三方返回嵌套 json 字符串
 jsonRes := `{
 "Id": 1001,
 "Name": "frank",
 "Details": {
 "Gender": "man",
 "Age": "18",
 "Phone": "13800138000",
 "address": "Beijing"
 }
 }`
 tmpData := make(map[string]interface{})
 err := json.Unmarshal([]byte(jsonRes), &tmpData)
 if err != nil {
  log.Printf("json Unmarshal err:%v\n", err)
  return
 }
 data2 := new(User)
 err = mapstructure.Decode(tmpData, data2)
 if err != nil {
  log.Printf("decode err:%v\n", err)
  return
 }
 fmt.Printf("data2=%+v\n", data2)
 fmt.Printf("age=%v\n", data2.Details.Age)
}

type User struct {
 Id      int
 Name    string
 Details Details
}

type Details struct {
 Gender  string
 Age     interface{}
 Phone   string
 Address string
}

输出结果：

data2=&{Id:1001 Name:frank Details:{Gender:man Age:18 Phone:13800138000 Address:Beijing}}
age=18

阅读上面这段代码，我们将嵌套 struct 的 Age 字段定义为 interface{} 类型，首先，我们使用 Go 标准库的 Unmarshal 函数将返回数据解码到 map[string]interface{} 类型的变量中。

然后使用三方库 mapstructure 的 Decode 函数，将 map[string]interface{} 类型的变量中的数据解码到 struct 中，从而实现我们可以读取内嵌 json 中的子字段。

三方库 mapstructure 还有很多其他好用的功能，感兴趣的读者朋友们可以阅读官方文档了解更多内容。

04

总结

本文我们主要介绍怎么处理三方接口返回数据，其中包含普通 json 和嵌套 json，在处理嵌套 json 的内容中，我们介绍了三方库 mapstructure 的简单使用方式。

建议读者朋友们阅读三方库 mapstructure 的官方文档，了解它提供的更多函数和方法。

推荐阅读：

  1. Go 语言内存逃逸案例
  2. Golang 语言的多种变量声明方式和使用场景
  3. Golang 语言中的内置函数 make 和 new
  4. Golang 语言怎么高效拼接字符串？
  5. Go 语言学习之运算符

参考资料：

  1. https://pkg.go.dev/github.com/mitchellh/mapstructure
  2. https://pkg.go.dev/encoding/json

相关文章