Partager via


Commencez avec iOS

Important

Visual Studio App Center a été mis hors service le 31 mars 2025, à l’exception des fonctionnalités d’analyse et de diagnostic, qui continueront d’être prises en charge jusqu’au 30 juin 2026. En savoir plus.

Le Kit de développement logiciel (SDK) App Center utilise une architecture modulaire pour vous permettre d’utiliser n’importe quel 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 kits SDK App Center, le règlement général sur la protection des donnéeset les pages FAQ. En outre, le FAQ contient les réponses que vous devez fournir pour la configuration de la confidentialité d’App Store.

Démarrons avec la configuration du SDK iOS App Center dans votre application pour utiliser App Center Analytics et App Center Crashes. 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 des appareils s’exécutant sur ios 11.0 ou version ultérieure.
  • Vous n’utilisez pas d'autres bibliothèques de logiciels qui fournissent des fonctionnalités de rapports d'incident (uniquement pour les plantages de l'App Center).
  • Si vous utilisez CocoaPods pour intégrer App Center, vous avez besoin de CocoaPods version 1.10 ou ultérieure.

L'analyse et les crashs du SDK App Center 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.

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

Une fois que vous avez créé une application, vous pouvez obtenir son secret d’application sur la page Paramètres du portail App Center. En haut à droite 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.

Remarque

Des modifications importantes ont été introduites dans la version 4.0.0 d'App Center. Suivez la section Migrate to 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

Remarque

Les simulateurs ARM64 (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’elles fonctionnent.

  1. Ajoutez les dépendances suivantes à votre podfile pour inclure App Center Analytics et App Center Défaillances dans votre app. Cette action emporte les frameworks suivants : AppCenter, AppCenterAnalytics et AppCenterCrashes. Au lieu de cela, vous pouvez spécifier les services souhaités dans votre application. Chaque service a sa propre sous-spécification et s’appuient tous sur AppCenter. Elle sera automatiquement extraite.

     # 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. Exécutez pod install pour installer votre pod nouvellement défini et ouvrez le projet .xcworkspace.

Remarque

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 pods les plus récents à 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 dans 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.

Remarque

L'intégration de Carthage ne fonctionne pas d'emblée dans Xcode 12. Pour que cela fonctionne, reportez-vous à cette instruction Carthage

  1. Ajoutez les dépendances suivantes à votre Cartfile pour inclure App Center. Ces dépendances intègrent tous les cadres. Vous pouvez ensuite lier uniquement ces 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
    
  2. Exécutez carthage update pour extraire des dépendances dans un dossier Carthage/Checkouts . Générez ensuite chaque framework.

  3. Ouvrez l’onglet Paramètres généraux de votre cible d’application. Faites glisser et déposez AppCenter.framework, AppCenterAnalytics.framework et les fichiers 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 fonctionnent pas et votre application ne se compile pas.

  4. Une boîte de dialogue s’affiche, vérifiez que la cible de votre application est coché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 kits SDK App Center, car ils sont expédié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

  1. Dans le menu Xcode, cliquez sur Fichier > Paquets Swift > Ajouter une Dépendance de Paquet.
  2. Dans la boîte de dialogue qui s’affiche, entrez l’URL du référentiel : https://github.com/microsoft/appcenter-sdk-apple.git.
  3. Dans Version, sélectionnez Jusqu’à La majeure suivante et utilisez l’option par défaut.
  4. Choisissez les modules dont vous avez besoin dans la colonne Package Product .

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.

Remarque

Si vous intégrez App Center via SwiftPM, et que vous souhaitez 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 dans 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 à suivre pour intégrer les fichiers binaires compilés au sein de votre projet Xcode afin de configurer App Center Analytics et App Center Crashes pour votre application iOS.

Remarque

Le Kit de développement logiciel (SDK) App Center prend en charge l’utilisation de XCframework. Si vous souhaitez intégrer XCframeworks dans 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 spécifique à la plateforme. Il contient plutôt XCframeworks pour chaque module. Elles peuvent être intégrées de la même façon que les frameworks habituels, comme décrit ci-dessous.

  1. Téléchargez les infrastructures du Kit de développement logiciel (SDK) App Center fournies sous forme de fichier zip.

  2. Décompressez le fichier et vous verrez un dossier appelé AppCenter-SDK-Apple qui contient des frameworks différents 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.

  3. [Facultatif] Créez un sous-répertoire pour les bibliothèques tierces.

    • Comme meilleure pratique, les bibliothèques tierces se trouvent généralement dans un sous-répertoire, souvent appelé Vendor. 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é Vendor à l’intérieur de votre projet Xcode pour imiter votre structure de fichiers sur le disque.
  4. Ouvrez le dossier AppCenter-SDK-Apple décompressé dans 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 Kit de développement logiciel (SDK) App Center. Vous devrez peut-être supprimer des sous-dossiers dont vous n’avez pas besoin.

  5. Ajoutez les frameworks sdk au projet dans Xcode :

    • Vérifiez que le navigateur de projets est visible (⌘+1).
    • Faites maintenant glisser et 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 requis 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 Kit de développement logiciel (SDK) et d’utiliser les services App Center.

4. Démarrez 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 en fonction du cycle de vie que vous utilisez. À partir de Xcode 12, vous pouvez sélectionner l’un des deux cycles de vie : « Swift UI App » (sélectionné 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 d’importation

Ouvrez le fichier AppDelegate du projet (pour le cycle de vie AppDelegate du kit d’interface utilisateur) ou <le fichier App.swift ProjectName> (pour le cycle de vie de l’application d’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 dans la méthode déléguée didFinishLaunchingWithOptions :

[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 d’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. Pour ce faire, la méthode la plus simple 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
    }
}

Ensuite, utilisez UIApplicationDelegateAdaptor dans struct

@main
struct YourAppName: App {

  @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

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

Si vous disposez d’une application Catalyst, vous pouvez transmettre 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 :

  1. Configurez ou démarrez-le avec le secret de l’application.
  2. Si le code peut être appelé plusieurs fois, vérifiez si l’App Center est déjà configuré.
  3. Démarrez le ou les services requis sans 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. La clé secrète de l’application se trouve dans la page Prise en main ou 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 dans celui-ci, vous pouvez copier-coller l’exemple entier.

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

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 comme paramètre dans la méthode de démarrage, 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 consignent un avertissement à la console et seuls les modules inclus dans le premier appel seront disponibles.

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

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

Excellent, vous êtes tous configurés pour visualiser les données d’analyse et de blocage sur le portail que le SDK collecte automatiquement.

Consultez les documents d'App Center Analytics et les documents d'App Center Incidents pour savoir comment personnaliser et utiliser des fonctionnalités plus avancées des deux services.

Pour savoir comment bien démarrer avec les mises à jour dans l’application, lisez la documentation de App Center Distribute.