すらぼうの開発ノート

flutterエンジニアのメモ

【Flutter】DateTimeクラスの使用方法まとめ

本エントリではDateTimeクラスの使用方法を説明する。



DateTimeとは

api.flutter.dev

日付と時刻に関する情報を扱うクラス。UNIXエポックの1970年1月1日から100,000,000日以内の時刻を扱える。


インスタンス生成

DateTimeインスタンスを生成するには以下の2通りの方法がある。

  • コンストラクタを利用
  • 文字列をパース

以下でそれぞれを説明する。

コンストラクタを利用

DateTime()

コンストラクDateTime()を使用することで、マイクロ秒まで指定したインスタンスを生成する。 各桁は値が指定されない場合0になる。

DateTime.now()

名前付きコンストラクDateTime.now()を使用することで、生成を行なった時刻をマイクロ秒まで指定したインスタンスを生成する。

DateTime.utc()

名前付きコンストラクDateTime.utc()を使用することで、タイムゾーンUTCとした時刻でインスタンスを生成する。 タイムゾーンUTCに指定しているのでprint()出力した値の末尾にZがついている。

ちなみにDateTime.utc()を使用しない場合、生成されるインスタンス保有する時刻のタイムゾーンはローカルのものになる。

文字列をパース

文字列をパースする際はDateTime.parse()に指定のフォーマットで文字列を渡す必要がある。

このフォーマットはISO 8601。上記のコード以外にもISO 8601の記法がいくつかあるので 以下のサイトなどを参考にお好みのフォーマットを選んでいただきたい。

api.dart.dev


プロパティ

DateTimeインスタンスで利用できる主なプロパティを以下で説明する。

すべてのプロパティはこちら

各時刻桁

年 ~ マイクロ秒 までそれぞれの値を取得できる。

isUtc

DateTimeインスタンスタイムゾーンUTCの場合true、それ以外はfalseになる。

timeZoneName

DateTimeインスタンスタイムゾーン名が取得できる。 このタイムゾーンはプログラムが動作するOSから取得する。

timeZoneOffset

DateTimeインスタンスタイムゾーンの時差を取得できる。 上記コードはタイムゾーンJSTなので時差は9時間となっている。

weekday

DateTimeインスタンスの曜日を数値で取得できる。 月曜日が1に対応し、日曜日まで1ずつ増える。


日付と時刻の操作

DateTimeインスタンスDurationを用いることで

  • 時間を足す
  • 時間を引く

の操作を行うことができる。

api.dart.dev

また複数のDateTimeインスタンスを用いて次の操作が可能。

  • 一致を確認
  • 差分を取得
  • 時刻の前後関係を取得

以下でそれぞれの操作を説明する。

時間を足す

add()メソッドを用いる。

引数にはDurationインスタンスを渡し、足し合わせる時間を設定する。

api.flutter.dev

時間を引く

subtract()メソッドを用いる。

引数にはDurationインスタンスを渡し、引く時間を設定する。

api.flutter.dev

一致・不一致を確認

compareTo()メソッドを用いる。

引数には比較したいDateTimeインスタンスを渡す。 時刻が同じ場合0、異なる場合は前後関係によって1または-1が返される。

api.flutter.dev

差分を取得

difference()メソッドを用いる。 上記コードではプログラム実行時の時刻がベルリンの壁崩壊時からどれくらい経ったかを求めている。

戻り値はDurationクラスなので、inDaysなどのプロパティで日などに単位を換算できる。

api.flutter.dev

時刻の前後関係を取得

isAfter()またはisBefore()を用いることで求められる。 それぞれ比較したいDateTimeインスタンスを引数に渡し、isAfter()の場合引数に渡されたインスタンスの時刻よりthisインスタンスが進んでいればtrue、遅れていればfaluseとなる。isBefore()メソッドではその関係が逆になる。

api.flutter.dev

api.flutter.dev