MobileFirst-Foundation-SDK zu Cordova-Anwendungen hinzufügen

improve this page | report issue

Übersicht

In diesem Lernprogramm erfahren Sie, wie das MobileFirst-SDK zu einer neuen oder vorhandenen Cordova-Anwendung, die mit Apache Cordova, Ionic oder einem anderen Tool eines anderen Anbieters erstellt wurde, hinzugefügt wird. Sie werden auch lernen, wie MobileFirst Server konfiguriert werden muss, um die Anwendung zu erkennen, Außerdem erfahren Sie, wie Sie Informationen zu den MobileFirst-Konfigurationsdateien, die im Projekt geändert werden, finden können.

Das MobileFirst-Cordova-SDK wird in Form von Cordova-Plug-ins bereitgestellt und in NPM registriert.
Folgende Plug-ins sind verfügbar:

  • cordova-plugin-mfp - zentrales SDK-Plug-in
  • cordova-plugin-mfp-push - Unterstützung für Push-Benachrichtigungen
  • cordova-plugin-mfp-jsonstore - Unterstützung für JSONStore
  • cordova-plugin-mfp-fips - Unterstützung für FIPS (nur Android)
  • cordova-plugin-mfp-encrypt-utils - Unterstützung für Ver- und Entschlüsselung (nur iOS)

Support-Level

Von den MobileFirst-Plug-ins werden folgende Cordova-Plattformversionen unterstützt:

  • cordova-ios: >= 4.1.1 und < 5.0
  • cordova-android: >= 6.1.2 und < 7.0
  • cordova-windows: >= 4.3.2 und < 6.0

Fahren Sie mit folgenden Abschnitten fort:

Hinweis: Die Funktion Keychain Sharing ist obligatorisch, wenn Sie Xcode 8 verwenden und iOS-Apps im iOS-Simulator ausführen. Sie müssen diese Funktion manuell aktivieren, bevor Sie das Xcode-Projekt erstellen.

Cordova-SDK-Komponenten

cordova-plugin-mfp

Das Plug-in cordova-plugin-mfp ist das zentrale MobileFirst-Plug-in für Cordova und ein erforderliches Plug-in. Wenn Sie eines der anderen MobileFirst-Plug-ins installieren, wird das Plug-in cordova-plugin-mfp automatisch mitinstalliert, sofern es noch nicht installiert ist.

Die folgenden Cordova-Plug-ins werden als Abhängigkeiten von cordova-plugin-mfp installiert:

  • cordova-plugin-device
  • cordova-plugin-dialogs
  • cordova-plugin-globalization
  • cordova-plugin-okhttp

cordova-plugin-mfp-jsonstore

Das Plug-in cordova-plugin-mfp-jsonstore ermöglicht Ihrer App die Verwendung von JSONstore. Weitere Informationen zu JSONStore enthält das Lernprogramm JSONStore.

cordova-plugin-mfp-push

Das Plug-in cordova-plugin-mfp-push stellt die Berechtigungen bereit, die für Android-Anwendungen erforderlich sind, um Push-Benachrichtigungen von MobileFirst Server erhalten zu können. Für die Verwendung von Push-Benachrichtigungen ist ein zusätzliches Setup erforderlich. Weitere Informationen zu Push-Benachrichtigungen enthält das Lernprogramm zu Push-Benachrichtigungen.

cordova-plugin-mfp-fips

Das Plug-in cordova-plugin-mfp-fips stellt FIPS-140-2-Unterstützung für die Android-Plattform bereit. Weitere Informationen enthält der Artikel Unterstützung für FIPS 140-2.

cordova-plugin-mfp-encrypt-utils

Das Plug-in cordova-plugin-mfp-encrypt-utils stellt iOS-OpenSSL-Frameworks für die Verschlüsselung von Cordova-Anwendungen auf der iOS-Plattform bereit. Weitere Informationen finden Sie unter OpenSSL für Cordova iOS aktivieren.

Voraussetzungen:

Mobile Foundation-Cordova-SDK hinzufügen

Folgen Sie den nachstehenden Anweisungen, um das Cordova-SDK der Mobile Foundation zu einem neuen oder vorhandenen Cordova-Projekt hinzuzufügen und bei MobileFirst Server zu registrieren.

Vergewissern Sie sich als Erstes, dass der MobileFirst Server aktiv ist.
Wenn Sie einen lokal installierten Server verwenden, navigieren Sie in einem Befehlszeilenfenster zum Serverordner und führen Sie den Befehl ./run.sh aus.

