More than 5 years have passed since last update.

SalesforceのLightningデータサービス(LDS)について学ぶ

Posted at 2019-03-04

はじめに

(Mac環境の記事ですが、Windows環境も同じ手順になります。環境依存の部分は読み替えてお試しください。)

この記事を最後まで読むと、次のことができるようになります。

Lightningデータサービス(LDS)について理解する
LDSを使って実装する

イメージ画像

レイアウトにLDSを実装

クイックアクションLDSを実装

実行環境

環境	Ver.
macOS Mojave	10.14.3
Salesforce	Winter '18

ソースコード

実際に実装内容やソースコードを追いながら読むとより理解が深まるかと思います。是非ご活用ください。

GitHub

Lightningデータサービスの特徴

Lightningデータサービス(LDS)は、Salesforce Winter '18より使用可能となりました。LDSを使用すると、Apexコードを必要とせずに、コンポーネントでレコードの読み込み、作成、編集、削除ができます。LDSに読み込まれたレコードはキャッシュされ、コンポーネント間で共有されます。サーバ側のApexコントローラの処理やデータアクセスが減少するため、パフォーマンスの改善が期待できます。

XMLHttpRequests (XHR) を最小限に抑える
レコードを 1 回だけ取得し、ネットワーク転送を減らし、アプリケーションサーバとデータベースサーバの負荷を軽減する
コンポーネントのメタデータとは別にレコードデータをクライアントでキャッシュする
コンポーネント間でレコードデータを共有する
レコードの段階的な読み取り、キャッシュ、およびキャッシュへのより多くの項目とレイアウトのマージを可能にする
プロアクティブなキャッシュ入力を可能にする
複数のコンポーネント間で 1 つのレコードデータインスタンスのみを使用することで、一貫性を促進する
レコードデータの変更時に通知を作成する

LDSの実装方法

force:recordDataタグについて

LDSを実装するには、コンポーネントにforce:recordDataタグを記述します。

sample.cmp

<force:recordData aura:id="recordEditor"
    layoutType="FULL"
    recordId="{!v.recordId}"
    targetError="{!v.recordError}"
    targetRecord="{!v.record}"
    targetFields="{!v.accountRecord}"
    fields="Name,Phone"
    recordUpdated="{!c.handleRecordUpdated}"
    mode="EDIT" />

属性	説明
layoutType	レイアウトタイプ(FULL or COMPACT)
recordId	読み込むレコードID
targetError	エラー結果
targetRecord	読み込まれたレコード
targetFields	読み込まれたレコードの簡易ビュー
fields	照会項目
recordUpdated	変更アクション
mode	操作モード(EDIT or VIEW)

LDSの実装例

取引先(Account)のレコードをレイアウト表示とクイックアクションから編集できるようにする。

編集をもつコンポーネントを作成する
取引先レイアウトにコンポーネントを設定する
クイックアクションにコンポーネントを設定する

コンポーネント実装

idsAccountEdit.cmp

<aura:component
    implements="flexipage:availableForRecordHome,force:hasRecordId,force:hasSObjectName,force:lightningQuickActionWithoutHeader">

    <aura:attribute name="record" type="Object" />
    <aura:attribute name="accountRecord" type="Account" />
    <aura:attribute name="recordError" type="String" default="" />

    <force:recordData aura:id="recordEditor" layoutType="FULL" recordId="{!v.recordId}" targetError="{!v.recordError}"
        targetRecord="{!v.record}" targetFields="{!v.accountRecord}" fields="Name,Phone"
        recordUpdated="{!c.handleRecordUpdated}" mode="EDIT" />

    <aura:if isTrue="{!not(empty(v.recordError))}">
        <div class="recordError">
            {!v.recordError}</div>
    </aura:if>

    <div class="Record Details">
        <lightning:card iconName="action:edit" title="{!'Edit ' + v.sObjectName}">
            <aura:set attribute="footer">
                <lightning:button label="Save" onclick="{!c.handleSaveRecord}" class="slds-button slds-button_brand" />
            </aura:set>
            <div class="slds-p-horizontal--small">
                <lightning:input label="Name" value="{!v.accountRecord.Name}" />
                <lightning:input label="Phone" value="{!v.accountRecord.Phone}" />
            </div>
        </lightning:card>
    </div>

</aura:component>

コントローラ実装

ldsAccountEditController.js

({
    handleSaveRecord: function (component, event, helper) {
        var recordEditor = component.find("recordEditor");
        recordEditor.saveRecord($A.getCallback(function (saveResult) {
            if (saveResult.state === "ERROR") {
                var errMsg = "";
                for (var err of saveResult.error) {
                    errMsg += err.message + "\n";
                }
                component.set("v.recordError", errMsg);
            } else {
                component.set("v.recordError", "");
                $A.get("e.force:closeQuickAction").fire();
            }
        }));
    },

    handleRecordUpdated: function (component, event, helper) {
        var eventParams = event.getParams();
        if (eventParams.changeType === "CHANGED") {
            var changedFields = eventParams.changedFields;
            console.log('Fields that are changed: ' + JSON.stringify(changedFields));
            var resultsToast = $A.get("e.force:showToast");
            resultsToast.setParams({
                "title": "Saved",
                "message": "The record was updated."
            });
            resultsToast.fire();
        } else if (eventParams.changeType === "LOADED") {
            // record is loaded in the cache
        } else if (eventParams.changeType === "REMOVED") {
            // record is deleted and removed from the cache
        } else if (eventParams.changeType === "ERROR") {
            console.log('Error: ' + component.get("v.error"));
        }
    }
})