【Go Web开发】自定义JSON解码

在本系列文章前面，我们在API中添加了一些自定义的JSON编码处理，以便在JSON响应中以“(runtime) mins”的格式显示电影时长信息。

在本章，我们将从另一方面考虑，如何将“(runtime) mins”字段解析到int32类型的Go结构体字段中，也称为反序列化处理。

如果你现在尝试用"(runtime) mins"这种格式发送一个请求，会得到一个400 Bad request响应(因为不可能将JSON字符串("107 mins")解码为int32类型)。如下所示:

$ curl -d '{"title": "Moana", "runtime": "107 mins"}' localhost:4000/v1/movies
{
    "error": "body contains incorrect JSON type for \"runtime\""
}

为了使其正常工作，我们需要拦截JSON解码过程，并手动将“<runtime> mins”JSON字符串转换为int32。

因此我们该如何处理呢？

json.Unmarshaler接口

这里的关键是了解Go的json.Unmarshaler接口，它看起来像这样:

type Unmarshaler interface { 
    UnmarshalJSON([]byte) error
}

当Go解码JSON时，会检查目标字段的类型是否实现了json.Unmarshaler接口。如果实现了该接口，Go将调用UnmarshalJSON()函数来决定如何将JSON解码到目标类型。这刚好与json.Marshaler接口相反，我们之前使用它来定制JSON编码行为。

我们看看如何实现这个接口。

首先我们需要做的第一件事是更新createMovieHandler，以便输入结构体使用我们自定义的Runtime类型，而不是常规的int32。你应该记得，我们的runtime类型仍然是基础类型int32，但通过自定义类型，我们可以自由地让它上实现UnmarshalJSON()方法。

下面更新接口处理程序如下：

File：cmd/api/movies.go

package main

...

func (app *application) createMovieHandler(w http.ResponseWriter, r *http.Request) {
    var input struct {
        Title   string       `json:"title"`
        Year    int32        `json:"year"`
        Runtime data.Runtime `json:"runtime"`
        Genres  []string     `json:"genres"`
    }
    err := app.readJSON(w, r, &input)
    if err != nil {
        app.badRequestResponse(w, r, err)
        return
    }

    fmt.Fprintf(w, "%+v\n", input)
}

然后我们转到internal/data/runtime.go文件，为Runtime类型添加UnmarshalJSON方法。在这个方法里面需要解析“(runtime) mins”格式的JSON字符串，然后将runtime数值解析为int32，并将其赋值给Runtime本身。

这实际上有点复杂，有一些重要的细节，最好直接进入代码，并在后面用注释进行解释。

File：internal/data/runtime.go

package data

import (
    "errors"
    "fmt"
    "strconv"
    "strings"
)

//如果UnmarshalJSON函数不能将JSON字符串解析为Runtime类型，就返回该错误
var ErrInvalidRuntimeFormat = errors.New("invalid runtime format")

type Runtime int32

//Runtime类型实现UnmarshalJSON()方法，这样就实现了json.Unmarshaler接口。注意，因为UnmarshalJSON()会改变状态
//因此需要使用指针接收者。否则就要返回一个实例的拷贝。
func (r *Runtime) UnmarshalJSON(jsonValue []byte) error {
        //希望接收到的值是一个JSON字符串"（runtime） mins"，第一步需要去掉双引号。
    unquotedJSONValue, err := strconv.Unquote(string(jsonValue))
    if err != nil {
        return ErrInvalidRuntimeFormat
    }
        //分割字符串以分离包含数字的部分
    parts := strings.Split(unquotedJSONValue, " ")
    if len(parts) != 2 || parts[1] != "mins" {
        return ErrInvalidRuntimeFormat
    }
        //将数字字符串转为int32类型
    i, err := strconv.ParseInt(parts[0], 10, 32)
    if err != nil {
        return ErrInvalidRuntimeFormat
    }
        //将int32强制转为Runtime类型，并赋值给接收者，注意是指针类型的接收者。
    *r = Runtime(i)
    return nil
}

完成以上代码后重启服务，然后使用"(runtime) min"格式的值作为JSON字段。可以看到请求会被正常处理。数值会从字符串中提取出来赋值给input结构体中的Runtime类型字段，如下所示：

 $ curl -d '{"title": "Moana", "runtime": "107 mins"}' localhost:4000/v1/movies
{Title:Moana Year:0 Runtime:107 Genres:[]}

然而，如果你使用JSON数字或任何其他格式发请求，你应该会得到一个ErrInvalidRuntimeFormat错误消息的响应，类似如下:

$ curl -d '{"title": "Moana", "runtime": 107}' localhost:4000/v1/movies
{
    "error": "invalid runtime format"
}

$ curl -d '{"title": "Moana", "runtime": "107 minutes"}' localhost:4000/v1/movies
{
    "error": "invalid runtime format"
}