【Salesforce】Apexでのdate format

（最終更新月: 2024年2月）

✔以下の疑問をお持ちの方へ向けた記事です

「Salesforce Apexで日付を”DD MM YYYY”形式でどのようにフォーマットするのか？」
「”DD MM YYYY”形式の日付フォーマットを実装する際のコーディングのヒントは？」
「Apexで日付フォーマットをカスタマイズする際のベストプラクティスは？」

✔当記事を読むことで得られる知識

Salesforce Apexにおける日付フォーマットの基本概念
“DD MM YYYY”形式での日付フォーマットのApexコード例
日付フォーマットのカスタマイズ時のベストプラクティスと注意点

Apexでは、DateTimeオブジェクトの format() メソッドを使用して、さまざまな形式で日付を表示できます。

当記事では、「DD MM YYYY」形式で日付をフォーマットする具体的なコーディング例を提供し、国際的なプロジェクトや地域特有の日付表示の要件に対応する方法を紹介します。

また、日付フォーマットをカスタマイズする際のベストプラクティスと、一般的な落とし穴を避けるためのヒントも提供。

Salesforceの開発者にとって、ユーザーインターフェースのローカライズやレポートの日付表示をカスタマイズするための貴重な情報源です。

ぜひ最後までご覧ください。

定義や属性などは公式ガイドを必ず参考にしましょう。

当記事では、主にその使い方を具体例とともに解説します。

筆者プロフィール

【現職】プロダクトマネージャー

プロダクトマネージャーとして、Apex・Visualforceの開発エンジニアとして、以下のようなプロジェクトに従事してきました

新規事業の立ち上げに伴うビジネスプロセス構築とSalesforceのカスタマイズ
SFDXを活用した大規模リリース
Visualforce等による一般ユーザー向けサイト・アプリケーションの構築

相談・業務の依頼も承ります。ご質問・ご希望をお問い合わせください。

Apexにおける日付処理の基本

こちらでは、Apex言語における日付処理の基本についてお伝えしていきます。

Apexでの効率的な日付処理を理解することで、Salesforceプラットフォーム上でのアプリケーション開発に役立つでしょう。

日付とDateTimeクラスの概要
日付データ型の操作
標準日付フォーマットとカスタマイズ

日付とDateTimeクラスの概要

Apexでは、日付と時刻を扱うための特別なデータ型としてDateとDateTimeクラスが提供されています。

Date: 日付を扱う
DateTime: 日付に加えて日時を扱う

例えば、今日の日付を取得するにはDate.today()メソッドを使用します。

具体的なコードは以下のとおりです。

Date today = Date.today();
System.debug('今日の日付: ' + today);

さらに、現在の日時をDateTimeクラスを使用して取得することも可能です。

以下のコマンドで現在日時を取得し、出力できます。

DateTime now = DateTime.now();
System.debug('現在の日時: ' + now);

日付や時刻の作成、操作、比較などの基本機能に加えて、フォーマットの変更などの高度な機能も提供しています。

これらを習得することで、多様な日付処理のニーズに対応できるのです。

日付データ型の操作

日付データ型を操作するには、加算や減算のような簡単なメソッドから開始すると理解が深まります。

例えば以下は、現在の日付から7日前の日付を計算するコードです。

Date today = Date.today();
Date lastWeek = today.addDays(-7);
System.debug('7日前の日付: ' + lastWeek);

また、月単位や年単位での計算を行うためのメソッドもあります。

例えば、3ヶ月後の日付を取得したい場合はaddMonthsメソッドを使用してください。

Date threeMonthsLater = today.addMonths(3);
System.debug('3ヶ月後の日付: ' + threeMonthsLater);

日付の操作にはさまざまなメソッドが用意されています。

アプリケーション上で複雑な日付計算を実行しましょう。

標準日付フォーマットとカスタマイズ

Apexでは、日付や時刻の表示形式をカスタマイズすることも可能です。

標準的な日付フォーマットを使用するにはformatメソッドを利用します。

例えば、以下はISO形式で日付を表示するコードです。

Date today = Date.today();
String formattedDate = today.format();
System.debug('ISO形式の日付: ' + formattedDate);

//08:05:22.39 (67734963)|USER_DEBUG|[3]|DEBUG|ISO形式の日付: 2024/02/19

カスタマイズされた日付フォーマットを作成するにはJavaのSimpleDateFormatを使用します。

以下のコードは、特定のパターンで日付をフォーマットする例です。

DateTime now = DateTime.now();
String customFormattedDate = now.format('MM/dd/yyyy HH:mm:ss');
System.debug('カスタムフォーマットの日付: ' + customFormattedDate);

//08:05:57.77 (79191492)|USER_DEBUG|[3]|DEBUG|カスタムフォーマットの日付: 02/19/2024 08:05:57

