[Go言語/Golang]返り値にtime.Time型を返す関数を作りたい。

Question

###実現したいこと
Goでコーディングをしている中で、下記の様な関数を実現する必要があります。
返り値はtime.Timeで実現したいです。（できればエラーとかも吐ける様にしたい）
フレームワークはEchoを使用しています。

const(
	ExpirationMonth = "month"
	ExpirationDay = "day"
	Forever = "forever"
	ForeverDate = //できれば9999年12月３１日０時０分０秒をここに入れたい
)

func getDate(dateType string, num int)time.Time{
	if dateType == ExpirationMonth {
		return　//今月の１日０時０分０秒からnum月進んだ数
	}
	if dateType == ExpirationDay {
		//今日の１０時からnum日進んだ数
	}
	if dateType == Forever {
		return //9999年12月３１日０時０分０秒
	}
	return //nil的な何か（nilは指定できなかった）
}

func main() {
	date = "month"
	num = 3
	result = getDate(date, num)
	printf(result)
}

###分からないところ
①time.Time型での日付の計算
②返り値にどの様な値が入るべきか（nilなどは片違いで怒られてまうので）

定数にtime.Timeを入れるのとエラーを吐きたいのも書いていますが、これらはできたらやりたい程度です。
もし思いついたらこれらも教えて欲しいです。
よろしくお願いいたします。

Answer 1

エラーメッセージが不要な場合に限定すると、
処理失敗をゼロ値で伝える方法もアリかと思いました。
（ポインタ型で失敗したらnilを返すのと同じ手法）

https://play.golang.org/p/WXJl_BTDppr

package main

import (
	"fmt"
	"time"
)

func GetNow() time.Time {
	return time.Now()
}

func GetNowFailed() time.Time {
	return time.Time{}
}

func main() {
	t := GetNow()
	fmt.Println(t.IsZero(), t)
	t = GetNowFailed()
	fmt.Println(t.IsZero(), t)
}

Answer 2

こんにちは。2つの質問に対してお答えしました。
疑問点などあれば、お気軽にどうぞ。

1. time.Time型での日付の計算

Add()やAddDate()などを使ってください。
詳しくは、timeパッケージのドキュメントを参照してください。
ドキュメント内でExampleが複数提示されているので、結構読みやすいと思います。

簡単な実装例を載せておきます。

package main

import (
	"fmt"
	"math"
	"time"
)

const (
	numMonths = 3
	numDays   = 23
)

func main() {
	// 今の時刻を出力
	// (Playground内の時刻はリアルタイムではない)
	var now time.Time = time.Now()
	fmt.Println(now)

	// numMonths月進んだ時刻を出力
	var numMonthsAfter time.Time = now.AddDate(0, numMonths, 0)
	fmt.Println(numMonthsAfter)

	// numDays日進んだ時刻を出力
	var numDaysAfter time.Time = now.AddDate(0, 0, numDays)
	fmt.Println(numDaysAfter)

	// 時刻の最大値を出力
	var maxLimitTime time.Time = time.Unix(math.MaxInt64, 0)
	fmt.Println(maxLimitTime)
}

// Output:
// 2009-11-10 23:00:00 +0000 UTC m=+0.000000001
// 2010-02-10 23:00:00 +0000 UTC
// 2009-12-03 23:00:00 +0000 UTC
// 292277026596-12-04 15:30:07 +0000 UTC

2.返り値にどの様な値が入るべきか（nilなどは片違いで怒られてまうので）

nilを返したい場合は、getDate()の実行を失敗したと捉えることが出来ると思います。そのため、返り値の第二引数としてerrorを返してあげるのが良いと思いました。

GoPlaygroundのサンプルコードを載せておきます。

package main

import (
	"fmt"
	"log"
	"math"
	"os"
	"time"
)

const (
	ExpirationMonth = "month"
	ExpirationDay   = "day"
	Forever         = "forever"
)

var ForeverDate = time.Unix(math.MaxInt64, 0) //できれば9999年12月３１日０時０分０秒をここに入れたい

func getDate(dateType string, num int) (time.Time, error) {
	if dateType == ExpirationMonth {
		return time.Now().AddDate(0, num, 0), nil //今日からnum月進んだ数
	}
	if dateType == ExpirationDay {
		return time.Now().AddDate(0, 0, num), nil //今日からnum日進んだ数
	}
	if dateType == Forever {
		return time.Unix(math.MaxInt64, 0), nil //9999年12月３１日０時０分０秒
	}
	return time.Time{}, fmt.Errorf("failed to getDate(%s, %d)", dateType, num) //nil的な何か（nilは指定できなかった）
}

