Fehlerbehebung für JSONStore

Übersicht

Hier finden Sie Informationen, die Ihnen bei der Lösung von Problemen helfen, die bei Verwendung der JSONStore-API auftreten können.

Stellen Sie beim Anfordern von Unterstützung Informationen bereit

Es ist besser, zu viele Informationen zur Verfügung zu stellen, als zu riskieren, dass nicht genug Informationen bereitgestellt wurden. Die folgende Liste ist ein guter Ausgangspunkt dafür, welche Informationen erforderlich sind, um Ihnen bei der Lösung JSONStore-Problemen behilflich sein zu können.

• Betriebssystem und Version, z. B. virtuelle Maschine mit Windows XP SP3 oder Mac OSX 10.8.3
• Eclipse-Version, z. B. Eclipse Indigo 3.7 Java EE
• JDK-Version, z. B. Java SE Runtime Environment (Build 1.7)
• Version der Mobile Foundation, z. B. IBM Worklight Version 5.0.6 Developer Edition
• iOS-Version, z. B. iOS Simulator 6.1 oder iPhone 4S iOS 6.0 (nicht mehr verwendet; siehe “Veraltete Features und API-Elemente”)
• Android-Version, z. B. Android Emulator 4.1.1 oder Samsung Galaxy Android 4.0 API-Ebene 14
• Windows-Version, z. B. Windows 8, Windows 8.1 oder Windows Phone 8.1
• ADB-Version, z. B. Android Debug Bridge Version 1.0.31
• Protokolle wie Xcode-Ausgaben unter iOS oder logcat-Ausgaben unter Android

Versuchen Sie, das Problem zu isolieren

Führen Sie die folgenden Schritte aus, um das Problem zu isolieren und möglichst präzise zu melden.

1. Setzen Sie den Emulator (Android) oder Simulator (iOS) zurück und rufen Sie die API “destroy” auf, um mit einem bereinigten System zu beginnen.
2. Stellen Sie sicher, dass Sie in einer unterstützten Produktionsumgebung arbeiten.
   • Android >= 2.3-Emulator oder -Gerät (ARM v7 / ARM v8 / x86)
   • iOS >= 6.0-Simulator oder -Gerät (nicht weiter unterstützt)
   • Windows-8.1/10-Simulator oder -Gerät (ARM / x86 / x64)
3. Versuchen Sie, die Verschlüsselung zu inaktivieren, indem Sie kein Kennwort an die API “init” oder “open” übergeben.

4. Sehen Sie sich die von JSONStore generierte SQLite-Datenbankdatei an. Die Verschlüsselung muss inaktiviert sein.

   • Android-Emulator:

   $ adb shell
   $ cd /data/data/com.<App-Name>/databases/wljsonstore
   $ sqlite3 jsonstore.sqlite
   

   • iOS-Simulator:

   $ cd ~/Library/Application Support/iPhone Simulator/7.1/Applications/<ID>/Documents/wljsonstore
   $ sqlite3 jsonstore.sqlite
   

   • Windows-8.1-Universal- bzw. Windows-10-UWP-Simulator:

   $ cd C:\Users\<Benutzername>\AppData\Local\Packages\<ID>\LocalState\wljsonstore
   $ sqlite3 jsonstore.sqlite
   

   • Hinweis: Eine reine JavaScript-Implementierung, die in einem Web-Browser (Firefox, Chrome, Safari, Internet Explorer) ausgeführt wird, verwendet keine SQLite-Datenbank. Die Datei wird im lokalen HTML5-Speicher gespeichert.
   • Sehen Sie sich die Suchfelder (searchFields) mit .schema an und wählen Sie Daten mit SELECT * FROM <Sammlungsname>; aus. Geben Sie .exit ein, um sqlite3 zu beenden. Wenn Sie einen Benutzernamen an die Methode “init” übergeben, hat die Datei den Namen Benutzername.sqlite. Wenn Sie keinen Benutzernamen übergeben, hat die Datei standardmäßig die Bezeichnung jsonstore.sqlite.

5. Aktivieren Sie für JSONStore die Option “verbose” (nur Android).

   adb shell setprop log.tag.jsonstore-core VERBOSE
   adb shell getprop log.tag.jsonstore-core
   

6. Verwenden Sie den Debugger.

Allgemeine Probleme

Wenn Sie die folgenden JSONStore-Merkmale verstehen, können Sie einige allgemeine Probleme lösen, die auftreten könnten.

