Salesforseの機能としてカスタム表示ラベルがありますが、なかなか使い方がピンと来ていませんでした。いくつかの案件を通じて学んだ使用方法を列記していきます。今後も随時追加していきたいです。
定数として使用する
Apexクラスで定数を扱うときにカスタム表示ラベルを使用します。シンプルにマジックナンバーを回避するためであり、カスタム表示ラベルの説明に定数の目的や意図を記載することで、可読性と保守性を高めることができます。
バッチサイズなどの設定値として使用する
Apexクラスやバッチでバッチサイズに限らず何かしらの設定値(固定のループ回数など)に対してカスタム表示ラベルとして使用します。普通に定数として使用すると、Apexクラスを修正してデプロイという流れが必要になり面倒臭いです。更に検証環境や本番環境は開発環境から変更セットをリリースする、という取り決めがある場合、設定変更だけで一々大きな手間がかかります。
API接続するクラスの単体テスト用ファイル名変数として使用する
外部APIをコールしてxmlやjsonなどの応答ファイルを読む込むクラスを実装するとき、単体テストではAPI接続せずに動作確認を行います。応答を想定したテスト用ファイルを用意して、クラス側では読込ファイル名を指定します。このとき、このファイル名をカスタム表示ラベルにします。これにより、単体テストで様々なケースのテストファイルを読み込ませたいときに、ソースコードを変更しなくてよいためデプロイが不要となり、カスタム表示ラベルの値にファイル名をコピペするだけでよくなるので、テストが大分スムーズに実施できるようになります。
表示名として使用する
LWCやVFで画面のタイトルや段落名をカスタム表示ラベルで表示します。1.と同じ考え方でクラス内に固定値や定数をなくすことで、可読性や保守性を高めることができます。
コメント