Compiler avec Jack (AOSP 6.0 à 8.1)

Jack est la chaîne d'outils de compilation Android par défaut pour Android 6.0 à 8.1.

Jack est une chaîne d'outils Android qui compile le code source Java en bytecode DEX Android. Vous n'avez rien d'autre à faire pour utiliser Jack. Il vous suffit d'utiliser vos commandes de fichier make standard pour compiler l'arborescence ou votre projet. Android 8.1 est la dernière version qui utilise Jack.

À propos de Jack

Jack fonctionne comme illustré dans la figure 1.

Figure 1 : Présentation de Jack.

Format de la bibliothèque Jack

Jack dispose de son propre format de fichier .jack qui contient le code DEX précompilé pour la bibliothèque, ce qui permet une compilation plus rapide (pré-DEX).

Figure 2. Contenu du fichier de bibliothèque Jack.

Jill

Comme illustré dans la figure suivante, l'outil Jill traduit les bibliothèques .jar existantes dans le nouveau format de bibliothèque.

Figure 3. Workflow permettant d'importer une bibliothèque .jar existante.

Serveur de compilation Jack

La première fois que vous utilisez Jack, il lance un serveur de compilation Jack local sur votre ordinateur. Ce serveur:

• Améliore la vitesse de manière intrinsèque, car il évite de lancer une nouvelle JVM JRE hôte, de charger le code Jack, d'initialiser Jack et de préchauffer le JIT à chaque compilation. Il offre également de très bons temps de compilation lors de petites compilations (par exemple, en mode incrémentiel).
• Il s'agit d'une solution à court terme pour contrôler le nombre de compilations Jack parallèles. Le serveur évite de surcharger votre ordinateur (problème de mémoire ou de disque) en limitant le nombre de compilations parallèles.

Le serveur Jack s'arrête après un temps d'inactivité sans aucune compilation. Il utilise deux ports TCP sur l'interface localhost et n'est pas disponible en externe. Tous les paramètres (nombre de compilations parallèles, délai avant expiration, nombre de ports, etc.) peuvent être modifiés en modifiant le fichier $HOME/.jack.

Fichier $HOME/.jack

Le fichier $HOME/.jack contient les paramètres suivants pour les variables du serveur Jack dans une syntaxe bash complète:

• SERVER=true active la fonctionnalité de serveur de Jack.
• SERVER_PORT_SERVICE=8072 définit le numéro de port TCP du serveur à des fins de compilation.
• SERVER_PORT_ADMIN=8073 définit le numéro de port TCP du serveur à des fins administratives.
• SERVER_COUNT=1 n'est pas utilisé.
• SERVER_NB_COMPILE=4 définit le nombre maximal de compilations parallèles autorisées. SERVER_TIMEOUT=60 définit le nombre de secondes d'inactivité que le serveur doit attendre sans compilation avant de s'arrêter. SERVER_LOG=${SERVER_LOG:=$SERVER_DIR/jack-$SERVER_PORT_SERVICE.log} définit le fichier dans lequel les journaux du serveur sont écrits. Par défaut, cette variable peut être surchargée par une variable d'environnement.
• JACK_VM_COMMAND=${JACK_VM_COMMAND:=java} définit la commande par défaut utilisée pour lancer une JVM sur l'hôte. Par défaut, cette variable peut être surchargée par une variable d'environnement.

Résoudre les problèmes de compilation Jack

Trouver le journal Jack

Si vous avez exécuté une commande make avec une cible dist, le journal Jack se trouve dans $ANDROID_BUILD_TOP/out/dist/logs/jack-server.log. Sinon, vous pouvez trouver le journal en exécutant jack-admin server-log. En cas d'échecs Jack reproductibles, vous pouvez obtenir un journal plus détaillé en définissant la variable suivante:

export ANDROID_JACK_EXTRA_ARGS="--verbose debug --sanity-checks on -D sched.runner=single-threaded"

Utilisez des commandes de fichier make standard pour compiler l'arborescence (ou votre projet) et joindre la sortie et l'erreur standards. Pour supprimer les journaux de compilation détaillés, exécutez la commande suivante:

unset ANDROID_JACK_EXTRA_ARGS

Limites de la prise jack