ここでは、月/日/年時:分:秒の形式で日時をフォーマット。

標準フォーマットとカスタムフォーマットを理解し使い分けることで、アプリケーション内で一貫性のある日付・時刻の表示を実現できます。

「DD MM YYYY」形式への日付フォーマット

こちらでは、日付を「日月年」の形式にフォーマットする方法に焦点を当てます。

「DD MM YYYY」形式は多くの国で標準とされており、この形式への変換を習得することは、国際的なユーザーベースに向けたアプリケーション開発において重要と言えるでしょう。

SimpleDateFormatクラスの使用
「DD MM YYYY」形式への変換手順
ロケールに基づいた日付フォーマット

SimpleDateFormatクラスの使用

SimpleDateFormatクラスは、Javaのクラスをベースに、Apexで日付と時刻の表示形式をカスタマイズするために使われます。

このクラスを使用することで、「DD MM YYYY」のような特定の日付フォーマットを容易に実現できます。

例として、以下のコードは日付を「DD MM YYYY」形式でフォーマットする方法を示しています。

DateTime now = DateTime.now();
String formattedDate = now.format('dd MM yyyy');
System.debug('日付のフォーマット: ' + formattedDate);

このコードでは、小文字のddが日を、MMが月を、大文字のYYYYが年を表していることに注意してください。

フォーマットパターンは大文字と小文字を区別するため、適切な記号を使用することが重要です。

「DD MM YYYY」形式への変換手順

「DD MM YYYY」形式へ日付を変換する手順は、以下のとおり。

DateTimeまたはDateオブジェクトを取得
SimpleDateFormatを使用して所望のフォーマットに整形

以下は、その具体的な手順を示したコードです。

// 1. 現在の日時を取得します。
DateTime now = DateTime.now();

// 2. SimpleDateFormatを使用して`DD MM YYYY`形式にフォーマットします。
String formattedDate = now.format('dd MM yyyy');

// 3. 結果を出力します。
System.debug('変換された日付形式: ' + formattedDate);

このように、DateTimeオブジェクトからformatメソッドを呼び出すことで、指定したフォーマットの文字列を簡単に得られます。

ロケールに基づいた日付フォーマット

ロケールは日付フォーマットにおいて重要な役割を担い、特定の地域の言語や文化に基づいた形式で日付を表示することを可能にします。

Apexでロケールを指定して日付をフォーマットする場合、タイムゾーン文字列を引数へ入力。

以下はその例です。

DateTime now = DateTime.now();
// ロケールをフランスに設定してフォーマットを適用します。
String formattedDate = now.format('dd MM yyyy', 'JST');
System.debug('日本のロケールで日付: ' + formattedDate);

文字列「JST」を指定して「DD MM YYYY」形式で日付をフォーマットしています。

例えばアメリカのニューヨークであれば次のようになります。

'America/New_York'

これにより、グローバルなユーザーに対して地域ごとに適切な日付形式を提供できます。

フォーマット変換の実践的活用

日付フォーマットは単なる表示の問題にとどまらず、実際のアプリケーション内でさまざまな形で活用されます。

ユーザーにとって意味のある形で日付情報を提供することで、使いやすさを向上させることが可能です。

ユーザーインターフェイスでの日付表示
レポートとデータエクスポート
日付の比較と検証

ユーザーインターフェイスでの日付表示

日付はユーザーインターフェイスの一部として頻繁に表示されるもの。

良い日付フォーマットは読みやすく、またユーザーが直感的に情報を理解できるようにする必要があります。

例えば、ユーザープロファイルに最終ログイン日時を表示したい場合、以下のようなApexコードをVisualforceページやLightningコンポーネントに組み込めます。

UserInfo.getLastLoginDate().format('dd/MM/yyyy HH:mm:ss');

このコードは、ユーザーの最終ログイン時刻を「日/月/年時:分:秒」のフォーマットで表示します。

これにより、ユーザーは最後にいつサービスを使用したかを容易に確認できます。

レポートとデータエクスポート

日付フォーマットはレポートの作成やデータのエクスポート時にも非常に重要です。

例えば、週報や月報を作成する際に、日付データを「YYYY/MM/DD」の形式でまとめられます。

以下はApexを利用して日付フォーマットを適用するコードの例です。

List<Opportunity> opps = [SELECT Name, CloseDate FROM Opportunity];
for (Opportunity opp : opps) {
    System.debug(opp.Name + ': ' + opp.CloseDate.format('yyyy/MM/dd'));
}

上記のコードでは、商談オブジェクトのリストから名前と予定完了日を取得し、予定完了日を「YYYY/MM/DD」形式にフォーマットしてデバッグログに出力。

これを通じて、レポートの日付が明確で一貫した形式で共有されることを保証します。

日付の比較と検証

アプリケーション内で2つの日付を比較する場面は数多く存在します。

