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

improve this page | report issue

Übersicht

Das SDK der IBM Mobile Foundation besteht aus einer Reihe von Abhängigkeiten, die über Maven Central verfügbar sind und zu einem Android-Studio-Projekt hinzugefügt werden können. Die Abhängigkeiten entsprechen Kernfunktionen und anderen Funktionen:

  • IBMMobileFirstPlatformFoundation - Implementiert Client-Server-Konnektivität, handhabt Authentifizierungs- und Sicherheitsaspekte, Ressourcenanforderungen und weitere erforderliche Kernfunktionen
  • IBMMobileFirstPlatformFoundationJSONStore - Enthält das JSONStore-Framework. Weitere Informationen enthält das Lernprogramm JSONStore für Android.
  • IBMMobileFirstPlatformFoundationPush - Enthält das Framework für Push-Benachrichtigungen. Weitere Informationen enthalten die Lernprogramme zu Benachrichtigungen.

In diesem Lernprogramm erfahren Sie, wie das native MobileFirst-SDK mithilfe von Gradle zu einer neuen oder vorhandenen Android-Anwendung 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 zum Projekt hinzugefügt werden, finden können.

Voraussetzungen:

Fahren Sie mit folgenden Abschnitten fort:

Natives MobileFirst-SDK hinzufügen

Folgen Sie den nachstehenden Anweisungen, um das native MobileFirst-SDK zu einem neuen oder vorhandenen Android-Studio-Projekt hinzuzufügen und die Anwendung bei der MobileFirst-Server-Instanz zu registrieren.

Vergewissern Sie sich als Erstes, dass 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 für ein Mac- oder Linux-Betriebssystem bzw. run.cmd für Windows aus.

Android-Anwendung erstellen

Erstellen Sie ein Android-Studio-Projekt oder verwenden Sie ein vorhandenes Projekt.

SDK hinzufügen

  1. Wählen Sie unter Android → Gradle Scripts die Datei build.gradle (Module: app) aus.

  2. Fügen Sie unter apply plugin: 'com.android.application' die folgenden Zeilen hinzu:

    repositories{
         jcenter()
    }
    
  3. Fügen Sie im Abschnitt android die folgende Zeile hinzu:

    packagingOptions {
         pickFirst 'META-INF/ASL2.0'
         pickFirst 'META-INF/LICENSE'
         pickFirst 'META-INF/NOTICE'
    }
    
  4. Fügen Sie im Abschnitt dependencies die folgenden Zeilen hinzu:

    implementation group: 'com.ibm.mobile.foundation',
    name: 'ibmmobilefirstplatformfoundation',
    version: '8.0.+',
    ext: 'aar',
    transitive: true
    

    Oder in einer einzelnen Zeile:

    implementation 'com.ibm.mobile.foundation:ibmmobilefirstplatformfoundation:8.0.+'
    

    Hinweis: Wenn Sie das Feature Google Dynamic Delivery verwenden und MobileFirst-APIs von einem Zusatzmodul aus aufrufen möchten, verwenden Sie die api-Deklaration anstelle von implementation. Wenn Sie implementation verwenden, ist die Nutzung von MobileFirst-APIs auf dasselbe Modul beschränkt. Bei Verwendung von api werden die MobileFirst-APIs dagegen für alle in der App vorhandenen Module verfügbar gemacht. Dies gilt auch für Zusatzmodule. Weitere Details finden Sie unter API and implementation separation.

   api 'com.ibm.mobile.foundation:ibmmobilefirstplatformfoundation:8.0.+'
  1. Öffnen Sie unter Android → app → manifests die Datei AndroidManifest.xml. Fügen Sie Folgendes über dem Element application hinzu:

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
    
  2. Fügen Sie die MobileFirst-Benutzerschnittstellenaktivität neben dem vorhandenen Element activity hinzu:

    <activity android:name="com.worklight.wlclient.ui.UIActivity" />
    

Wenn eine Gradle-Synchronisationsaufforderung angezeigt wird, stimmen Sie zu.

Natives MobileFirst-SDK manuell hinzufügen

Sie können das SDK der MobileFirst auch manuell hinzufügen:

Wenn Sie das MobileFirst-SDK manuell hinzufügen möchten, müssen Sie zunächst über das Download-Center der MobileFirst Operations Console die SDK-ZIP-Datei auf der Registerkarte SDKs herunterladen. Wenn Sie die obigen Schritte ausgeführt haben, gehen Sie wie nachfolgend beschrieben vor.

  • Entpacken Sie die heruntergeladene ZIP-Datei und stellen Sie die relevanten aar-Dateien in den Ordner app\libs.
  • Fügen Sie am Ende von dependencies Folgendes hinzu:
    compile(name:'ibmmobilefirstplatformfoundation', ext:'aar')
    compile 'com.squareup.okhttp3:okhttp-urlconnection:3.4.1'   
    compile 'com.squareup.okhttp3:okhttp:3.4.1'
  • Fügen Sie am Ende von repositories Folgendes hinzu:
    repositories {
        flatDir {
            dirs 'libs'
        }
    }

Anwendung registrieren

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

  2. Führen Sie den folgenden Befehl aus:

     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 mfpclient.properties im Ordner [Projektstammverzeichnis]/app/src/main/assets/ des Android-Studio-Projekts generiert. Zu der Datei werden Metadaten hinzugefügt, die den MobileFirst Server angeben.

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.
  3. Navigieren Sie nach der Anwendungsregistrierung zum Anwendungsregister Konfigurationsdateien und kopieren Sie die Datei mfpclient.properties laden Sie diese Datei herunter. Folgen Sie den angezeigten Anweisungen, um die entsprechende Datei zu Ihrem Projekt hinzuzufügen.

WLClient-Instanz erstellen

Erstellen Sie eine WLClient-Instanz, bevor Sie MobileFirst-APIs verwenden.

WLClient.createInstance(this);

Hinweis: Eine WLClient-Instanz sollte im gesamten Anwendungslebenszyklus nur einmal erstellt werden. Es wird empfohlen, dafür die Android-Application-Klasse zu verwenden.

Natives MobileFirst-SDK aktualisieren

Wenn Sie das native MobileFirst-SDK auf den neuesten Releasestand bringen möchten, suchen Sie die neueste Releaseversion und aktualisieren Sie die Eigenschaft version in der Datei build.gradle entsprechend.
(Vergleichen Sie dazu oben Schritt 4.)

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

Generierte Artefakte des nativen MobileFirst-SDK

mfpclient.properties

Diese Datei befindet sich im Ordner ./app/src/main/assets/ des Android-Studio-Projekts. Sie enthält die clientseitigen Eigenschaften für die Registrierung Ihrer Android-App bei MobileFirst Server.

Eigenschaft Beschreibung Beispielwerte
wlServerProtocol Protokoll für die Kommunikation mit MobileFirst Server http oder https
wlServerHost Hostname von MobileFirst Server 192.168.1.63
wlServerPort Port von MobileFirst Server 9080
wlServerContext Kontextstammverzeichnis der Anwendung auf dem MobileFirst Server /mfp/
languagePreferences Legt die Standardsprache für Client-SDK-Systemnachrichten fest en

Unterstützung für Javadoc und den Android-Service

Informationen zur Unterstützung für Javadoc und den Android-Service finden Sie auf der Seite Zusätzliche Informationen.

Nächste Lernprogramme

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

Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on February 27, 2020