Par défaut, le serveur Jack ne peut être utilisé que par un seul utilisateur sur un ordinateur. Pour prendre en charge d'autres utilisateurs, sélectionnez des numéros de port différents pour chaque utilisateur et ajustez SERVER_NB_COMPILE en conséquence. Vous pouvez également désactiver le serveur Jack en définissant SERVER=false dans $HOME/.jack. La compilation du CTS est lente en raison de l'intégration actuelle de vm-tests-tf. Les outils de manipulation du code octet (tels que JaCoCo) ne sont pas compatibles.

Utiliser Jack

Jack est compatible avec le langage de programmation Java 1.7 et intègre les fonctionnalités supplémentaires décrites ci-dessous.

Pré-dex

Lorsque vous générez un fichier de bibliothèque Jack, le .dex de la bibliothèque est généré et stocké dans le fichier de bibliothèque .jack en tant que pré-dex. Lors de la compilation, Jack réutilise le pré-dex de chaque bibliothèque. Toutes les bibliothèques sont pré-indexées.

Figure 4. Bibliothèques Jack avec pré-dex.

Jack ne réutilise pas le pré-dex de la bibliothèque si le rétrécissement, l'obscurcissement ou le reconditionnement sont utilisés lors de la compilation.

Compilation incrémentielle

La compilation incrémentielle signifie que seuls les composants modifiés depuis la dernière compilation (et leurs dépendances) sont recompilés. La compilation incrémentielle peut être beaucoup plus rapide qu'une compilation complète lorsque les modifications sont limitées à un ensemble de composants.

La compilation incrémentielle est désactivée par défaut (et est automatiquement désactivée lorsque la réduction, l'obscurcissement, le reconditionnement ou l'ancienneté multi-dex sont activés). Pour activer les builds incrémentaux, ajoutez la ligne suivante au fichier Android.mk du projet que vous souhaitez compiler de manière incrémentielle:

LOCAL_JACK_ENABLED := incremental

Minification et obscurcissement

Jack utilise des fichiers de configuration ProGuard pour activer la réduction et l'obscurcissement.

Voici quelques-unes des options courantes:

• @
• -include
• -basedirectory
• -injars
• -outjars (un seul fichier JAR de sortie accepté)
• -libraryjars
• -keep
• -keepclassmembers
• -keepclasseswithmembers
• -keepnames
• -keepclassmembernames
• -keepclasseswithmembernames
• -printseeds

Voici les différentes options de réduction:

• -dontshrink

Voici les différentes options d'obscurcissement:

• -dontobfuscate
• -printmapping
• -applymapping
• -obfuscationdictionary
• -classobfuscationdictionary
• -packageobfuscationdictionary
• -useuniqueclassmembernames
• -dontusemixedcaseclassnames
• -keeppackagenames
• -flattenpackagehierarchy
• -repackageclasses
• -keepattributes
• -adaptclassstrings

Les options ignorées sont les suivantes:

• -dontoptimize (Jack n'effectue pas d'optimisation)
• -dontpreverify (Jack ne prévalide pas)
• -skipnonpubliclibraryclasses
• -dontskipnonpubliclibraryclasses
• -dontskipnonpubliclibraryclassmembers
• -keepdirectories
• -target
• -forceprocessing
• -printusage
• -whyareyoukeeping
• -optimizations
• -optimizationpasses
• -assumenosideeffects
• -allowaccessmodification
• -mergeinterfacesaggressively
• -overloadaggressively
• -microedition
• -verbose
• -dontnote
• -dontwarn
• -ignorewarnings
• -printconfiguration
• -dump

Reconditionnement

Jack utilise des fichiers de configuration jarjar pour effectuer le reconditionnement. Bien que Jack soit compatible avec les types de règles "rule", il ne l'est pas avec les types de règles "zap" ou "keep".

Compatibilité avec Multidex

Jack propose une prise en charge intégrée et ancienne de la multidex. Étant donné que les fichiers dex sont limités à 65 000 méthodes, les applications comportant plus de 65 000 méthodes doivent être divisées en plusieurs fichiers dex. Pour en savoir plus, consultez la section Activer multidex pour les applications comportant plus de 64 000 méthodes.