Utilisation des projets Android library

| Nicolas KLEIN | Djug |

Ce tutoriel suppose que vous utilisiez Eclipse en version 3.5.2 (la version 3.6 est déconseillée pour le plugin Android), le SDK en révision 7 et le plugin ADT pour Eclipse en version 0.9.8. Cet article a pour objectif d'expliquer ce que sont et comment utiliser les Android library dans vos projets Android.
Commentez ♪

- Titre : Utilisation des projets Android library

- Auteurs : Nicolas KLEIN, Djug

- Parution : 25 avril 2011

- Licence : Copyright ® 2010 foxykeep. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Présentation

- II. Création d'un projet library

- Gestion du fichier manifest d'un projet library

- III. Référencer un projet library dans le projet principal

- Gestion spéciale des composants library dans le fichier manifest du projet standard

- IV. Fonctionnement spécial : l'imbrication des projets library

- Migration des projets library de ADT 0.9.7 à 0.9.8

- V. Conclusion

- V-A. Remerciements

I - Présentation

Cette fonctionnalité relativement récente (intégré au SDK en mai 2010 avec la révision 6) permet de factoriser du code commun à plusieurs applications et donc de profiter d'une réutilisabilité plus forte de vos développements.

Elle est compatible avec les versions d'Android suivantes : 1.5, 1.6, 2.1 et 2.2.

La grande différence par rapport à l'utilisation d'un JAR contenant son code source est que les projets library Android permettent également de factoriser les ressources (layout, drawable…) et donc de pouvoir réutiliser également des Activities ou des Providers !

Par exemple dans le cas d'une application disponible en version gratuite et payante, toute la partie commune peut être mise dans un projet library. Les deux versions, payante et gratuite, vont inclure cette library et vont seulement ajouter le mécanisme spécifique de leur version : des pubs dans la version gratuite et le mécanisme de vérification d'achat réel de l'application dans la version payante par exemple.

Le code est du coup beaucoup plus simple à maintenir plutôt que de devoir continuellement copier/coller du code entre les deux applications à chaque modification de la partie commune.

Du point de vue de l'architecture, un projet library Android ne se différencie pas, ou très peu, d'un projet standard Android. Il contient également un fichier manifest, des dossiers src/ et res/. Il est possible d'inclure des layouts ou de stocker des images via le dossier standard drawable. Le code source peut utiliser ces ressources via la classe R standard.

Un projet library Android n'est par contre pas compilable en l'état en un fichier .apk. De la même façon, il n'est pas possible d'exporter ce projet sous la forme d'un JAR. À la place, il faut le référencer dans un projet standard Android qui va, lui, générer l'application complète. Il est par contre totalement possible d'intégrer une library JAR dans un projet library et même de référencer un projet library dans un projet library (mais on y reviendra plus tard dans l'article).

Cette génération va fusionner les sources provenant du projet principal et celles venant du projet library. Les ressources (contenues dans le dossier res/) seront également fusionnées. Si une ressource a le même ID dans le projet principal et le projet library, c'est celle du projet principal qui aura la priorité. Cela va permettre entre autres de surcharger des ressources.

Un projet peut référencer sans problème plusieurs projets library. Cela va permettre de segmenter son projet encore mieux. Comme on le verra tout à l'heure, il va être possible de prioriser un projet library par rapport à une autre (cela est principalement utile pour les ressources).

Les ressources du projet final ayant la priorité, si vous ne voulez pas que quelqu'un qui inclut votre librairie écrase une de vos ressources par erreur en en ajoutant une avec le même nom dans son projet, pensez à utiliser des noms spéciaux ou encore mieux à préfixer toutes vos ressources par un identifiant spécifique à votre projet.

II - Création d'un projet library

La création d'un projet library est en tout point identique à la création d'un projet standard Android. Une fois ce projet créé (nommé dans le cas de ce tutoriel AndroLibFirst), nous allons changer un paramètre afin de transformer ce projet standard en projet library :

- dans l'onglet Package Explorer , faire un clic droit sur le projet et choisir Properties ;

- dans la fenêtre qui s'ouvre, choisir la section « Android ». On remarque alors la présence d'une section Library en bas de la fenêtre

- cocher la case « Is Library » et cliquer sur Apply.

- valider les changements en cliquant sur le bouton OK.

Le projet est devenu un projet library ! Il est maintenant possible de le référencer dans un projet principal.

Gestion du fichier manifest d'un projet library

De la même façon que pour un projet standard, le fichier manifest doit définir les composants partagés de la librairie : les Activities, les Providers…

III - Référencer un projet library dans le projet principal

Dans l'interface qu'on vient d'utiliser pour transformer notre projet standard en projet library, on remarque qu'il y a quatre boutons : Add, Remove, Up et Down. Ils vont permettre d'ajouter ou de retirer une référence vers un projet library et d'ordonner les références aux projets library entre elles. Il faut savoir que la librairie la plus haute dans la liste est prioritaire sur celles qui la suivent et que les ressources sont donc choisies en fonction de ces priorités.

Pour ajouter une référence vers notre projet AndroLibFirst depuis notre projet principal AndroLibMain, les actions sont les suivantes :

- dans l'onglet Package Explorer , faire un clic droit sur le projet et choisir Properties ;