func main() {
	date := "month"
	num := 3
	result, err := getDate(date, num)
	if err != nil {
		log.Printf("failed to getDate: %s", err.Error())
		os.Exit(1)
	}
	log.Println(result)

	// 実行に失敗するケース
	_, err = getDate("hogefugapiyo", num)
	if err != nil {
		log.Printf("failed to getDate: %s", err.Error())
		os.Exit(1)
	}

}

// Output:
// 2009/11/10 23:00:00 2010-02-10 23:00:00 +0000 UTC
// 2009/11/10 23:00:00 failed to getDate: failed to getDate(hogefugapiyo, 3)

※2021/02/21 9:21追記

①日にち単位での計算の時に、その日の10時からN日といったカウントを実現したいので、nowを設定するときにその日の10時と設定する方法も知っていたら教えて欲しいなと思っています！

time.Date()の引数にtime.Now()を入れれば良いと思います。
Playgroundのサンプルコード

package main

import (
	"fmt"
	"log"
	"time"
)

func main() {
	now := time.Now()
	// func Date(year int, month Month, day, hour, min, sec, nsec int, loc *Location) Time
	// 10時を明示的に指定
	tenOClock := time.Date(now.Year(), now.Month(), now.Day(), 10, 0, 0, 0, time.Local)

	fmt.Println(now)
	fmt.Println(tenOClock)

	// サーバの環境情報がJSTになってない場合は、明示的にJSTを指定する
	jst, err := time.LoadLocation("Asia/Tokyo")
	if err != nil {
		log.Fatalf("failed to LoadLocation: %s", err.Error())
	}
	fmt.Println(tenOClock.In(jst))
}

// Output:
// 2009-11-10 23:00:00 +0000 UTC m=+0.000000001
// 2009-11-10 10:00:00 +0000 UTC
// 2009-11-10 19:00:00 +0900 JST

②ForeverDateですが、本当のMaxというよりは9999年12月３１日０時０分０秒でセットしたいので、その方法でも教えて欲しいです！

同様に、time.Date()で日付を設定してください。

Playgroundのサンプルコード

package main

import (
	"fmt"
	"log"
	"time"
)

func main() {
	// func Date(year int, month Month, day, hour, min, sec, nsec int, loc *Location) Time
	// ForeverDateを明示的に指定
	foreverDate := time.Date(9999, 12, 31, 0, 0, 0, 0, time.Local)

	fmt.Println(foreverDate)

	// サーバの環境情報がJSTになってない場合は、明示的にJSTを指定する
	jst, err := time.LoadLocation("Asia/Tokyo")
	if err != nil {
		log.Fatalf("failed to LoadLocation: %s", err.Error())
	}
	foreverDateJST := time.Date(9999, 12, 31, 0, 0, 0, 0, jst)
	fmt.Println(foreverDateJST)
}

// Output:
// 9999-12-31 00:00:00 +0000 UTC
// 9999-12-31 00:00:00 +0900 JST

Comments

[Nave]

回答ありがとうございます！！
疑問に思っていたことはほとんど回答してもらった内容で解決したので、ベストアンサーにさせていただきました！

もし差し支えなければもう少し聞きたいのですが、
①日にち単位での計算の時に、その日の10時からN日といったカウントを実現したいので、nowを設定するときにその日の10時と設定する方法も知っていたら教えて欲しいなと思っています！
②ForeverDateですが、本当のMaxというよりは9999年12月３１日０時０分０秒でセットしたいので、その方法でも教えて欲しいです！

[task4233]

追記しました。

[Nave]

丁寧な回答ありがとうございます！
全て解決しました????

[task4233]

????

Answer 3

①日にち単位での計算の時に、その日の10時からN日といったカウントを実現したいので、nowを設定するときにその日の10時と設定する方法も知っていたら教えて欲しいなと思っています！

②ForeverDateですが、本当のMaxというよりは9999年12月３１日０時０分０秒でセットしたいので、その方法でも教えて欲しいです！

package main

import(
    "fmt"
    "time"
)

func main(){
  now := time.Now()
  japan := time.FixedZone("JST", int((9 * time.Hour).Seconds()))
  t := time.Date(now.Year(), now.Month(), 10, 0, 0, 0, 0, japan) // [1]
  fmt.Println(t)
  max := time.Date(9999, 12, 31, 0, 0, 0, 0, japan) // [2]
  fmt.Println(max)
}