Intégration de Scripts Ant dans l'EDI NetBeans

-   Exemples de Code -
-  
  • Exemples NetBeans(ZIP)

  •   -
    - - - -

    Ce document explique les bases de l'intégration de scripts Ant dans l'EDI NetBeans version 3.5. Bien qu'il comprend quelques explications des fonctionnalités de Ant, il est tout d'abord concçu pour vous enseigner quant à la façon de travaille avec le module de support d'Ant de l'EDI NetBeans. Il est donc plus orienté sur la façon d'éditer et d'exécuter des scripts Ant que de ce qui se passe dans les scripts. Si vous désirez apprendre Ant, rendez vous sur la page http://ant.apache.org/resources.html.

    Ce guide couvre les sujets suivants:

    Pour Démarrer

    L'EDI vient avec tout le nécessaire pour construire vos application à l'aide de Ant. L'EDI NetBeans 3.6 contient la version 1.6.1 de Ant. Vous ne devez donc pas pointer l'EDI vers un exécutable différent sur votre machine. Pour les exercices de ce chapître, nous utiliserons les sources d'exemples qui sont fournit avec l'EDI. Si vous les avez effacés ou modifiés, vous pouvez télécharger une copie en utilisant le lien Exemple de Code ci-dessus.

    Nous avons également besoin d'un script Ant. L'EDI vient avec un Modèle de script Ant vierge, ainsi qu'un modèle de script Ant prêt à l'emploi. Ce modèle de script Ant prêt à l'emploi contient déjà les targets pour les tâches les plus courantes comme la compilation, le nettoyage, le paquetage de votre code dans un fichier JAR. Nous utiliserons également un script d'exemple pour les exercices de ce chapître..

    Pour créer le script Ant d'Exemple, cliquez-droit sur le noeud du répertoire examples dans l'EDI et sélectionnez New > All Templates. Dans le nouvel assistant, veuillez ouvrir le dossier Ant Build Scripts, et choisir Sample Ant Project, en cliquez ensuite sur Next. A la page suivante de l'assistant, introduisez build comme nom de fichier (sans l'extension .xml ) et cliquez sur Finish. Le fichier build.xml apparaît dans la fenêtre FileSystems et l'Éditeur de Source.

    Scripts Scripts dans l'EDI

    Noeud
