Swift DateをUILabelに表示！リアルタイム更新もマスターしよう🗓️

はじめに (対象読者・この記事でわかること)

この記事は、SwiftでのiOSアプリ開発を始めたばかりの方や、アプリ内で日付や時刻を表示する方法に興味がある方を対象としています。特に、UILabelに現在の日付や時刻を動的に表示したいと考えている方にとって役立つ内容となっています。

この記事を読むことで、SwiftのDate型を使って現在の日付と時刻を取得し、DateFormatterを利用して表示形式を自由にカスタマイズする方法がわかります。さらに、Timerを使って時刻をリアルタイムで更新し続ける実装方法までを具体的に習得できます。シンプルな時計アプリや、イベントまでの残り時間を表示する機能などを実装する際の基礎知識としてご活用ください。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。 - Swiftの基本的な文法（変数、関数、クロージャなど） - iOSアプリ開発の基本的な知識（Xcodeの操作、StoryboardやSwiftUIでのUILabelの配置など）

Swiftにおける日付と時刻の基本

iOSアプリケーションで日付や時刻を扱う際、SwiftにはDate型という非常に便利な構造体があります。しかし、Date型はあくまで内部的に時刻を表現するためのものであり、人間が読みやすい形式に直接変換してくれるわけではありません。そこで必要になるのがDateFormatterです。

Date型とは

Dateは、特定の日付と時刻を表す値型です。内部的には、グリニッジ標準時（GMT）の2001年1月1日0時0分0秒からの経過秒数として管理されており、タイムゾーンやロケールといった概念は含まれていません。そのため、Date()を呼び出すと、現在時刻を表すDateインスタンスが生成されますが、このインスタンスをそのままprintしても、協定世界時（UTC）ベースの形式で出力されるため、私たちが見慣れた「日本の現在時刻」とは異なる場合があります。

DateFormatterの役割

DateFormatterは、Dateオブジェクトを人間が読みやすい文字列（例: "2024年7月26日 15時30分00秒"）に変換したり、逆に特定のフォーマットを持つ文字列からDateオブジェクトを生成したりするためのクラスです。DateFormatterを使うことで、日付や時刻の表示形式を自由にカスタマイズしたり、ユーザーの地域設定（ロケール）に合わせて表示を調整したりすることができます。

なぜこれらが必要なのでしょうか？例えば、ユーザーが日本の場合は「2024年7月26日」、アメリカの場合は「July 26, 2024」と表示したいといったニーズがある場合、DateFormatterがその橋渡し役となります。ロケールを考慮しないと、世界中のユーザーが同じ形式で日付を見ることになり、非常に不便です。DateFormatterはこのような国際化対応（i18n）においても重要な役割を果たします。

UILabelに日付と時刻を表示する具体的な実装方法

ここからは、実際にUILabelに現在の日付と時刻を表示し、さらにリアルタイムで更新する方法をコードを交えて解説します。

ステップ1: 現在の日付と時刻をUILabelに表示する

まずは、アプリを起動した時点の現在の日付と時刻をUILabelに表示してみましょう。

Swift

import UIKit

class ViewController: UIViewController {

    @IBOutlet weak var timeLabel: UILabel! // StoryboardでUILabelを接続

    override func viewDidLoad() {
        super.viewDidLoad()

        // 現在の日付と時刻を表示する関数を呼び出す
        displayCurrentTime()
    }

    func displayCurrentTime() {
        // 1. 現在のDateオブジェクトを取得
        let now = Date()

        // 2. DateFormatterのインスタンスを作成
        let formatter = DateFormatter()

        // 3. 表示形式を設定 (例: "yyyy年MM月dd日 HH時mm分ss秒")
        // 日本語環境では、この形式がよく使われます。
        formatter.dateFormat = "yyyy年MM月dd日 HH時mm分ss秒"

        // 4. ロケールを設定 (オプション: 国や地域による表示の違いを吸収)
        // デフォルトではデバイスのロケールが使われますが、明示的に指定することもできます。
        // 例: 日本語 (ja_JP)
        formatter.locale = Locale(identifier: "ja_JP")

        // 5. Dateオブジェクトを文字列に変換
        let formattedDateString = formatter.string(from: now)

        // 6. UILabelに表示
        timeLabel.text = formattedDateString
    }
}

