【Rails】 strftimeの使い方と扱えるクラスについて

strftimeとは、日時データを指定したフォーマットで文字列に変換することができるメソッドです。

1
2
3
4
5
6
7
8
9
blog = Blog.find(1)

# 通常の出力結果
blog.created_at
=> Fri, 26 Jul 2019 12:00:00 UTC +00:00

# strftimeメソッドを使い指定した形で文字列として出力
blog.created_at.strftime("%Y年%m月%d日")
=> "2019年07月26日"

TimeクラスとDateクラス、DateTimeクラスのオブジェクトを指定したフォームで文字列として取得し表示させることができるのがstrftimeメソッドです。

strftimeが扱えるクラス

リンクをコピーしました

strftimeメソッドはTimeクラスとDateクラス、DateTimeクラスのオブジェクトに対して使うことができます。
それぞれのクラスの特徴を確認しましょう。

Timeクラスとは

リンクをコピーしました

日時を扱えるクラスです。
このクラスのインスタンスは下記のように取得することができます。

1
2
3
4
5
6
7
# 現在の日時を取得
today = Time.now
=> 2020-01-01 12:00:00 +0900

# 日時を指定して作成
day = Time.new(2020,1,1,12,00,00)
=> 2020-01-01 12:00:00 +0900

Dateクラスとは

リンクをコピーしました

日付を扱えるクラスです。
このクラスのインスタンスは下記のように取得することができます。
rubyで使うにはrequire "date"が必要です。

1
2
3
4
5
6
7
8
9
require "date"

# 現在の日付を取得
today = Date.today
=> Wed, 01 Jan 2020

# 日付を指定して作成
day = Date.new(2020, 1, 1)
=> Wed, 01 Jan 2020

DateTimeクラスとは

リンクをコピーしました

日時を扱えるクラスです。
DateTimeクラスはDateクラスのサブクラスとして定義されています。
ですのでrubyで使うにはDateクラスと同じようにrequire "date"が必要です。

1
2
3
4
5
6
7
8
9
require "date"

# 現在の日時を取得
today = DateTime.now
=> Wed, 01 Jan 2020 12:00:00 +0000

# 日時を指定して作成
day = DateTime.new(2020,1,30,12,00,30)
=> Wed, 01 Jan 2020 12:00:00 +0000

このようにして日時や日付を取得できますが、このままだと2020-01-01 12:00:00 +0900やWed, 01 Jan 2020の形式でしか出力されません。

これを2019年1月1日や2019/1/1など指定したフォームで表示させたいときにstrftimeメソッドを使います。

strftimeメソッドの使い方

リンクをコピーしました

strftimeメソッドは下記のように使用します。

1
2
datetime = DateTime.now
datetime.strftime("書式")

例えば2019年01月01日と表示させたい時は下記のように記述します。

1
2
datetime.strftime("%Y年%m月%d日")
=> "2019年01月01日"

指定できる書式を確認しよう

リンクをコピーしました

指定できる書式は下記のものがあり、それぞれを組み合わせて使うことも可能です。

個別に取得

リンクをコピーしました

※元データは2019-01-01T12:00:00+09:00を使用

これを使った例を見てみましょう。

1
2
3
4
5
6
date = DateTime.new(2020,1,30,12,00,30)
p date
=> #<DateTime: 2020-01-30T12:00:30+00:00>

p date.strftime("%m月%d日")
=> "01月30日"

このように自分が指定した初期で文字列として取得することができました。

まとめて取得

リンクをコピーしました

※元データは2019-01-01T12:00:00+09:00を使用

その他の書式

リンクをコピーしました

※元データは2019-01-01T12:00:00+09:00を使用

実際に使ってみよう

リンクをコピーしました

それではrailsで実際に使ってみましょう。

strftimeはTime型やDate型、DateTime型に使うので、保存する時にはそれぞれの型を指定する必要があります。

その為、マイグレーションファイルでtime型やdate型、datetime型でカラムを作成します。

railsだとテーブルを作成する際のマイグレーションファイルにデフォルトでt.timestampsという記述があり、自動でcreated_atカラムとupdated_atカラムがdatetime型カラムとして作成されます。

1
2
3
4
5
6
t.time :カラム名
t.date :カラム名
t.datetime :カラム名

# created_atカラムとupdated_atカラムをdatetime型で自動で作成
t.timestamps

そして、コントローラーやモデルでインスタンスを取得します。

