# Datetime datetime 日期时间处理包,格式化日期,比较日期。
## 源码: [https://github.com/duke-git/lancet/blob/v1/datetime/datetime.go](https://github.com/duke-git/lancet/blob/v1/datetime/datetime.go)
## 用法: ```go import ( "github.com/duke-git/lancet/datetime" ) ```
## 目录 - [AddDay](#AddDay) - [AddHour](#AddHour) - [AddMinute](#AddMinute) - [AddYear](#AddYear) - [BeginOfMinute](#BeginOfMinute) - [BeginOfHour](#BeginOfHour) - [BeginOfDay](#BeginOfDay) - [BeginOfWeek](#BeginOfWeek) - [BeginOfMonth](#BeginOfMonth) - [BeginOfYear](#BeginOfYear) - [EndOfMinute](#EndOfMinute) - [EndOfHour](#EndOfHour) - [EndOfDay](#EndOfDay) - [EndOfWeek](#EndOfWeek) - [EndOfMonth](#EndOfMonth) - [EndOfYear](#EndOfYear) - [GetNowDate](#GetNowDate) - [GetNowTime](#GetNowTime) - [GetNowDateTime](#GetNowDateTime) - [GetZeroHourTimestamp](#GetZeroHourTimestamp) - [GetNightTimestamp](#GetNightTimestamp) - [FormatTimeToStr](#FormatTimeToStr) - [FormatStrToTime](#FormatStrToTime) - [NewUnixNow](#NewUnixNow) - [NewUnix](#NewUnix) - [NewFormat](#NewFormat) - [NewISO8601](#NewISO8601) - [ToUnix](#ToUnix) - [ToFormat](#ToFormat) - [ToFormatForTpl](#ToFormatForTpl) - [ToIso8601](#ToIso8601) - [IsLeapYear](#IsLeapYear) - [BetweenSeconds](#BetweenSeconds) - [DayOfYear](#DayOfYear) - [IsWeekend](#IsWeekend) - [NowDateOrTime](#NowDateOrTime) - [Timestamp](#Timestamp) - [TimestampMilli](#TimestampMilli) - [TimestampMicro](#TimestampMicro) - [TimestampNano](#TimestampNano) - [TrackFuncTime](#TrackFuncTime) - [DaysBetween](#DaysBetween) - [GenerateDatetimesBetween](#GenerateDatetimesBetween)
## 文档 ## 注: 1. 函数中`format`参数值需要传以下值之一 (忽略大小写): - yyyy-mm-dd hh:mm:ss - yyyy-mm-dd hh:mm - yyyy-mm-dd hh - yyyy-mm-dd - yyyy-mm - mm-dd - dd-mm-yy hh:mm:ss - yyyy/mm/dd hh:mm:ss - yyyy/mm/dd hh:mm - yyyy/mm/dd hh - yyyy/mm/dd - yyyy/mm - mm/dd - dd/mm/yy hh:mm:ss - yyyymmdd - mmddyy - yyyy - yy - mm - hh:mm:ss - hh:mm - mm:ss ### AddDay

将日期加/减天数

函数签名: ```go func AddDay(t time.Time, day int64) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() after2Days := datetime.AddDay(now, 2) before2Days := datetime.AddDay(now, -2) fmt.Println(after2Days, before2Days) } ``` ### AddHour

将日期加/减小时数

函数签名: ```go func AddHour(t time.Time, hour int64) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() after2Hours := datetime.AddHour(now, 2) before2Hours := datetime.AddHour(now, -2) fmt.Println(after2Hours, after2Hours) } ``` ### AddMinute

将日期加/减分钟数

函数签名: ```go func AddMinute(t time.Time, minute int64) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() after2Minute := datetime.AddMinute(now, 2) before2Minute := datetime.AddMinute(now, -2) fmt.Println(after2Minute, before2Minute) } ``` ### AddYear

将日期加/减年数。

函数签名: ```go func AddYear(t time.Time, year int64) time.Time ``` 示例: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() after1Year := datetime.AddYear(now, 1) diff1 := after1Year.Sub(now) before1Year := datetime.AddYear(now, -1) diff2 := before1Year.Sub(now) fmt.Println(diff1) fmt.Println(diff2) // Output: // 8760h0m0s // -8760h0m0s } ``` ### BeginOfMinute