このコードでは、Date()で現在時刻のDateインスタンスを取得し、DateFormatterを使って「YYYY年MM月DD日 HH時mm分ss秒」という形式の文字列に変換しています。そして、その文字列をtimeLabelというUILabelにセットしています。@IBOutletを使ってStoryboardでUILabelを接続することを忘れないでください。

ステップ2: 表示形式をカスタマイズする

DateFormatterのdateFormatプロパティは非常に強力で、様々な形式で日付や時刻を表示することができます。よく使われるパターンをいくつか紹介します。

フォーマット文字	意味	例
yyyy	西暦年（4桁）	2024
MM	月（2桁、01-12）	07
M	月（1桁または2桁）	7
dd	日（2桁、01-31）	26
d	日（1桁または2桁）	26
HH	時（24時間表記、00-23）	15
hh	時（12時間表記、01-12）	03
mm	分（2桁、00-59）	30
ss	秒（2桁、00-59）	05
SSS	ミリ秒（3桁）	123
EEEE	曜日（完全名）	金曜日
EEE	曜日（短縮名）	金
a	午前/午後（AM/PM）	PM
z	タイムゾーン略称	JST
zzz	タイムゾーン完全名	日本標準時

様々な表示例:

Swift

func customizeDateFormat() {
    let now = Date()
    let formatter = DateFormatter()
    formatter.locale = Locale(identifier: "ja_JP") // 日本語ロケールを固定

    // 例1: 日付のみ（年/月/日）
    formatter.dateFormat = "yyyy/MM/dd"
    print("日付のみ: \(formatter.string(from: now))") // 例: 2024/07/26

    // 例2: 時刻のみ（時:分:秒）
    formatter.dateFormat = "HH:mm:ss"
    print("時刻のみ: \(formatter.string(from: now))") // 例: 15:30:05

    // 例3: 曜日を含む
    formatter.dateFormat = "yyyy年M月d日 (EEEE) HH:mm"
    print("曜日付き: \(formatter.string(from: now))") // 例: 2024年7月26日 (金曜日) 15:30

    // 例4: 12時間表記とAM/PM
    formatter.dateFormat = "yyyy/MM/dd hh:mm a"
    formatter.locale = Locale(identifier: "en_US_POSIX") // AM/PMは英語ロケールが一般的
    print("12時間表記: \(formatter.string(from: now))") // 例: 2024/07/26 03:30 PM
}
// customizeDateFormat()を呼び出してテストできます。

dateFormatプロパティの代わりに、dateStyleとtimeStyleプロパティを使用することもできます。これらは、地域ごとの一般的な日付・時刻の表現方法を自動的に選択してくれるため、国際化対応を意識する際に非常に便利です。

Swift

func useDateAndTimeStyle() {
    let now = Date()
    let formatter = DateFormatter()
    formatter.locale = Locale(identifier: "ja_JP") // 日本語ロケール

    formatter.dateStyle = .full // 2024年7月26日金曜日
    formatter.timeStyle = .medium // 15:30:05
    print("Full Date Medium Time (ja_JP): \(formatter.string(from: now))")

    formatter.locale = Locale(identifier: "en_US") // 英語ロケール
    formatter.dateStyle = .long // July 26, 2024
    formatter.timeStyle = .short // 3:30 PM
    print("Long Date Short Time (en_US): \(formatter.string(from: now))")
}
// useDateAndTimeStyle()を呼び出してテストできます。

.full, .long, .medium, .short, .noneのいずれかを指定できます。これらのスタイルは、ロケールによって表示が大きく変わるため、柔軟な国際化対応が可能です。