1
2
3
def show
  @message = Message.find(params[:id])
end

ビューで日時を表示させます。
2019年01月11日14時15分と表示させたい時は下記のように記述します。

1
<%= @message.created_at.strftime("%Y年%m月%d日%H時%M分") %>

ただこれだとコードが長くなるのでメソッド化するのが一般的です。
ビューで使うメソッドはモデルに記述しましょう。

1
2
3
def set_date
  created_at.strftime("%Y年%m月%d日%H時%M分")
end

ビューで使うときは下記のように記述します。

1
<%= @message.set_date %>

だいぶスッキリしましたね！

曜日を日本語で表示させてみよう

リンクをコピーしました

用意されている書式の中には日本語表記のものがありません。
曜日などは、日本語で表示したいですね。

ではどういった方法があるでしょうか。

この時に使う書式は%wです。これは曜日を表す数を取得する書式です。
0から6までの数字が取得でき、日曜日が0、月曜日が1といった感じで取得できます。

勘のいい方ならもうわかりますね。
そうです、配列を作ってあげてそこから取得できる数字を使って日本語の曜日名を取得すればいいですね。

ただこの返り値は文字列としての数字なので、to_iメソッドを使って数値オブジェクトに変換する必要があります。

下記のようなコードになります。

1
2
3
4
weeks = ["日","月","火","水","木","金","土"]
num = @message.created_at.strftime("%w").to_i
week = weeks[num]
=> "日"

これでweekという変数に日本語の曜日名が入りました。

またはwdayメソッド使っても同じことができます。

wdayメソッド

リンクをコピーしました

Timeクラス、Dateクラス、DataTimeクラスのオブジェクトに使用すると曜日を0(日曜日)から6(土曜日)の整数で取得できるメソッドです。
このメソッドを使うと下記のように書くこともできます。

1
2
3
4
weeks = ["日","月","火","水","木","金","土"]
week = weeks[@message.created_at.wday]
# @message.created_at.wdayで日曜日なら数字として0を取得
=> "日"

配列は%記法を使うともっと短く書くことができます。

1
2
week = %w(日 月 火 水 木 金 土)[@message.created_at.wday]
=> "日"

ビューで表示させるには下記のように記述します。

1
<%= @message.created_at.strftime("%Y年%m月%d日%H時%M分#{week}曜日") %>

time_formatsを使ってみよう

リンクをコピーしました

TimeクラスやDateクラス、DateTimeクラスのオブジェクトに対してto_sメソッドを使うと日時を文字列として取得することができます。
デフォルトだと下記の形で取得できます。

1
2
3
datetime = DateTime.now
datetime.to_s
=> "2019-01-10T12:00:00+09:00"

この形を変えるためstrftimeメソッドを使っていました。
time_formatsを使うとstrftimeメソッドを使わなくてもto_sメソッドで取得できる形式を指定することができます。

time_formats.rbを作成しよう

リンクをコピーしました

それでは設定の流れを確認していきましょう。
まずはconfig/initializersフォルダ内にtime_formats.rbを作成します。

このファイルに下記のように定義します。

1
クラス名::DATE_FORMATS[:名前] = "書式"

[:名前]とするとto_s(:名前)の形で指定した形式で取得することができます。
この部分は好きな名前をつけることができます。
いくつでも指定が可能です。

定義できるのはTimeクラスとDateクラスです。

Timeクラスの例

リンクをコピーしました

それではTimeクラスの書き方を例をみてみましょう。

1
2
3
4
# Timeクラスの定義
Time::DATE_FORMATS[:date] = "%m/%d"
Time::DATE_FORMATS[:yeardate] = "%Y年%m月%d日"
Time::DATE_FORMATS[:datetime] = "%Y年%m月%d日 %H時%M分"

railsのcreated_atやupdated_atで取得できるクラスはActiveSupport::TimeWithZoneクラスです。Time::DATE_FORMATSの接頭辞のTimeがActiveSupport::TimeWithZoneクラスに呼応していています。
上のように定義すると下記のように使うことができます。

1
2
3
4
5
6
7
8
9
10
11
12
13
blog = Blog.find(1)

blog.created_at
=> Wed, 01 Jan 2020 12:00:00 UTC +00:00

blog.created_at.to_s(:date)
=> "01/01"

blog.created_at.to_s(:yeardate)
=> "2020年01月01日"

blog.created_at.to_s(:datetime)
=> "2020年01月01日 12時00分"