• Die einzige Möglichkeit, Binärdaten in JSONStore zu speichern, besteht darin, sie zuerst in Base64 zu codieren. Speichern Sie Dateinamen oder Pfade anstelle der tatsächlichen Dateien in JSONStore.
• Der Zugriff auf JSONStore-Daten von nativem Code azs ist nur in IBM Worklight Foundation Version 6.2.0 möglich.
• Es gibt abgesehen von der Begrenzung des Betriebssystems für mobile Geräte keine Begrenzung hinsichtlich der Datenmenge, die Sie in JSONStore speichern können.
• JSONStore ist ein persistenter Datenspeicher. Die Daten werden nicht nur im Speicher aufbewahrt.
• Die API “init” schlägt fehl, wenn der Sammlungsname mit einer Ziffer oder einem Symbol beginnt. IBM Worklight Version 5.0.6.1 und aktuellere Versionen geben einen entsprechenden Fehler zurück: 4 BAD\_PARAMETER\_EXPECTED\_ALPHANUMERIC\_STRING
• In Suchfeldern wird zwischen Zahlen vom Typ “number” und vom Typ “integer” unterschieden. Numerische Werte wie 1 und 2 werden als 1.0 und 2.0 gespeichert, wenn der Typ number ist. Sie werden als 1 und 2 gespeichert, wenn der Typ integer ist.
• Falls eine Anwendung gestoppt werden muss oder abstürzt, lautet der Fehlercode immer -1, wenn die Anwendung erneut gestartet wird und die API init oder open aufgerufen wird. Sollte dieses Problem auftreten, rufen Sie zuerst die API closeAll auf.
• Die JavaScript-Implementierung von JSONStore erwartet, dass Code seriell aufgerufen wird. Warten Sie, bis eine Operation beendet ist, bevor Sie die nächste Operation aufrufen.
• Transaktionen werden nicht in Android 2.3.x für Cordova-Anwendungen unterstützt.
• Wenn Sie JSONStore auf einem 64-Bit-Gerät verwenden, wird möglicherweise der folgende Fehler angezeigt: java.lang.UnsatisfiedLinkError: dlopen failed: "..." is 32-bit instead of 64-bit
• Dieser Fehler bedeutet, dass es in Ihrem Android-Projekt native 64-Bit-Bibliotheken gibt. JSONStore funktioniert momentan nicht, wenn Sie diese Bibliotheken verwenden. Navigieren Sie zur Bestätigung in Ihrem Android-Projekt zu src/main/libs oder src/main/jniLibs und überprüfen Sie, ob es einen Ordner x86_64 oder arm64-v8a gibt. Ist das der Fall, löschen Sie diese Ordner, damit JSONStore wieder funktioniert.