ステップ3: Timerを使ってリアルタイムで時刻を更新する

静的な時刻表示だけでなく、秒単位で時刻が更新されるデジタル時計のような機能を実装してみましょう。これにはTimerクラスを使用します。

Swift

import UIKit

class ViewController: UIViewController {

    @IBOutlet weak var timeLabel: UILabel!
    var timer: Timer? // Timerオブジェクトを保持するプロパティ

    override func viewDidLoad() {
        super.viewDidLoad()

        // 最初の時刻表示
        displayCurrentTime()

        // 1秒ごとにdisplayCurrentTimeを呼び出すTimerを設定
        // repeats: true で繰り返し実行
        timer = Timer.scheduledTimer(withTimeInterval: 1.0, repeats: true) { [weak self] _ in
            self?.displayCurrentTime()
        }
    }

    // viewDidLoad()で定義したdisplayCurrentTime()関数を再利用します。
    // func displayCurrentTime() { ... }

    // 画面が非表示になる際など、Timerを停止する処理も重要
    // この例ではViewControllerが破棄されるときにTimerも自動的に解放されますが、
    // 明示的に停止したい場合は以下のように記述します。
    deinit {
        timer?.invalidate() // Timerを無効化し、メモリを解放
        print("Timerが無効化されました。")
    }
}

このコードでは、Timer.scheduledTimerメソッドを使って1秒ごとにdisplayCurrentTime()関数が呼び出されるように設定しています。 - withTimeInterval: 実行間隔を秒単位で指定します。 - repeats: trueにすると、指定した間隔で繰り返し実行されます。 - block: 繰り返し実行される際に呼び出されるクロージャです。クロージャ内でselfを参照する場合は、循環参照を防ぐために[weak self]を付けるのがベストプラクティスです。

注意点: - TimerはUIを更新するブロックをメインスレッドで実行する必要があります。scheduledTimerのブロックはデフォルトでメインスレッドで実行されるため、通常は意識する必要はありませんが、複雑な処理を行う場合は注意が必要です。 - Timerはインスタンスが保持されている限り動き続けます。不要になった場合は、invalidate()メソッドを呼び出して停止し、リソースを解放することが重要です。deinitブロックでinvalidate()を呼ぶことで、ViewControllerがメモリから解放される際にTimerも停止するようにしています。

ハマった点やエラー解決

1. DateFormatterのインスタンス生成コスト

DateFormatterは、内部的に多くのリソースを消費するため、インスタンスの生成には比較的コストがかかります。もしDateFormatterを頻繁に生成・破棄していると、アプリのパフォーマンスに影響を与える可能性があります。

問題:

Swift

// 毎秒呼ばれる関数内でDateFormatterを新規作成する場合
func updateTimeBadPractice() {
    let now = Date()
    let formatter = DateFormatter() // ここで毎秒インスタンスが作られる
    formatter.dateFormat = "HH:mm:ss"
    timeLabel.text = formatter.string(from: now)
}

解決策

DateFormatterは一度作成したら、プロパティとして保持し、使い回すのが良いプラクティスです。

Swift

class ViewController: UIViewController {
    @IBOutlet weak var timeLabel: UILabel!
    var timer: Timer?

    // DateFormatterをプロパティとして保持し、使い回す
    let dateFormatter: DateFormatter = {
        let formatter = DateFormatter()
        formatter.dateFormat = "yyyy年MM月dd日 HH時mm分ss秒"
        formatter.locale = Locale(identifier: "ja_JP")
        return formatter
    }()

    override func viewDidLoad() {
        super.viewDidLoad()
        setupTimer()
    }

    // Timerの設定と更新ロジックを分離
    func setupTimer() {
        timer = Timer.scheduledTimer(withTimeInterval: 1.0, repeats: true) { [weak self] _ in
            self?.updateTimeLabel()
        }
        // 初回表示
        updateTimeLabel()
    }