返回指定时间的分钟开始时间

函数签名: ```go func BeginOfMinute(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.BeginOfMinute(td) fmt.Println(bm) //2022-02-15 15:48:00 +0800 CST } ``` ### BeginOfHour

返回指定时间的小时开始时间

函数签名: ```go func BeginOfHour(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.BeginOfHour(td) fmt.Println(bm) //2022-02-15 15:00:00 +0800 CST } ``` ### BeginOfDay

返回指定时间的当天开始时间

函数签名: ```go func BeginOfDay(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.BeginOfDay(td) fmt.Println(bm) //2022-02-15 00:00:00 +0800 CST } ``` ### BeginOfWeek

返回指定时间的星期开始时间

函数签名: ```go func BeginOfWeek(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.BeginOfWeek(td) fmt.Println(bm) //2022-02-13 00:00:00 +0800 CST } ``` ### BeginOfMonth

返回指定时间的当月开始时间

函数签名: ```go func BeginOfMonth(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.BeginOfMonth(td) fmt.Println(bm) //2022-02-01 00:00:00 +0800 CST } ``` ### BeginOfYear

返回指定时间的当年开始时间

函数签名: ```go func BeginOfYear(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.BeginOfYear(td) fmt.Println(bm) //2022-01-01 00:00:00 +0800 CST } ``` ### EndOfMinute

返回指定时间的分钟结束时间

函数签名: ```go func EndOfMinute(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.EndOfMinute(td) fmt.Println(bm) //2022-02-15 15:48:59.999999999 +0800 CST } ``` ### EndOfHour

返回指定时间的小时结束时间

函数签名: ```go func EndOfHour(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.EndOfHour(td) fmt.Println(bm) //2022-02-15 15:59:59.999999999 +0800 CST } ``` ### EndOfDay

返回指定时间的当天结束时间.

函数签名: ```go func EndOfDay(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.EndOfDay(td) fmt.Println(bm) //2022-02-15 23:59:59.999999999 +0800 CST } ``` ### EndOfWeek

返回指定时间的星期结束时间

函数签名: ```go func EndOfWeek(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.EndOfWeek(td) fmt.Println(bm) //2022-02-19 23:59:59.999999999 +0800 CST } ``` ### EndOfMonth

返回指定时间的月份结束时间

函数签名: ```go func EndOfMonth(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.EndOfMonth(td) fmt.Println(bm) //2022-02-28 23:59:59.999999999 +0800 CST } ``` ### EndOfYear

返回指定时间的年份结束时间

函数签名: ```go func EndOfYear(t time.Time) time.Time ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { td := time.Date(2022, 2, 15, 15, 48, 40, 112, time.Local) bm := datetime.EndOfYear(td) fmt.Println(bm) //2022-12-31 23:59:59.999999999 +0800 CST } ``` ### GetNowDate

获取当天日期,返回格式:yyyy-mm-dd

函数签名: ```go func GetNowDate() string ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() currentDate := datetime.GetNowDate() fmt.Println(currentDate) // 2022-01-28 } ``` ### GetNowTime

获取当时时间,返回格式:hh:mm:ss

函数签名: ```go func GetNowTime() string ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() currentTime := datetime.GetNowTime() fmt.Println(currentDate) // 15:57:33 } ``` ### GetNowDateTime

获取当时日期和时间,返回格式:yyyy-mm-dd hh:mm:ss.

函数签名: ```go func GetNowDateTime() string ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() current := datetime.GetNowDateTime() fmt.Println(current) // 2022-01-28 15:59:33 } ``` ### GetZeroHourTimestamp

获取零时时间戳(timestamp of 00:00).

函数签名: ```go func GetZeroHourTimestamp() int64 ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() zeroTime := datetime.GetZeroHourTimestamp() fmt.Println(zeroTime) // 1643299200 } ``` ### GetNightTimestamp

获取午夜时间戳(timestamp of 23:59).

函数签名: ```go func GetNightTimestamp() int64 ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() nightTime := datetime.GetNightTimestamp() fmt.Println(nightTime) // 1643385599 } ``` ### FormatTimeToStr