Hinweis: Wenn Sie das SDK zu einer vorhandenen Cordova-Anwendung hinzufügen, überschreibt das Plug-in die Datei MainActivity.java für Android und die Datei Main.m für iOS.

SDK hinzufügen

Sie können das Projekt mit der MobileFirst-Cordova-Anwendungsschablone erstellen. Die Schablone fügt die erforderlichen MobileFirst-spezifischen Plug-in-Einträge zur Datei config.xml des Cordova-Projekts hinzu und stellt eine einsatzbereite MobileFirst-spezifische Datei index.js bereit, die für die MobileFirst-Anwendungsentwicklung konzipiert ist.

Neue Anwendung

  1. Erstellen Sie mit folgendem Befehl ein Cordova-Projekt: cordova create projectName applicationId applicationName --template cordova-template-mfp.

Beispiel:

   cordova create Hello com.example.helloworld HelloWorld --template cordova-template-mfp
 - "Hello" ist der Ordnername der Anwendung. 
 - "com.example.helloworld" ist die ID der Anwendung. 
 - "HelloWorld" ist der Name der Anwendung. 
 - --template modifiziert die Anwendung mit MobileFirst-spezifischen Zusätzen.

> Mit der von der Schablone bereitgestellten Datei **index.js** können Sie zusätzliche MobileFirst-Features verwenden, z. B. die [Anwendungsübersetzung in mehrere Sprachen](../../translation) und Initialisierungsoptionen. (Weitere Informationen finden Sie in der Benutzerdokumentation.)
  1. Navigieren Sie mit cd hello zum Stammverzeichnis des Cordova-Projekts.

  2. Fügen Sie mindestens eine unterstützte Plattform zum Cordova-Projekt hinzu. Verwenden Sie dazu den CLI-Befehl cordova platform add ios|android|windows. Beispiel:

    cordova platform add ios
    

    Hinweis: Da die Anwendung mit der MobileFirst-Schablone konfiguriert wurde, wird das zentrale MobileFirst-Cordova-Plug-in in Schritt 3 automatisch hinzugefügt, wenn die Plattform hinzugefügt wird.

  3. Erstellen Sie die Anwendungsressourcen mit dem Befehl cordova prepare command:

    cordova prepare
    

Vorhandene Anwendung

  1. Navigieren Sie zum Stammverzeichnis Ihres vorhandenen Cordova-Projekts und fügen Sie das zentrale MobileFirst-Cordova-Plug-in hinzu:

    cordova plugin add cordova-plugin-mfp
    
  2. Navigieren Sie zum Ordner www\js und wählen Sie die Datei index.js aus.

  3. Fügen Sie die folgende Funktion hinzu:

    function wlCommonInit() {
    
    }
    

Die MobileFirst-API-Methoden sind nach dem Laden des MobileFirst-Client-SDK verfügbar Die Funktion wlCommonInit wird nach dem Laden aufgerufen.
Mit dieser Funktion können Sie die verschiedenen MobileFirst-API-Methoden aufrufen.

Anwendung registrieren

  1. Öffnen Sie ein Befehlszeilenfenster und navigieren Sie zum Stammverzeichnis des Cordova-Projekts.

  2. Registrieren Sie die Anwendung bei MobileFirst Server:

    mfpdev app register
    

Der CLI-Befehl mfpdev app register stellt zunächst eine Verbindung zu MobileFirst Server her, um die Anwendung zu registrieren. Anschließend wird die Datei config.xml im Stammverzeichnis des Cordova-Projekts mit Metadaten aktualisiert, die den MobileFirst Server angeben.

Jede Plattform wird in MobileFirst Server als Anwendung registriert.

Tipp: Sie können Anwendungen auch über die MobileFirst Operations Console registrieren:

  1. Laden Sie die MobileFirst Operations Console.
  2. Klicken Sie neben Anwendungen auf die Schaltfläche Neu, um eine neue Anwendung zu registrieren. Folgen Sie den angezeigten Anweisungen.

SDK verwenden

Die MobileFirst-API-Methoden sind nach dem Laden des MobileFirst-Client-SDK verfügbar Die Funktion wlCommonInit wird nach dem Laden aufgerufen.
Mit dieser Funktion können Sie die verschiedenen MobileFirst-API-Methoden aufrufen.

MobileFirst-Cordova-SDK aktualisieren

Wenn Sie das MobileFirst-Cordova-SDK auf den neuesten Releasestand bringen möchten, entfernen Sie das Plug-in cordova-plugin-mfp. Führen Sie dazu den Befehl cordova plugin remove cordova-plugin-mfp aus. Führen Sie dann den Befehl cordova plugin add cordova-plugin-mfp aus, um das Plug-in wieder hinzuzufügen.

