Salesforceガイド｜Apexコントローラを活用しよう

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

「SalesforceのApexコントローラーとは具体的に何を指すのだろうか？」
「Apexコントローラーの作成と使用法を理解したい」
「Apexコントローラーを使用した実践的な例を知りたい」

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

SalesforceにおけるApexコントローラーの基本概念
Apexコントローラーの作成方法と主な機能
Apexコントローラーを使用した具体的な実装例

当記事では、Salesforceのビジュアルコンポーネントやページと連動するApexコントローラーの重要性と基本的な概念を紹介します。

Salesforceの開発者や学習者にとって、実践的なガイドとなる内容です。

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

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

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

筆者プロフィール

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

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

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

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

Apexコントローラーの概要

こちらでは、Apexコントローラーについてお伝えしていきます。

Apexコントローラーについて理解することで、Salesforceプラットフォームでより洗練されたアプリケーションを開発するのに役立つでしょう。

Apexコントローラーとは何か
コントローラーとSalesforceの統合
コントローラーの役割と重要性
コントローラーとビジネスロジックの関係

Apexコントローラーとは何か

Apexコントローラーとは、SalesforceのカスタムWebページを支えるバックエンドロジックを含むクラスのこと。

Apexコードは、Javaに似た構文を持ちます。

例えば、単純なコントローラーを定義するには以下のように記述します。

public class MySimpleController {
   // コントローラーのロジックをここに記述
}

このコントローラーは、Salesforceのデータにアクセスしたり、ページフローを制御したりするために使用されます。

コントローラーとSalesforceの統合

コントローラーはSalesforceのデータモデルと密接に統合されており、標準・カスタム問わず、Salesforceのオブジェクトとのデータ交換を可能にします。

以下のApexコードは、特定のオブジェクトデータを取得しているものです。

public class MyController {
   public Account myAccount {get; set;} 

   public MyController() {
      String paramId = ApexPages.currentPage().getParameters().get('id');
      myAccount = [SELECT Name, Revenue__c FROM Account WHERE Id = :paramId];
   }
}

コントローラーがページリクエスト（URLのパラメータ）からAccountオブジェクトのIDを取得し、それを使用してデータベースから情報を取得しています。

コントローラーの役割と重要性

Apexコントローラーは、ユーザーインターフェイスとデータベース間の中間者の役割を果たします。

ビジネスロジックを実行してユーザーのアクションに応答するのが役割です。

例えば、以下のコードはユーザーからの入力を処理しています。

public class MyController {
   public String userInput {get; set;} //ここにユーザーからの入力が格納される

   public void processInput() {
      // ユーザーの入力に基づいて何らかの処理
   }
}

ユーザーの入力がuserInputに保存されます。

例えばVisualforceページでは以下のようにフォームを設定。

<apex:page controller="MyController">
  <apex:form>
    <apex:inputText value="{!userInput}" />
    <apex:commandButton value="送信" action="{!processInput}" />
  </apex:form>
</apex>

コントローラーとビジネスロジックの関係

Apexコントローラーは、アプリケーションのビジネスロジックをカプセル化するために使用されます。

public class MyBusinessLogicController {
   public void performComplexOperation() {
      // 複雑なビジネスロジックの処理
   }
}

このコントローラーは、Salesforceオブジェクトとの複雑なインタラクションを管理し、ビジネス要件に応じてカスタマイズされた動作を定義します。

ユーザーの意図を正確に理解し、それを効率的で再利用可能なコードに変換することが、コントローラー開発の鍵となるでしょう。

Apexコントローラーの基本コンセプト

こちらでは、Apexコントローラーに関わる基本的な概念にフォーカスします。

Apexコントローラーの基本を把握することで、Salesforceアプリケーションの開発を始めるための土台を築けるのです。

コントローラーの種類と特徴
MVCモデルとコントローラー
Apexコードの基本構造
データバインディングの概念

コントローラーの種類と特徴

Apexコントローラーにはいくつかの種類があり、それぞれ異なる用途や特徴があります。

主なコントローラーの種類は以下のとおりです。

スタンダードコントローラー：Salesforceの標準機能を拡張する
カスタムコントローラー：独自のビジネスロジックを完全にカスタマイズする
コントローラー拡張：スタンダードコントローラーに独自の機能を追加する

それぞれの設定方法を、ApexコントローラとVisualforceで示します。

スタンダードコントローラ

スタンダードコントローラは、特定のオブジェクトに関連付けられるもの。

Visualforceへ関連付けるには以下のようにします。

<apex:page standardController="MyCustomObject__c">
</apex:page>

カスタムコントローラ

カスタムコントローラは、Apexコントローラとページを関連付けます。

カスタムコントローラのサンプルです。

public class MyCustomController{
    public MyCustomController{
        //コンストラクタです
    }
}

Visualforceページの例です。

