golang package time 用法詳解

frluter發表於2019-03-04

在我們程式設計過程中,經常會用到與時間相關的各種務需求,下面來介紹 golang 中有關時間的一些基本用法,我們從 time 的幾種 type 來開始介紹。

時間可分為時間點與時間段,golang 也不例外,提供了以下兩種基礎型別

  • 時間點(Time)
  • 時間段(Duration)

除此之外 golang 也提供了以下型別,做一些特定的業務

  • 時區(Location)
  • Ticker
  • Timer(定時器)

我們將按以上順序來介紹 time 包的使用。

時間點(Time)

我們使用的所有與時間相關的業務都是基於點而延伸的,兩點組成一個時間段,大多數應用也都是圍繞這些點與面去做邏輯處理。

初始化

go 針對不同的引數型別提供了以下初始化的方式

      // func Now() Time
      fmt.Println(time.Now())

      // func Parse(layout, value string) (Time, error)
      time.Parse("2016-01-02 15:04:05", "2018-04-23 12:24:51")

      // func ParseInLocation(layout, value string, loc *Location) (Time, error) (layout已帶時區時可直接用Parse)
      time.ParseInLocation("2006-01-02 15:04:05", "2017-05-11 14:06:06", time.Local)

      // func Unix(sec int64, nsec int64) Time
      time.Unix(1e9, 0)

      // func Date(year int, month Month, day, hour, min, sec, nsec int, loc *Location) Time
      time.Date(2018, 1, 2, 15, 30, 10, 0, time.Local)

      // func (t Time) In(loc *Location) Time 當前時間對應指定時區的時間
      loc, _ := time.LoadLocation("America/Los_Angeles")
      fmt.Println(time.Now().In(loc))

      // func (t Time) Local() Time
複製程式碼

獲取到時間點之後為了滿足業務和設計,需要轉換成我們需要的格式,也就是所謂的時間格式化。

格式化

to string

格式化為字串我們需要使用 time.Format 方法來轉換成我們想要的格式

      fmt.Println(time.Now().Format("2006-01-02 15:04:05"))  // 2018-04-24 10:11:20
      fmt.Println(time.Now().Format(time.UnixDate))         // Tue Apr 24 09:59:02 CST 2018
複製程式碼

Format 函式中可以指定你想使用的格式,同時 time 包中也給了一些我們常用的格式

const (
	ANSIC       = "Mon Jan _2 15:04:05 2006"
	UnixDate    = "Mon Jan _2 15:04:05 MST 2006"
	RubyDate    = "Mon Jan 02 15:04:05 -0700 2006"
	RFC822      = "02 Jan 06 15:04 MST"
	RFC822Z     = "02 Jan 06 15:04 -0700" // RFC822 with numeric zone
	RFC850      = "Monday, 02-Jan-06 15:04:05 MST"
	RFC1123     = "Mon, 02 Jan 2006 15:04:05 MST"
	RFC1123Z    = "Mon, 02 Jan 2006 15:04:05 -0700" // RFC1123 with numeric zone
	RFC3339     = "2006-01-02T15:04:05Z07:00"
	RFC3339Nano = "2006-01-02T15:04:05.999999999Z07:00"
	Kitchen     = "3:04PM"
	// Handy time stamps.
	Stamp      = "Jan _2 15:04:05"
	StampMilli = "Jan _2 15:04:05.000"
	StampMicro = "Jan _2 15:04:05.000000"
	StampNano  = "Jan _2 15:04:05.000000000"
)     
複製程式碼

注意: galang 中指定的特定時間格式"2006-01-02 15:04:05 -0700 MST", 為了記憶方便,按照美式時間格式 月日時分秒年 外加時區 排列起來依次是 01/02 03:04:05PM ‘06 -0700,剛開始使用時需要注意。

to time stamp

      func (t Time) Unix() int64
      func (t Time) UnixNano() int64

      fmt.Println(time.Now().Unix())

      // 獲取指定日期的時間戳
      dt, _ := time.Parse("2016-01-02 15:04:05", "2018-04-23 12:24:51")
      fmt.Println(dt.Unix())

      fmt.Println(time.Date(2018, 1,2,15,30,10,0, time.Local).Unix())
複製程式碼

其他

time 包還提供了一些常用的方法,基本覆蓋了大多數業務,從方法名就能知道代表的含義就不一一說明了。

      func (t Time) Date() (year int, month Month, day int)
      func (t Time) Clock() (hour, min, sec int)
      func (t Time) Year() int
      func (t Time) Month() Month
      func (t Time) Day() int
      func (t Time) Hour() int
      func (t Time) Minute() int
      func (t Time) Second() int
      func (t Time) Nanosecond() int
      func (t Time) YearDay() int
      func (t Time) Weekday() Weekday
      func (t Time) ISOWeek() (year, week int)
      func (t Time) IsZero() bool
      func (t Time) Local() Time
      func (t Time) Location() *Location
      func (t Time) Zone() (name string, offset int)
      func (t Time) Unix() int64
複製程式碼

時間段(Duartion)

介紹完了時間點,我們再來介紹時間段,即 Duartion 型別, 我們業務也是很常用的型別。

      // func ParseDuration(s string) (Duration, error)
      tp, _ := time.ParseDuration("1.5s")
      fmt.Println(tp.Truncate(1000), tp.Seconds(), tp.Nanoseconds())

      func (d Duration) Hours() float64
      func (d Duration) Minutes() float64
      func (d Duration) Seconds() float64
      func (d Duration) Nanoseconds() int64
      func (d Duration) Round(m Duration) Duration         // 四捨五入
      func (d Duration) Truncate(m Duration) Duration      // 向下取整
複製程式碼

時區(Location)

