Erste Schritte mit iOS

Das App Center SDK verwendet eine modulare Architektur, sodass Sie einen oder alle Dienste verwenden können.

Informationen zu den vom App Center gesammelten Daten finden Sie unter Von App Center SDKs erfasste Daten, allgemeine Datenschutzbestimmungen und häufig gestellte Fragen . Außerdem enthält FAQ die Antworten, die Sie für App Store Datenschutzkonfiguration bereitstellen müssen.

Beginnen wir mit dem Einrichten des App Center iOS SDK in Ihrer App für die Verwendung von App Center Analytics und App Center-Absturz. Wenn Sie Ihrer App App Center Distribute hinzufügen möchten, sehen Sie sich die Dokumentation für App Center Distribute an.

1. Voraussetzungen

Für die Verwendung des App Center SDK müssen die folgenden Anforderungen erfüllt sein:

  • Ihr iOS-Projekt ist in Xcode 13 oder höher unter macOS Version 10.14.4 oder höher eingerichtet.
  • Sie zielen auf Geräte ab ios 11.0 ab.
  • Sie verwenden keine andere Bibliothek, die Absturzberichterstattungsfunktionen bereitstellt (nur für App Center-Abstürze).
  • Wenn Sie CocoaPods zur Integration von App Center verwenden, benötigen Sie CocoaPods Version 1.10 oder höher.

App Center SDK Analytics und Abstürze sind über XCFramework oder SwiftPM mit Mac Catalyst kompatibel.

2. Erstellen Sie Ihre App im App Center-Portal, um das App-Geheimnis abzurufen.

Wenn Sie Ihre App bereits im App Center-Portal erstellt haben, können Sie diesen Schritt überspringen.

  1. Wechseln Sie zu appcenter.ms.
  2. Melden Sie sich an oder melden Sie sich an, und klicken Sie auf die blaue Schaltfläche in der oberen rechten Ecke des Portals mit der Bezeichnung Neu hinzufügen , und wählen Sie im Dropdownmenü Die Option Neue App hinzufügen aus.
  3. Geben Sie einen Namen und eine optionale Beschreibung für Ihre App ein.
  4. Wählen Sie iOS als Betriebssystem und Objective-C/Swift als Plattform aus.
  5. Klicken Sie auf die Schaltfläche unten rechts mit der Bezeichnung Neue App hinzufügen.

Nachdem Sie eine App erstellt haben, können Sie ihr App-Geheimnis auf der Seite Einstellungen im App Center-Portal abrufen. Klicken Sie oben rechts auf der Seite Einstellungen auf die dreifachen vertikalen Punkte , und wählen Sie aus Copy app secret , um Ihr App-Geheimnis abzurufen.

3. Hinzufügen der App Center SDK-Module

Das App Center SDK für iOS kann Ihrer App über Cocoapods, Carthage, Swift Package Manager oder durch manuelles Hinzufügen der Binärdateien zu Ihrem Projekt hinzugefügt werden.

Hinweis

In der 4.0.0 Version von App Center wurden breaking changes eingeführt. Folgen Sie dem Abschnitt Migrieren zu App Center SDK 4.0.0 und höher , um App Center von früheren Versionen zu migrieren.

3.1 Integration über Cocoapods

Hinweis

ARM64-Simulatoren (wenn sie mit Xcode gestartet werden, die auf Apple Silicon Mac ausgeführt werden) werden nicht über CocoaPods unterstützt. Erwägen Sie, andere Integrationsmethoden zu verwenden, damit dies funktioniert.

  1. Fügen Sie Ihnen die folgenden Abhängigkeiten hinzu, podfile um App Center Analytics und App Center-Abstürze in Ihre App einzuschließen. Mit dieser Aktion werden die folgenden Frameworks abgerufen: AppCenter, AppCenterAnalytics und AppCenterCrashes. Stattdessen können Sie die gewünschten Dienste in Ihrer App angeben. Jeder Dienst verfügt über eine eigene Subspec, und alle sind auf AppCenter angewiesen. Es wird automatisch abgerufen.

     # Use the following line to use App Center Analytics and Crashes.x
     pod 'AppCenter'
    
     # Use the following lines if you want to specify which service you want to use.
     pod 'AppCenter/Analytics'
     pod 'AppCenter/Crashes'
     pod 'AppCenter/Distribute'
    
  2. Führen Sie aus pod install , um Ihren neu definierten Pod zu installieren und das Projekt zu .xcworkspaceöffnen.