<apex:page controller="MyCustomController">
    <!-- 表示したい内容を記述 -->
</apex>

コントローラー拡張

コントローラ拡張は、スタンダードコントローラで特定のオブジェクトと関連付けながら、Apexコントローラで処理をおこなえるもの。

コントローラ拡張により、各オブジェクトの詳細ページにボタン設置などが可能になります。

コントローラは、StandardControllerを使い以下のようになります。

public class myCustomExtension {
  public Lead lead{get; private set;}

  public myCustomExtension (ApexPages.StandardController stdController){
    //使用するフィールドを指定する
    this.lead = (Lead)stdController.getRecord();
  }
}

Visualforceページでは以下のようになります。

<apex:page standardController="MyCustomObject__c" extensions="myCustomExtension">
   <!-- 内容 -->
</apex:page>

MVCモデルとコントローラー

MVC（Model-View-Controller）モデルは、アプリケーションの構造を明確に分ける設計パターンのこと。

その中でコントローラーは次のような役割を果たします。

Model（モデル）: データ構造とビジネスロジック
View（ビュー）: ユーザーインターフェースとデータの表示
Controller（コントローラー）: モデルとビューの仲介とユーザー入力の処理

例を挙げると、以下のコードはMVCパターン内でのControllerの実装を示しています。

public class MyMVCController {
   // モデルからデータを取得
   public List<Account> getAccounts() {
      return [SELECT Name, Industry FROM Account];
   }

   // ビューからのアクションを処理
   public void updateAccounts() {
      // アカウント更新処理
   }
}

このコードは、データを取得し、ユーザーのアクションに応じてそれを更新する方法をコントローラーを通じて示しています。

Apexコードの基本構造

Apexコードを書く際に理解すべき基本的な構造には、以下が含まれます。

変数宣言
メソッド定義
クラス宣言

Apexコードの基本的な例は以下のとおりです。

public class MyClass {
   // 変数の宣言
   private String myVariable{get; set;}

   // メソッドの定義
   public void myMethod() {
      // メソッドの処理
   }
}

ここで、myVariableはクラス内で使用される変数であり、myMethod()は特定のアクションを実行するメソッドです。

データバインディングの概念

データバインディングは、コントローラーの変数やメソッドをビジュアルフォースページのコンポーネントに関連付けるプロセスです。

例えば、以下のApexコードはビジュアルフォースページの入力フィールドにバインドされます。

public class MyDataBindingController {
   public String userName {get; set;}
   // その他のコントローラーのロジック
}

<!-- こちらがVisualforceページ -->
<apex:page controller="MyDataBindingController">
    <apex:form>
        <apex:inputText value={!userName} />
    </apex:form>
</apex>

この例では、userName変数がビジュアルフォースページの入力フィールドとバインドされ、ユーザーがフィールドに入力したデータが直接この変数に格納されます。

Apexコントローラーの実装方法

こちらでは、Apexコントローラーの具体的な実装手順に焦点を当てます。

Apexコントローラーの実装方法を学ぶことで、具体的なケースに対してSalesforce上でのソリューションを構築する能力が高まるはず。

シンプルなコントローラーの作成
ビジネスロジックの統合
ビューとコントローラーの連携
ユーザー入力の処理とバリデーション

シンプルなコントローラーの作成

シンプルなコントローラーを作成する最初のステップは、コントローラークラスを定義し、必要なデータやメソッドを追加することです。

例として以下のように記述できます。

public class SimpleController {
   public String greeting {get; set;}

   public SimpleController() {
      greeting = 'こんにちは、Salesforceの世界へ！';
   }
}

この例では、コンストラクター内でgreeting変数を初期化しており、この変数はビジュアルフォースページで表示されるメッセージを保持します。

ビジネスロジックの統合

ビジネスロジックをコントローラーに統合するには、特定のビジネスルールに従ってメソッドを実装する必要があります。

以下のコード例は、ビジネスロジックを統合する方法を示すものです。

public class BusinessLogicController {
   public void processOrder() {
      // 注文処理ロジック
   }
}

このメソッドは、注文のプロセスを管理するために使用され、具体的なビジネスケースに応じた処理が含まれるべきです。

ビューとコントローラーの連携

ビューとコントローラーを連携させるためには、コントローラーの変数やメソッドをビューの要素と動的にバインドする必要があります。

以下は連携の例です。

public class ViewController {
   public List<Contact> contacts {get; private set;}

   public ViewController() {
      contacts = [SELECT Name, Email FROM Contact];
   }
}

contacts変数はビジュアルフォースページの表またはリストにバインドされ、ユーザーにデータが表示されます。

ユーザー入力の処理とバリデーション

ユーザー入力の処理には、入力を受け取り、それを検証し、適切なデータベース操作を実行するロジックが含まれます。

例を以下に示します。

public class InputController {
   public String userEmail {get; set;}

