Schrittweise Anleitung für eine Beispielanwendung und Einführung in die Cache-Diagnose

Übersicht über die Beispielanwendung

Unsere Beispielanwendung für Wechselkurse basiert auf einer Visualforce-Seite und einem Apex-Steuerfeld, das die Logik zum Abrufen von Wechselkursen enthält. Beim ersten Zugriff auf diese Seite werden die Kurse über einen API-Aufruf eines externen Webservice ermittelt. Nachfolgende Ausführungen dieser Seite geben die Kurse aus dem Cache zurück, solange die Kurse weniger als einen Tag alt sind. Für jeden Wechselkurs werden auf dieser Seite die Ausgangswährung, die Zielwährung für die Umrechnung und der Umrechnungskurs angezeigt. Zur Veranschaulichung wird eine kleine Menge von Währungen zurückgegeben.

Dieses Beispiel ist das Markup der Visualforce-Seite. Diese Seite ist mit dem Apex-Steuerfeld ExchangeRates verknüpft.

<apex:page controller="ExchangeRates" action="{!init}">
   <apex:pageBlock title="Rates">
      <apex:pageBlockTable value="{!Rates}" var="rate">
         <apex:column value="{!rate.Base_Currency__c}"/>
         <apex:column value="{!rate.To_Currency__c}"/>
         <apex:column value="{!rate.Rate__c }"/>
      </apex:pageBlockTable>
   </apex:pageBlock>
</apex:page>

Beispiel eines Apex-Steuerfelds

Unser Apex-Beispielsteuerfeld übernimmt die wichtigsten Aufgaben. Es dient zum Abrufen von Wechselkursen, deren Speicherung in Salesforce und im Cache sowie zum Abrufen von Kursen aus dem Cache. Hier ist eine Aufschlüsselung der Vorgänge, die das Beispielsteuerfeld durchführt, gefolgt vom Quellcode.

Beim ersten Ausführen des Beispiels finden die folgenden Vorgänge statt.

• Die Wechselkurse werden über einen API-Aufruf an einen externen Endpunkt ermittelt.
• Das vom API-Aufruf (im JSON-Format) zurückgegebene Ergebnis wird analysiert und in sObjects des Typs "Exchange_Rate__c" in Salesforce gespeichert.
• Die getCachedRates()-Methode speichert das Array von sObjects des Typs Exchange_Rate__c im Organisations-Cache.

Dies erfolgt bei nachfolgenden Ausführungen des Beispiels:

• Das Beispiel prüft, wie aktuell die gespeicherten Daten sind. Zu diesem Zweck erfolgt eine SOQL-Abfrage, um den Wert createdDate des ersten zurückgegebenen Exchange_Rate__c-Datensatzes abzurufen.
• Wenn das Datum älter als ein Tag ist, werden die Wechselkurse wie bei der ersten Ausführung über den API-Aufruf abgerufen.
• Ist das Datum jünger als ein Tag, werden die Kurse aus dem Organisations-Cache ausgelesen. Bei einem Cache-Fehlzugriff werden die Kurse aus sObjects des Typs "Exchange_Rate__c " abgefragt und im Organisations-Cache gespeichert.

Hinweis

Das Apex-Steuerfeld verwendet eine Apex-Hilfsklasse namens RateLib, die hier nicht gezeigt wird. Diese Hilfsklasse enthält Methoden, um den ausgehenden API-Aufruf an einen Wechselkurs-Service zu richten, das JSON-Ergebnis aus dem API-Aufruf zu analysieren und "Exchange_Rate__c"-Datensätze zu speichern.

public class ExchangeRates {
    private String currencies = 'EUR,GBP,CAD,PLN,INR,AUD,SGD,CHF,MYR,JPY,CNY';
    public String getCurrencies() { return currencies;}
    public Exchange_Rate__c[] rates {get; set;}
    //                                                                          
    // Checks if the data is old and gets new data from an external web service 
    // through a callout. Calls getCachedRates() to manage the cache.           
    // 
    public void init() {
        // Let's query the latest data from Salesforce
        Exchange_Rate__c[] latestRecords = ([SELECT CreatedDate FROM Exchange_Rate__c 
                        WHERE Base_Currency__c =:RateLib.baseCurrencies 
                              AND forList__c = true 
                        ORDER BY CreatedDate DESC
                        LIMIT 1]);
        // If what we have in Salesforce is old, get fresh data from the API
        if ( latestRecords == null  
            || latestRecords.size() == 0 
            || latestRecords[0].CreatedDate.date() < Datetime.now().date()) {
            // Do API request and parse value out
            String tempString = RateLib.getLoadRate(currencies);
            Map<String, String> apiStrings = RateLib.getParseValues(
                tempString, currencies);
            // Let's store the data in Salesforce
            RateLib.saveRates(apiStrings);
            // Remove the cache key so it gets refreshed in getCachedRates()
            Cache.Org.remove('Rates');
        }
        // Call method to manage the cache
        rates = getCachedRates();
    }
    //                                                                          
    // Main method for managing the org cache.                                  
    // - Returns exchange rates (Rates key) from the org cache.                 
    // - Checks for a cache miss.                                               
    // - If there is a cache miss, returns exchange rates from Salesforce       
    //    through a SOQL query, and updates the cached value.                   
    //
    public Exchange_Rate__c[] getCachedRates() {
        // Get the cached value for key named Rates
        Exchange_Rate__c[] rates = (Exchange_Rate__c[])Cache.Org.get(
            RateLib.cacheName+'Rates');
        // Is it a cache miss? 
        if(rates == null) {
            // There was a cache miss so get the data via SOQL
            rates = [SELECT Id, Base_Currency__c, To_Currency__c, Rate__c 
                        FROM Exchange_Rate__c 
                        WHERE Base_Currency__c =:RateLib.baseCurrencies 
                              AND forList__c = true
                              AND CreatedDate = TODAY];
            // Reload the cache
            Cache.Org.put(RateLib.cacheName+'Rates', rates);
        }
        return rates;
    }
}

