Go必知必会：扩展包（上）——全面解析 jsonTime 包的奥秘

序言

github.com/liamylian/jsontime 是一个Go语言的第三方库，它的主要目的是提供更灵活和强大的JSON时间序列化和反序列化功能。这个库可以帮助开发者在处理包含日期和时间的JSON数据时，更加容易地进行格式转换。 在开发过程中，我们经常需要处理时间数据，尤其是在前后端交互时。默认情况下，时间数据通常以 UTC 格式存储和传输，但这并不总是符合一些用户的习惯。为了提供更友好的时间显示，我们需要将时间格式转换为用户习惯的本地时间格式。本文将介绍如何使用 jsontime 包来实现这一目标。

我们希望将时间字段从 UTC 格式转换为用户的习惯的本地时间格式，例如：

{
    "code": 200,
    "data": {
        "count": 12,
        "info": [
            {
                "updated_at": "2021-03-17T07:11:24+08:00" //原生方式
                "created_at": "2021-03-17 07:11:24",  //需要优化成这种
            }
        ]
    },
    "message": "成功"
}

首先引入一个包，在控制台运行：

go get github.com/liamylian/jsontime

下载相关依赖：

go mod download

修改结构体，声明要处理时间的字段：

type Order struct {
        CreatedAt       time.Time `json:"created_at" time_format:"sql_datetime" time_utc:"false"`       // 格式化时间示例
        UpdatedAt       string  `json:"updated_at"`       // 原生状态示例
}

1. 取值时调用MarshalToString把结构体数据转为字符串

2. 但是转完的字符串存在反斜线的问题，使用json.RawMessage()处理一下

var timeJson = jsontime.ConfigWithCustomTimeFormat

func AllOrder(c *gin.Context) {
        limitStr := c.DefaultQuery("limit", "10")
        pageStr := c.DefaultQuery("page", "0")
        orderType := c.DefaultQuery("orderType", "desc")
        orderField := c.DefaultQuery("orderField", "id")
        orderSql := orderField + " " + orderType
        limit, _ := strconv.Atoi(limitStr)
        page, _ := strconv.Atoi(pageStr)
        count, res := model.QueryOrder(0, limit, page, orderSql)
        //处理1：MarshalToString
        bytes, _ := timeJson.MarshalToString(&res)

        jsonInfo := map[string]interface{}{
                "count": count,
                //处理2：解决反斜线的问题
                "info":  json.RawMessage(bytes), 
        }

        c.JSON(http.StatusOK, ReturnJson{
                http.StatusOK,
                jsonInfo,
                "成功",
        })
}

我们最终实现出来的效果如下：

{
    "code": 200,
    "data": {
        "count": 12,
        "info": [
            {
                "updated_at": "2021-03-17 07:13:24",
                "created_at": "2021-03-17 07:11:24",  
            }
        ]
    },
    "message": "成功"
}

再深入理解一下time包的使用：time包提供了时间的显示和测量用的函数；日历的计算采用的是公历。

时间类型

time.Time类型表示时间。我们可以通过time.Now()函数获取当前的时间对象，然后获取时间对象的年月日时分秒等信息。示例代码如下：

func timeDemo() {
        now := time.Now() //获取当前时间
        fmt.Printf("current time:%v\n", now)

        year := now.Year()     //年
        month := now.Month()   //月
        day := now.Day()       //日
        hour := now.Hour()     //小时
        minute := now.Minute() //分钟
        second := now.Second() //秒
        fmt.Printf("%d-%02d-%02d %02d:%02d:%02d\n", year, month, day, hour, minute, second)
}

时间戳

时间戳是自1970年1月1日（08:00:00GMT）至当前时间的总毫秒数，它也被称为Unix时间戳（UnixTimestamp）。

基于时间对象获取时间戳的示例代码如下：

func timestampDemo() {
        now := time.Now()            //获取当前时间
        timestamp1 := now.Unix()     //时间戳
        timestamp2 := now.UnixNano() //纳秒时间戳
        fmt.Printf("current timestamp1:%v\n", timestamp1)
        fmt.Printf("current timestamp2:%v\n", timestamp2)
}

使用time.Unix()函数可以将时间戳转为时间格式。

