Erste Schritte mit macOS-Erweiterungen

Wichtig

Visual Studio App Center wird am 31. März 2025 eingestellt. Sie können Visual Studio App Center zwar weiterhin verwenden, bis es vollständig eingestellt ist, es gibt jedoch mehrere empfohlene Alternativen, zu denen Sie eine Migration in Betracht ziehen können.

Erfahren Sie mehr über Supportzeitpläne und Alternativen.

• Android
• iOS
• iOS-Erweiterungen
• React Native
• MAUI/Xamarin
• UWP
• WPF/WinForms
• Unity
• macOS
• macOS-Erweiterungen
• tvOS
• Cordova

Erweiterungen unterstützen nur Absturzberichte.

Informationen zum Hinzufügen des App Center SDK zu Ihrer Container-App finden Sie in der Dokumentation für app Center macOS Erste Schritte.

Beginnen wir mit dem Einrichten des App Center macOS SDK in Ihrer App-Erweiterung, um App Center-Abstürze zu verwenden.

1. Voraussetzungen

Die folgenden Anforderungen müssen erfüllt sein, um das App Center SDK verwenden zu können:

• Ihr macOS-Projekt ist in Xcode 13 oder höher unter macOS Version 10.14.4 oder höher eingerichtet.
• Sie zielen auf Geräte ab macOS 10.13 ab.
• Sie verwenden keine andere Bibliothek, die Absturzberichterstattungsfunktionen bereitstellt.

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

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

1. Wechseln Sie zu appcenter.ms.
2. Registrieren Sie sich, oder melden Sie sich an, und klicken Sie auf die blaue Schaltfläche in der oberen rechten Ecke des Portals mit dem Namen 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 macOS 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.

Hinweis

Die Verwendung eines vorhandenen App-Geheimnisses aus einem anderen macOS-Projekt hat Nebenwirkungen. App Center unterstützt das Filtern nach Projekt in derselben App Center-Anwendung nicht. Für instance Auflistung von Abstürze für eine bestimmte Version werden alle Abstürze aus beiden Projekten für diese Version ohne Unterschied aufgelistet. Es kann verwirrend sein.

Hinweis

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

3. Hinzufügen der App Center SDK-Module

Das App Center SDK kann über Cocoapods, Carthage oder durch manuelles Hinzufügen der Binärdateien zu Ihrem Projekt in Ihre App integriert werden.

3.1 Integration über Cocoapods

1. Fügen Sie die folgenden Abhängigkeiten hinzu, podfile um App Center-Abstürze in Ihre App einzuschließen. Dadurch werden die folgenden Frameworks abgerufen: AppCenter und AppCenterCrashes.

    pod 'AppCenter/Crashes'
   

2. Führen Sie aus pod install , um Den neu definierten Pod zu installieren, und öffnen Sie den des Projekts .xcworkspace.

Hinweis

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

Nachdem Sie die Frameworks nun 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 zur Integration des App Center SDK in Ihr Xcode-Projekt mit Carthage Version 0.30 oder höher, einem dezentralisierten Abhängigkeits-Manager, der Ihre Abhängigkeiten erstellt und Ihnen binäre Frameworks bereitstellt.

1. Fügen Sie ihrer die folgenden Abhängigkeiten hinzu Cartfile , um App Center in Ihre App einzuschließen. Dadurch werden alle Frameworks abgerufen. Anschließend können Sie nur diese Frameworks verknüpfen, um sie in Ihrer App zu verwenden.

   # 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. carthage update ausführen. Dadurch werden Abhängigkeiten in einen Carthage/Checkouts-Ordner abgerufen und dann jedes Framework erstellt.

3. Öffnen Sie die Registerkarte Allgemeine Einstellungen Ihres Anwendungsziels. Ziehen Sie die Dateien AppCenter.framework und AppCenterCrashes.framework aus dem Ordner Carthage/Build/ 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 Sie sicherstellen, dass 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 nicht dort hinzufügen, da sie als statische Frameworks ausgeliefert werden.

Nachdem Sie die Frameworks nun 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 Menü Xcode auf Datei > Swift-Pakete > Paketabhängigkeit hinzufügen.
2. Geben Sie im angezeigten Dialogfeld die Repository-URL ein: https://github.com/microsoft/appcenter-sdk-apple.git.
3. Wählen Sie unter Version die Option Up to Next Major (Nach oben) aus, und wählen Sie die Standardoption aus.
4. Wählen Sie in der Spalte Paketprodukt die benötigten Module aus.

Nachdem Sie die Frameworks nun 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-Abstürze für Ihre App-Erweiterung einzurichten.

Hinweis

Das 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 entpacken Sie sie. Die resultierenden Ordnerinhalte sind nicht plattformspezifisch, sondern enthalten 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 Vendor-Unterverzeichnis .
   • Erstellen Sie eine Gruppe namens Vendor in Ihrem Xcode-Projekt, um Ihre Dateistruktur auf dem Datenträger nachzuahmen.

4. Öffnen Sie den entpackten Ordner AppCenter-SDK-Apple im Finder, und kopieren Sie den Ordner in den Ordner Ihres Projekts an der gewünschten Stelle. Der Ordner enthält Frameworks in Unterordnern für andere Plattformen, die das App Center SDK unterstützt. Daher müssen Sie möglicherweise nicht benötigte Unterordner löschen.

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

   • Stellen Sie sicher, dass der Projektnavigator sichtbar ist (⌘+1).
   • Ziehen Sie nun AppCenter.framework und AppCenterCrashes.framework aus dem Finder (an der Position aus dem vorherigen Schritt) in den Projektnavigator 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-Erweiterung wird nicht kompiliert.
   • Es wird ein Dialogfeld angezeigt, in dem Ihr App-Erweiterungsziel aktiviert ist. Klicken Sie auf Fertig stellen.

Nachdem Sie die Frameworks nun in Ihre App-Erweiterung 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 verwenden zu können, müssen Sie die zu verwendenden Module aktivieren. Standardmäßig werden keine Module gestartet, und Sie müssen diese beim Starten des SDK explizit aufrufen.

4.1 Hinzufügen der Importanweisungen

Fügen Sie die folgenden Zeilen in die Datei ein, die den Einstiegspunkt der App-Erweiterung enthält. Beispielsweise innerhalb der Standard ViewController-Datei einer Today-Erweiterung.

@import AppCenter;
@import AppCenterCrashes;

import AppCenter
import AppCenterCrashes

4.2 Hinzufügen der start:withServices: -Methode

Fügen Sie die folgende Zeile in den Einstiegspunkt der App-Erweiterung ein. Beispielsweise innerhalb der viewDidLoad -Methode der Standard ViewController-Datei einer Today-Erweiterung.

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACCrashes class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Crashes.self])

Derzeit werden nur Absturzberichte für Anwendungserweiterungen unterstützt.

4.3 Ersetzen Sie den Platzhalter durch Ihr App-Geheimnis.

Stellen Sie sicher, dass Sie Text durch den tatsächlichen Wert für Ihre Anwendungserweiterung ersetzen {Your App Secret} . 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.

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

In der Dokumentation für App Center-Abstürze erfahren Sie, wie Sie Ihre App-Erweiterung anpassen und erweiterte Funktionen verwenden.