Bien démarrer avec iOS

Article
03/15/2024

Important

Visual Studio App Center doit être mis hors service le 31 mars 2025. Bien que vous puissiez continuer à utiliser Visual Studio App Center jusqu’à ce qu’il soit entièrement mis hors service, il existe plusieurs alternatives recommandées vers lesquelles vous pouvez envisager de migrer.

En savoir plus sur les chronologies et les alternatives de support.

Le Kit de développement logiciel (SDK) App Center utilise une architecture modulaire pour vous permettre d’utiliser tous les services ou tous les services.

Vous trouverez des informations sur les données collectées par App Center sur les données collectées par les SDK App Center, le Règlement général sur la protection des données et les pages FAQ . En outre, le FORUM aux questions contient les réponses que vous devez fournir pour App Store configuration de confidentialité.

Commençons à configurer le KIT de développement logiciel (SDK) iOS App Center dans votre application pour utiliser App Center Analytics et les incidents d’App Center. Pour ajouter App Center Distribute à votre application, consultez la documentation relative à App Center Distribute.

1. Prérequis

Les conditions suivantes doivent être remplies pour utiliser le Kit de développement logiciel (SDK) App Center :

Votre projet iOS est configuré dans Xcode 13 ou version ultérieure sur macOS version 10.14.4 ou ultérieure.
Vous ciblez les appareils s’exécutant sur ios 11.0 ou version ultérieure.
Vous n’utilisez aucune autre bibliothèque qui fournit la fonctionnalité Rapport d’incidents (uniquement pour les incidents d’App Center).
Si vous utilisez CocoaPods pour intégrer App Center, vous avez besoin de CocoaPods version 1.10 ou ultérieure.

App Center SDK Analytics and Crashes sont compatibles avec Mac Catalyst via XCFramework ou SwiftPM.

2. Créez votre application dans le portail App Center pour obtenir le secret d’application

Si vous avez déjà créé votre application dans le portail App Center, vous pouvez ignorer cette étape.

Dirigez-vous vers appcenter.ms.
Inscrivez-vous ou connectez-vous, puis appuyez sur le bouton bleu en haut à droite du portail qui indique Ajouter une nouvelle application, puis sélectionnez Ajouter une nouvelle application dans le menu déroulant.
Entrez un nom et une description facultative pour votre application.
Sélectionnez iOS comme système d’exploitation et Objective-C/Swift en tant que plateforme.
Appuyez sur le bouton en bas à droite qui indique Ajouter une nouvelle application.

Une fois que vous avez créé une application, vous pouvez obtenir son secret d’application dans la page Paramètres du portail App Center. Dans le coin supérieur droit de la page Paramètres , cliquez sur les points verticaux triples et sélectionnez Copy app secret pour obtenir votre secret d’application.

3. Ajouter les modules du Kit de développement logiciel (SDK) App Center

Le Kit de développement logiciel (SDK) App Center pour iOS peut être ajouté à votre application via Cocoapods, Carthage, Swift Package Manager ou en ajoutant manuellement les fichiers binaires à votre projet.

Notes

Dans la 4.0.0 version d’App Center, des changements cassants ont été introduits. Suivez la section Migrer vers app Center SDK 4.0.0 et versions ultérieures pour migrer App Center à partir des versions précédentes.

3.1 Intégration via Cocoapods

Notes

Les simulateurs ARM64 (lorsqu’ils sont lancés à partir de Xcode s’exécutant sur Apple Silicon Mac) ne sont pas pris en charge via CocoaPods. Envisagez d’utiliser d’autres méthodes d’intégration pour qu’il fonctionne.

Ajoutez les dépendances suivantes à votre podfile pour inclure App Center Analytics et App Center Se bloque dans votre application. Cette action extrait les frameworks suivants : AppCenter, AppCenterAnalytics et AppCenterCrashes. Au lieu de cela, vous pouvez spécifier les services que vous souhaitez dans votre application. Chaque service a sa propre sous-spécification et ils s’appuient tous sur AppCenter. Il est automatiquement extrait.
```
 # 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'
```
Exécutez pod install pour installer votre pod nouvellement défini et ouvrir le projet ..xcworkspace

Notes

Si vous voyez une erreur comme [!] Unable to find a specification for `AppCenter` lors de l’exécution pod install, exécutez pod repo update pour obtenir les derniers pods à partir du référentiel Cocoapods, puis exécutez pod install.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le KIT de développement logiciel (SDK) et d’utiliser les services App Center.

3.2 Intégration via Carthage

Vous trouverez ci-dessous les étapes à suivre pour intégrer le Kit de développement logiciel (SDK) App Center à votre projet Xcode à l’aide de Carthage version 0.30 ou ultérieure, un gestionnaire de dépendances décentralisé qui génère vos dépendances et vous fournit des frameworks binaires.

Notes

L’intégration de Carthage ne fonctionne pas de manière prête à l’emploi dans Xcode 12. Pour que cela fonctionne, reportez-vous à cette instruction Carthage

