（最終更新月: 2024年2月）
✔以下の疑問をお持ちの方へ向けた記事です
「Salesforce Apexで選択リストの値をどのように取得するのか？」
「選択リスト値を動的に取得するメリットは？」
「Apexで選択リスト値を取得する際のコーディングのヒントは？」
✔当記事を読むことで得られる知識
- Salesforce Apexでの選択リスト値の取得方法
- 動的に選択リスト値を取得する際のメリット
- Apexで選択リスト値を取得する際のコーディングのヒントとベストプラクティス
選択リストの値をプログラムで取得することで、アプリケーションの柔軟性が高まり、ユーザーインターフェースを動的に調整することが可能です。
当記事では、Schema.DescribeFieldResultを使用してピックリストのメタデータを取得し、その値をリストとして抽出する具体的なコーディング手法を紹介します。
Salesforceの開発者にとって、カスタムアプリケーションやプロセスオートメーションを実装する際に役立つ情報が満載です。
ぜひ最後までご覧ください。
定義や属性などは公式ガイドを必ず参考にしましょう。
当記事では、主にその使い方を具体例とともに解説します。
筆者プロフィール
【現職】プロダクトマネージャー
プロダクトマネージャーとして、Apex・Visualforceの開発エンジニアとして、以下のようなプロジェクトに従事してきました
- 新規事業の立ち上げに伴うビジネスプロセス構築とSalesforceのカスタマイズ
- SFDXを活用した大規模リリース
- Visualforce等による一般ユーザー向けサイト・アプリケーションの構築
相談・業務の依頼も承ります。ご質問・ご希望をお問い合わせください。
Salesforceの選択リストとApexの連携
こちらでは、Salesforceにおける選択リストとApex言語の連携について解説します。
Salesforce上でアプリケーションをカスタマイズする際には、選択リストの管理が不可欠です。
また、この連携についての理解は、データの統合性を保ちつつ、よりダイナミックなアプリケーション開発を可能にします。
- 選択リストの概要とSalesforceでの役割
- Apexで選択リストの値を扱う意義
- 選択リスト値取得の典型的な用途
選択リストの概要とSalesforceでの役割
選択リストは、Salesforceでユーザーがデータを入力する際に利用されるドロップダウンメニューです。
その役割は、データの一貫性を保つこと。
リストからアイテムを選択することにより、ユーザーが意図しない値の入力を防ぎます。
たとえば、ケースの選択リストをメタデータで取得すると以下のようになります。
<?xml version="1.0" encoding="UTF-8"?>
<StandardValueSet xmlns="http://soap.sforce.com/2006/04/metadata">
<sorted>false</sorted>
<standardValue>
<fullName>新規登録</fullName>
<default>true</default>
<label>新規登録</label>
<closed>false</closed>
</standardValue>
<standardValue>
<fullName>対応中</fullName>
<default>false</default>
<label>対応中</label>
<closed>false</closed>
</standardValue>
<standardValue>
<fullName>クローズ</fullName>
<default>false</default>
<label>クローズ</label>
<closed>true</closed>
</standardValue>
</StandardValueSet>このように、特定の値のみを入力できることによって、データ品質を向上させられます。
Apexで選択リストの値を扱う意義
Apexで選択リストの値を扱うことの重要性は、ApexがSalesforceのカスタムロジックを記述するためのプログラミング言語。
そのロジックに選択リストの値が重要であることにあります。
Apexを用いて選択リストの値を取得すると、プログラム的に条件分岐や加工を実現できます。
以下はそのための基本的なApexコードの例です。
Schema.DescribeFieldResult fieldResult =
Account.Type.getDescribe();
List<Schema.PicklistEntry> ple = fieldResult.getPicklistValues();このコードは、アカウントの「Type」フィールドから選択リストの値を取得する方法を示しています。
これにより、開発者は選択リストの値に基づいたプログラミングが可能です。
選択リスト値取得の典型的な用途
選択リスト値をApexで取得する典型的な用途は、以下のようなものです。
- レポート生成
- データ検証
- 動的フォーム生成
とくに動的なビジュアルフォースページやライトニングコンポーネントで、ユーザーインターフェースをリアルタイムで更新する際には、Apexで取得した選択リストの値を利用します。
ユーザーがある選択リストを変更した際に、関連する別の選択リストの値を更新したい場合、以下のようなコードが利用されるでしょう。
public class AccountController {
public List<SelectOption> getTypes() {
List<SelectOption> options = new List<SelectOption>();
options.add(new SelectOption('', 'None'));
for (PicklistEntry e : Account.Type.getDescribe().getPicklistValues()) {
options.add(new SelectOption(e.getValue(), e.getLabel()));
}
return options;
}
}このコードスニペットは、選択リストから動的にオプションを作成して、ビジュアルフォースページで用いるためのデータを提供します。
Salesforce Apexによる選択リスト値の取得手順
次に、Apexを使用してSalesforceの選択リストから値を取得する具体的な手順について説明します。
選択リスト値を取得し、それをソフトウェアアプリケーションで使うことにより、プロセスの自動化や動的なユーザーエクスペリエンスの提供が実現します。
- Schema.DescribeFieldResultを利用したアプローチ
- 選択リストからの値の抽出とSchema.PicklistEntryの活用
- カスタムオブジェクトと標準オブジェクトの選択リスト値取得
Schema.DescribeFieldResultを利用したアプローチ
Schema.DescribeFieldResultメソッドは、フィールドメタデータ情報を提供するものです。
このメソッドを使用して、選択リストフィールドから関連するプロパティや値を取得できます。
コードでこのメソッドを呼び出す方法は以下のとおりです。
Schema.DescribeFieldResult fieldResult = Account.Industry.getDescribe();
List<Schema.PicklistEntry> ple = fieldResult.getPicklistValues();このコードは、アカウントの「Industry」フィールドについての情報を取得し、その後、その選択リストに記載されているすべての個別の値にアクセスしています。
選択リストからの値の抽出とSchema.PicklistEntryの活用
選択リストから値を抽出する際は、Schema.PicklistEntryクラスを使用します。
このクラスには、値(value)とラベル(label)という2つの主要なプロパティが含まれており、これにより選択リストのエントリを表現。
以下のように使用します。
Schema.DescribeFieldResult field = Account.Industry.getDescribe();
List<Schema.PicklistEntry> values = field.getPicklistValues();
for (Schema.PicklistEntry p : values) {
System.debug(p.getLabel() + ' - ' + p.getValue());
}このコードは、「Industry」フィールドの各選択リストエントリに対して、そのラベルと値をデバッグログに出力します。
カスタムオブジェクトと標準オブジェクトの選択リスト値取得
カスタムオブジェクトと標準オブジェクトの両方で選択リスト値を取得する手順は同じですが、カスタムオブジェクトはオブジェクト名に__cがついたAPI名を使用する点が異なります。
以下がカスタムオブジェクトの例です。
Schema.DescribeFieldResult fieldResult = MyCustomObject__c.CustomPicklist__c.getDescribe();
List<Schema.PicklistEntry> ple = fieldResult.getPicklistValues();このコードは、カスタムオブジェクトMyCustomObject__cにある、カスタム選択リストフィールドCustomPicklist__cから値を取得しています。
Salesforce Apexで選択リスト値を活用する方法
選択リストの価値を最大化するための具体的な方法を次にご紹介します。
Apexを介して取得した選択リストの値は、UIのカスタマイズ、ビジネスロジックの実装、ユーザーエクスペリエンスの向上に活用が可能。
- UIの動的な選択リスト生成
- 選択リストを基にしたビジネスロジックの実装
- カスタマイズされたユーザーエクスペリエンスの向上
UIの動的な選択リスト生成
ユーザーインターフェースで動的な選択リストを生成する方法は、Apexコードで選択リストの値を取得し、それをビジュアルフォースページまたはライトニングコンポーネントの選択オプションとしてバインディングします。
例えば、以下のようなApexクラスとビジュアルフォースコンポーネントのコードです。
public class AccountController {
public List<SelectOption> accountTypes { get; set; }
public AccountController() {
accountTypes = new List<SelectOption>();
for (PicklistEntry entry : Account.Type.getDescribe().getPicklistValues()) {
accountTypes.add(new SelectOption(entry.getValue(), entry.getLabel()));
}
}
}<apex:selectList size=""1"" value=""{!selectedType}"">
<apex:selectOptions value=""{!accountTypes}""></apex:selectOptions>
</apex:selectList>この例では、選択リストから値を動的に取得し、accountTypesプロパティにバインドしています。
ビジュアルフォースページでは、このプロパティを選択リストのオプションとして利用可能です。
選択リストを基にしたビジネスロジックの実装
選択リストの値を基にビジネスロジックを実装するときは、Apexトリガーやクラス内で条件分岐などをおこないます。
例えば、選択リストの値に基づいて特定のアクションを実行するトリガーは次のとおり。
trigger AccountTrigger on Account (before insert) {
for (Account acc : Trigger.new) {
if (acc.Type == 'Prospect') {
// プロスペクトとしてマークされたアカウントに対するアクションを実行
}
}
}このトリガーは、新しく挿入されたアカウントがプロスペクトタイプである場合に、特定のロジックを実行します。
カスタマイズされたユーザーエクスペリエンスの向上
選択リストの値を使って、ユーザーに合わせたカスタムエクスペリエンスを提供することも可能。
たとえば、ユーザーが特定の選択リストアイテムを選択したときに、関連情報を表示または隠すスクリプトです。
public class AccountController {
public String selectedType { get; set; }
public Boolean showAdditionalInfo { get; set; }
public void updateUI() {
showAdditionalInfo = selectedType == 'ImportantClient';
}
}上記のクラスは、selectedTypeに応じてshowAdditionalInfoフラグを更新し、ユーザーインターフェースがこのフラグに基づいて追加情報を表示するよう設計されます。
Salesforce Apexでの選択リスト値取得のベストプラクティス
Salesforce Apexを使って選択リストの値を取得する際には、いくつか重要なベストプラクティスがあります。
Apexでは、ガバナ制限への対応やメンテナンス性の向上、多言語環境での扱いなどに気をつける必要があるからです。
- Salesforceのガバナ制限への対応
- ハードコード値の排除とメンテナンス性の向上
- 多言語環境下での選択リスト値の扱い
Salesforceのガバナ制限への対応
Salesforceでは、Apexコードに対して実行時間やメモリ使用量などのガバナ制限が設けられています。
選択リストの値を取得する際も、これらの制限内で処理を完了させなければいけません。
例えば、余計なSOQLクエリやループの深度を減らす工夫が必要です。
以下は、効率的なコードの書き方の一例となります。
public with sharing class PicklistValuesHelper {
public static Map<String, List<String>> getPicklistValuesMap() {
Map<String, List<String>> picklistMap = new Map<String, List<String>>();
Schema.DescribeFieldResult fieldResult = Account.Industry.getDescribe();
for (Schema.PicklistEntry entry : fieldResult.getPicklistValues()) {
List<String> valuesList = picklistMap.getOrDefault(entry.getLabel(), new List<String>());
valuesList.add(entry.getValue());
picklistMap.put(entry.getLabel(), valuesList);
}
return picklistMap;
}
}この例では、一度の操作で選択リストの値を取得し、マップに保存して必要なときに再利用することで、リクエストを最小限に抑えています。
ハードコード値の排除とメンテナンス性の向上
選択リストの値をApexコード内でハードコードすることは、将来的な変更が発生したときに修正が大変になるため避けるべきです。
選択リストが更新された場合、選択リストの値をコードから直接取得していれば、コードの修正は不要になります。
public class AccountHelper {
public static String getDefaultAccountType() {
for (Schema.PicklistEntry entry : Account.Type.getDescribe().getPicklistValues()) {
if (entry.isDefaultValue()) {
return entry.getValue();
}
}
return null;
}
}このコードは、選択リストからデフォルトのアカウントタイプを動的に取得するため、ハードコードをしていない点がベストプラクティスです。
多言語環境下での選択リスト値の扱い
グローバルなアプリケーションでは多言語対応が重要です。
選択リストのラベルはユーザーが見る言葉で、値はシステムが利用する文字列のこと。
多言語対応をおこなう際は、各言語のラベルに対応しつつ、システム内の値は一貫性を保つように実装する必要があります。
public class AccountHelper {
public static String getLocalizedTypeLabel(String value, String userLanguage) {
List<Schema.PicklistEntry> entries = Account.Type.getDescribe().getPicklistValues();
for (Schema.PicklistEntry entry : entries) {
if (entry.getValue() == value) {
// Get localized label based on the user's language
return LabelUtils.getLocalizedLabel(entry.getLabel(), userLanguage);
}
}
return null;
}
}上記の関数getLocalizedTypeLabelは、引数で渡された選択リストの値valueとユーザーの言語userLanguageに基づいて対応するローカライズされたラベルを取得するためのものです。
ここで、LabelUtilsは架空のユーティリティクラスで、ローカライズされたラベルを取得するためのメソッドgetLocalizedLabelを提供しているとしています。
これにより、コードのメンテナンス性を保ちつつ多言語環境をサポートできます。
Salesforce Apexで選択リスト値取得時のよくある課題と解決策
SalesforceのApexコードで選択リストの値を取得する際に直面する可能性のある一般的な課題への対処法を下記に示します。
- 取得不能な選択リスト値のトラブルシューティング
- 選択リスト値の変更に伴う対応
- 処理性能の最適化とセキュリティ考慮点
取得不能な選択リスト値のトラブルシューティング
ときには、Apexコードで期待している選択リストの値が取得できない場合があります。
これは通常、以下のようなセキュリティ構成が原因です。
- フィールドレベルのセキュリティ設定
- オブジェクトのアクセス許可
取得不能な問題に対処するためには、以下のステップを確認します。
- フィールドレベルのセキュリティ設定をチェックし、必要なプロファイルにフィールドへのアクセス権があるかを確認
- カスタムオブジェクトやフィールドに対するCRUD権限を検証
- Apexクラスに
with sharingまたはwithout sharingキーワードが適切に適用されており、実行ユーザーのセキュリティコンテキストが正しく反映されているかを確認
選択リスト値の変更に伴う対応
選択リストの値が変更された場合、関連するApexコードも更新する必要が生じることがあります。
これを防ぐためには、リストの値が変更されても、それに依存するコードを変更する必要がないように、設計の初期段階から慎重に考慮することが重要です。
たとえば、選択リストの値を判定のための定数としてコード内に保存するのではなく、カスタムメタデータやカスタム設定を用いて外部から値を取得できます。
public class SettingsUtils {
public static String getSetting(String key) {
CustomSetting__c setting = CustomSetting__c.getValues(key);
return (setting != null) ? setting.Value__c : null;
}
}上記の例では、CustomSetting__cというカスタム設定を介して設定値を取得することで、選択リストの値が変更されたとしても、Apexコードの変更は不要になります。
処理性能の最適化とセキュリティ考慮点
選択リストの値を取得する際に、高い処理性能とセキュリティを確保するためには、不要なApexコードの実行を避け、SOQLクエリの最適化により、フィールドやオブジェクトへの適切な権限を実行ユーザーに付与するなどの措置が必要です。
また、可変データをSOQLクエリに含める場合は、インジェクション攻撃を防ぐために適切にエスケープ処理を行う必要があります。
public class AccountService {
public static List<Account> getAccountsByType(String accountType) {
String safeAccountType = String.escapeSingleQuotes(accountType);
return [SELECT Id, Name, Type FROM Account WHERE Type = :safeAccountType];
}
}この例では、ユーザー入力を利用してSOQLクエリを実行する前に、String.escapeSingleQuotesメソッドでエスケープ処理を行い、SOQLインジェクションを防いでいます。
まとめ
SalesforceとApexを利用した選択リストの値の取得および活用方法について解説しました。
選択リストは、アプリケーションのデータ整合性とユーザビリティを向上させる上で重要な機能であり、Apexの機能を最大限に活用することにより、パワフルで柔軟なカスタマイズが可能になります。
今回の解説が、Salesforceでの開発作業に役立つ情報を提供することができれば幸いです。
常にベストプラクティスを念頭に置き、メンテナンス性と拡張性のあるコードを心がけてください。