Ant dans la fenêtre FileSystemL'EDI reconnaît automatiquement les scripts Ant et les affiche comme noeud Script Ant (icône Ant) dans la fenêtre FileSystems plutôt que comme un fichier XML normal. Comme pour tous les types de fichiers dans l'EDI, vous pouvez cliquez-droit sur le script Ant dans la fenêtre FileSystem ou l'Éditeur de Source, pour accéder à un menu contextuel de commandes. Vous pouvez également ouvrir le noeud de script Ant pour voir les sous-noeuds représentant la structure interne du fichier. Chacun de ses sous-noeuds possède également un menu contextuel de commandes.

    Installation de la Documentation Ant

    Même si vous êtes un expert Ant, vous aurez probablement besoin de consulter le manuel Ant de temps à autre. Vous pouvez installer le manuel Ant 1.6.1 directement dans le système d'aide de l'EDI en allant au Centre de Mise à Jour de NetBeans et en installant le module Documentation Ant. Voir Installation de Nouveaux Modules depuis le Centre de Mise à Jour pour plus d'information quant à l'utilisation du Centre de Mise à Jour.

    Lorsque le module de Documentation Ant est installé, vous pouvez sélectionner n'importe quelle tâche dans la fenêtre FileSystems et presser F1 pour obtenir la page du manuel Ant, décrivant cette tâche. Par exemple, pour obtenir de l'aide concernant la tâche javac, ouvrez le target compile, sélectionnez javac, et pressez F1. Le module de Documentation Ant monte également d'importants API Ant pour l'écriture de tâches Ant personnalisée. Vous pouvez voir la JavaDoc et utiliser la fonctionnalité de completion de code pour n'importe laquelle de ces classes dans l'API montée.

    Changer de Versions d'Ant

    L'EDI est livré avec la version 1.6.1 d'Ant et utilise cette installation pour exécuter les scripts Ant. Vous pouvez modifier la version de Ant que l'EDI utilise en modifiant le répertoire d'installation de Ant dans les paramètres Ant. Vous ne pouvez que changer vers des versions 1.5.3 et supérieures de Ant.

    Pour modifier la version d'Ant de l'EDI:

    1. Sélectionnez Tools > Options depuis le menu principal.
    2. Etendre le noeud Building et sélectionner Ant Settings.
    3. Introduisez le chemon complet du répertoire d'installation de la propriété Ant Home. Le répertoire d'installation de Ant doit contenir un sous-répertoire lib/ contenant le binaire ant.jar. Par exemple, pour la version standard de Ant 1.5.4, le répertoire d'installation est apache-ant-1.5.4. Si vous introduisez un répertoire qui ne répond pas à cette structure, l'EDI vous donne une erreur.

    Édition d'un Script Ant

    La façon la plus facile d'éditer un script Ant est d'utiliser l'Éditeur de Source. Tout ce qui fait partie de la recherche XML et outils de sélection sont également disponibles pour l'édition de Scripts Ant. Présentemment, le seul completion de code actuellement disponible pour les scripts Ant dans la distribution standard de l'EDI NetBeans est l'auto-completion des tags finaux. Si vous écrivez un tag target d'ouverture et qu'ensuite vous tapiez </, L´Éditeur de Source va compléter automatiquement le tag </target>.

    Vous pouvez également éditeur un script Ant en cliquant droit sur son noeud dans la fenêtre FileSystems. Les menus contextuels d'un script Ant et chacun de ses sous-noeuds contiennent une entrée Ajouter que vous pouvez utiliser pour rajouter des targets, properties, tasks, ainsi que d'autres éléments à votre script Ant. Vous pouvez également utiliser les commandes Move Up [Monter], Move Down [Descendre], et Change Order [Modifier l'Ordre] pour modifier le layout de votre script Ant.

    Note: Lorsque vous changez un script Ant via son noeud dans la fenêtre FileSystems, l'EDI reformatte automatiquement votre script Ant. Si votre script Ant est sous contrôle de version, cela peut provoquer que vos diffs pointent des modifications de format sans importance.

    Gestion de l'Introduction de Données par l'Utilisateur

    La tâche input vous demande un utilisateur lorsque vous exécutez un script Ant. L'EDI affiche la boîte de dialogue de gestion d'introduction de donnée lorsqu'il rencontre une tâche input durant l'exécution du script Ant. La boîte de dialogue montre le message spécifié dans l'attribut message de la tâche. Si un attribut validargs est défini, une liste déroulantes contenant les différents choix possibles est affichée. Aussi non, la boîte de dialogue affiche un champs de saisie au format texte.

    Par exemple, créez une nouvelle target dans build.xml nommé choix. Ajoutez la tâche suivante à la target choix:

    <input message="Pensez-vous que l'intégration de Ant dans NetBeans est
    bien faites?"
        validargs="Oui,Non"
        addproperty="reponse"/>
    <echo message="Est-ce que l'intégration de Ant dans NetBeans est bien faites
    ? ${reponse}" />
    

    Etendez le noeud du script Ant dans la fenêtre FileSystems et double-cliquez sur le noeud choix pour exécuter la cible (target). L'EDI affichera alors la boîte de dialogue ci-dessous et imprimera votre réponse dans la fenêtre de console.

    Dialogue d'Introduction de Donnée

    Gestion du ClassPath d'un script Ant

    Par défaut, l'EDI ignore la variable CLASSPATH de votre environnement lorsqu'il exécute Ant. Pour vos scripts qui utilisent des tâches personnalisées, vous devez ajouter la tâches au classpath de Ant dans l'EDI.

    Vous pouvez ajouter des tâches personnalisées au classpath de Ant dans l'EDI en :

    • Fournissant un chemin explicite où se situent les tâches dans votre script. Ceci est la méthode recommandée.
    • Ajout des tâches au classpath de Ant dans l'EDI

    Ecrire des Scripts Ayant un Classpath Explicite

    L'utilisation d'un classpath explicite est la méthode recommandée, car elle assure que vos scripts seront totalement portable. Vous pouvez écrire vos tâches et inclure des instructions pour les compiler et produire un fichier JAR dans le fichier de script. Pour utiliser ces tâches, il vous faut inclure la forme longue de taskdef, qui inclut un classpath. Voici un simple exemple d'une telle tâche:

    <project name="test" default="all" basedir=".">
        <target name="init">
            <javac srcdir="tasksource" destdir="tasksource"/>
            <jar jarfile="mytasks.jar" basedir="tasksource">
                <exclude name="**/*.java"/>
            </jar>
            <taskdef name="customtask" classname="com.mycom.MyCustomTask">
                <classpath>
                     <pathelement location="mytasks.jar"/>
                </classpath>
            </taskdef>
        </target>
        <target name="all" depends="init">
            <customtask someparam="val"/>
        </target>
    </project>

    L'avantage de cette méthode est qu'aucune préparation spécial n'est nécessaire pour commencer à utiliser le script. Le script est entièrement auto-satisfaisant et portable. Cette méthode facilite également le développement de vos tâches dans l'EDI, comme le script les (re)compile pour vous automatiquement.

    Pour rendre vos scripts encore plus robustes, utilisez une propriété au lieu d'une location hard-codée pour spécifier la classpath de vos tâches. Vous pouvez stoquer la propriété dans le script lui-même ou dans un fichier ant.properties séparé. Vous pouvez alors modifier les paramètres du classpath via votre script en modifiant simplement la valeur de la propriété spécifiée.

    Exécuter des Scripts Sans de Classpath défini

    Si vous ne pouvez pas déclarer un classpath dans votre script, ou que vous utilisez une script externe que vous ne pouvez modifier, vous pouvez ajouter les tâches au classpath de Ant dans l'EDI. Ouvrez la fenêtre d'options (Tools > Options), sélectionnez Building >Ant Settings, et introduisez le chemin complet du JAR désiré dans la propriété Additional Classpath

    Stoquer des Propriétés dans un Fichier ant.properties

    Si vous travaillez en équipe, il est important que tous vos scripts soient portables et utilisable sur chacun des ordinateurs des développeurs. Les détails locaux comme l'endroit des divers bibliothèques et exécutables peuvent varier d'ordinateur à ordinateur. Une façon de résoudre cela est de définir ces locations en tant que propriétés dans un fichier ant.properties. Chaque développeur de votre équipe peut alors indiquer les bon paramètres dans leur version du fichier ant.properties.

    Modifier Fichiers ant.propertiesLa façon la plus aisée de créer un nouveau fichier ant.properties et de le référencer dans votre script est d'utiliser la feuille de propriété du script. Sélectionnez le script et cliquez sur le bouton (...) de la propriété Project Properties. Dans l'assistant, entrez le nom du fichier properties. Vous pouvez alors cliquer sur Finish pour sortir de l'assistant ou cliquez sur Next pour introduire des propriétés dans le fichier. L'EDI crée le fichier (s'il n'existe pas déjà) et rajoute la ligne suivante à votre script Ant:

    <property file="build.ant.properties"/> 

    Une fois le fichier ant.properties créé, il se comporte comme tous les fichiers properties dans l'EDI. Si vous double-cliquez sur le noeud du fichier, l'EDI l'ouvre dans un éditeur spécial pour les fichiers properties Si vous préférez éditer le code directement en mode texte, vous pouvez cliquez-droit sur le noeud du fichier ant.properties dans la fenêtre FileSystems et choisir Edit.

    Si vous avez plusieurs fichiers ant.properties dans le même répertoire que le script Ant, vous pouvez basculer de l'un à l'autre en utilisant la propriété Switch Properties File de la feuille de propriétés du script. Cette propriété n'apparaît que si vous avez un fichier ant.properties référencé dans votre script. Une fois que vous avez défini une propriété dans le fichier ant.properties, vous pouvez y faire référence dans votre script en écrivant ${property_name}.

    Construire Avec Ant

    Il y a plusieurs façon de construire votre project avec un script Ant dans l'EDI:

    • Faire de la Compilation Ant Indirecte la compilation par défaut de votre projet et utilisez la commande Compile Project
    • Exécuter le script Ant manuellement depuis la fenêtre FileSystems
    • Créer et utiliser les raccourcis vers les targets individuels dans le script Ant

    Mettre Ant comme Méthode de Compilation par Défaut pour un Projet

    Chaque projet a un type de compilateur par défaut qui est utilisé pour compiler le project lorsque vous utilser les commandes Compile (F9) ou Build (F11). Pour indiquer que ces commandes utilisent un script Ant, ouvrez la fenêtre Options et sélectionnez Editing > Java Sources. Dans la feuille de propriétés, mettez la propriété Default Compiler [Compilateur par Défaut] sur Indirect Ant Compilation (ATTENTION: PAS Ant Script Compilation).

    mettre Compilation Ant Indirect en tant que type de compilateur par défaut

    Dans la majorité des cas, c'est tout ce que vous dévez faire. Lorsque vous exécutez la commande Compile sur un fichier, l'EDI utilisera l'agorythme normal de Ant -find pour retrouver le script ant approprié a exécuter. Cet algorythme recherche en remontant les répertoires depuis l'endroit où se trouve le fichier source jusqu'à ce qu'il trouve un fichier build.xml. Par défaut, l'EDI exécute la target clean lorsque vous sélectionnez la commande Clean, , les targets clean et all lorsque vous sélectionnez la commande Build, and la target par défaut du script Ant lorsque vous sélectionnez la commande Compile.

    Vous pouvez modifier tous ces paramètres par défaut dans la fenêtre Options. Sélectionnez Building > Compiler Types > Indirect Ant Compilation. Dans la feuille de propriété, vous pouvez choisir différentes targets pour les commandes Compile, Build, et Clean commands ou spécifier explicitement quel script Ant l'EDI doit exécuter. Le script Ant doit être monté dans l'EDI pour que vous puissiez le sélectionner.

    Indirect Ant Compilation options

    Exécuter un Script Ant ou une Target

    Si vous désirez exécuter manuellement un script Ant, cliquez-droit sur le script Ant dans la fenêtre FileSystems et sélectionnez Execute (F6). Exécuter un script Ant va exécuter la target par défaut du script. Pour exécuter une target spécifique d'un script Ant, il vous faut étendre le noeud du script dans la fenêtre FileSystems et double cliquer sur le noeud correspondant à la target que vous désirez exécuter. Vous pouvez également cliquer-droit sur le noeud du script Ant et choisir dans le sous-menu Run Target.

    Création d'un raccourci vers une Target

    Si vous désirez accéder facilement à votre script Ant, vous pouvez même créer des raccourcis vers les targets que vous utilisez souvent. Un raccourcis vers une target est un mini-script qui va lier une target à un élément de menu, un noeud de le fenêtre FileSystems, un bouton de la barre d'outils, un lien dans la fenêtre Projet, ou un raccourcis clavier. Le script Ant que vous désirez lier doit être monté dans la fenêtre FileSystems.

    Par exemple, créons un raccourcis pour la target all de notre fichier build.xml. Ouvrez l'assistant New [Nouveau] en pressant Ctrl-N. Dans l'assistant New, étendez le dossier Ant Build Scripts [Scripts Ant], sélectionnez Shortcut to Target [Raccourcis vers Target] et cliquez sur Next [Suivant]. sur la page Configure Basic Options [Configurer Options de Base] sélectionnez ce que vous désirez lier au raccourci. Nous pouvons alors donner au raccourci un raccourci clavier et un élément de men, pour finir en cliquant sur Next [Suivant]. Utilisez alors les pages suivantes de l'assistant pour naviguer jusqu'à la target all dans le build.xml et l'assigner à un raccourci clavier et un élement de menu dans me menu Build. Notez que si vous choisissez un raccourci clavier qui est déjà pris, le bouton Finish [Terminer] est désactiver dans l'assistant. Lorsque vous avez fini, cliquez sur Finish [Terminer].

    Si vous désirez éditer votre mini-script, rendez-vous dans la fenêtre Options et étender IDE Configuration > Look and Feel > Menu Bar > Build. Cliquez ensuite sur le noeud myapp-clean pour ouvrir le script dans l'Éditeur de Source. Cela est très utile si vous désirez effectuer des modifications ou ajouter des propriétés à votre raccourcis. Par exemple, vous pouvez modifier le nom du raccourci dans le menu Build en modifiant l'attribut name dans l'élément project.

    Ecrire ses propres tâches Ant

    Vous pouvez créer vos propres tâches pour étendre les fonctionnalités fournies par les tâches intégrées dans Ant. Les propres tâches sont souvent utilisées pour défnir des propriétés, créer des éléments imbriqués, ou écrire du texte directement entre les tags en utilisant la méthode addText.

    Pour créer votre propre tâche Ant dans l'EDI, pressez CTRL-N et sélectionnez l'entrée Custom Task template depuis le dossier Ant Build Scripts. Nommez le fichier MyTask et placez le dans le répertoire examples à coté de votre build.xml. La tâche personnalisée contient un code d'exemple pour a plupart des opérations courantes effectuées par des tâches Ant. Après chaque partie de code, le modèle vous montre également comment utiliser la tâche dans un script Ant.

    Remarque: Pour que vous puissiez compiler et exécuter les tâches Ant personnalisées, vous devez monter le fichier JAR ant dans la fenêtre FileSystems. Montez le JAR modules/ext/ant-1.6.1.jar (ATTENTION: PAS modules/ant.jar) depuis le répertoire d'installation de votre EDI. Si vous utilisez un script Ant pour compiler la tâche personnalisée, vous devrez egalement ajouter ant-1.6.1.jar au classpath du script Ant.

    Créons par exemple notre propre tâche Ant qui créer une simple option ainsi qu'une simple propriété et afficher leurs valeurs via echo. Supprimez les commentaires des lignes de code suivantes dans MyTask:

    private boolean opt;
    public void setOpt(Boolean b) {
        opt = b;
    }
    
    private String myprop;
    public void setMyprop(String s) {
        myprop = s;
    }
    

    Allons ensuite sur la méthode execute et introduisons ce qui suit:

    log("myprop=" + myprop + " opt=" + opt);

    Ajoutons maintenant une target à notre script build.xml qui donne des valeurs à l'options et la propriété dans MyTask.java. Ajoutons ce qui suit au script build.xml:

    <target name="mytask">
        <javac classpath="${ant.location}" destdir="." srcdir="."/>
        <taskdef classname="examples.MyTask" classpath="." name="mytask"/>
        <mytask myprop="hello" opt="true"/>
    </target>
    

    Vous devez définir la propriété ant.location avec le chemin vers votre JAR Ant, soit dans le script Ant lui-même, ou dans un fichier ant.properties. Vous pouvez également introduire le chemin vers le JAR ant directement dans la tâche javacc. Étendez le noeud build.xml dans la fenêtre FileSystems et double-cliquez sur la target mytask. La target est exécutée et la fenêtre de résultat affiche les valeurs de myprop et opt.

    Project Features

    About this Project

    fr was started in November 2009, is owned by petras, and has 104 members.
    By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20160708.bf2ac18). © 2014, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
     
     
    Close
    loading
    Please Confirm
    Close