golang怎么返回json

2023-05-15 13:05:57 json 返回 Golang

开发网站或者网络应用程序时,经常需要通过 api 的形式返回 JSON 数据。因此,掌握如何在 golang 中返回 jsON 数据至关重要。

本文将介绍 Golang 的 json 包及其基本用法,以及如何使用它来将 Golang 数据结构编码为 JSON 字符串或将 JSON 字符串解码为 Golang 数据结构。

  1. 基本用法

在 Golang 程序中,使用 json 包操作 JSON 数据非常简单。可以将 JSON 字符串解析为 Golang 变量,也可以将 Golang 变量编码为 JSON 字符串。

  1. 将 Golang 变量编码为 JSON 字符串

在 Golang 程序中,如果需要将 Golang 变量编码为 JSON 字符串,可以使用 json.Marshal() 函数来完成这个任务。以下是一个示例程序,演示如何将 Go 结构体编码为 JSON 字符串:

package main

import (
    "encoding/json"
    "fmt"
)

type Person struct {
    Name string
    Age  int
}

func main() {
    p := Person{"Tom", 30}

    b, err := json.Marshal(p)
    if err != nil {
        fmt.Println("error:", err)
        return
    }

    fmt.Println(string(b))
}

输出结果为:

{"Name":"Tom","Age":30}

在上面的示例程序中,Person 结构体包含两个字段 Name 和 Age。我们将其实例化为一个名为 p 的变量,并将其传递给 json.Marshal() 函数。函数将返回一个 JSON 字符串的字节数组及一个可选的错误。

如果JSON编码失败,将会返回一个非空错误。在上述示例中,我们检查错误并输出错误信息。

注意:使用 json.Marshal() 编码 JSON 字符串时,JSON 字段的名称是结构体字段的名称,必须大写字母开头。

  1. 将 JSON 字符串解码为 Golang 变量

在 Golang 程序中,如果需要将 JSON 字符串解码为 Golang 变量,可以使用 json.Unmarshal() 函数。以下是一个示例程序,演示如何将 JSON 字符串解码为 Go 结构体:

package main

import (
    "encoding/json"
    "fmt"
)

type Person struct {
    Name string
    Age  int
}

func main() {
    jsonStr := `{"Name":"Tom","Age":30}`
    var p Person

    err := json.Unmarshal([]byte(jsonStr), &p)
    if err != nil {
        fmt.Println("error:", err)
        return
    }

    fmt.Println(p.Name, p.Age)
}

输出结果为:

Tom 30

在上面的示例程序中,我们将 JSON 字符串与空的 Person 结构体进行解码。需要将 JSON 字符串转换为字节数组,该字节数组会被修改以适应解码结果。解码结果将存储在经过 unmarshal 的变量中。

这里使用了一个 & 运算符,用于将变量地址传递给函数,并将其用于实际结果的修改。

同样的,如果 JSON 解码失败,将会返回一个错误并打印错误信息。

  1. 返回 JSON 数据

在 Golang 中,可以使用 net/Http 包创建 API,返回 JSON 数据。以下是一个简单的示例程序,演示如何使用 Golang 返回 JSON 数据:

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
)

type Person struct {
    Name string
    Age  int
}

func main() {
    http.HandleFunc("/person", handlePerson)
    http.ListenAndServe(":8080", nil)
}

func handlePerson(w http.ResponseWriter, r *http.Request) {
    p := Person{"Tom", 30}

    b, err := json.Marshal(p)
    if err != nil {
        fmt.Println("error:", err)
        return
    }

    w.Header().Set("Content-Type", "application/json")
    w.Write(b)
}

在上面的示例程序中,我们创建了一个基本的HTTP服务器,使用了 net/http 包。我们使用 http.HandleFunc() 函数来将路径 /person 和 handlePerson 处理函数进行绑定。

handlePerson 函数返回了一个具有 Name 和 Age 字段的 Person 结构体。它将使用 json.Marshal() 函数将 Person 结构体编码为 JSON 格式。最后,我们使用 http.ResponseWriter 接口来写入 JSON 响应。在写入之前,我们使用 w.Header().Set() 函数设置了响应头的 Content-Type 为 application/json。

现在,你已经知道如何使用 Golang 编码和解码 JSON 数据,以及如何在 HTTP 响应中返回 JSON 数据。学会这些技能将使你在开发网络应用程序时更加得心应手。

以上就是golang怎么返回json的详细内容,更多请关注其它相关文章!

相关文章