Outils de développement pour Java Marc Christie. LPMI Techniques de Développement

Transcription

1 Outils de développement pour Java Marc Christie LPMI Techniques de Développement

2 Plan Documentation Organisation de code Deboggage Précompilation et rétrocompilation Ofuscation Analyse de code Analyses lexicales et grammaticales

3 Documentation Javadoc (je ne vous apprends rien!) Fonctionne par instrumentation @throws Possibilité d'ajout de format HTML dans la doc Génère les formats HTML, XML, RTF, LaTeX, Man,...

4 Documentation Exemple pour une classe /** * A class representing a window on the screen. * For example: * <pre> * Window win = new Window(parent); * win.show(); * </pre> * Sami Shaio %I%, %G% java.awt.basewindow java.awt.button */ class Window extends BaseWindow {... }

5 Documentation Exemple pour un attribut de classe /** * The X-coordinate of the component. * #getlocation() */ int x = ;

6 Documentation Exemple pour une méthode /** * Returns the character at the specified index. An index * ranges from <code>0</code> to <code>length() - 1</code>. * index the index of the desired character. the desired character. StringIndexOutOfRangeException * if the index is not in the range <code>0</code> * to <code>length()-1</code>. java.lang.character#charvalue() */ public char charat(int index) {... }

7 Normes de Programmation Facilite la relecture des sources (80% de la durée de vie d'un logiciel est consacré à la maintenance) Il existe plusieurs normes, celle de SUN étant la principale (java.sun.com/docs/codeconv) Définit : Nom des classes, méthodes, attributs Organisation des structures de contrôle (itératives, conditionnelles, exception) Il existe des outils de vérification (CheckStyle)

8 Normes de Programmation Exemple : Packetages en minuscule Classe MajusculePourLaPremiereLettreDeChaqueMot Interface MajusculePourLaPremiereLettreDeChaqueMot Méthodes minusculepourlapremierelettre() Constantes MAJUSCULES_AVEC_UNDERSCORE Variables minusculepourlapremierelettre Méthode de conversion vers X: X tox() Accesseur get : X gety() Accesseur set : void sety(x val)

9 Outil CheckStyle Vérfie : Conventions de nommage Entetes Imports Commentaires Javadoc Longueurs de structures, fichiers, méthodes,... Formattage du code (gestion des blancs) Ordre des modificateurs (public, protected,...static...final...) Formattage des accolades sur les blocs Codage (pb d'initialisation, default switch, throws, simplification d'expressions booléennes...) Design de classes (visibilité, extension possible...) Code dupliqué Métriques (couplage de classes, nombre cyclomatique)

10 Portabilité Identifie les problèmes de portabilité (vérification des normes Java car les compilateurs présentent des différences) Outils : JavaPureCheck (Sun) Ouvrage Web 100% PureJava CookBook Guide le développeur vers a 100% compliance Donne des règles

11 Outils de reformatage & qualité Reformatage Jindent Jalopy Javastyle Qualité : Métriques sur le code JMetra Nombre de paquetages, métodes, interfaces Sources non commentés PMD Variables inutilisées, non initialisées Blocs (catch, if, while) vides Imports identiques multiples Méthodes privées inutilisées JDepend

12 Outil JDepend Métriques classiques # de classes, d'interfaces et de package Couplage de classes Couplage afferent (qui dépend de cette classe?) Couplage efferent (quelles classes dépendent de cette classe?) Cycles de dépendances de classes

13 Jalopy Outil paramétrable de reformatage de sources (jalopy.sourceforge.net) Gestion des accolades Gestion des espaces Indentation Wrapping de lignes Séparation de code Autogénération de Javadoc (classes, méthodes, arguments de méthodes) Templates header (entête) et footer (bas de page)

14 Organisation Make, gmake Ant Maven Outil d'automatisation des tâches Regroupe et automatise les bonnes pratiques : Build, docs, reporting Dépendences, Vesionning Releases, Distributions Créee une organisation uniforme des répertoires Gère des informations de qualité sur le code Propose toutes les cibles courantes

15 Outils de Tests Tests unitaires Junit Automatise la tâche de tests Suites de Tests Tests de couverture Clover ( : Couverture des tests unitaires : quelles sections de code n'ont pas été couvertes par les tests? Donne une indication de la qualtié des tests Reporting (PDF, HTML) Intégration dans Eclipse, NetBeans, JBuilder... Extensions pour Maven et Ant

16 Outils de Tests Tests de performance server en applications réparties (tests d'intégration) Cactus(jakarta.apache.org/cactus Tests des Servlets, EJB, Tag Libs, Filters... Facilite l'écriture et le reporting de tests Intégration par plugin dans Ant, Maven, Eclipse Tests d'applications Web HttpUnit (httpunit.sourceforge.net) Prend la place d'un browser Maintien des sessions, cookies,...

17 Maven Un build uniforme Basé sur POM (Project Object Model) Beaucoup d'extensions possibles Qualité de projet Changelog Mailing lists Dépendences des jar Tests unitaires et de couverture Bonnes pratiques Tests maintenus à part des sources Conventions de nommage des tests Release Management et Tracking (bugs/features)

18 Organisation : Maven (1) Fichier pom.xml <project xmlns=" xmlns:xsi=" xsi:schemalocation=" <modelversion>4.0.0</modelversion> <groupid>com.mycompany.app</groupid> <artifactid>my-app</artifactid> <packaging>jar</packaging> <version>1.0-snapshot</version> <name>maven Quick Start Archetype</name> <url> <dependencies> <dependency> <groupid>junit</groupid> <artifactid>junit</artifactid> <version>3.8.1</version> <scope>test</scope> </dependency> </dependencies> </project>

19 Organisation : Maven(2) Compilation : mvn compile JAR : mvn jar Tests : mvn test Package : mvn package Installation : mvn install Nettoyage : mvn clean Site Web : mvn site

20 Déboggage Symbolique Option de compilation: -g, -g:source,vars,lines Accès en ligne de commande : jdb Accès par des interfaces Permet : Pas à pas Point d'arrêts (simples ou conditionnelles) Exploration des structures de données Traces (pile, mémoire, procédures...)

21 Traces et Journalisation Traces Principe : instrumenter le code Mais ralentit l'execution Journalisation Enregistrement d'évènements dans un journal Outil Log4J, ObjectWeb MonoLog

22 Journalisation(1) Log4J Propose différents niveaux de logs DEBUG < INFO < WARN < ERROR < FATAL Propose différentes cibles Fichiers, consoles, GUI, sockets,... Possibilité de définir différentes Loggers Par classe, par package, par hiérarchie, par fonctionnalité Pratique pour du client/server (log client/log server) Configuration à l'execution Formatage des sorties Faible surcoût à l'execution

23 Journalisation(2) // cree un logger nommé "com.foo" Logger logger = Logger.getLogger("com.foo"); logger.setlevel(level.info); Logger barlogger = Logger.getLogger("com.foo.Bar"); // affiché à l'écran car WARN >= INFO. logger.warn("low fuel level."); // non affiché car DEBUG < INFO. logger.debug("starting search for nearest gas station."); // herite des propriétés de com.foo barlogger.info("located nearest gas station."); // non affiché car DEBUG < INFO. barlogger.debug("exiting gas station search");

24 Vérification(1) Par assertion (une hypthèse qui doit être vérifiée) Ex : assert x >0 && x < MAX_VALUE Vérification des pré/post conditions et des invariants de boucle Outils : J2SE1.4 AssertMate Icontract JavaFAQ

25 Vérification(2) Exemple : int toto(int x) { // precondition assert x > 0 && x < MAX_VALUE;... traitement... // postcondition assert x > 0 && x < MAX_VALUE; }... // invariant de classe, de boucle... assert balanced(); Activation : java -ea:<class> -da:<class> main.class

26 Précompilation Objectifs : à partir d'un seul fichiers source, générer différents fichiers java Avec trace/sans trace Avec assertion/sans assertion Avec optimisation/sans optimisation Comment? Directives de précompilation et symboles #include, #define, #ifdef Exemple : Mocha Source Obfuscator

27 Refactoring Refactoring = réorganisation d'un ensemble de sources Modification de la hiérarchie, des noms de classes, de méthodes... Comment? Par rétro-compilation Génération d'un.java à partir d'un.class (décompilation du bytecode) Imaginez les risques industriels Droits d'auteurs, piratage, espionnage industriel

28 Ofuscateur Objectif : éviter la rétro-compilation Comment? Brouillage des noms de classe/méthode/variable Mélange des propriétés d'accès Suppression de l'info de débuggage Outils : Décompilateurs : Javap, WingDis, NMI's code viewer, JAD, DeCafe Ofuscateurs : Mocha Source Ofuscator, Jmange,...

29 Inspection de code Objectifs : inspecter, transformer et générer du bytecode Comment? L'AOP (Aspect Oriented Programming) Pose des points de coupe dans le source/bytecode Insère/remplace/supprime des trairements Outils AspectJ, JAC, AOP

30 Distributions & Installations Objectifs : faciliter la création et l'installation des packages Jar, Fichiers ressources, icones, Manfest Dépendances Vérification de l'environnement (Jvm, versions, extensions...) Comment? Outils Jar file, OSGi bundle, Jpackage InstallShield, SuperPimp, IZPack, Ant, RPM Java Plugin/Java Web Start

31 Licences Etat des lieux 50% d'utilisation illégale en Europe 95% en Asie, Amérique latine, Europe Pertes financières importantes Vérification software Utilisateur, société, adresse MAC et clé Vérification hardware Par dongle ou smartcard

32 Mesure de Performances Outils : Java Xrunhprof Profiling du tas (heap) Usage CPU (temps, pourcentage du temps, et nbre d'appels de toutes les méthodes) Sorties fichiers Threads... Sortie sur fichier, socket,... Exemple : java -Xrunhprof:heap=dump,cpu=times,file=log.txt JVMStat (java.sun.com/performance/jvmstat)

33 Optimisation des performances Moteur de script Java Jython (jython.sourceforge.net Interpréteur de Bytecode Compilateur natif Permet de passer un.class en.c puis.exe Compilateur à la volée JIT (Just-In-Time) Optimiseur HotSpot Garbage collector Inlining

34 Compilateur natif Permet la transformation d'un fichier java en code C Très performant Empreinte mémoire réduite (pr embarqué) Evidemment dépendant de la cible Outils : GCJ (gcc.gnu/org/java) sourceware.cygnus.com/java

35 Compilateur à la volée Compilateur Just In Time (Symantec) Comment ça marche? Compilation du bytecode vers le langage machine puis exécution Mais : Consommation mémoire Durée de compilation

36 Optimisation HotSpot(tm) Compilation à la volée des sections critiques Généralement 5% du bytecode occupe 96% du CPU On ne compile à la volée que ces sections Jikes RVM JVM écrite en Java Benchmark sur les JVM Sun, Symantes, IBM, Kaffe

37 Analyse Lexicale et grammaticale Permet de faire un parser en Java à partir d'une grammatire et d'action Outils : Analyse grammaticale (LALR) JavaCC AntLR BYACC QJJ Analyse Lexicale JavaLex

38 Bibliographie Cours Didier DONSEZ J. Shirazi Java Performance Tuning, Ed. Oreilly, 2000 R. Hightower, Nicholas Lesiecki, Java Tools for Extreme Programming: Mastering Open Source Tools, including Ant, JUnit and Cactus, Ed. Wiley, 2001 E. Burke, B. Coyner, Java Extreme Programming Cookbook, Ed. Oreilly, 2003