SDK-Releases sind im NPM-Repository für das jeweilige SDK enthalten.

Generierte Artefakte des MobileFirst-Cordova-SDK

config.xml

Die Cordova-Konfigurationsdatei ist eine obligatorische XML-Datei, die Anwendungsmetadaten enthält und im Stammverzeichnis der App gespeichert wird.
Wenn das MobileFirst-Cordova-SDK zum Projekt hinzugefügt wurde, empfängt die von Cordova generierte Datei config.xml neue Elemente, die über den Namespace mfp: identifiziert werden können. Die hinzugefügten Elemente enthalten Informtionen zu MobileFirst-Features und zu MobileFirst Server.

Beispiel für zur Datei config.xml hinzugefügte MobileFirst-Einstellungen

<?xml version='1.0'encoding='utf-8'?>
<widget id="..." xmlns:mfp="http://www.ibm.com/mobilefirst/cordova-plugin-mfp">
    <mfp:android>
        <mfp:sdkChecksum>3563350808</mfp:sdkChecksum>
        <mfp:appChecksum>0</mfp:appChecksum>
        <mfp:security>
            <mfp:testWebResourcesChecksum enabled="false" ignoreFileExtensions="png, jpg, jpeg, gif, mp4, mp3" />
        </mfp:security>
    </mfp:android>
    <mfp:windows>
        <mfp:sdkChecksum>3563350808</mfp:sdkChecksum>
       <mfp:windows10>
          <mfp:sdkChecksum>...</mfp:sdkChecksum>          
          <mfp:security>
             <mfp:testWebResourcesChecksum/>
          </mfp:security>
    </mfp:windows>
    <mfp:platformVersion>8.0.0.00-20151214-1255</mfp:platformVersion>
    <mfp:clientCustomInit enabled="false" />
    <mfp:server runtime="mfp" url="http://10.0.0.1:9080" />
    <mfp:directUpdateAuthenticityPublicKey>the-key</mfp:directUpdateAuthenticityPublicKey>
    <mfp:languagePreferences>en</mfp:languagePreferences>
</widget>
Element Beschreibung Konfiguration
widget Stammelement des Dokuments config.xml. Das Element enthält zwei erforderliche Attribute:
  • id: Dies ist der Anwendungspaketname, der angegeben wurde, als das Cordova-Projekt erstellt wurde. Wenn dieser Wert nach der Registrierung der Anwendung bei MobileFirst Server manuell geändert wird, muss die Anwendung erneut registriert werden.
  • xmlns:mfp: Dies ist der XML-Namespace des MobileFirst-Plug-ins.
mfp:platformVersion Erforderlich. Produktversion, mit der die Anwendung entwickelt wurde Standardmäßig festgelegt; darf nicht geändert werden
mfp:directUpdateAuthenticityPublicKey Optional; wenn Sie das Feature für die Authentizität direkter Aktualisierungen aktivieren, wird das Paket für direkte Aktualisierung während der Implementierung digital signiert. Nachdem der Client das Paket heruntergeladen hat, wird eine Sicherheitsüberprüfung ausgeführt, um die Paketauthentizität zu validieren. Dieser Zeichenfolgewert ist der öffentliche Schlüssel, mit dem die ZIP-Datei für die direkte Aktualisierung authentifiziert wird. Wird mit dem Befehl mfpdev app config direct_update_authenticity_public_key Schlüsselwert festgelegt
mfp:languagePreferences Optional; enthält eine Liste mit Ländereinstellungen für die Anzeige von Systemnachrichten. Die einzelnen Einträge sind jeweils durch ein Komma getrennt. Wird mit dem Befehl mfpdev app config language_preferences Schlüsselwert festgelegt
mfp:clientCustomInit Steuert, wie die Methode WL.Client.init aufgerufen wird. Standardmäßig ist dieses Attribut auf den Wert "false" gesetzt, sodass die Methode WL.Client.init automatisch aufgerufen wird, sobald das MobileFirst-Plug-in initialisiert ist. Setzen Sie dieses Attribut auf den Wert true, wenn der Clientcode explizit steuern soll, wann WL.Client.init aufgerufen wird. Wird manuell bearbeitet; Sie können das Attribut enabled auf den Wert true oder false setzen.
mfp:server Verbindungsinformationen für die Verbindung zum fernen Server, die der Client standardmäßig für die Kommunikation mit MobileFirst Server verwendet
  • url: Der Wert für url gibt das Protokoll-, Host- und Portwert für MobileFirst Server an. Der Client verwendet diese Werte standardmäßig für die Verbindung zum Server.
  • runtime: Der Wert für runtime gibt die MobileFirst-Server-Laufzeit an, in der die Anwendung registriert wurde. Weitere Informationen zur MobileFirst-Laufzeit finden Sie in der Übersicht über MobileFirst Server.
  • Der Serverwert für url wird mit dem Befehl mfpdev app config server festgelegt.
  • Der Serverwert für runtime wird mit dem Befehl mfpdev app config runtime festgelegt.