Ajoutez les dépendances suivantes à votre Cartfile pour inclure App Center. Ces dépendances extrayent tous les frameworks. Ensuite, vous pouvez lier uniquement les frameworks que vous souhaitez utiliser dans votre application.
```
# 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
```
Exécutez carthage update pour extraire les dépendances dans un dossier Carthage/Checkouts . Ensuite, générez chaque infrastructure.
Ouvrez l’onglet Paramètres généraux de votre cible d’application. Faites glisser et déposez les fichiers AppCenter.framework, AppCenterAnalytics.framework et AppCenterCrashes.framework à partir du dossier Carthage/Build/iOS dans le Navigateur de projet de Xcode. AppCenter.framework est requis pour démarrer le KIT de développement logiciel (SDK). S’il n’est pas ajouté au projet, les autres modules ne fonctionneront pas et votre application ne sera pas compilée.
Une boîte de dialogue s’affiche, vérifiez que la cible de votre application est vérifiée. Puis, cliquez sur Terminer.

Remarque

Si vous utilisez carthage copy-frameworks dans votre phase de génération , vous ne devez pas y ajouter les SDK App Center, car ils sont livrés en tant que frameworks statiques.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le KIT de développement logiciel (SDK) et d’utiliser les services App Center.

3.3 Intégration via Swift Package Manager

Dans le menu Xcode, cliquez sur Fichier > Des packages > Swift Ajouter une dépendance de package.
Dans la boîte de dialogue qui s’affiche, entrez l’URL du dépôt : https://github.com/microsoft/appcenter-sdk-apple.git.
Dans Version, sélectionnez Jusqu’à La majeure suivante et utilisez l’option par défaut.
Choisissez les modules dont vous avez besoin dans la colonne Produit de package .

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le KIT de développement logiciel (SDK) et d’utiliser les services App Center.

Notes

Si vous intégrez App Center via SwiftPM et que vous souhaitez également l’utiliser dans la cible d’extension de votre application, vérifiez que vous fournissez DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES dans votre configuration. Cela est nécessaire pour éviter les limitations SwiftPM lors de la liaison d’un module à plusieurs cibles.

3.4 Intégration en copiant les fichiers binaires dans votre projet

Vous trouverez ci-dessous les étapes permettant d’intégrer les fichiers binaires compilés dans votre projet Xcode pour configurer App Center Analytics et App Center Crashs pour votre application iOS.

Notes

Le Kit de développement logiciel (SDK) App Center prend en charge l’utilisation de XCframework. Si vous souhaitez intégrer XCframeworks à votre projet, téléchargez le AppCenter-SDK-Apple-XCFramework.zip à partir de la page des versions et décompressez-le. Le contenu du dossier résultant n’est pas propre à la plateforme, mais il contient XCframeworks pour chaque module. Ils peuvent être intégrés de la même façon que les frameworks habituels, comme décrit ci-dessous.

Téléchargez les frameworks du Kit de développement logiciel (SDK) App Center fournis sous forme de fichier zip.
Décompressez le fichier et vous verrez un dossier appelé AppCenter-SDK-Apple qui contient des infrastructures différentes pour chaque service App Center sur chaque dossier de plateforme. L’infrastructure appelée AppCenter est requise dans le projet, car elle contient du code partagé entre les différents modules.
[Facultatif] Créez un sous-répertoire pour les bibliothèques tierces.
- Comme bonne pratique, les bibliothèques tierces se trouvent généralement dans un sous-répertoire, souvent appelé Fournisseur. Si le projet n’est pas organisé avec un sous-répertoire pour les bibliothèques, créez un sous-répertoire Fournisseur maintenant.
- Créez un groupe appelé Fournisseur à l’intérieur de votre projet Xcode pour imiter votre structure de fichiers sur le disque.
Ouvrez le dossier AppCenter-SDK-Apple décompressé dans le Finder et copiez le dossier dans le dossier de votre projet à l’emplacement où vous le souhaitez. Le dossier contient des frameworks dans des sous-dossiers pour d’autres plateformes prises en charge par le SDK App Center. Vous devrez donc peut-être supprimer les sous-dossiers dont vous n’avez pas besoin.
Ajoutez les frameworks sdk au projet dans Xcode :
- Vérifiez que le Navigateur de projet est visible (⌘+1).
- Faites maintenant glisser & déposez AppCenter.framework, AppCenterAnalytics.framework et AppCenterCrashes.framework à partir du Finder (à l’emplacement de l’étape précédente) dans le Navigateur de projet de Xcode. AppCenter.framework est nécessaire pour démarrer le KIT de développement logiciel (SDK). S’il n’est pas ajouté au projet, les autres modules ne fonctionnent pas et votre application ne se compile pas.
- Une boîte de dialogue s’affiche, vérifiez que la cible de votre application est cochée. Puis, cliquez sur Terminer.

