【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"
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,204评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,091评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,548评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,657评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,689评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,554评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,302评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,216评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,661评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,851评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,977评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,697评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,306评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,898评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,019评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,138评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,927评论 2 355

推荐阅读更多精彩内容