Bien démarrer avec les extensions iOS

  • Article

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.

Les extensions d’application prennent uniquement en charge les rapports sur les incidents.

Pour savoir comment ajouter le Kit de développement logiciel (SDK) App Center à votre application conteneur, reportez-vous à la documentation relative aux Prise en main App Center iOS.

Commençons par configurer le KIT de développement logiciel (SDK) iOS App Center dans votre extension d’application pour utiliser App Center Crashs.

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é De rapport sur les incidents.

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. Dirigez-vous vers appcenter.ms.
  2. 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.
  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 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.

Notes

L’utilisation d’un secret d’application existant à partir d’un autre projet iOS a des effets secondaires. App Center ne prend pas en charge le filtrage par projet sur la même application App Center. Par instance liste des blocages pour une version particulière répertoriera tous les incidents des deux projets pour cette version sans distinction. Cela peut prêter à confusion.

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. Ajouter les modules du Kit de développement logiciel (SDK) App Center

Le Kit de développement logiciel (SDK) App Center peut être intégré à votre application via Cocoapods, Carthage ou en ajoutant manuellement les fichiers binaires à votre projet.

3.1 Intégration via Cocoapods

  1. Ajoutez les dépendances suivantes à votre podfile pour inclure app Center Crashs dans votre application. Cela extrait les frameworks suivants : AppCenter et AppCenterCrashes.

     pod 'AppCenter/Crashes'

  2. 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.

  1. Ajoutez les dépendances suivantes à votre Cartfile pour inclure App Center dans votre application. Cela extrait tous les frameworks. Vous pouvez ensuite lier uniquement ces frameworks à 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. Cela extrait les dépendances dans un dossier Carthage/Checkouts , puis génère chaque infrastructure.

  3. Ouvrez l’onglet Paramètres généraux de votre cible d’application. Faites glisser et déposez des fichiers AppCenter.framework et AppCenterCrashes.framework à partir du dossier Carthage/Build/ 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.

  4. 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

  1. Dans le menu Xcode, cliquez sur Fichier > Des packages > Swift Ajouter une dépendance de package.
  2. Dans la boîte de dialogue qui s’affiche, entrez l’URL du dépôt : 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 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 Crashs pour votre extension d’application.

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.

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

  2. 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.

  3. [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.

  4. 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 Kit de développement logiciel (SDK) App Center. Vous devrez peut-être supprimer les sous-dossiers dont vous n’avez pas besoin.

  5. Ajoutez les frameworks sdk au projet dans Xcode :

    • Vérifiez que le Navigateur de projet est visible (⌘+1).
    • À présent, faites glisser appCenter.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 extension d’application ne sera pas compilée.
    • Une boîte de dialogue s’affiche, vérifiez que la cible de votre extension d’application est vérifiée. Puis, cliquez sur Terminer.

Maintenant que vous avez intégré les frameworks dans votre extension d’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, vous devez choisir le ou les modules à utiliser. Par défaut, aucun module n’est démarré, et vous devez appeler explicitement chacun d’eux lors du démarrage du SDK.

4.1 Ajouter les instructions import

Insérez les lignes suivantes dans le fichier contenant le point d’entrée de l’extension d’application. Par exemple, dans le main fichier ViewController d’une extension Today.

@import AppCenter;
@import AppCenterCrashes;

import AppCenter
import AppCenterCrashes

4.2 Ajouter la start:withServices: méthode

Insérez la ligne suivante dans le point d’entrée de l’extension d’application. Par exemple, à l’intérieur de la viewDidLoad méthode du main fichier ViewController d’une extension Today.

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

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

Actuellement, seuls les rapports d’incidents sont pris en charge pour les extensions d’application.

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 extension d’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.

Bien, vous êtes prêt à visualiser les données de plantage sur le portail que le SDK collecte automatiquement.

Consultez la documentation relative aux incidents d’App Center pour savoir comment personnaliser votre extension d’application et utiliser des fonctionnalités plus avancées.