Hinweis

Wenn beim Ausführen pod installein Fehler wie angezeigt [!] Unable to find a specification for `AppCenter` wird, führen Sie auspod repo update, um die neuesten Pods aus dem Cocoapods-Repository abzurufen, und führen Sie dann auspod install.

Nachdem Sie nun die Frameworks in Ihre Anwendung integriert haben, ist es an der Zeit, das SDK zu starten und die App Center-Dienste zu nutzen.

3.2 Integration über Karthage

Im Folgenden finden Sie die Schritte zum Integrieren des App Center SDK in Ihr Xcode-Projekt mit Carthage Version 0.30 oder höher, einem dezentralen Abhängigkeits-Manager, der Ihre Abhängigkeiten erstellt und Ihnen binäre Frameworks bereitstellt.

Hinweis

Die Carthage-Integration funktioniert in Xcode 12 nicht sofort einsatzbereit. Damit es funktioniert, lesen Sie diese Karthage-Anweisung.

  1. Fügen Sie Ihnen die folgenden Abhängigkeiten hinzu, um Cartfile App Center einzuschließen. Diese Abhängigkeiten ziehen alle Frameworks ein. Dann können Sie nur die Frameworks verknüpfen, die Sie in Ihrer App verwenden möchten.

    # Use the following line to get the latest version of App Center
    github "microsoft/appcenter-sdk-apple"
    
    # Use the following line to get the specific version of App Center
    github "microsoft/appcenter-sdk-apple" ~> X.X.X
    
  2. Führen Sie aus carthage update , um Abhängigkeiten in einen Ordner Carthage/Checkouts abzurufen. Erstellen Sie dann jedes Framework.

  3. Öffnen Sie die Registerkarte Allgemeine Einstellungen Ihres Anwendungsziels. Ziehen Sie die Dateien AppCenter.framework, AppCenterAnalytics.framework und AppCenterCrashes.framework aus dem Ordner Carthage/Build/iOS in den Project Navigator von Xcode. Das AppCenter.framework ist erforderlich, um das SDK zu starten. Wenn sie dem Projekt nicht hinzugefügt wird, funktionieren die anderen Module nicht, und Ihre App wird nicht kompiliert.

  4. Es wird ein Dialogfeld angezeigt, in dem Ihr App-Ziel aktiviert ist. Klicken Sie auf Fertig stellen.

    Hinweis

    Wenn Sie in Ihrer Buildphase verwendencarthage copy-frameworks, sollten Sie die App Center-SDKs dort nicht hinzufügen, da sie als statische Frameworks ausgeliefert werden.

Nachdem Sie nun die Frameworks in Ihre Anwendung integriert haben, ist es an der Zeit, das SDK zu starten und die App Center-Dienste zu nutzen.

3.3 Integration über Swift Package Manager

  1. Klicken Sie im Xcode-Menü auf Datei > Swift-Pakete > Paketabhängigkeit hinzufügen.
  2. Geben Sie im daraufhin angezeigten Dialogfeld die Repository-URL ein: https://github.com/microsoft/appcenter-sdk-apple.git.
  3. Wählen Sie in Versiondie Option Up to Next Major (Weiter Haupt) aus, und wählen Sie die Standardoption aus.
  4. Wählen Sie die benötigten Module in der Spalte Paketprodukt aus .

Nachdem Sie nun die Frameworks in Ihre Anwendung integriert haben, ist es an der Zeit, das SDK zu starten und die App Center-Dienste zu nutzen.

Hinweis

Wenn Sie App Center über SwiftPM integrieren und es auch im Erweiterungsziel Ihrer App verwenden möchten, stellen Sie sicher, dass Sie in Ihrer Konfiguration angeben DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES . Dies ist erforderlich, um SwiftPM-Einschränkungen beim Verknüpfen eines Moduls mit mehreren Zielen zu vermeiden.