将日期格式化成字符串,`format` 参数格式参考注1

函数签名: ```go func FormatTimeToStr(t time.Time, format string) string ``` 例子: ```go package main import ( "fmt" "time" "github.com/duke-git/lancet/datetime" ) func main() { now := time.Now() timeStr := datetime.FormatTimeToStr(now, "yyyy/mm/dd hh:mm:ss") fmt.Println(timeStr) //2022/01/28 16:07:44 } ``` ### FormatStrToTime

将字符串格式化成时间,`format` 参数格式参考注1

函数签名: ```go func FormatStrToTime(str, format string) (time.Time, error) ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { time := datetime.FormatStrToTime("2006-01-02 15:04:05", "yyyy/mm/dd hh:mm:ss") fmt.Println(time) } ``` ### NewUnixNow

创建一个当前时间的unix时间戳

函数签名: ```go type theTime struct { unix int64 } func NewUnixNow() *theTime ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm := datetime.NewUnixNow() fmt.Println(tm) //&{1647597438} } ``` ### NewUnix

创建一个unix时间戳

函数签名: ```go type theTime struct { unix int64 } func NewUnix(unix int64) *theTime ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm := datetime.NewUnix(1647597438) fmt.Println(tm) //&{1647597438} } ``` ### NewFormat

创建一个yyyy-mm-dd hh:mm:ss格式时间字符串的unix时间戳

函数签名: ```go type theTime struct { unix int64 } func NewFormat(t string) (*theTime, error) ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm, err := datetime.NewFormat("2022-03-18 17:04:05") fmt.Println(tm) //&{1647594245} } ``` ### NewISO8601

创建一个iso8601格式时间字符串的unix时间戳

函数签名: ```go type theTime struct { unix int64 } func NewISO8601(iso8601 string) (*theTime, error) ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm, err := datetime.NewISO8601("2006-01-02T15:04:05.999Z") fmt.Println(tm) //&{1136214245} } ``` ### ToUnix

返回unix时间戳

函数签名: ```go func (t *theTime) ToUnix() int64 ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm := datetime.NewUnixNow() fmt.Println(tm.ToUnix()) //1647597438 } ``` ### ToFormat

返回格式'yyyy-mm-dd hh:mm:ss'的日期字符串

函数签名: ```go func (t *theTime) ToFormat() string ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm, _ := datetime.NewFormat("2022-03-18 17:04:05") fmt.Println(tm.ToFormat()) //"2022-03-18 17:04:05" } ``` ### ToFormatForTpl

返回tpl格式指定的日期字符串

函数签名: ```go func (t *theTime) ToFormatForTpl(tpl string) string ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm, _ := datetime.NewFormat("2022-03-18 17:04:05") ts := tm.ToFormatForTpl("2006/01/02 15:04:05") fmt.Println(ts) //"2022/03/18 17:04:05" } ``` ### ToIso8601

返回iso8601日期字符串

