Projets
Pages enfant
  • 1.6 Organisation des fichiers

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.
Commentaire: Migrated to Confluence 5.3
Remarque
titleA compléter

Manque l'arborescence de test dans la capture d'écran développeur Manque le repertoire src/main/config

Faire une première partie qui reprend l'arborescence des fichiers modules maven pom etc.

Du point de vue du développeur, une application est composée de plusieurs projets Eclipse, chaque projet correspondant à un module MAVEN.

...

Sommaire :

Sommaire
maxLevel3

...

Arborescence développeur

le Le fonctionnement de MAVEN impose une architecture particulière : il n'y a que deux répertoires.

  • /src/ : répertoire de travail. Sous src, nous allons voir deux répertoires : main et test.
    • le répertoire main correspond au code et aux fichiers qui seront déployés.
    • le répertoire test correspond aux test unitaires 
  • /target/ : répertoire de travail de MAVEN (ne pas utiliser).

    Liste des répertoires présents dans /src/main/ :
    java : toutes les sources JAVA du projet (cible coté côté exploitant : monApplication/WEB-INF/classes/)
    resources : contient tous les fichier fichiers de propriétés (cible coté côté exploitant : monApplication/WEB-INF/classes/)
    webapp : Le répertoire d'application web du projets projet WAR monApplication.

    Liste des répertoires présents dans /src/test/ :

    java : les test tests unitaires, qui ne seront pas déployées.
    resources : les ressources nécessaires aux tests unitaires, qui ne seront pas déployées.
    Info

    il n'y a pas de repertoire lib pour déposer les librairies nécessaires au projet. Ces librairies seront à déclarer dans le fichier pom.xml pour que ce soit MAVEN qui gère la dépendance

 

 

Arborescence exploitant

l L'arborescence du produit déployé par l'exploitant est obtenue en décompressant un fichier WAR.

Elle correspond donc à la norme J2EE.

Remarque

Les chemins spécifiques à chaque type d'utilisateurs ont été décrits ci-dessus, nous allons maintenant voir les les arborescences communes. Les répertoires seront présentés avec des chemins relatifs. Les chemins sont

...

à adapter en fonction du contexte de l'utilisateur : exploitant ou développeur.

Le répertoire properties : les fichiers de configuration

Astuce

Afin de centraliser la configuration une bonne pratique consiste à utiliser un fichier de configuration centralisant les paramètres de l'application. Ceci évite notamment de devoir modifier n fichiers différents.
Les paramètres seront définis dans le fichier default.properties et pourront être surchargé surchargés dans le fichier config.properties.
Les exploitants ont ainsi un seul fichier de configuration à gérer. Et la gestion des fichiers de propriétés décrits ci-dessous est alors à la charge du développeur.

Dans le cas ou la configuration n'est pas centralisée, les fichiers de configuration sont en général fournis sous forme de fichiers d'exemple (xxx-example.xml).

...

Le fichier de configuration Spring auth-example.xml définit le bean authenticationService, qui sert à l'application à récupérer l'identifiant de l'utilisateur connecté. Il doit être copié en auth.xml.

...

Le fichier de configuration Spring cache-example.xml définit le bean cacheManager, qui sert à l'application à s'appuyer sur un gestionnaire de cache. Il doit être copié en cache.xml.

...

Le fichier de configuration Spring dao-example.xml définit la manière dont l'application récupère les données de la base de données, par exemple avec Hibernate.
Il doit être copié en dao.xml.
Le fichier de configuration Hibernate hibernate/hibernate.cfg-example.xml définit la manière dont Hibernate se connecte à la base de données. Il doit être copié en hibernate.cfg.xml. Il est référencé par le bean abstractHibernateSessionFactory de défini dans le dao.xml.

Les fichiers de configuration Hibernate hibernate/mapping/.hbm* décrivent le mappingentre les classes Java et les tables de la base de données. Ils sont également référencés par le bean abstractHibernateSessionFactory de dao.xml. Il n'est en général pas nécessaire pour les administrateurs de modifier ces fichiers, ils ne sont pas fournis sous forme d'exemples.

...

Le fichier de configuration Spring i18n-example.xml définit le bean i18nService, qui indique comment l'application récupère les chaînes de caractères utilisés utilisées dans l'application. Il doit être copié en i18n.xml. Les fichiers bundles/_.properties contiennent les chaînes de caractères proprement dites.

...

Le fichier de configuration Spring converters.xml définit les convertisseurs de l'application, qui convertissent des objets en chaînes (vice-versaet inversement) lors des interactions utilisateur.

Le répertoire webapp : l'application web et ses bibliothèques

webapp/media : les fichiers statiques

On trouvera dans ce répertoire tous les fichiers délivrés de manière statique par l'application web aux clients :

...

L'intérêt de ce regroupement est de pouvoir shunter Tomcat par un frontal Apache, plus efficace pour le délivrement de ressources statiques.

/webapp/META-INF : le manifest

Le fichier /webapp/META-INF/MANIFEST.MF est produit automatiquement par MAVEN

/webapp/stylesheets : les pages JSF

Toutes les pages JSF doivent être situées à cet endroit pour pouvoir être protégées d'un accès direct de manière globale.

/webapp/WEB-INF : la configuration de l'application web

Le fichier portlet-example.xml indique à Pluto comment configurer la portlet, il n'est utilisé qu'en mode portlet. Il doit être copié en portlet.xml.

Les fichiers web-portlet-example.xml (resp. web-servlet-example.xml) est un exemple de configuration du contexte Tomcat associé à l'application. En mode portlet (resp. servlet), il doit être copié en web.xml.

/webapp/WEB-INF/jsf : les composants facelets

Tous les composants facelets utilisés dans le projet doivent se trouver dans ce répertoire.

/webapp/WEB-INF/lib : les bibliothèques de l'application

Même les applications en mode batch seulement doivent utiliser /webapp/WEB-INF/lib pour déposer leurs bibliothèques, même si dans ce cas le nommage n'est pas très approprié. C'est MAVEN qui se charge de créer et remplir ce répertoire.