3.4 Integration durch Kopieren der Binärdateien in Ihr Projekt

Im Folgenden finden Sie die Schritte zum Integrieren der kompilierten Binärdateien in Ihr Xcode-Projekt, um App Center Analytics und App Center Crashes für Ihre iOS-App einzurichten.

Hinweis

App Center SDK unterstützt die Verwendung von XCframework. Wenn Sie XCframeworks in Ihr Projekt integrieren möchten, laden Sie die AppCenter-SDK-Apple-XCFramework.zip von der Releaseseite herunter, und entzippen Sie sie. Der resultierende Ordnerinhalt ist nicht plattformspezifisch, sondern enthält XCframeworks für jedes Modul. Sie können auf die gleiche Weise wie übliche Frameworks integriert werden, wie unten beschrieben.

  1. Laden Sie die App Center SDK-Frameworks herunter, die als ZIP-Datei bereitgestellt werden.

  2. Entzippen Sie die Datei, und Sie sehen einen Ordner namens AppCenter-SDK-Apple , der verschiedene Frameworks für jeden App Center-Dienst auf jedem Plattformordner enthält. Das Framework namens AppCenter ist im Projekt erforderlich, da es Code enthält, der von den verschiedenen Modulen gemeinsam genutzt wird.

  3. [Optional] Erstellen Sie ein Unterverzeichnis für Drittanbieterbibliotheken.

    • Als bewährte Methode befinden sich Drittanbieterbibliotheken in der Regel in einem Unterverzeichnis, das häufig als Vendor bezeichnet wird. Wenn das Projekt nicht mit einem Unterverzeichnis für Bibliotheken organisiert ist, erstellen Sie jetzt ein Unterverzeichnis Vendor .
    • Erstellen Sie eine Gruppe namens Vendor in Ihrem Xcode-Projekt, um Ihre Dateistruktur auf dem Datenträger nachzuahmen.
  4. Öffnen Sie den entzippten Ordner AppCenter-SDK-Apple im Finder, und kopieren Sie den Ordner in den Ordner Ihres Projekts an dem gewünschten Speicherort. Der Ordner enthält Frameworks in Unterordnern für andere Plattformen, die das App Center SDK unterstützt. Daher müssen Sie unter Umständen nicht benötigte Unterordner löschen.

  5. Fügen Sie dem Projekt in Xcode die SDK-Frameworks hinzu:

    • Stellen Sie sicher, dass der Project Navigator sichtbar ist (-+1).
    • Ziehen Sie & nun AppCenter.framework, AppCenterAnalytics.framework und AppCenterCrashes.framework aus dem Finder (an der Position aus dem vorherigen Schritt) in den Project Navigator von Xcode. Das AppCenter.framework ist erforderlich, um das SDK zu starten. Wenn sie dem Projekt nicht hinzugefügt wird, funktionieren die anderen Module nicht, und Ihre App wird nicht kompiliert.
    • Es wird ein Dialogfeld angezeigt, in dem Sie sicherstellen, dass Ihr App-Ziel aktiviert ist. Klicken Sie auf Fertig stellen.

Nachdem Sie die Frameworks in Ihre Anwendung integriert haben, ist es an der Zeit, das SDK zu starten und die App Center-Dienste zu nutzen.

4. Starten des SDK

Um App Center zu verwenden, wählen Sie die Module aus, die Sie verwenden möchten. Standardmäßig werden keine Module gestartet, und Sie müssen jedes modul beim Starten des SDK aufrufen.

Die folgenden Anweisungen unterscheiden sich geringfügig, je nachdem, welchen Lebenszyklus Sie verwenden. Ab Xcode 12 können Sie einen von zwei Lebenszyklen auswählen: "Swift UI App" (standardmäßig in Xcode 12 ausgewählt) und "UI Kit AppDelegate". Wenn Sie für eine Erweiterung entwickeln, lesen Sie die Seite Erste Schritte mit der Erweiterung.

4.1 Hinzufügen der Importanweisungen

Öffnen Sie die AppDelegate-Datei des Projekts (für den AppDelegate-Lebenszyklus des UI Kit) oder <die Datei ProjectName>App.swift (für Swift UI App Lifecycle), und fügen Sie die folgenden Importanweisungen hinzu:

