golang xorm及time.Time自定義解決json日期格式的問題
golang默認的time.Time類型在轉為json格式時不是常用的2019-05-08 10:00:01這種格式,解決辦法是自定義一個時間類型,例如
type myTime time.Time ,然后針對myTime實現Marshaler接口的MarshalJSON方法,例如:
package models import ( "database/sql/driver" "time" ) const localDateTimeFormat string = "2006-01-02 15:04:05" type LocalTime time.Time func (l LocalTime) MarshalJSON() ([]byte, error) { b := make([]byte, 0, len(localDateTimeFormat)+2) b = append(b, '"') b = time.Time(l).AppendFormat(b, localDateTimeFormat) b = append(b, '"') return b, nil } func (l *LocalTime) UnmarshalJSON(b []byte) error { now, err := time.ParseInLocation(`"`+localDateTimeFormat+`"`, string(b), time.Local) *l = LocalTime(now) return err }
上面的代碼在網上隨手一搜就能找到,沒有什么困難的,接下來的才是本篇文章的重點,這玩意結合xorm使用時,特別是字段類型為*LocalTime的時候才需要折騰一番。
下面是我的對應數據庫表結構的struct 定義,
type ServerInfo struct { ServerInfoId string `xorm:"varchar(32) pk server_info_id"` CreatedAt LocalTime `xorm:"timestamp created"` UpdatedAt LocalTime `xorm:"timestamp updated"` DeletedAt *LocalTime `xorm:"timestamp deleted index"` OrgId string `xorm:"varchar(100) org_id" json:"orgId"` ServerIp string `xorm:"varchar(128) server_ip" json:"serverIp"` ServerNameDesc string `xorm:"varchar(500) server_name_desc" json:"serverNameDesc"` ServerTimeNow LocalTime `xorm:"timestamp server_time" json:"serverTime"` DataReceiveTime LocalTime `xorm:"timestamp data_receive_time" sql:"DEFAULT:current_timestamp" json:"dataRecvTime"` LastUploadDataTime *LocalTime `xorm:"timestamp last_upload_data_time" json:"lastUploadDataTime"` LastCheckTime *LocalTime `xorm:"timestamp last_check_time" json:"lastCheckTime"` LastErrorTime *LocalTime `xorm:"timestamp last_error_time" json:"lastErrorTime"` }
注意上面的字段類型,既有LocalTime類型的,又有*LocalTime類型的,*LocalTime是考慮到有時候數據值可能為NULL,即字段值可能為空的情況。
xorm不知道如何為LocalTime這個自定義類型進行賦值或者取值,因此需要實現xorm的core包中的Conversion接口,這個接口的定義如下:
注意,坑已經隱藏在上面的接口定義中了,過一會說。
整個完整的自定義時間類型的代碼變成了下面的這樣:
package models import ( "database/sql/driver" "time" ) const localDateTimeFormat string = "2006-01-02 15:04:05" type LocalTime time.Time func (l LocalTime) MarshalJSON() ([]byte, error) { b := make([]byte, 0, len(localDateTimeFormat)+2) b = append(b, '"') b = time.Time(l).AppendFormat(b, localDateTimeFormat) b = append(b, '"') return b, nil } func (l *LocalTime) UnmarshalJSON(b []byte) error { now, err := time.ParseInLocation(`"`+localDateTimeFormat+`"`, string(b), time.Local) *l = LocalTime(now) return err } func (l LocalTime) String() string { return time.Time(l).Format(localDateTimeFormat) } func (l LocalTime)Now()(LocalTime){ return LocalTime(time.Now()) } func (l LocalTime)ParseTime(t time.Time)(LocalTime){ return LocalTime(t) } func (j LocalTime) format() string { return time.Time(j).Format(localDateTimeFormat) } func (j LocalTime) MarshalText() ([]byte, error) { return []byte(j.format()), nil } func (l *LocalTime) FromDB(b []byte) error { if nil == b || len(b) == 0 { l = nil return nil } var now time.Time var err error now, err = time.ParseInLocation(localDateTimeFormat, string(b), time.Local) if nil == err { *l = LocalTime(now) return nil } now, err = time.ParseInLocation("2006-01-02T15:04:05Z", string(b), time.Local) if nil == err { *l = LocalTime(now) return nil } panic("自己定義個layout日期格式處理一下數據庫里面的日期型數據解析!") return err } //func (t *LocalTime) Scan(v interface{}) error { // // Should be more strictly to check this type. // vt, err := time.Parse("2006-01-02 15:04:05", string(v.([]byte))) // if err != nil { // return err // } // *t = LocalTime(vt) // return nil //} func (l *LocalTime) ToDB() ([]byte, error) { if nil == l { return nil,nil } return []byte(time.Time(*l).Format(localDateTimeFormat)), nil } func (l *LocalTime) Value() (driver.Value, error) { if nil==l { return nil, nil } return time.Time(*l).Format(localDateTimeFormat), nil }
此時,要是數據庫的字段內容都有值的話插入和更新應該是沒有什么問題,但是*LocalTime字段的值為nil的話問題就開始出現了,上面說了,ToDB()方法的返回值類型為[]byte,當字段值為nil時,返回nil看上去一切正常,但是xorm打印出來的sql語句數據值是下面這個樣子的:
這個[]uint8(nil)就是*LocalTime值為nil時的情況,數據庫驅動是不認可[]uint8(nil)這種數據去寫給timestamp類型字段的,問題的根源就是ToDB方法的返回值類型為[]byte,既然是這樣,就需要我們人為的把[]uint8(nil)這種類型改為interface(nil)類型,數據庫驅動會識別interface(nil)為NULL值,修改代碼xorm\statement.go第322行,把原來的val=data改成下面的樣子:
就是把val=data改為 if nil==data { val=nil } else {val=data} ,看上去邏輯沒有什么變化,但是給val=nil賦值的時候,val的類型就從[]uint8(nil)變成了interface(nil)了,這樣數據庫驅動就可以正確處理空值了。
除了需要修改xorm\statement.go文件的內容,還需要修改xorm\session_convert.go的第558行,增加以下代碼:
主要是增加下面的代碼
//fix when pointer type value is null,added by peihexian,2019-05-07 if nil==data { return nil,nil }
之所以加這個代碼是因為xorm作者沒有考慮指針類型字段值為nil的情況,xorm對有轉換的字段要么當成數字,要么當成了字符串,這兩種對于NULL類型的值都不適用,所以需要增加if nil==data return nil,nil這樣的代碼,還是把數據值組織成interface(nil)去給數據庫驅動去處理。
另外還有一個地方,是session_convert.go 第556行,同樣需要增加
if nil==data { //edit by peihexian 2019.06.19 return nil,nil }
下面是加完以后的樣子
到這里,對xorm做了幾處小的修改,自定義日期的問題及json格式化問題完美解決。
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方,望不吝賜教。