time

The time package provides functions and methods related to time and calendar.

The time.Now() function can get the current time:

func Now() Time

now := time.Now()
fmt.Println(now)
//2022-11-17 10:00:18.6983438 +0800 CST m=+0.007095001

Its return data type is the Time struct, which contains many time operation methods.

func (t *Time) nsec() int32 // Nanoseconds

func (t *Time) sec() int64 // Seconds

func (t *Time) unixSec() // Returns seconds in Unix time format

func (t *Time) addSec(d int64) // Add seconds

func (t *Time) setLoc(loc *Location) // Set location

func (t *Time) stripMono() // Remove monotonic clock reading from time

func (t Time) After(u Time) // Check if a time is after another

func (t Time) Before(u Time) bool // Check if a time is before another

func (t Time) Equal(u Time) bool // Check if two times represent the same instant

func (t Time) Sub(u Time) Duration // Calculate the difference between two times

func (t Time) Add(d Duration) Time // Add a time duration

Time Units

The time package stores basic time unit constants:

const (
  minDuration Duration = -1 << 63
  maxDuration Duration = 1<<63 - 1
)

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

Their type is time.Duration, with the smallest unit being nanoseconds and the largest being hours.

Formatting

Time types can be formatted for output. Note that in Go, the formatting template is not the common yyyy-mm-dd format, but uses Go's birth time as the template. Go was born on January 2, 2006, at 3:04 PM.

Example:

now := time.Now()

24-hour format output:

fmt.Println(now.Format("2006-01-02 15:04:05 Monday Jan"))
//2022-11-17 10:44:48 Thursday Nov

Output only the date:

fmt.Println(now.Format("2006-01-02"))
//2022-11-17

Output only 12-hour time format:

fmt.Println(now.Format("15:04:05 PM"))
//10:48:47 AM

Parsing Time

Often we have a requirement to convert a string time in a specific format to Go's time struct. This is what we're going to do next.

func main() {
   location, err := time.LoadLocation("Asia/Shanghai")
   if err != nil {
      fmt.Println(err)
      return
   }

   inLocation, err := time.ParseInLocation("2006/01/02", "2012/10/12", location)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(inLocation.String())
}

Final output:

2012-10-12 00:00:00 +0800 CST

Timer

Timer is a timer that exposes a channel. When the specified time arrives, the channel will receive a message and close.

func NewTimer(d Duration) *Timer

You can create a new timer through time.NewTimer():

func main() {
  timer := time.NewTimer(time.Second)
  defer timer.Stop()
  select {
  case t := <-timer.C:
    fmt.Println(t)
  }
}

2023-09-25 21:25:03.5696803 +0800 CST m=+1.007908001

After using the timer, it should be closed promptly.

Ticker

Ticker is a timer. The difference from Timer is that Timer is one-time, while Ticker triggers periodically.

func NewTicker(d Duration) *Ticker

You can create a new ticker through time.NewTicker():

func main() {
  ticker := time.NewTicker(time.Second)
  defer ticker.Stop()
  for i := 0; i < 3; i++ {
    select {
    case t := <-ticker.C:
      fmt.Println(t)
    }
  }
}

2023-09-25 21:29:20.4429256 +0800 CST m=+1.009508401
2023-09-25 21:29:21.4512075 +0800 CST m=+2.017790301
2023-09-25 21:29:22.4501592 +0800 CST m=+3.016742001

Similarly, after using the ticker, it should also be closed promptly.

Sleep

time.Sleep() can put the current goroutine in a suspended state for a certain period. During this time, the goroutine will be blocked until it resumes running.

func Sleep(d Duration)

func main() {
  start := time.Now()
  fmt.Println(start)
  time.Sleep(time.Second * 2)
  end := time.Now()
  fmt.Println(end)
}

2023-09-25 21:36:35.7229057 +0800 CST m=+0.001627901
2023-09-25 21:36:37.7347742 +0800 CST m=+2.013496401

The above program will block for two seconds after outputting start, then output end.