@import AppCenter;
@import AppCenterAnalytics;
@import AppCenterCrashes;
import AppCenter
import AppCenterAnalytics
import AppCenterCrashes

4.2 Hinzufügen der start:withServices: -Methode

UI Kit AppDelegate

Fügen Sie Initialisierungscode zur didFinishLaunchingWithOptions Delegatmethode hinzu.

Schneller Benutzeroberflächen-App-Lebenszyklus

Erstellen Sie init() eine Methode, struct und fügen Sie darin Initialisierungscode hinzu.

Verwenden Sie diesen Code in den zuvor beschriebenen Methoden, um das SDK zu starten:

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];
AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self, Crashes.self])

Wenn Sie über eine Catalyst-Anwendung verfügen, können Sie App-Geheimnisse für iOS und macOS gleichzeitig übergeben:

[MSACAppCenter start:@"ios={Your iOS App Secret};macos={Your macOS App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];
AppCenter.start(withAppSecret:"ios={Your iOS App Secret};macos={Your macOS App Secret}", services: [Analytics.self, Crashes.self])

Warnung

Es wird nicht empfohlen, Ihr App-Geheimnis in den Quellcode einzubetten.

Wenn Sie App Center-Dienste separat starten müssen, sollten Sie:

  1. Konfigurieren oder starten Sie sie mit dem App-Geheimnis.
  2. Wenn der Code mehrmals aufgerufen werden kann, überprüfen Sie, ob das App Center bereits konfiguriert ist.
  3. Starten Sie die erforderlichen Dienste ohne das App-Geheimnis.
[MSACAppCenter configureWithAppSecret:@"{Your App Secret}"];
if ([MSACAppCenter isConfigured]) {
   [MSACAppCenter startService:[MSACAnalytics class]];
   [MSACAppCenter startService:[MSACCrashes class]];
}
AppCenter.configure(withAppSecret: "{Your App Secret}")
if AppCenter.isConfigured {
    AppCenter.startService(Analytics.self)
    AppCenter.startService(Crashes.self)
}

4.3 Ersetzen Sie den Platzhalter durch Ihr App-Geheimnis.

Stellen Sie sicher, dass Text durch den tatsächlichen Wert für Ihre Anwendung ersetzt {Your App Secret} wird. Das App-Geheimnis finden Sie auf der Seite Erste Schritte oder auf der Seite Einstellungen im App Center-Portal.

Die Seite Erste Schritte enthält das obige Codebeispiel mit Ihrem App-Geheimnis. Sie können das gesamte Beispiel kopieren und einfügen.

Im obigen Beispiel wird gezeigt, wie Sie die start:withServices -Methode (start(withAppSecret:services:) für Swift) verwenden und sowohl App Center Analytics als auch App Center-Abstürze einschließen.

Wenn Sie keinen der beiden Dienste verwenden möchten, entfernen Sie den entsprechenden Parameter aus dem obigen Methodenaufruf.

Wenn Sie jedes Modul nicht explizit als Parameter in der start-Methode angeben, können Sie diesen App Center-Dienst nicht verwenden. Außerdem kann die start:withServices API (start(withAppSecret:services:) für Swift) nur einmal im Lebenszyklus Ihrer App verwendet werden. Alle anderen Aufrufe protokollieren eine Warnung in der Konsole, und nur die module, die im ersten Aufruf enthalten sind, sind verfügbar.

Beispiel: Wenn Sie das Onboarding in App Center Analytics durchführen möchten, sollten Sie den start:withServices API-Aufruf (start(withAppSecret:services:) für Swift) wie folgt ändern:

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class]]];
AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self])

Großartig, Sie sind alle bereit, Analyse- und Absturzdaten im Portal zu visualisieren, die das SDK automatisch erfasst.

Sehen Sie sich die Dokumentation zu App Center Analytics und App Center Crashes an, um zu erfahren, wie Sie erweiterte Funktionen beider Dienste anpassen und verwenden.

Informationen zu den ersten Schritten mit In-App-Updates finden Sie in der Dokumentation von App Center Distribute.