mfp:ios Dieses Element enthält die gesamte, MobileFirst-bezogene Clientanwendungskonfiguration für die iOS-Plattform.
  • mfp:appChecksum
  • mfp:sdkChecksum
  • mfp:security
mfp:android Dieses Element enthält die gesamte, MobileFirst-bezogene Clientanwendungskonfiguration für die Android-Plattform.
  • mfp:appChecksum
  • mfp:sdkChecksum
  • mfp:security
mfp:windows Dieses Element enthält die gesamte, MobileFirst-bezogene Clientanwendungskonfiguration für die Windows-Plattform.
  • mfp:appChecksum
  • mfp:windowsphone8
  • mfp:windows8
  • mfp:windows10
mfp:windows8 Dieses Element enthält die gesamte, MobileFirst-bezogene Clientanwendungskonfiguration für die Windows-8.1-Plattform.
  • mfp:sdkChecksum
  • mfp:security
mfp:windows10 Dieses Element enthält die gesamte, MobileFirst-bezogene Clientanwendungskonfiguration für die Windows-10-Plattform.
  • mfp:sdkChecksum
  • mfp:security
mfp:windowsphone8 Dieses Element enthält die gesamte, MobileFirst-bezogene Clientanwendungskonfiguration für die Windows-Phone-8.1-Plattform.
  • mfp:sdkChecksum
  • mfp:security
mfp:appChecksum Dieser Wert ist die Kontrollsumme der Anwendungswebressourcen. Er wird bei Ausführung von mfpdev app webupdate berechnet. Kann nicht vom Benutzer konfiguiert werden; der Kontrollsummenwert wird bei Ausführung des Befehls mfpdev app webupdate aktualisiert. Wenn Sie weitere Informationen zum Befehl mfpdev app webupdate benötigen, geben Sie im Befehlsfenster mfpdev help app webupdate ein.
mfp:sdkChecksum Dieser Wert ist die Kontrollsumme des IBM MobileFirst-Platform-SDK, über die der eindeutige Level des MobileFirst-SDK identifiziert wird. Kenn nicht vom Benutzer konfiguriert werden; standardmäßig festgelegter Wert
mfp:security Dieses Element enthält die plattformspezifische Konfiguration der Clientanwendung für die MobileFirst-Sicherheit. Enthält
  • mfp:testWebResourcesChecksum
mfp:testWebResourcesChecksum Steuert, ob die Anwendung die Integrität ihrer Webressourcen bei jedem Start auf dem mobilen Gerät überprüft. Attribute:
  • enabled: Gültige Werte sind true und false. Wenn dieses Attribut auf true gesetzt ist, berechnet die Anwendung die Kontrollsumme ihrer Webressourcen und vergleicht diese Kontrollsumme mit einem Wert, der bei der ersten Ausführung der Anwendung gespeichert wurde.
  • ignoreFileExtensions: Die Kontrollsummenberechnung hängt von der Größe der Webressourcen ab und kann einige Sekunden dauern. Sie können die Berechnung beschleunigen, indem Sie eine Liste mit Dateierweiterungen angeben, die bei der Berechnung ignoriert werden können. Dieser Wert wird ignoriert, wenn das Attribut enabled auf den Wert false gesetzt ist.
  • Das Attribut enabled wird mit dem Befehl mfpdev app config android_security_test_web_resources_checksum Schlüsselwert festgelegt.
  • Das Attribut ignoreFileExtensions wird mit dem Befehl mfpdev app config android_security_ignore_file_extensions Wert festgelegt.

MobileFirst-Einstellungen in der Datei config.xml bearbeiten

Sie können die MobileFirst CLI verwenden, um mit folgendem Befehl die obigen Einstellungen zu bearbeiten:

mfpdev app config

Nächste Lernprogramme

Jetzt, da das MobileFirst-Cordova-SDK integriert ist, können Sie Folgendes tun:

Last modified on July 03, 2017