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 la source Java en bytecode dex Android. Vous n'avez rien de particulier à faire pour utiliser Jack. Il vous suffit d'utiliser vos commandes makefile standards pour compiler l'arborescence ou votre projet. Android 8.1 est la dernière version à utiliser Jack.

À propos de Jack

Le fonctionnement de la prise est illustré dans la figure 1.

Présentation de Jack.

Figure 1 : Présentation de Jack.

Format de la bibliothèque Jack

Jack possè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).

Contenu du fichier de bibliothèque Jack.

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

Jill

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

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

Figure 3. Workflow pour importer une bibliothèque .jar existante.

Serveur de compilation Jack

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

  • Cela permet d'accélérer intrinsèquement le processus, car cela évite de lancer une nouvelle JVM JRE hôte, de charger le code Jack, d'initialiser Jack et de préparer le JIT à chaque compilation. Il offre également de très bons temps de compilation lors de petites compilations (par exemple, en mode incrémentiel).
  • 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 une période d'inactivité sans 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, numéro de port, etc.) peuvent être modifiés en éditant 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 d'administration.
  • SERVER_COUNT=1 est inutilisé.
  • 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 liés aux compilations Jack

Problème Action
Votre ordinateur ne répond plus pendant la compilation ou vous rencontrez des échecs de compilation Jack avec l'erreur Mémoire insuffisante Réduisez le nombre de compilations Jack simultanées en modifiant $HOME/.jack et en remplaçant SERVER_NB_COMPILE par une valeur inférieure.
Les compilations échouent avec le message d'erreur Cannot launch background server (Impossible de lancer le serveur en arrière-plan) La cause la plus probable est que les ports TCP sont déjà utilisés sur votre ordinateur. Modifiez les ports en modifiant $HOME/.jack (variables SERVER_PORT_SERVICE et SERVER_PORT_ADMIN). Pour débloquer la situation, désactivez le serveur de compilation Jack en modifiant $HOME/.jack et en remplaçant SERVER par false. Malheureusement, cela ralentit considérablement votre compilation et peut vous obliger à lancer make -j avec le contrôle de charge (option -l de make).
La compilation reste bloquée sans progresser Pour débloquer la situation, arrêtez le serveur d'arrière-plan Jack à l'aide de jack-admin kill-server, puis supprimez les répertoires temporaires contenus dans jack-$USER de votre répertoire temporaire (/tmp ou $TMPDIR).

Trouver le journal Jack

Si vous avez exécuté une commande make avec une cible de distribution, le journal Jack se trouve à l'adresse $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'échec de Jack reproductible, 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 les commandes makefile standards pour compiler l'arborescence (ou votre projet) et joindre la sortie standard et les erreurs. Pour supprimer les journaux de compilation détaillés, exécutez la commande suivante :

unset ANDROID_JACK_EXTRA_ARGS

Limites de 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 différents numéros de port pour chacun d'eux 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 CTS est lente en raison de l'intégration vm-tests-tf actuelle. Les outils de manipulation de bytecode (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

Lors de la génération d'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 fichier DEX prédéfini. Lors de la compilation, Jack réutilise le fichier DEX de chaque bibliothèque. Toutes les bibliothèques sont pré-dexées.

Bibliothèques Jack avec pré-dex.

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

Jack ne réutilise pas le fichier dex prédéfini de la bibliothèque si la compilation utilise la réduction, l'obscurcissement ou le reconditionnement.

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 le multidex hérité sont activés). Pour activer les builds incrémentiels, 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 minification et l'obscurcissement.

Voici quelques options courantes :

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

Voici les différentes options de réduction :

  • -dontshrink

Voici les options d'obscurcissement :

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

Voici quelques exemples d'options ignorées :

  • -dontoptimize (Jack n'optimise pas)
  • -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 reconditionner les fichiers. Jack est compatible avec les types de règles "rule", mais pas avec les types de règles "zap" ni "keep".

Compatibilité avec multidex

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