Dateクラスの例

リンクをコピーしました

次にDateクラスの書き方を例をみてみましょう。

1
2
3
# Dateクラスの定義
Date::DATE_FORMATS[:date] = "%m月%d日"
Date::DATE_FORMATS[:yeardate] = "%Y年%m月%d日"

Date::DATE_FORMATSの接頭辞のDateがDateクラスに呼応していています。
上のように定義すると下記のように使うことができます。

1
2
3
4
5
6
7
day = Date.today

day.to_s(:date)
=> "01月01日"

day.to_s(:yeardate)
=> "2020年01月01日"

DateTimeクラスの場合

リンクをコピーしました

DateTimeクラスはDateTime::DATE_FORMATSではなくTime::DATE_FORMATSが適用されます。

1
2
3
4
# Timeクラスの定義
Time::DATE_FORMATS[:date] = "%m/%d"
Time::DATE_FORMATS[:yeardate] = "%Y年%m月%d日"
Time::DATE_FORMATS[:datetime] = "%Y年%m月%d日 %H時%M分"

上のように定義した場合、DateTimeはTimeクラスが適用されるか確認してみます。

1
2
3
4
5
6
7
day = DateTime.now

day.to_s(:date)
=> "01月01日"

day.to_s(:yeardate)
=> "2020年01月01日"

もしtime_formats.rbにDateTimeクラスで定義するとDate型として定義されます。

1
2
Time::DATE_FORMATS[:date] = "%m/%d"
DateTime::DATE_FORMATS[:date] = "%m月%d日"

上のように定義した場合の結果を確認してみましょう。

1
2
3
4
5
6
7
8
9
10
11
day = DateTime.now

# Time型が適用される
day.to_s(:date)
=> "01/01"

today = Date.today

# Date型として定義される
today.to_s(:date)
=> "01月01日"

このようにDateTime::DATE_FORMATSとして定義するとDate::DATE_FORMATSとして定義されてしまいます。

ですのでDate::DATE_FORMATSを定義した後にDateTime::DATE_FORMATSを定義すると、その前に定義したDate::DATE_FORMATSが上書きされてしまうので注意しましょう。

1
2
3
# 下記のように記述するとDate型のコードが上書きされる
Date::DATE_FORMATS[:date] = "%m月%d日"
DateTime::DATE_FORMATS[:date] = "%m/%d"

上のように定義した場合の結果を確認してみましょう。

1
2
3
4
5
day = Date.today

day.to_s(:date)
=> "01/01"
# Date型が上書きされDateTime型で定義した結果が表示される

このようにDateTime型を定義したためDate型の定義が上書きされてしまいます。
DateTime型を定義をするといろいろややこしくなるのでしないようにしましょう。

time_formatsのメリット

リンクをコピーしました

strftimeメソッドの場合は毎回指定しないと行けなかったり、dateの記述を人によって
%y/%m/%dだったり%y年%m月%d日にしたりとか偏りが出て統一が難しいというデメリットがあったりします。
ですがtime_formatsを使って日付や時刻の表示をあらかじめ決めておけば、複数人でアプリを開発しているときにでも表示形式を一貫させることができます。

またtime_formatsを使うとこのように短く直感的に記述することができます。

1
2
3
4
5
blog.created_at.strftime("%Y年%m月%d日 %H時%M分")
=> "2020年01月01日 12時00分"

blog.created_at.to_s(:datetime)
=> "2020年01月01日 12時00分"

上のように比較してみるとtime_formatsを使ったほうがコードがスッキリしていて、datetimeという名前なので日時を表示できるなと推測でき、コードの可読性も上がることがわかります。

また下記のように名前の部分をdefaultとするとto_sメソッドのみで使ったときの結果を変えることができます。

1
Time::DATE_FORMATS[:default] = "%Y年%m月%d日"

上のように定義するとto_sメソッドのみで取得ができます。

1
2
3
4
5
6
7
8
9
blog = Blog.find(1)

# :defaultで変更している場合の結果
blog.created_at.to_s
=> "2020年01月01日"

# 変更前の結果
blog.created_at.to_s
=> "2020-01-01 12:00:00 +0900"

ですが、defaultを変更してしまうとアプリケーション全体に影響が及んでしまい、インストールしているgemにも影響を与えて、アプリケーションによってはエラーが起こる危険性があるので変更するのはあまりおすすめしません。

役に立ったらSHARE♪

• twitter
• facebook
• はてブ