jsontime

README

jsontime

A json iterator extension that support custom time format.

Install

go get github.com/liamylian/jsontime/v3

or

go mod edit -require=github.com/liamylian/jsontime/v3@v3.0.0

Usage

100% compatibility with standard lib

Replace

import "encoding/json"

json.Marshal(data)
json.Unmarshal(input, &data)

with

import (
    jsoniter "github.com/json-iterator/go"
    jsontime "github.com/liamylian/jsontime/v3"
)

json := jsoniter.ConfigCompatibleWithStandardLibrary
json.RegisterExtension(jsontime.NewCustomTimeExtension())

json.Marshal(data)
json.Unmarshal(input, &data)

Example

package main

import (
	"fmt"
	"time"

	jsoniter "github.com/json-iterator/go"
	jsontime "github.com/liamylian/jsontime/v3"
)

type Book struct {
	Id          int        `json:"id"`
	PublishedAt time.Time  `json:"published_at"`
	UpdatedAt   *time.Time `json:"updated_at"`
	CreatedAt   time.Time  `json:"created_at"`
}

func main() {
	json := jsoniter.ConfigCompatibleWithStandardLibrary
	timeExtension := jsontime.NewCustomTimeExtension()
	timeExtension.SetDefaultTimeFormat(time.RFC3339, time.Local)
	json.RegisterExtension(timeExtension)

	book := Book{
		Id:          1,
		PublishedAt: time.Now(),
		UpdatedAt:   nil,
		CreatedAt:   time.Now(),
	}

	bytes, _ := json.Marshal(book)
	fmt.Printf("%s", bytes)
}

Advanced Usage

package main

import (
	"fmt"
	"time"

	jsoniter "github.com/json-iterator/go"
	jsontime "github.com/liamylian/jsontime/v3"
)

type Book struct {
	Id          int        `json:"id"`
	PublishedAt time.Time  `json:"published_at" time_format:"sql_datetime" time_location:"shanghai"`
	UpdatedAt   *time.Time `json:"updated_at" time_format:"sql_datetime" time_location:"shanghai"`
	CreatedAt   time.Time  `json:"created_at" time_format:"sql_datetime" time_location:"shanghai"`
}

func main() {
	json := jsoniter.ConfigCompatibleWithStandardLibrary
	timeExtension := jsontime.NewCustomTimeExtension()

	timeZoneShanghai, _ := time.LoadLocation("Asia/Shanghai")
	timeExtension.AddTimeFormatAlias("sql_datetime", "2006-01-02 15:04:05")
	timeExtension.AddLocaleAlias("shanghai", timeZoneShanghai)
	json.RegisterExtension(timeExtension)

	book := Book{
		Id:          1,
		PublishedAt: time.Now(),
		UpdatedAt:   nil,
		CreatedAt:   time.Now(),
	}
	bytes, _ := json.Marshal(book)
	fmt.Printf("%s", bytes)
}

Notice

Because there are two maps in the package, that is not thread safe. So it is suggested to call AddTimeFormatAlias, AddLocaleAlias only once, right before calling Marshal and UnMarshal. Or you should make sure not to call them at the same time (writing and reading map at the same time will panic).

Documentation

Index

• Constants
• type CustomTimeExtension
  • func NewCustomTimeExtension() *CustomTimeExtension
  • func (extension *CustomTimeExtension) AddLocaleAlias(alias string, locale *time.Location)
  • func (extension *CustomTimeExtension) AddTimeFormatAlias(alias, format string)
  • func (extension *CustomTimeExtension) SetDefaultTimeFormat(timeFormat string, timeLocation *time.Location)
  • func (extension *CustomTimeExtension) UpdateStructDescriptor(structDescriptor *jsoniter.StructDescriptor)

Constants

const (
	ANSIC       = "ANSIC"
	UnixDate    = "UnixDate"
	RubyDate    = "RubyDate"
	RFC822      = "RFC822"
	RFC822Z     = "RFC822Z"
	RFC850      = "RFC850"
	RFC1123     = "RFC1123"
	RFC1123Z    = "RFC1123Z"
	RFC3339     = "RFC3339"
	RFC3339Nano = "RFC3339Nano"
	Kitchen     = "Kitchen"
	Stamp       = "Stamp"
	StampMilli  = "StampMilli"
	StampMicro  = "StampMicro"
	StampNano   = "StampNano"
)

time format alias

const (
	Local = "Local"
	UTC   = "UTC"
)

time zone alias

Types

type CustomTimeExtension

type CustomTimeExtension struct {
	jsoniter.DummyExtension
	// contains filtered or unexported fields
}

func NewCustomTimeExtension

func NewCustomTimeExtension() *CustomTimeExtension

func (*CustomTimeExtension) AddLocaleAlias

func (extension *CustomTimeExtension) AddLocaleAlias(alias string, locale *time.Location)

func (*CustomTimeExtension) AddTimeFormatAlias

func (extension *CustomTimeExtension) AddTimeFormatAlias(alias, format string)

func (*CustomTimeExtension) SetDefaultTimeFormat

func (extension *CustomTimeExtension) SetDefaultTimeFormat(timeFormat string, timeLocation *time.Location)

func (*CustomTimeExtension) UpdateStructDescriptor

func (extension *CustomTimeExtension) UpdateStructDescriptor(structDescriptor *jsoniter.StructDescriptor)