たとえば、契約が有効であるか、イベントが過去か未来かを決定するために日付が使われる、など。

以下はApexで日付を比較する方法の例です。

Date contractStartDate = Date.newInstance(2023, 1, 1);
Date contractEndDate = Date.newInstance(2023, 12, 31);
if (contractStartDate.daysBetween(contractEndDate)) {
    System.debug('契約は有効です。');
} else {
    System.debug('契約は無効です。');
}

このコードは、Date.today()が契約開始日と終了日の間にあるかどうかをチェックしています。

このような検証により、条件に基づいた処理の分岐やユーザーへの通知をおこなうことが可能です。

日付フォーマットのベストプラクティス

日付フォーマットを適切に扱うことはアプリケーション開発において避けて通れない要素のひとつです。

以下に、効率的かつ正確な日付フォーマット処理を実現するためのベストプラクティスを示します。

効率的な日付変換コードの作成
タイムゾーンと夏時間の考慮
日付フォーマットの検証とエラーハンドリング

効率的な日付変換コードの作成

日付変換処理はアプリケーション全体で何度もおこなわれるため、効率的なコードを書くことが重要です。

処理の重複を防ぎ、変換のロジックを一箇所に集約するために、変換の処理を共通のメソッドとして定義すると良いでしょう。

例えば、以下は日付フォーマットを変換する共通のユーティリティメソッドです。

public class DateUtils {
    public static String formatDate(Date date, String pattern) {
        return date != null ? date.format(pattern) : '';
    }
}

// 使用例
String formattedDateString = DateUtils.formatDate(Date.today(), 'yyyy-MM-dd');

この方法を採用し、プログラム全体で一貫した日付フォーマットが用いられ、将来の変更が必要になった際の修正作業も最小限に抑えられます。

タイムゾーンと夏時間の考慮

グローバルなアプリケーションでは、異なるタイムゾーンや夏時間の影響により、日付と時刻の管理が一層複雑になります。

正しい日付と時刻を維持するためには、DateTimeオブジェクトが作成される際のユーザーのタイムゾーンを考慮しなければなりません。

以下はタイムゾーンの考慮を示すコードです。

TimeZone tz = UserInfo.getTimeZone();
DateTime localTime = DateTime.now();
DateTime adjustedTime = localTime.addSeconds(tz.getOffset(localTime) / 1000);
System.debug('タイムゾーン調整後の日時: ' + adjustedTime.format());

ログインしているユーザーのタイムゾーンを取得し、現在の時刻にオフセットを加えることで、ローカルタイムゾーンの正確な日時を計算しています。

日付フォーマットの検証とエラーハンドリング

アプリケーションがユーザーから日付を受け取る際や、APIなどの外部システムと日付データを交換する際には、予期せぬフォーマットや無効な日付に遭遇することがあります。

エラーハンドリングを適切におこない、無効な入力を処理することが重要です。

以下は日付フォーマットの検証の例です。

try {
    Date parsedDate = Date.parse('2023-01-32');
    System.debug('パースされた日付: ' + parsedDate);
} catch (Exception e) {
    System.debug('日付フォーマットが無効です: ' + e.getMessage());
}

文字列から日付への変換を試みていますが、文字列が無効な日付を表しているために例外が発生。

try-catchブロックを使用することで、このような例外を捉えて適切に処理できるのです。

日付フォーマット関連のトラブルシューティング

日付フォーマットの実装においては、様々な問題やエラーが発生します。

これらの問題を解決し、アプリケーションの信頼性を高めるためのトラブルシューティング法について見ていきましょう。

よくある日付フォーマットのエラー
パフォーマンスの最適化
ユーザーからのフィードバックに基づいた改善

よくある日付フォーマットのエラー

日付フォーマットに関するエラーは非常に一般的で、パターンの誤りや無効な日付の使用が主な原因です。

たとえば、月(MM)と分(mm)を間違えてフォーマットしたり、存在しない日(31日以外の月での31日など)を使用するケースが求められます。

以下は、月と分を混同した際の修正前と修正後の例です。

// 誤ったフォーマット例
DateTime now = DateTime.now();
try {
    String incorrectFormat = now.format('dd MM yyyy HH:MM:ss');
    System.debug('誤ったフォーマット: ' + incorrectFormat);
} catch (Exception e) {
    System.debug('フォーマットエラー: ' + e.getMessage());
}

// 正しいフォーマット例
try {
    String correctFormat = now.format('dd MM yyyy HH:mm:ss');
    System.debug('正しいフォーマット: ' + correctFormat);
} catch (Exception e) {
    System.debug('フォーマットエラー: ' + e.getMessage());
}

エラーが発生した場合は、フォーマットパターンが適切かどうかを検証し、ユーザーが入力した日付がカレンダー上で有効かどうかをチェックする必要があります。