Lightning Aura Components Developer Guide (Lightning Aura コンポーネント開発者ガイド)
Winter '25 (API version 62.0)
Spring '24 (API version 60.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Apex サーバ側コントローラの概要
AuraEnabled アノテーション
Apex サーバ側コントローラの作成
Apex コントローラへのデータの受け渡し
Apex サーバ側コントローラからデータを返す
Apex サーバ側コントローラからエラーを返す
サーバ側のアクションのキュー配置
フォアグラウンドアクションおよびバックグラウンドアクション
中止可能なアクション
Apex コードのテスト
Apex からの API コールの実行
Apex でのコンポーネントの作成
コントローラのサーバ側ロジックの作成
フレームワークは、クライアント側コントローラとサーバ側コントローラをサポートします。イベントは常にクライアント側コン���ローラのアクションに結び付けられ、このアクションがサーバ側コントローラのアクションをコールします。 たとえば、クライアント側コントローラでイベントを処理し、サーバ側コントローラアクションをコールしてレコードを保持する場合などがあります。
サーバ側のアクションは、クライアントからサーバ、その後サーバからクライアントに往復させる必要があるため、通常はクライアント側のアクションよりも完了に時間がかかります。
サーバ側のアクションをコールするプロセスについての詳細は、「サーバ側のアクションのコール」を参照してください。
-
Apex サーバ側コントローラの概要
サーバ側コントローラを Apex で作成し、@AuraEnabled アノテーションを使用して、コントローラメソッドにアクセスできるようにします。 -
AuraEnabled アノテーション
AuraEnabled アノテーションにより、Lightning コンポーネントから Apex メソッドおよびプロパティへのアクセスが可能になります。 -
Apex サーバ側コントローラの作成
開発者コンソールを使用して、Apex サーバ側コントローラを作成します。 -
サーバ側のアクションのコール
クライアント側コントローラからサーバ側コントローラのアクションをコールします。クライアント側コントローラにコールバックを設定し、サーバ側のアクションが完了したときにコールされるようにします。サーバ側のアクションは、逐次化可能な JSON データを含む任意のオブジェクトを返すことができます。 -
Apex コントローラへのデータの受け渡し
Apex コントローラに渡すデータを設定するには、JavaScript で action.setParams() を使用します。 -
Apex サーバ側コントローラからデータを返す
return ステートメントを使用して、サーバ側コントローラからクライアント側コントローラに結果を返します。結果データは、JSON 形式に逐次化できる必要があります。 -
Apex サーバ側コントローラからエラーを返す
サーバ側コントローラから System.AuraHandledException を作成してスローし、カスタムエラーメッセージを返します。 -
サーバ側のアクションのキュー配置
フレームワークは、アクションをサーバに送信する前にキューに配置します。コードの記述時のこのメカニズムの大半は透過的ですが、複数のアクションを 1 つの要求 (XHR) にまとめて、フレームワークがネットワークトラフィックを最小限に抑えることができます。 -
フォアグラウンドアクションおよびバックグラウンドアクション
フォアグラウンドアクションがデフォルトです。アクションをバックグラウンドアクションとしてマークできます。ユーザに対するアプリケーションの応答性を維持しながら、優先度が低く実行時間が長いアクションをアプリケーションで実行する場合、これが役立ちます。大まかなガイドラインとして、応答がサーバから戻るまでに 5 秒以上かかる場合は、バックグラウンドアクションを使用します。 -
保存可能なアクション
アクションを保存可能 (キャッシュ可能) としてマークすると、サーバとの往復を待たずにクライアント側ストレージのキャッシュデータをすばやく表示できるようになり、コンポーネントのパフォーマンスが向上します。キャッシュデータが古くなっている場合、フレームワークによってサーバから最新データが取得されます。特に、待ち時間の長い接続、低速の接続、信頼性の低い接続 (3G ネットワークなど) のユーザの場合には、キャッシュが役立ちます。 -
中止可能なアクション
アクションを中止可能とマークして、サーバへの送信キューに入っているときに中止可能にすることができます。キュー内の中止可能なアクションは、そのアクションを作成したコンポーネントが無効になった場合 (cmp.isValid() == false)、サーバに送信されません。コンポーネントは自動的に破棄され、表示されないときにフレームワークによって無効とマークされます。