Golang API/time.TimeオブジェクトのUnmarshalに関する質問

Question

Golang API/time.TimeオブジェクトのUnmarshalに関する質問

Golangを最近始めたのですが、どうもUnmarshalがうまくいかず、調べても解決できなかったため質問させてください。

POSTMANを使いPOSTメソッドでデータを送信しています。

POST methodのFunction

"""
controllers.goのPOST Methodの関数
"""
func CreateProblem(w http.ResponseWriter, r *http.Request) {
	CreateProblem := &models.Problem{}
        body, err := ioutil.ReadAll(r.Body)
	    if err != nil {
		return
	}
	fmt.Println(string(body))            　　　　           ------ (1)
	utils.ParseBody(r, CreateProblem)
	b := CreateProblem.CreateProblem()
	fmt.Println("printing DT")
	fmt.Println(b.FinishedDT)　　　　　　　　　　　　　　　　　　------ (2)
	res, _ := json.Marshal(b)
	w.WriteHeader(http.StatusOK)
	w.Write(res)
}

controllers.goの(1)を実行後(POSTMANから実際に送ったデータ)は以下がプリント
{
    "number": 122,
    "title": "String Manupulation",
    "difficulty": "easy",
    "date": "2022-01-01"
}
Unmarshalされた後の日付はこのようなものをプリント
0001-01-01 00:00:00 +0000 UTC

このUnmarshalでPOSTMANで指定した"2022-01-01"が返ってこないのがとても不思議です。ネットで調べた上で、time.TimeをどのようにUnmarshalするか試行錯誤しましたが、特にParsebodyのReadAllでbodyをstringにしたのちどのようにすれば良いのかがわからないです。CreatedDateを追加するというソースは出てきましたが、僕がやりたいのは日にちとフォーマットを指定したdate: "yyyy-mm-dd"を返すというものです。

また、model.go, unmarshalしているutils.goは以下のようになっております。

"""
utils.goの中身
"""
func ParseBody(r *http.Request, x interface{}) {
	if body, err := ioutil.ReadAll(r.Body); err == nil {
		if err := json.Unmarshal([]byte(body), x); err != nil {
			return
		}
	}
}

"""
model.goの中身
"""
var db *gorm.DB

type Problem struct {
	gorm.Model
	Number     int    `gorm:"" json:"number"`
	Title      string `json:"title"`
	Difficulty string `json:"difficulty"`
	FinishedDT Date   `json:"date"`
}

type Date struct {
	time.Time
}

func init() {
	config.Connect()
	db = config.GetDB()
	// automigrate empty problem
	db.AutoMigrate(&Problem{})
}

// functions to communicate with database

func (b *Problem) CreateProblem() *Problem {
	// gorm function
	db.NewRecord(b)
	db.Create(&b)
	return b
}

現在このような構成でプロジェクトがあります。

(RESTfulAPI)
├── (cmd)
│   └── main.go
│  
├── (pkg)
│   ├── (config)
│        └──── app.go
│
│   ├── (controllers)
│        └──── controllers.go
│
│   ├── (models)
│        └──── model.go
│
│   ├── (routes)
│        └──── route.go
│
│   ├── (utils)
│        └──── utils.go   
│
├── go.mod
└── go.sum

どうぞ宜しくおねがいたします。

Answer 1

GoのJSONデコーダはtime.Time型に対してはtime.RFC3339という書式で書かれた文字列でなければいけません。
この日時のパースに成功する文字列の場合のみデコードに成功します。
（失敗した場合はゼロ値になります）

https://go.dev/play/p/qrcd4wXjCsA

// You can edit this code!
// Click here and start typing.
package main

import (
	"encoding/json"
	"fmt"
	"time"
)

type Problem struct {
	FinishedDT Date `json:"date"`
}

type Date struct {
	time.Time
}

const body = `
{
  "date": "2021-01-08T00:00:00+09:00"
}
`

func main() {
	var p *Problem
	b := []byte(body)
	if err := json.Unmarshal(b, &p); err != nil {
	}
	fmt.Printf("%v", p)
}

ここを意図した書式の文字列でデコードさせたい場合はカスタムのUnmashalerを実装しなくてはなりません。

このjson.Unmarshalerを実装した型は標準のUnmarshal処理ではなく、この実装を優先的に使ってJSONのデコードを行います。

https://go.dev/play/p/BRbtRfN5x5_B

package main

import (
	"encoding/json"
	"fmt"
	"time"
)

type Problem struct {
	FinishedDT *Date `json:"date"`
}

type Date struct {
	time.Time
}

func (d *Date) UnmarshalJSON(b []byte) error {
	v, err := time.Parse(`"2006-01-02"`, string(b))
	if err != nil {
		return err
	}
	d.Time = v
	return nil
}

const body = `
{
  "date": "2021-01-08"
}
`

func main() {
	var p *Problem
	b := []byte(body)
	if err := json.Unmarshal(b, &p); err != nil {
	}
	fmt.Printf("%v", p)
}

Comments

[nobonobo]

そして、元のコードでもこのコードでもjson.Unmarshalが返すエラーを見ていれば、日付のパースに失敗していたことはわかるはずです。

[Yuta_Hayashi]

返信が遅くなってしまいまして、大変申し訳ございません。そしてとても親切なご回答ありがとうございました。調べても解決できなかったのは”このjson.Unmarshalerを実装した型は標準のUnmarshal処理ではなく、この実装を優先的に使ってJSONのデコードを行います。”
を理解していなかったことでした。おかげさまでDateをフォーマットすることができました。