Golang日期处理与操作插件库gostradamus的使用

介绍

Gostradamus是一个Go库，提供了一种轻量级且人性化的方式来创建、转换、格式化和解析日期时间。它基于Go的time库，主要类型DateTime可以轻松地与time.Time相互转换。

Gostradamus以法国药剂师Nostradamus命名，他因预言而闻名，因此与时间工作密切相关，就像Gostradamus一样。

特性

✅ 轻松在time.Time和gostradamus.DateTime之间转换
✅ 使用常见格式标记如YYYY-MM-DD HH:mm:ss进行格式化
✅ 生成从秒到年的时间跨度、下限和上限（包括周）
✅ 周操作和辅助函数
✅ 时区感知和转换
✅ 经过全面测试，可用于生产环境

基础用法

package main

import "github.com/bykof/gostradamus"

func main() {
    // 简单解析
    dateTime, err := gostradamus.Parse("14.07.2017 02:40:00", "DD.MM.YYYY HH:mm:ss")
    if err != nil {
        panic(err)
    }

    // 简单操作
    dateTime = dateTime.ShiftMonths(-5).ShiftDays(2)

    // 简单格式化
    println(dateTime.Format("DD.MM.YYYY HH:mm:ss"))
    // 16.02.2017 02:40:00

    // 简单辅助函数
    start, end := dateTime.SpanWeek()

    println(start.String(), end.String())
    // 2017-02-13T00:00:00.000000Z 2017-02-19T23:59:59.999999Z
}

完整示例

创建DateTime

// 使用定义好的时区创建
dateTime := gostradamus.NewDateTime(2020, 1, 1, 12, 0, 0, 0, gostradamus.EuropeBerlin)

// 使用预定义UTC时区创建
dateTime := gostradamus.NewUTCDateTime(2020, 1, 1, 12, 0, 0, 0)

// 使用本地时区创建
dateTime := gostradamus.NewLocalDateTime(2020, 1, 1, 12, 0, 0, 0)

// 从ISO-8601格式创建
dateTime := gostradamus.Parse("2017-07-14T02:40:00.000000+0200", gostradamus.Iso8601)

// 从自定义格式创建
dateTime := gostradamus.Parse("10.02.2010 14:59:53", "DD.MM.YYYY HH:mm:ss")

// 从UNIX时间戳创建
dateTime := gostradamus.FromUnixTimestamp(1500000000)

// 当前时间
dateTime := gostradamus.Now() // 本地时区
dateTime = gostradamus.UTCNow() // UTC时区
dateTime = gostradamus.NowInTimezone(gostradamus.EuropeParis) // 指定时区

时区操作

// 使用时区常量
gostradamus.EuropeParis  // Europe/Paris
gostradamus.EuropeBerlin // Europe/Berlin
gostradamus.AmericaNewYork // America/New_York

// 时区转换
dateTime := gostradamus.NewUTC(2020, 1, 1, 12, 12, 12, 0).InTimezone(gostradamus.EuropeBerlin)
println(dateTime.String())
// 2020-02-15T13:12:12.000000+0100

dateTime = dateTime.InTimeZone(America_New_York)
println(dateTime.String())
// 2020-02-15T07:12:12.000000-0500

时间偏移

dateTime := gostradamus.NewUTCDateTime(2020, 1, 1, 1, 1, 1, 1)
dateTime = dateTime.ShiftYears(10)
println(dateTime.String())
// 2030-01-01T01:01:01.000000+0000

dateTime = gostradamus.NewUTCDateTime(2020, 1, 1, 1, 1, 1, 1)
dateTime = dateTime.ShiftDays(-10)
println(dateTime.String())
// 2019-12-22T01:01:01.000000+0000

dateTime = gostradamus.NewUTCDateTime(2020, 1, 1, 1, 1, 1, 1)
dateTime = dateTime.ShiftWeeks(2)
println(dateTime.String())
// 2020-01-15T01:01:01.000000+0000

dateTime = gostradamus.NewUTCDateTime(2020, 1, 1, 1, 1, 1, 1)
dateTime = dateTime.Shift(0, 1, 10, 0, 0, 0, 0)
println(dateTime.String())
// 2020-02-11T01:01:01.000000+0000

时间替换

dateTime := gostradamus.NewUTCDateTime(2020, 1, 1, 1, 1, 1, 1)
dateTime = dateTime.ReplaceYear(2010)
println(dateTime.String())
// 2010-01-01T01:01:01.000000+0000

dateTime = gostradamus.NewUTCDateTime(2020, 1, 1, 1, 1, 1, 1)
dateTime = dateTime.ReplaceYear(2010).ReplaceMonth(2)
println(dateTime.String())
// 2010-02-01T01:01:01.000000+0000

格式化与解析

// 格式化
dateTimeString := gostradamus.NewDateTime(2017, 7, 14, 2, 40, 0, 0, UTC).Format("DD.MM.YYYY Time: HH:mm:ss")
println(dateTimeString)
// 14.07.2017 Time: 02:40:00

// 解析
dateTime, err := gostradamus.Parse("10.02.2010 14:59:53", "DD.MM.YYYY HH:mm:ss")
println(dateTime.String())
// 2010-02-10T14:59:53.000000Z

// 带时区解析
dateTime, err := gostradamus.ParseInTimezone("10.02.2010 14:59:53", "DD.MM.YYYY HH:mm:ss", gostradamus.EuropeBerlin)
println(dateTime.String())
// 2010-02-10T14:59:53.000000+0100

时间范围与辅助函数

// 下限
dateTimeString := gostradamus.NewDateTime(2017, 7, 14, 2, 40, 0, 0, UTC).FloorDay()
println(dateTimeString.String())
// 2017-07-14T00:00:00.000000Z

// 上限
dateTimeString := gostradamus.NewDateTime(2017, 7, 14, 2, 40, 0, 0, UTC).CeilMonth()
println(dateTimeString.String())
// 2017-07-31T23:59:59.999999Z

// 时间跨度
start, end := NewDateTime(2017, 7, 14, 2, 40, 0, 0, UTC).SpanMonth()
println(start.String())
// 2017-07-01T00:00:00.000000Z
println(end.String())
// 2017-07-31T23:59:59.999999Z

// 判断时间是否在范围内
isBetween := gostradamus.NewUTCDateTime(2020, 1, 1, 12, 0, 0, 0).IsBetween(
    gostradamus.NewUTCDateTime(2020, 1, 1, 11, 0, 0, 0),
    gostradamus.NewUTCDateTime(2020, 1, 1, 13, 0, 0, 0),
)
println(isBetween)
// true

// 获取ISO日历
year, month, day := gostradamus.NewUTCDateTime(2020, 1, 1, 12, 0, 0, 0).IsoCalendar()
println(year, month, day)
// 2020 1 1

格式标记表

贡献

如果您有改进Gostradamus的想法，可以创建issue。如果您已经编写了代码，可以创建pull request。如果发现bug，也可以创建issue。

许可证

MIT许可证。详见LICENSE文件。