Im Abschnitt "Ressourcen" können Sie den Quellcode des Beispiels für Wechselkurse herunterladen und mit ihm in Ihrer Developer Edition-Organisation experimentieren.

Muster für die Cache-Speicherung

Die Apex-Klasse ExchangeRates enthält Methoden, die die Logik der Initialisierung und Aktualisierung des Caches kapseln. Wenn die Daten veraltet sind oder nicht gefunden werden, ruft die init()-Methode neue Wechselkurse über einen API-Aufruf ab und speichert sie dann in Salesforce. Mit der getCachedRates()-Methode wird der Cache intern verwaltet. Wenn der zwischengespeicherte Wert nicht gefunden wird, ruft diese Methode ein Array von Kursen aus Salesforce ab und speichert es im Cache.

Da unsere Anwendung externe Daten verwendet, ruft sie über API-Aufrufe Daten von einem Webservice ab. Außerdem werden die Daten als Salesforce-Datensätze als Ersatz für die Aktualisierung des Caches gespeichert. Anwendungen, die keine externen Daten verwenden, rufen Salesforce-Datensätze mithilfe von SOQL ab und speichern sie im Cache. In diesem Fall ist die Cache-Verwaltung einfacher und die Implementierung der Cache-Methoden schneller. Falls Ihre Anwendung beispielsweise nur lokale Daten aus SOQL verwendet, benötigen Sie nicht die init()-Methode, sondern nur die getCachedRates()-Methode.

Wir empfehlen, die gesamte Logik zur Verwaltung des Caches in einer Methode zusammenzufassen. Auf diese Weise wird der Cache nur an einer Stelle in Ihrer Anwendung bearbeitet. Die zentrale Verwaltung des Caches reduziert das Risiko von Fehlzugriffen auf den Cache oder eines versehentlichen Überschreibens von Cache-Werten.

Entscheiden, was im Cache zwischengespeichert werden soll

Dieses Beispiel speichert ein Array von sObjects im Cache. Ist dieser Ansatz für die zu speichernden Datenstruktur am besten? Bei jeder Wahl, die Sie treffen, sind Kompromisse einzugehen. Das Speichern kleinerer Daten, wie z. B. von Feldwerten anstelle ganzer sObjects, kann den Umfang der Cache-Nutzung verringern. Wenn Sie jedoch weniger Daten in jedem Schlüssel speichern, benötigen Sie möglicherweise komplexe Logik, um die Daten und sObjects neu zu erstellen, was mehr Verarbeitungszeit erfordert. Und ein in einem Schlüssel gespeichertes sObject-Array belegt weniger Cache-Speicherplatz als die Gesamtgröße der in einzelnen Schlüsseln gespeicherten sObjects. Durch das Zwischenspeichern kleinerer Elemente anstelle einer Liste von Elementen verschlechtert sich die Cache-Leistung aufgrund des Aufwands für Serialisierung und der nötigen Zeit für den Commit im Cache. Anstatt beispielsweise eine Liste von Wechselkursen zu speichern (auf die von der Variablen "rates" in diesem Codeausschnitt verwiesen wird):

Cache.Org.put('Rates', rates);

Können Sie die einzelnen Wechselkurse, jeweils als Feld mit eigenem Cache-Schlüssel, wie folgt speichern.

Cache.Org.put('DollarToEuroRate', rateEUR);
Cache.Org.put('DollarToChineseYuan', rateCNY);
Cache.Org.put('DollarToJapaneseYen', rateJPY);
// etc.

Die Entscheidung, welche Datenstruktur zwischengespeichert werden soll, hängt davon ab, was Ihre Anwendung mit den Daten macht. Wenn die Anwendung beispielsweise Währungen für dieselbe Basiswährung umrechnet, speichern Sie mindestens den Wechselkurs jeder Zielwährung. Sie können jeden Währungskurs als eigenen Schlüssel speichern. Um die Anzeige der Wechselkurse auf einer Visualforce-Seite zu vereinfachen, speichern Sie die Daten als Liste von sObjects im Cache. sObjects können mehr Speicherplatz beanspruchen, da sie Systemfelder wie das Erstellungsdatum enthalten, reduzieren aber die logische Verarbeitungszeit und erhöhen die Anwendungs- und Cache-Leistung. Denken Sie daran, dass das Hauptziel bei der Verwendung des Caches die Beschleunigung der Anwendungsausführung ist.