Visualiser

NORMES & CONVENTIONS DE
DEVELOPPEMENT JAVA ET SQL
Conseil, Etudes et Edition de logiciels

Table des matières
Système d'exploitation ...................................................... 3
Environnement de développement intégré ...................................... 3
Le workspace ................................................................ 3
Le serveur applicatif ....................................................... 3
Règles de nommages des objets ............................................... 4
Les tables .................................................................. 4
Les colonnes ................................................................ 5
Les index ................................................................... 5
Introduction ................................................................ 5
Normalisation des projets ................................................... 6
Normalisation des noms de packages .......................................... 6
Normalisation des noms de fichiers .......................................... 6
Normalisation des noms des classes .......................................... 6
Règles communes .......................................................... 6
Nommage des objets métiers ............................................... 6
Nommage des DAO .......................................................... 7
Nommage des services .................................................... 7
Nommage des Contrôleurs .................................................. 7
Nommage des JSPX ......................................................... 7
Normalisation des noms des méthodes ...................................... 8
Normalisation des noms des variables ..................................... 8
Normalisation des noms des constantes .................................... 8
Taille limite des éléments .................................................... 9
Organisation du code .......................................................... 9
183 avenue Georges Clemenceau – 92000 NANTERRE – Tél. : [phone]
E-mail : [e-mail] – Site : http://www.phoenix-access.com
Phoenix Access SARL au capital de 30 000 € - 417 781 028 RCS Nanterre - Code NAF 721 Z

1. Introduction
Les normes sont importantes pour les développeurs, et ce pour différentes raisons :
•La maintenance d’un logiciel représente environ 80% de son coût total,
•Il est rare que la personne ayant développé le logiciel à l’origine le maintienne pendant
toute sa durée de vie.
•L’utilisation des normes permet d’accroître la lisibilité du code, tout en aboutissant à une
industrialisation et à une standardisation du code.
2. Objectif du document
Ce document décrit l'environnement de travail du poste de développement, et recense les
normes, standards et conventions à appliquer lors des développements des projets.
3. Environnement de travail
Système d'exploitation
Le système d'exploitation du poste de développement est Microsoft Windows XP.
Environnement de développement intégré
L'environnement de développement utilisé est Eclipse : Eclipse IDE for Java EE
Developers téléchargeable depuis : http://www.eclipse.org/downloads/packages/eclipse-
ide-java-ee-developers/heliossr2.
Plu-gins
Plugin Jbosstools : pour installer ce plugin suivez l'une des deux procédures proposé sur
cette page : http://www.jboss.org/tools/download/installation
Le workspace
L'environnement de développement nécessite la définition d'un espace de travail où est
sauvegardé l'ensemble des codes sources des différents projets. Chaque développeur du
projet dit disposer un répertoire nommé workspace.
Le serveur applicatif
Le serveur tomcat doit être installé sur chaque poste de développement. L'installable de
tomcat est téléchargeable depuis: http://tomcat.apache.org/download-70.cgi#7.0.14

Remarque :
Aucune bibliothèque autre que celles déjà existantes le répertoire tomcat\common\lib ne
doit être copié.
4. Normes de réalisation SQL
Règles de nommages des objets
Les identifiants
Les identifiants servent à nommer les objets SQL tels que : Tables, Procédures, Triggers…
.
Les règles syntaxiques générales qui s’appliquent à ces identifiants sont les suivantes :
La longueur maximale d'un identifiant est de 50 caractères.
 Un nom d'identifiant commence nécessairement par une lettre.
 Les caractères qui peuvent être utilisés sont :
 les lettres non accentués,
 les chiffres,
 le caractère _ (underscore).
Les tables
Les seules contraintes existant sur les identifiants des tables sont la conformité aux règles
syntaxiques générales des objets SQL. Toutefois, il est recommandé de respecter les
bonnes pratiques suivantes :
 Le nom de la table doit être court et permettre d’identifier rapidement l’entité
fonctionnelle concernée. Exemple : Poste, Pays, …
 Si le nom de la table est trop long pour une utilisation simple, une abréviation dont
la signification reste aisée à déchiffrer peut être utilisée. Exemple : ImpBud pour
Imputation Budgétaire
 Il est préférable, dans le cas d’un nombre important de tables, d’utiliser un préfixe
de 3 caractères suivi du caractère souligné faisant référence à un domaine
fonctionnel particulier. Ex : prv_budget pour budget prévisionnel, rea_budget pour
budget réalisation.
Les colonnes
 Le nom d’une colonne de table doit être court et permettre d’identifier rapidement
l’information. Exemple : Nom, Adresse, …
 Le type de données de la colonne doit correspondre de préférence à un type de

données utilisateur
 Chaque table possède une colonne identifiant considérée comme clé primaire. Son
nom est défini sous la forme : <id>
5. Normes de réalisation Java/J2ee
Introduction
Chaque Mini projet développé est composée de deux parties :
 Une partie métier, qui implémente les fonctionnalités de l'application
(données, traitements, règles de gestion), sachant que cette partie peut utiliser des
parties métier tierces.
 Une partie interface (web) qui utilise la partie métier et qui représente la
partie visuelle de l'application.
Normalisation des projets
Le répertoire principal du module applicatif est composé de deux sous-répertoires :
 un répertoire pour l'application métier, dont le nom est composé de la concaténation
du code du mini projet et de CORE. Exemple : MP_HABILITATION_01_CORE.
 un répertoire pour l'application web, dont le nom est composé de la concaténation
du mini projet et de RIA. Exemple: MP_HABILITATION_01_RIA.
Le mini projet est un projet Maven, qui contient deux modules : le module CORE le
module RIA. Les deux modules sont regroupe dans un parent.
Normalisation des noms de packages
Il est important de noter que le nom du package de l'application est celui utilisé dans le
dossier de conception ; de plus, le package principal est nommé : com.gol .
Normalisation des noms de fichiers
Les fichiers JAVA ne contiennent qu’une seule classe (ou interface). Ainsi, le nom du
fichier et le nom de la classe sont identiques.
Normalisation des noms des classes
La normalisation des noms de classes dans les packages est la suivante :