- dans la fenêtre qui s'ouvre, cliquer sur le bouton Add. Une popup s'ouvre alors montrant la liste des projets library disponibles dans le workspace ;

- choisir le projet AndroLibFirst que l'on veut référencer et cliquer sur le bouton OK ;

- validez les changements en cliquant sur le bouton OK.

La référence est alors mise en place par Eclipse et le code et les ressources du projet library (encadrés en bleu ci-dessous) sont maintenant accessibles dans le projet principal comme on peut le voir dans ce screenshot :

Gestion spéciale des composants library dans le fichier manifest du projet standard

Les composants du projet library que l'on veut rendre accessibles dans l'APK final doivent être redéfinis dans le manifest afin qu'ils soient pris en compte lors de la création de l'APK.

Cela concerne les balises <activity>, <service>, <receiver>, <provider> ainsi que les <permission> et <uses-library> entre autres. Les déclarations doivent utiliser les noms complets avec les packages afin qu'ADT puisse savoir exactement où chercher les éléments.

IV - Fonctionnement spécial : l'imbrication des projets library

On va commencer ici à s'amuser un peu en enchaînant les projets library.

Exemple : un projet principal qui référence un projet library (jusque-là c'est standard), qui lui-même référence un projet library qui peut lui aussi référencer un projet library, etc., etc., etc. \x{0085} (Toute ressemblance avec Inception n'est que pure coïncidence. On pourrait parler d'Androidception !)

Avant de voir comment faire cela, une chose à savoir ! Cela ne fonctionne que depuis la toute récente mise à jour du SDK et du plugin ADT. Il faut donc avoir le SDK révision 7 et le plugin ADT en version 0.9.8. Mettez à jour, si besoin, votre environnement avant de tester cette nouvelle fonctionnalité donc.

Prenons un exemple bidon : un projet principal AndroLibMain qui inclut un projet library AndroLibFirst qui lui-même inclut un projet library AndroLibSecond. Le projet AndroLibMain contient une classe LibMain qui étend la classe LibFirst du projet AndroLibFirst qui elle-même étend la classe LibSecond du projet AndroLibSecond. Totalement inutile comme fonctionnement, mais cela ira très bien comme exemple. Voyons maintenant comment réaliser cela.

1. Pour commencer, on va créer nos trois projets sans se soucier de savoir si ce sont des projets library ou non.

2. Une fois cela fait, on commence par transformer le projet AndroLibSecond en projet library. Pour ceux qui ont oublié comment faire, remontez un peu dans l'article pour trouver la marche à suivre.

3. On attaque ensuite la nouveauté ! À savoir transformer le projet AndroLibFirst en projet library et référencer dans celui-ci le projet AndroLibSecond.

1. Pour la partie, transformer le projet en projet library, on fonctionne comme précédemment.

2. Pour ajouter le projet library AndroLibSecond, on remarque que la zone d'ajout d'un projet library n'est pas en gris (ce qui était le cas avant la mise à jour du SDK r7 et du plugin ADT en version 0.9.8). Il nous suffit d'ajouter le projet library comme expliqué précédemment.

3. On valide le tout. On a donc désormais un projet library AndroLibFirst référençant le projet AndroLibSecond.

4. Pour finir, il nous faut référencer ce projet AndroLibFirst dans le projet principal. On ajoute donc cette référence comme précédemment.

5. Et la surprise ! Le projet principal AndroLibMain contient désormais une référence vers le projet AndroLibFirst ce qui est logique, mais aussi vers le projet AndroLibSecond. Le plugin ADT s'est chargé de reporter la référence entre le projet AndroLibFirst et AndroLibSecond afin que lors de la création de l'apk du projet principal toutes les librairies nécessaires soient présentes !

Le résultat est donc le suivant :

On voit donc dans le projet AndroLibFirst les éléments entourés en bleu de la référence du projet AndroLibSecond.

Dans le projet principal, on a en vert les éléments du référencement direct du projet AndroLibFirst et en rouge les éléments indirectement référencés du projet AndroLibSecond.

Migration des projets library de ADT 0.9.7 à 0.9.8

Afin de pouvoir gérer l'imbrication des projets library, le fonctionnement des projets library a été revu entre la version 0.9.7 et 0.9.8 du plugin ADT. La conséquence de cette modification est que si vous ouvrez un workspace ayant un projet library après avoir mis à jour le plugin ADT, vous allez tomber sur ce problème :

La référence MyLibrary est celle d'ADT 0.9.7 tandis que MyLibrary_src est celle d'ADT 0.9.8. Il faut donc déréférencer l'ancienne. Pour cela, les étapes à effectuer sont les suivantes :

- faire un clic droit sur MyLibrary et choisir Build Path puis Remove from Build Path ;

- ensuite valider la pop-up qui s'ouvre en vérifiant que le choix \x{0093}Also unlink the folder from the project\x{0094} est bien coché .

Le temps que Eclipse rebuild le projet et ça devrait être nickel !

V - Conclusion

Voila ! c'est la fin de ce tutoriel sur les projets library Android. Si vous avez encore des interrogations, n'hésitez pas à poser vos questions dans les commentaires, je ferais de mon mieux pour y répondre et sinon je vous conseille l'article plus complet disponible sur le site officiel Android (en anglais par contre) : àlire ici.

V-A - Remerciements

Merci à ClaudeLELOUP pour la correction orthographique.