我們在來介紹一下時區的相關的函式

    // 預設UTC    
    loc, err := time.LoadLocation("") 
    // 伺服器設定的時區,一般為CST
    loc, err := time.LoadLocation("Local")
    // 美國洛杉磯PDT
    loc, err := time.LoadLocation("America/Los_Angeles")

    // 獲取指定時區的時間點
    local, _ := time.LoadLocation("America/Los_Angeles")
    fmt.Println(time.Date(2018,1,1,12,0,0,0, local))
複製程式碼

可以在 $GOROOT/lib/time/zoneinfo.zip 檔案下看到所有時區。

時間運算

好了,基礎的型別我們介紹完,現在開始時間運算相關的函式,也是日常業務中我們大量應用的。

      // func Sleep(d Duration)   休眠多少時間,休眠時處於阻塞狀態,後續程式無法執行
      time.Sleep(time.Duration(10) * time.Second)

      // func After(d Duration) <-chan Time  非阻塞,可用於延遲
      time.After(time.Duration(10) * time.Second)

      // func Since(t Time) Duration 兩個時間點的間隔
      start := time.Now()
      fmt.Println(time.Since(start))   // 等價於 Now().Sub(t), 可用來計算一段業務的消耗時間

      func Until(t Time) Duration     //  等價於 t.Sub(Now()),t與當前時間的間隔

      // func (t Time) Add(d Duration) Time
      fmt.Println(dt.Add(time.Duration(10) * time.Second))   // 加

      func (t Time) Sub(u Time) Duration                    // 減 

      // func (t Time) AddDate(years int, months int, days int) Time
      fmt.Println(dt.AddDate(1, 1, 1))

      // func (t Time) Before(u Time) bool
      // func (t Time) After(u Time) bool
      // func (t Time) Equal(u Time) bool          比較時間點時儘量使用Equal函式 
複製程式碼

我們大概就介紹完了多數涉及時間點與時間段的函式,接下面我們通過一些使用場景來做一些演示。

使用場景

日期時間差

      dt1 := time.Date(2018, 1, 10, 0, 0, 1, 100, time.Local)
      dt2 := time.Date(2018, 1, 9, 23, 59, 22, 100, time.Local)
      // 不用關注時區,go會轉換成時間戳進行計算
      fmt.Println(dt1.Sub(dt2))        
複製程式碼

基於當前時間的前後運算

      now := time.Now()

      // 一年零一個月一天之後
      fmt.Println(now.Date(1,1,1))
      // 一段時間之後
      fmt.Println(now.Add(time.Duration(10)*time.Minute))

      // 計算兩個時間點的相差天數
      dt1 = time.Date(dt1.Year(), dt1.Month(), dt1.Day(), 0, 0, 0, 0, time.Local)
      dt2 = time.Date(dt2.Year(), dt2.Month(), dt2.Day(), 0, 0, 0, 0, time.Local)
      fmt.Println(int(math.Ceil(dt1.Sub(dt2).Hours() / 24)))
複製程式碼

時區轉換

      // time.Local 用來表示當前伺服器時區
      // 自定義地區時間
      secondsEastOfUTC := int((8 * time.Hour).Seconds())
      beijing := time.FixedZone("Beijing Time", secondsEastOfUTC)
      fmt.Println(time.Date(2018,1,2,0,0,0,0, beijing))  // 2018-01-02 00:00:00 +0800 Beijing Time  

      // 當前時間轉為指定時區時間
      fmt.Println(time.Now().In(beijing))

      // 指定時間轉換成指定時區對應的時間
      dt, err := time.ParseInLocation("2006-01-02 15:04:05", "2017-05-11 14:06:06", time.Local)

      // 當前時間在零時區年月日   時分秒  時區
      year, mon, day := time.Now().UTC().Date()     // 2018 April 24 
      hour, min, sec := time.Now().UTC().Clock()    // 3 47 15
      zone, _ := time.Now().UTC().Zone()            // UTC
複製程式碼

比較兩個時間點

      dt := time.Date(2018, 1, 10, 0, 0, 1, 100, time.Local)
      fmt.Println(time.Now().After(dt))     // true
      fmt.Println(time.Now().Before(dt))    // false

      // 是否相等 判斷兩個時間點是否相等時推薦使用 Equal 函式
      fmt.Println(dt.Equal(time.Now()))
複製程式碼

設定執行時間

通過time.After 函式與 select 結合使用可用於處理程式超時設定

      select {
      case m := <- c:
            // do something
      case <- time.After(time.Duration(1)*time.Second):
            fmt.Println("time out")
      }
複製程式碼

Ticker型別

Ticker 型別包含一個 channel,有時我們會遇到每隔一段時間執行的業務(比如設定心跳時間等),就可以用它來處理,這是一個重複的過程

      // 無法取消
      tick := time.Tick(1 * time.Minute)
      for _ = range tick {
            // do something
      }

      // 可通過呼叫ticker.Stop取消
      ticker := time.NewTicker(1 * time.Minute)
      for _ = range tick {
            // do something
      }
複製程式碼

Timer型別

Timer 型別用來代表一個單獨的事件,當設定的時間過期後,傳送當前的時間到 channel, 我們可以通過以下兩種方式來建立

      func AfterFunc(d Duration, f func()) *Timer   // 指定一段時間後指定的函式
      func NewTimer(d Duration) *Timer     
複製程式碼

以上兩函式都可以使用 Reset, 這個有個需要注意的地方是使用 Reset 時需要確保 t.C 通道被釋放時才能呼叫,以防止發生資源競爭的問題,可通過以下方式解決

      if !t.Stop() {
            <-t.C
      }
      t.Reset(d)

複製程式碼

參考文獻

package time

golang積累-時間、時區、格式的使用

論golang Timer Reset方法使用的正確姿勢

相關文章