Par rapport aux mises à jour précédentes, la transition de Capacitor 4 vers Capacitor 5 implique des changements de rupture minimaux. Ce guide fournit des instructions étape par étape pour mettre à jour votre projet vers Capacitor 5, ainsi qu'une liste des changements de rupture pour les plugins officiels.
Remarque : Capacitor 5 nécessite NodeJS 16 ou supérieur, car Node 12 a atteint la fin de vie et Node 14 atteindra la fin de vie le 30 avril 2023. Il est recommandé d'utiliser la dernière version LTS de NodeJS.
-
Installez la
latestversion de Capacitor CLI dans votre projet :npm i -D @capacitor/cli@latest -
Exécutez la commande suivante pour permettre au CLI de gérer la migration :
npx cap migrateSi les étapes de migration ne peuvent pas être réalisées, des informations supplémentaires seront fournies dans la sortie de la console. Les étapes de migration manuelles sont listées ci-dessous.
-
Si vous avez l'extension VS Code installée, consultez la section recommandations de l'extension pour trouver l'option de migration de votre projet vers Capacitor 5.
Mise à niveau de projet iOS Capacitor 4 vers Capacitor 5
-
Mettre à jour Xcode: Capacitor 5 nécessite Xcode 14.1+.
-
Mettre à jour .gitignore: Apportez les modifications suivantes à votre
.gitignorefichier :- App/Podfile.lock + App/output -
Mettre à jour les Assets pour utiliser un seul icône d'application: Xcode 14 prend en charge un seul icône d'application de 1024x1024. Nettoyez votre AppIcon.appiconset en supprimant toutes les tailles inutiles.
Mise à niveau de projet Android Capacitor 4 vers Capacitor 5
-
Mettre à jour Android Studio: Capacitor 5 nécessite Android Studio Flamingo | 2022.2.1 ou une version plus récente en raison de l'utilisation de Gradle 8, qui nécessite Java JDK 17. Java 17 est livré avec Android Studio Flamingo, il n'est donc pas nécessaire de télécharger quoi que ce soit.
-
Exécuter l'Assistant de mise à jour AGP: Android Studio peut aider avec certaines mises à jour liées à Gradle et au déplacement de packages dans les fichiers de construction. Pour commencer, exécutez
Tools -> AGP Upgrade Assistant. -
Mettre à jour les variables du projet Android: Dans votre
variables.gradlefichier, mettez à jour vos valeurs pour les nouveaux minimums suivants :minSdkVersion = 22 compileSdkVersion = 33 targetSdkVersion = 33 androidxActivityVersion = '1.7.0' androidxAppCompatVersion = '1.6.1' androidxCoordinatorLayoutVersion = '1.2.0' androidxCoreVersion = '1.10.0' androidxFragmentVersion = '1.5.6' coreSplashScreenVersion = '1.0.0' androidxWebkitVersion = '1.6.1' junitVersion = '4.13.2' androidxJunitVersion = '1.1.5' androidxEspressoCoreVersion = '3.5.1' cordovaAndroidVersion = '10.1.1' -
Mettre à jour les services Google:
# build.gradle dependencies { - classpath 'com.google.gms:google-services:4.3.13' + classpath 'com.google.gms:google-services:4.3.15' } -
Mettre à jour le plugin Gradle à 8.0.0:
# build.gradle dependencies { - classpath 'com.android.tools.build:gradle:7.2.1' + classpath 'com.android.tools.build:gradle:8.0.0' } -
Mettre à jour le wrapper Gradle à 8.0.2:
# gradle-wrapper.properties distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists - distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip + distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-all.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -
Désactiver Jetifier:
# gradle.properties android.useAndroidX=true - android.enableJetifier=true -
Déplacer le package
build.gradle:# AndroidManifest.xml <?xml version="1.0" encoding="utf-8"?> - <manifest xmlns:android="http://schemas.android.com/apk/res/android" - package="[YOUR_PACKAGE_ID]"> + <manifest xmlns:android="http://schemas.android.com/apk/res/android"># build.gradle android { + namespace "[YOUR_PACKAGE_ID]" compileSdkVersion rootProject.ext.compileSdkVersion -
Mise à jour de l'application Android: Dans Capacitor 6,
httpssera la configuration par défaut pourandroidSchemepour les applications existantes afin de permettre aux applications Capacitor d'utiliser la fonctionnalité de remplissage automatique du système. Pour éviter toute perte de données résultant de cette modification, définissez le schéma surhttpmaintenant, même si c'est la configuration par défaut actuelle.{ server: { androidScheme: "http" } } -
Mise à jour de la version Kotlin: Si votre projet utilise Kotlin, mettez à jour la
kotlin_versionvariable à'1.8.20'.
Changements de fonctionnalités des plugins
Les fonctionnalités suivantes des plugins ont été modifiées ou supprimées. Mettez à jour votre code en conséquence :
- Feuille de dialogue d'action
- Navigateur
- Appareil
- Appareil
- Localisation
- Cartes de Google
- Notifications locales
- Notifications Push
- Barre de statut
Feuille d'action
- Mettre à jour le
androidxMaterialVersion__CAPGO_KEEP_0__ pour1.8.0.
Navigateur
- Mettre à jour le
androidxBrowserVersionvariable à1.5.0.
Camera
- Pour Android 13, ajoutez la permission de lecture des images de médias (
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>) dansAndroidManifest.xml. - Mettre à jour le
androidxMaterialVersionvariable à1.8.0. - Mettre à jour le
androidxExifInterfaceVersionvariable à1.3.6.
Appareil
- Changer
DeviceId.uuidàDeviceId.identifier. - Sur iOS 16+,
DeviceInfo.nameretournera un nom de appareil générique à moins que vous n'ajoutiez les autorisations appropriées entitlements.
Geolocalisation
- Mettre à jour
playServicesLocationVersionà21.0.1.
Google Maps
- Mettre à jour les variables suivantes :
googleMapsPlayServicesVersionà18.1.0.googleMapsUtilsVersionà3.4.0.googleMapsKtxVersionà3.4.0.googleMapsUtilsKtxVersionà3.4.0.kotlinxCoroutinesVersionà1.6.4.androidxCoreKTXVersionà1.10.0.kotlin_versionà1.8.20.
Notifications locales
- Pour Android 13, un nouveau contrôle de permission d'exécution est requis pour planifier les notifications locales lorsque vous ciblez SDK 33. Appelez
checkPermissions()etrequestPermissions()en conséquence.
Notifications Push
- Pour Android 13, un nouveau contrôle de permission d'exécution est requis pour recevoir les notifications push lorsque vous ciblez SDK 33. Appelez
checkPermissions()etrequestPermissions()en conséquence. - Mettez à jour
firebaseMessagingVersionla23.1.2.
Barre de Statut
- Sur iOS, l'animation de la barre de statut par défaut a été modifiée en
FADE.
En suivant ces étapes et en mettant à jour votre code en conséquence, vous devriez maintenant avoir mis à jour votre projet avec succès de Capacitor 4 vers Capacitor 5. Assurez-vous de tester votre application soigneusement pour vous assurer que toutes les fonctionnalités et les plugins fonctionnent comme prévu.