Maintenant que vous avez intégré les frameworks dans votre application, il est temps de démarrer le SDK et d’utiliser les services App Center.

4. Démarrer le KIT de développement logiciel (SDK)

Pour utiliser App Center, optez pour le ou les modules que vous souhaitez utiliser. Par défaut, aucun module n’est démarré et vous devez appeler chacun d’eux lors du démarrage du Kit de développement logiciel (SDK).

Les instructions ci-dessous sont légèrement différentes selon le cycle de vie que vous utilisez. À partir de Xcode 12, vous pouvez sélectionner l’un des deux cycles de vie suivants : « Application d’interface utilisateur Swift » (sélectionnée par défaut dans Xcode 12) et « Ui Kit AppDelegate ». Si vous développez pour une extension, reportez-vous à la page Prise en main de l’extension.

4.1 Ajouter les instructions import

Ouvrez le fichier AppDelegate du projet (pour le cycle de vie appDelegate du kit d’interface utilisateur) ou <le fichier ProjectName>App.swift (pour le cycle de vie de l’application de l’interface utilisateur Swift) et ajoutez les instructions d’importation suivantes :

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

import AppCenter
import AppCenterAnalytics
import AppCenterCrashes

4.2 Ajouter la `start:withServices:` méthode

Kit d’interface utilisateur AppDelegate

Ajoutez du code d’initialisation à la didFinishLaunchingWithOptions méthode de délégué :

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

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

Cycle de vie de l’application de l’interface utilisateur Swift

Pour vous assurer que le Kit de développement logiciel (SDK) App Center fonctionne correctement avec l’interface utilisateur Swift, initialisez-le une fois l’interface utilisateur chargée. Le moyen le plus simple d’y parvenir consiste à utiliser UIApplicationDelegate :

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
          AppCenter.start(withAppSecret: "{Your App Secret}", services:[
            Crashes.self, Analytics.self, Distribute.self])
        return true
    }
}

UIApplicationDelegateAdaptor Utilisez ensuite dans struct:

@main
struct YourAppName: App {

  @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Si vous avez une application Catalyst, vous pouvez passer des secrets d’application pour iOS et macOS en même temps :

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

Avertissement

Il n’est pas recommandé d’incorporer votre secret d’application dans le code source.

Si vous devez démarrer les services App Center séparément, vous devez :

Configurez ou démarrez-le avec le secret de l’application.
Si le code peut être appelé plusieurs fois, case activée si l’App Center est déjà configuré.
Démarrez le ou les services requis sans le secret d’application.

[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 Remplacer l’espace réservé par votre secret d’application

Veillez à remplacer {Your App Secret} le texte par la valeur réelle de votre application. Le secret de l’application se trouve dans la page Prise en main ou dans la page Paramètres du portail App Center.

La page Prise en main contient l’exemple de code ci-dessus avec votre secret d’application. Vous pouvez copier-coller l’exemple entier.

L’exemple ci-dessus montre comment utiliser la start:withServices méthode (start(withAppSecret:services:) pour Swift) et inclure les incidents App Center Analytics et App Center.

Si vous ne souhaitez pas utiliser l’un des deux services, supprimez le paramètre correspondant de l’appel de méthode ci-dessus.

Sauf si vous spécifiez explicitement chaque module en tant que paramètre dans la méthode start, vous ne pouvez pas utiliser ce service App Center. En outre, l’API start:withServices (start(withAppSecret:services:) pour Swift) ne peut être utilisée qu’une seule fois dans le cycle de vie de votre application : tous les autres appels enregistrent un avertissement dans la console et seuls les modules inclus dans le premier appel sont disponibles.

Par exemple : si vous souhaitez intégrer App Center Analytics, vous devez modifier l’appel d’API start:withServices (start(withAppSecret:services:) pour Swift) comme suit :

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

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

Très bien, vous êtes prêt à visualiser les données d’analyse et de plantage sur le portail que le KIT de développement logiciel (SDK) collecte automatiquement.

Pour savoir comment personnaliser et utiliser des fonctionnalités plus avancées des deux services, consultez la documentation App Center Analytics et les incidents App Center .

Pour savoir comment prendre en main les mises à jour dans l’application, lisez la documentation d’App Center Distribute.

Bien démarrer avec iOS

1. Prérequis

2. Créez votre application dans le portail App Center pour obtenir le secret d’application

3. Ajouter les modules du Kit de développement logiciel (SDK) App Center

3.1 Intégration via Cocoapods

3.2 Intégration via Carthage

3.3 Intégration via Swift Package Manager

3.4 Intégration en copiant les fichiers binaires dans votre projet

4. Démarrer le KIT de développement logiciel (SDK)

4.1 Ajouter les instructions import

4.2 Ajouter la start:withServices: méthode

Kit d’interface utilisateur AppDelegate

Cycle de vie de l’application de l’interface utilisateur Swift

4.3 Remplacer l’espace réservé par votre secret d’application

Ressources supplémentaires

4.2 Ajouter la `start:withServices:` méthode