Compiler avec Jack pour Android 6.0–8.1

Jack est une chaîne d'outils Android qui a compilé la source Java en bytecode Android dex. Vous n'avez rien à faire de différent pour utiliser Jack - utilisez simplement vos commandes makefile 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é à la figure 1.

Présentation de Jack
Figure 1. Vue d'ensemble du cric

Format de bibliothèque Jack

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

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

Julie

L'outil Jill traduit les bibliothèques .jar existantes dans le nouveau format de bibliothèque, comme indiqué ci-dessous.

Importation de bibliothèques .jar avec Jill
Figure 3. Flux de travail 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 :

  • Apporte une accélération intrinsèque car il évite de lancer une nouvelle JVM JRE hôte, de charger du code Jack, d'initialiser Jack et de réchauffer le JIT à chaque compilation. Il fournit également de très bons temps de compilation lors de petites compilations (par exemple, en mode incrémental).
  • Est une solution à court terme pour contrôler le nombre de compilations parallèles de Jack. Le serveur évite de surcharger votre ordinateur (problème de mémoire ou de disque) car il limite le nombre de compilations parallèles.

Le serveur Jack s'éteint 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, timeout, nombre de ports, 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 fonction 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 n'est pas utilisé.
  • SERVER_NB_COMPILE=4 définit le nombre maximum de compilations parallèles autorisées.
  • SERVER_TIMEOUT=60 définit le nombre de secondes d'inactivité que le serveur doit attendre sans aucune 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.

Dépannage des compilations Jack

Problème Action
Votre ordinateur ne répond plus pendant la compilation ou vous rencontrez des échecs de compilations Jack sur une erreur de mémoire insuffisante Réduisez le nombre de compilations Jack simultanées en éditant $HOME/.jack et en changeant SERVER_NB_COMPILE à une valeur inférieure.
Les compilations échouent sur Impossible de lancer le serveur d'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 éditant $HOME/.jack et en changeant SERVER en false . Malheureusement, cela ralentit considérablement votre compilation et peut vous obliger à lancer make -j avec contrôle de charge (option -l de make ).
La compilation se bloque sans aucun progrès Pour débloquer la situation, tuez le serveur d'arrière-plan Jack à l'aide 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 de 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 de défaillances reproductibles de Jack, 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 standard pour compiler l'arborescence (ou votre projet) et joindre la sortie et l'erreur standard. Pour supprimer les journaux de compilation détaillés, exécutez :

unset ANDROID_JACK_EXTRA_ARGS

Limites du cric

  • Par défaut, le serveur Jack ne peut être utilisé que par un seul utilisateur sur un ordinateur. Pour prendre en charge des utilisateurs supplémentaires, 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 CTS est lente en raison de l'intégration actuelle de vm-tests-tf .
  • Les outils de manipulation de bytecode (tels que JaCoCo) ne sont pas pris en charge.

Utiliser Jack

Jack prend en charge le langage de programmation Java 1.7 et intègre les fonctionnalités supplémentaires décrites ci-dessous.

Pré-dexing

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 pré-dex. Lors de la compilation, Jack réutilise le pré-dex de chaque bibliothèque. Toutes les bibliothèques sont pré-indexées.

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

Jack ne réutilise pas le pré-dex de la bibliothèque si la réduction, l'obscurcissement ou le reconditionnement est utilisé dans la compilation.

Compilation incrémentale

La compilation incrémentale signifie que seuls les composants touché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'héritage multi-dex est activé). Pour activer les compilations incrémentielles, ajoutez la ligne suivante au fichier Android.mk du projet que vous souhaitez compiler de manière incrémentielle :

LOCAL_JACK_ENABLED := incremental

Rétrécissement et obscurcissement

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

Les options courantes incluent les suivantes :

  • @
  • -include
  • -basedirectory
  • -injars
  • -outjars (un seul pot de sortie pris en charge)
  • -libraryjars
  • -keep
  • -keepclassmembers
  • -keepclasseswithmembers
  • -keepnames
  • -keepclassmembernames
  • -keepclasseswithmembernames
  • -printseeds

Les options de réduction incluent les éléments suivants :

  • -dontshrink

Les options d'obscurcissement incluent les éléments suivants :

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

Les options ignorées incluent les éléments suivants :

  • -dontoptimize (Jack n'optimise pas)
  • -dontpreverify (Jack ne prévérifie 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 n'est pas compatible avec les types de règles "zap" ou "keep".

Prise en charge multi-index

Jack offre un support multidex natif et hérité. É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 plus de détails, reportez-vous à Activer le multidex pour les applications avec plus de 64 000 méthodes .