Comment est structuré le code source de l'application Android WooCommerce officielle

Lorsqu'il s'agit d'étudier l'architecture d'une application Android e-commerce de grande envergure, trouver un exemple adapté peut s'avérer difficile. La plupart des projets réels sont dissimulés dans les dépôts privés des entreprises, et les tutoriels publics se limitent à de simples listes de tâches. L'application mobile WooCommerce est une exception bienvenue. L'équipe Automattic maintient le code source du client entièrement ouvert.

Le dépôt contient une application Kotlin complète utilisée quotidiennement par des milliers de propriétaires de boutiques en ligne. C'est une excellente plateforme pour apprendre des solutions architecturales pratiques, des approches de test et des mises en page.

Ce qu'il y a à l'intérieur du projet

L'application est construite autour de Kotlin et des composants Android Jetpack. Auparavant, la couche de données résidait dans une bibliothèque FluxC distincte. Plus tard, les développeurs ont déplacé cette logique directement dans le dépôt principal.

Détail intéressant : Google ML Kit est utilisé pour la lecture de codes-barres et la reconnaissance de texte sur les emballages de produits. C'est l'une des rares dépendances propriétaires du projet. Si vous prévoyez de compiler sans les services Google, ce module devra être remplacé.

La documentation du dépôt comprend des guides sur les sujets suivants :

• Configuration de l'autorisation OAuth2 pour travailler avec l'API REST WooCommerce.
• Prise en charge des interfaces de droite à gauche (RTL) et de la localisation.
• Adaptation des écrans pour les tablettes et les grands écrans.
• Utilisation des feature flags pour un déploiement sécurisé de nouvelles fonctionnalités.

Compilation et exécution

Vous pouvez faire fonctionner le projet localement en quelques minutes. Les exigences de base sont simplement Android Studio et un SDK installé.

Tout d'abord, clonez le dépôt :

git clone https://github.com/woocommerce/woocommerce-android.git
cd woocommerce-android

Ensuite, copiez le modèle de configuration dans le répertoire des secrets :

cp defaults.properties ~/.configure/woocommerce-android/secrets/secrets.properties

Après cela, ouvrez le dossier dans Android Studio. L'interface graphique créera automatiquement local.properties avec les chemins du SDK. Vous pouvez compiler une version de débogage ou exécuter les tests depuis le terminal à l'aide des commandes Gradle standard :

./gradlew assembleVanillaDebug                         
./gradlew installVanillaDebug                          
./gradlew :WooCommerce:testVanillaDebugUnitTest        
./gradlew :WooCommerce:connectedVanillaDebugAndroidTest

Pourquoi vous devriez étudier ce dépôt

Dans le code Android WooCommerce, vous pouvez trouver des solutions à des tâches quotidiennes auxquelles font face les développeurs de niveau intermédiaire ou senior :

• Analyseur statique Detekt configuré avec un ensemble de règles prêt à l'emploi conforme aux standards de l'équipe.
• Génération automatique de captures d'écran pour Google Play grâce à une exécution de test spéciale.
• Suivi analytique des événements organisé séparément pour la gestion de base de la boutique et le terminal de point de vente.
• Séparation appropriée des styles et des thèmes utilisant Material Design.

Qui bénéficiera de ce projet

Le dépôt sera utile aux développeurs Android qui souhaitent voir comment est structurée une application Kotlin réelle avec un riche historique. Ici, vous pouvez évaluer comment l'équipe d'ingénierie d'Automattic gère la dette technique, structure les modules et intègre les nouvelles bibliothèques Jetpack.

Si vous construisez votre propre client e-commerce ou une intégration d'API WordPress, ce code vous fera gagner beaucoup de temps lors de la phase de conception de l'architecture.