   public void submit() {
      if (String.isNotBlank(userEmail)) {
         // バリデーションが成功した場合の処理
      } else {
         // エラーメッセージの表示などバリデーション失敗の処理
      }
   }
}

この例では、userEmailが空でない場合のみ処理を進め、さもなければエラー処理を実行しています。

Apexコントローラーの高度な活用

いったん基本を押さえたら、Apexコントローラーをより高度に活用する方法を学びましょう。

高度なテクニックを習得することで、Salesforce開発のハードルをより一層越えられます。

カスタムコントローラーと拡張
イベント処理と動的バインディング
性能とセキュリティの最適化
テストとデプロイメントの戦略

カスタムコントローラーと拡張

カスタムコントローラーの作成および既存のスタンダードコントローラーを拡張することで、より洗練されたコードを実装可能です。

以下に拡張コントローラーの例を示します。

public class ExtendedController {

  public ExtendedControlle (ApexPages.StandardController stdController){
     //オブジェクトレコードを受け取る記述を書きます。
  }
}

拡張コントローラーでは、既存の機能に加えて追加のカスタムロジックを実装できます。

Salesforceアプリケーションを柔軟に拡張することが可能です。

イベント処理と動的バインディング

イベント処理&動的バインディングを用いることで、ユーザーのインタラクションやページの状態変化をリアルタイムで処理できるようになります。

以下は、動的バインディングの一例です。

public class DynamicBindingController {
   public String selectedOption {get; set;}
   public Map<String, String> optionsMap {get; set;}

   public DynamicBindingController() {
      optionsMap = new Map<String, String>{
         'Option1' => 'Value1',
         'Option2' => 'Value2'
      };
   }

   public void handleSelection() {
      String chosenValue = optionsMap.get(selectedOption);
      // 選択されたオプションに応じた処理
   }
}

ページ上のユーザーの選択に基づいて、異なる処理を動的にバインドして実行できます。

性能とセキュリティの最適化

性能向上とセキュリティの強化は、高度なApexコントローラー開発において重要です。

以下のコーディングプラクティスもさまざまなテクニックがありますが、SOQLのクエリバッチサイズの設定や、共有設定を適切に利用することが挙げられます。

public class OptimizeController {
　public List<Account> getLargeData() {
　　return [SELECT Name, Revenue__c FROM Account LIMIT :Limits.getLimitQueryRows()];
　}
　// その他のパフォーマンス改善処理
}

Apexが処理できる最大行数に基づいてSOQLクエリのバッチサイズを動的に設定しています。

大量データ取得時の性能を向上させると同時に、ガバナリミットを超えないよう管理する方法です。

テストとデプロイメントの戦略

確実なテストと戦略的なデプロイメントプロセスを構築することで、コントローラーが本番環境で正しく機能することを保証できます。

以下はテストクラスの基本的な例です：

@IsTest\nprivate 
class MyControllerTest {

  @IsTest 
  static void testMyController() {
     // テストデータの準備
     Test.startTest();
     // コントローラーのロジックをテスト
     MyController controller = new MyController();
     controller.performAction();
     // アサーションを使って期待される結果をアサート
     Test.stopTest();
   }
}

このテストクラスは、コントローラーのメソッドが期待通りに機能するかを検証し、Test.startTest()とTest.stopTest()メソッドを使用してテスト実行時のリソース制限をリセットしています。

Apexコントローラーのトラブルシューティング

Apexコントローラーの開発では、さまざまな問題に直面することがありますが、それぞれのトラブルに適切な解決策を知っておくことが重要です。

トラブルシューティングのノウハウとリソースを身に付けることが、開発プロセスをスムーズに保つ鍵となります。

一般的なエラーとその解決法
デバッグとロギングのベストプラクティス
コミュニティとサポートリソース
ドキュメンテーションとリファレンスの利用

一般的なエラーとその解決法

Apexコントローラー開発で遭遇する可能性のあるいくつかの一般的なエラーには、以下などがあります。

ガバナリミット超過
型の不一致
null参照例外

ガバナリミットを超えた場合は、以下のようにクエリを最適化する必要があります。

List<Account> accounts = [SELECT Id, Name FROM Account WHERE Id IN :accIds]

IN句を活用することで、一度のクエリで取得するレコード数を制限し、ガバナリミットを遵守できます。

デバッグとロギングのベストプラクティス

効果的なデバッグとロギングは、エラーの特定と解決を大いに助けてくれます。

以下にデバッグとロギングの一例を示します。

public class DebugExampleController {
  public void myMethod() {
    try {
      // ロジックの処理
    } catch (Exception e) {
      System.debug('エラーが発生しました: ' + e.getMessage());
      //ページ状などではe.getMessage()を表示しないようにしましょう。
    }
  }
}

try-catchブロックを用いて例外を捕捉し、System.debugを使用してエラーメッセージをロギングしています。