func timestampDemo2(timestamp int64) {
        timeObj := time.Unix(timestamp, 0) //将时间戳转为时间格式
        fmt.Println(timeObj)
        year := timeObj.Year()     //年
        month := timeObj.Month()   //月
        day := timeObj.Day()       //日
        hour := timeObj.Hour()     //小时
        minute := timeObj.Minute() //分钟
        second := timeObj.Second() //秒
        fmt.Printf("%d-%02d-%02d %02d:%02d:%02d\n", year, month, day, hour, minute, second)
}

时间间隔

time.Duration是time包定义的一个类型，它代表两个时间点之间经过的时间，以纳秒为单位。time.Duration表示一段时间间隔，可表示的最长时间段大约290年。

time包中定义的时间间隔类型的常量如下：

const (
    Nanosecond  Duration = 1
    Microsecond          = 1000 * Nanosecond
    Millisecond          = 1000 * Microsecond
    Second               = 1000 * Millisecond
    Minute               = 60 * Second
    Hour                 = 60 * Minute
)

例如，time.Duration表示1纳秒，time.Second表示1秒。

时间操作

Add 我们在日常的编码过程中可能会遇到要求时间+时间间隔的需求，Go语言的时间对象有提供Add方法如下：

func (t Time) Add(d Duration) Time 举个例子，求一个小时之后的时间：

func main() {
        now := time.Now()
        later := now.Add(time.Hour) // 当前时间加1小时后的时间
        fmt.Println(later)
}

Sub 求两个时间之间的差值：

func (t Time) Sub(u Time) Duration 返回一个时间段t-u。如果结果超出了Duration可以表示的最大值/最小值，将返回最大值/最小值。要获取时间点t-d（d为Duration），可以使用t.Add(-d)。

Equal func (t Time) Equal(u Time) bool 判断两个时间是否相同，会考虑时区的影响，因此不同时区标准的时间也可以正确比较。本方法和用t==u不同，这种方法还会比较地点和时区信息。

Before func (t Time) Before(u Time) bool 如果t代表的时间点在u之前，返回真；否则返回假。

After func (t Time) After(u Time) bool 如果t代表的时间点在u之后，返回真；否则返回假。

定时器 使用time.Tick(时间间隔)来设置定时器，定时器的本质上是一个通道（channel）。

func tickDemo() {
        ticker := time.Tick(time.Second) //定义一个1秒间隔的定时器
        for i := range ticker {
                fmt.Println(i)//每秒都会执行的任务
        }
}

时间格式化

时间类型有一个自带的方法Format进行格式化，需要注意的是Go语言中格式化时间模板不是常见的Y-m-d H:M:S，而是使用Go的诞生时间2006年1月2号15点04分（记忆口诀为2006 1 2 3 4）。也许这就是技术人员的浪漫吧。

补充：如果想格式化为12小时方式，需指定PM。

func formatDemo() {
        now := time.Now()
        // 格式化的模板为Go的出生时间2006年1月2号15点04分 Mon Jan
        // 24小时制
        fmt.Println(now.Format("2006-01-02 15:04:05.000 Mon Jan"))
        // 12小时制
        fmt.Println(now.Format("2006-01-02 03:04:05.000 PM Mon Jan"))
        fmt.Println(now.Format("2006/01/02 15:04"))
        fmt.Println(now.Format("15:04 2006/01/02"))
        fmt.Println(now.Format("2006/01/02"))
}

解析字符串格式的时间：

now := time.Now()
fmt.Println(now)
// 加载时区
loc, err := time.LoadLocation("Asia/Shanghai")
if err != nil {
        fmt.Println(err)
        return
}
// 按照指定时区和指定格式解析字符串时间
timeObj, err := time.ParseInLocation("2006/01/02 15:04:05", "2019/08/04 14:15:20", loc)
if err != nil {
        fmt.Println(err)
        return
}
fmt.Println(timeObj)
fmt.Println(timeObj.Sub(now))

总结

通过使用 jsontime 包，能够灵活地处理 JSON 数据中的时间字段，将其从 UTC 格式转换为用户习惯的本地时间格式。这不仅提升了用户体验，还简化了开发过程中的时间处理逻辑。