函数签名: ```go func (t *theTime) ToIso8601() string ``` 例子: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { tm, _ := datetime.NewISO8601("2006-01-02T15:04:05.999Z") ts := tm.ToIso8601() fmt.Println(ts) //"2006-01-02T23:04:05+08:00" } ``` ### IsLeapYear

验证是否是闰年。

函数签名: ```go func IsLeapYear(year int) bool ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { result1 := datetime.IsLeapYear(2000) result2 := datetime.IsLeapYear(2001) fmt.Println(result1) fmt.Println(result2) // Output: // true // false } ``` ### BetweenSeconds

返回两个时间的间隔秒数。

函数签名: ```go func BetweenSeconds(t1 time.Time, t2 time.Time) int64 ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { today := time.Now() tomorrow := AddDay(today, 1) yesterday := AddDay(today, -1) result1 := datetime.BetweenSeconds(today, tomorrow) result2 := datetime.BetweenSeconds(today, yesterday) fmt.Println(result1) fmt.Println(result2) // Output: // 86400 // -86400 } ``` ### DayOfYear

返回参数日期是一年中的第几天。

函数签名: ```go func DayOfYear(t time.Time) int ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { date1 := time.Date(2023, 02, 01, 1, 1, 1, 0, time.Local) result1 := datetime.DayOfYear(date1) date2 := time.Date(2023, 01, 02, 1, 1, 1, 0, time.Local) result2 := datetime.DayOfYear(date2) date3 := time.Date(2023, 01, 01, 1, 1, 1, 0, time.Local) result3 := datetime.DayOfYear(date3) fmt.Println(result1) fmt.Println(result2) fmt.Println(result3) // Output: // 31 // 1 // 0 } ``` ### IsWeekend

判断日期是否是周末。

函数签名: ```go func IsWeekend(t time.Time) bool ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { date1 := time.Date(2023, 06, 03, 0, 0, 0, 0, time.Local) date2 := time.Date(2023, 06, 04, 0, 0, 0, 0, time.Local) date3 := time.Date(2023, 06, 02, 0, 0, 0, 0, time.Local) result1 := datetime.IsWeekend(date1) result2 := datetime.IsWeekend(date2) result3 := datetime.IsWeekend(date3) fmt.Println(result1) fmt.Println(result2) fmt.Println(result3) // Output: // true // true // false } ``` ### NowDateOrTime

根据指定的格式和时区返回当前时间字符串。

函数签名: ```go func NowDateOrTime(format string, timezone ...string) string ``` 实例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { result1 := datetime.NowDateOrTime("yyyy-mm-dd hh:mm:ss") result2 := datetime.NowDateOrTime("yyyy-mm-dd hh:mm:ss", "EST") fmt.Println(result1) fmt.Println(result2) // Output: // 2023-07-26 15:01:30 // 2023-07-26 02:01:30 } ``` ### Timestamp

返回当前秒级时间戳。

函数签名: ```go func Timestamp(timezone ...string) int64 ``` 实例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { ts := datetime.Timestamp() fmt.Println(ts) // Output: // 1690363051 } ``` ### TimestampMilli

返回当前毫秒级时间戳。

函数签名: ```go func TimestampMilli(timezone ...string) int64 ``` 实例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { ts := datetime.TimestampMilli() fmt.Println(ts) // Output: // 1690363051331 } ``` ### TimestampMicro

返回当前微秒级时间戳。

函数签名: ```go func TimestampMicro(timezone ...string) int64 ``` 实例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { ts := datetime.TimestampMicro() fmt.Println(ts) // Output: // 1690363051331784 } ``` ### TimestampNano

返回当前纳秒级时间戳。

函数签名: ```go func TimestampNano(timezone ...string) int64 ``` 实例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { ts := datetime.TimestampNano() fmt.Println(ts) // Output: // 1690363051331788000 } ``` ### TrackFuncTime

返回两个日期之间的天数差。

函数签名: ```go func TrackFuncTime(pre time.Time) func() ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { defer datetime.TrackFuncTime(time.Now())() var n int for i := 0; i < 5000000; i++ { n++ } // Output: // Function main execution time: 1.608195ms } ``` ### DaysBetween

返回两个日期之间的天数差。

函数签名: ```go func DaysBetween(start, end time.Time) int ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { start := time.Date(2024, time.September, 1, 0, 0, 0, 0, time.UTC) end := time.Date(2024, time.September, 10, 0, 0, 0, 0, time.UTC) result := datetime.DaysBetween(start, end) fmt.Println(result) // Output: // 9 } ``` ### GenerateDatetimesBetween

生成从start到end的所有日期时间的字符串列表。layout参数表示时间格式,例如"2006-01-02 15:04:05",interval参数表示时间间隔,例如"1h"表示1小时,"30m"表示30分钟。

函数签名: ```go func GenerateDatetimesBetween(start, end time.Time, layout string, interval string) ([]string, error) ``` 示例: ```go package main import ( "fmt" "github.com/duke-git/lancet/datetime" ) func main() { start := time.Date(2024, time.September, 1, 0, 0, 0, 0, time.UTC) end := time.Date(2024, time.September, 1, 2, 0, 0, 0, time.UTC) layout := "2006-01-02 15:04:05" interval := "1h" result, err := datetime.GenerateDatetimesBetween(start, end, layout, interval) fmt.Println(result) fmt.Println(err) // Output: // [2024-09-01 00:00:00 2024-09-01 01:00:00 2024-09-01 02:00:00] // } ```