    func updateTimeLabel() {
        let now = Date()
        // 既存のdateFormatterインスタンスを使用
        timeLabel.text = dateFormatter.string(from: now)
    }

    deinit {
        timer?.invalidate()
    }
}

このようにすることで、DateFormatterのインスタンス生成が一度だけで済み、パフォーマンスが向上します。

2. Timerが動作しない、またはUIが更新されない

Timer関連でよくある問題は、Timerが意図した通りに動作しない、あるいはUIが更新されないケースです。

原因: - Timerを保持するプロパティがnilになっている（強い参照がないためすぐに解放される）。 - TimerをRunLoopに追加し忘れている（scheduledTimerを使う場合は自動で追加されるので稀だが、手動でTimer(timeInterval:repeats:block:)を使う場合に発生しうる）。 - UIの更新処理をメインスレッド以外で行っている。

解決策: - timerプロパティをvar timer: Timer?のように宣言し、ViewControllerが生存している間はTimerインスタンスへの強い参照を保持するようにします。 - scheduledTimerメソッドを使用することで、自動的に現在のRunLoopに追加されるため、特別な設定は不要です。 - UIの更新は必ずメインスレッドで行う必要があります。Timerのブロックはメインスレッドで実行されるため通常は問題ありませんが、もし別のバックグラウンドスレッドで重い処理を行った結果をUIに反映する場合は、DispatchQueue.main.asyncを使ってメインスレッドで更新する必要があります。 ```swift // 例: バックグラウンド処理後にUIを更新する場合 DispatchQueue.global().async { // バックグラウンドで時間のかかる処理 let heavyProcessingResult = self.performHeavyCalculation()

    // UI更新はメインスレッドで
    DispatchQueue.main.async {
        self.timeLabel.text = heavyProcessingResult
    }
}
```

3. ロケールによる表示の違い

DateFormatterは、localeプロパティを設定しない場合、ユーザーのデバイスのロケール設定に依存します。これにより、開発環境と異なる表示になることがあります。

問題: 日本のユーザーには「2024年7月26日」と表示したいのに、英語圏のユーザーのデバイスでは「Jul 26, 2024」と表示される。

解決策: 明示的にDateFormatter.localeを設定することで、特定の地域での表示形式を強制できます。

Swift

let formatter = DateFormatter()
formatter.dateFormat = "yyyy年MM月dd日"
formatter.locale = Locale(identifier: "ja_JP") // 明示的に日本語ロケールを指定

ただし、通常はユーザーのロケール設定を尊重することが推奨されます。特定の国や地域向けのアプリでない限り、Locale.currentを使用するか、localeを設定しない（デフォルトのLocale.currentが使われる）のが一般的です。

まとめ

本記事では、Swiftで現在の日付と時刻をUILabelに表示し、リアルタイムで更新する方法について解説しました。

• Date型で時刻を取得し、DateFormatterで表示形式をカスタマイズできる
• DateFormatterのdateFormatプロパティやdateStyle/timeStyleを使って、様々な表示形式を実現できる
• Timerを使うことで、1秒ごとなどの間隔で時刻をリアルタイムに更新できる
• DateFormatterのインスタンスは使い回し、Timerは不要になったらinvalidate()で停止するなど、パフォーマンスとメモリ管理に配慮する必要がある

この記事を通して、Swiftでの日付・時刻の扱い方と、UILabelへの動的な表示、そしてリアルタイム更新の実装方法という基本的なスキルを習得できたかと思います。

今後は、カレンダーピッカーとの連携、タイムゾーンのより詳細な扱い、異なるタイムゾーンでの時刻表示、あるいは特定の日時までのカウントダウンタイマーなど、より発展的な内容についても応用できるでしょう。

参考資料

• Apple Developer Documentation - Date
• Apple Developer Documentation - DateFormatter
• Apple Developer Documentation - Timer