• In einigen Fällen (oder Umgebungen) wird im Ablauf wlCommonInit() eingegeben, bevor das JSONStore-Plug-in initialisiert wird. Dadurch scheitern JSONStore-bezogene API-Aufrufe. Das Bootprogramm cordova-plugin-mfp ruft automatisch WL.Client.init auf, wonach die Funktion wlCommonInit ausgelöst wird. Dieser Initialisierungsprozess unterscheidet sich für das JSONStore-Plug-in. Das JSONStore-Plug-in hat keine Möglichkeit, den Aufruf von WL.Client.init zu stoppen. In verschiedenen Umgebungen kann es vorkommen, dass im Ablauf wlCommonInit() eingegeben wird, bevor mfpjsonjslloaded abgeschlossen ist. Der Entwickler kann die richtige Reihenfolge von mfpjsonjsloaded und mfpjsloaded sicherstellen, indem er WL.CLient.init manuell aufruft. Dadurch entfällt die Notwendigkeit für plattformspezifischen Code.

  Führen Sie die folgenden Schritte aus, um den manuellen Aufruf von WL.CLient.init zu konfigurieren:

  1. Setuem Sie in der Datei config.xml die Eigenschaft clientCustomInit auf true.
  • Gehen Sie in der Datei index.js wie folgt vor:
    • Fügen Sie am Anfang der Datei die folgende Zeile hinzu:

      document.addEventListener('mfpjsonjsloaded', initWL, false);
      

    • Übernehmen Sie den Aufruf von WL.JSONStore.init in wlCommonInit().

    • Fügen Sie die folgende Funktion hinzu:
      ```javascript
      function initWL(){

var options = typeof wlInitOptions !== ‘undefined’ ? wlInitOptions : {};
WL.Client.init(options);
}

Auf diese Weise wird (außerhalb von 'wlCommonInit') auf das Ereignis `mfpjsonjsloaded` gewartet.
So wird sichergestellt, dass das Script geladen wurde und nachfolgend `WL.Client.init` aufruft, was wiederum `wlCommonInit` auslöst und dann `WL.JSONStore.init` aufruft.

## Store-Interna
{: #store-internals }
Es folgt ein Beispiel für die Speicherung von JSONStore-Daten.

Dieses vereinfachte Beispiel enthält folgende Schlüsselelemente:

* '_id' ist die eindeutige Kennung (z. B. AUTO INCREMENT PRIMARY KEY).
* 'json' enthält eine exakte Darstellung des zu speichernden JSON-Objekts.
* 'name' und 'age' sind Suchfelder.
* 'key' ist ein zusätzliches Suchfeld.

| _id | key | name | age | JSON |
|-----|-----|------|-----|------|
| 1   | c   | carlos | 99 | {name: 'carlos', age: 99} |
| 2   | t   | tim   | 100 | {name: 'tim', age: 100} |

Wenn Sie für die Suche eine der folgenden Abfragen oder eine Kombination dieser Abfragen verwenden: `{_id : 1}, {name: 'carlos'}`, `{age: 99}, {key: 'c'}`, wird das Dokument `{_id: 1, json: {name: 'carlos', age: 99} }` zurückgegeben.

Die übrigen internen JSONStore-Felder sind:

* `_dirty`: Bestimmt, ob das Dokument als vorläufig markiert wurde oder nicht. Dieses Feld ist nützlich, um Änderungen an den Dokumenten zu verfolgen.
* `_deleted`: Markiert, ob ein Dokument gelöscht wurde oder nicht. Dieses Feld ist nützlich, um Objekte aus der Sammlung zu entfernen, die später genutzt werden können, um mit Ihrem Back-End Änderungen zu verfolgen und zu entscheiden, ob diese entfernt werden sollen oder nicht.
* `_operation`: Zeichenfolge, die die letzte für das Dokument auszuführende Operation angibt (z. B. "replace").

## JSONStore-Fehler
{: #jsonstore-errors }
### JavaScript
{: #javascript }
JSONStore verwendet ein Fehlerobjekt, um Nachrichten zur Ursache von Fehlern zurückzugeben.

Wenn während einer JSONStore-Operation (z. B. in den Methoden `find` und `add` der Klasse `JSONStoreInstance`) ein Fehler auftritt, wird ein Fehlerobjekt zurückgegeben. Es stellt Informationen zur Ursache des Fehlers bereit.

```javascript
var errorObject = {
  src: 'find', // Fehlgeschlagene Operation
  err: -50, // Fehlercode
  msg: 'PERSISTENT\_STORE\_FAILURE', // Fehlernachricht
  col: 'people', // Sammlungsname
  usr: 'jsonstore', // Benutzername
  doc: {_id: 1, {name: 'carlos', age: 99}}, // Fehlerbezogenes Dokument
  res: {...} // Antwort vom Server
}

Nicht alle Schlüssel-Wert-Paare sind Teil jedes Fehlerobjekts. Der doc-Wert ist beispielsweise nur verfügbar, wenn die Operation wegen eines Dokuments fehlgeschlagen ist (z. B. wenn die Methode remove der Klasse JSONStoreInstance ein Dokument nicht entfernen konnte).

Objective-C

Alle APIs, die fehlschlagen können, verwenden einen Fehlerparameter mit der Adresse eines NSError-Objekts. Wenn Sie nicht über Fehler informiert werden möchten, können Sie nil übergeben. Wenn eine Operation fehlschlägt, wird als Adresse ein NSError mit einer Fehlerangabe und potenziell mit Benutzerinformationen (userInfo) angegeben. Die Benutzerinformationen können zusätzliche Details enthalten (z. B. das Dokument, das den Fehler verursacht hat).

// Dieser NSError zeigt auf einen Fehler, sobald ein solcher auftritt.
NSError* error = nil;



// Löschung durchführen
[JSONStore destroyDataAndReturnError:&error];

Java

Alle Java-API-Aufrufe lösen je nach aufgetretenem Fehler eine bestimmte Ausnahme aus. Sie können jede Ausnahme einzeln behandeln oder JSONStoreException als Umbrella für alle JSONStore-Ausnahmen abfangen.

try {
  WL.JSONStore.closeAll();
}

catch(JSONStoreException e) {
  // Fehlerbedingung behandeln
}

Liste der Fehlercodes

Es folgt eine Liste der allgemeinen Fehlercodes mit einer Beschreibung: