|
|
|
|
|
|
|
|
|
|
- Leçon 1 - Audits du projet
- Présentation
- Qu'est-ce qu'un audit ?
- Ouverture du projet
- Audit statique
- Optimisation 1 : Procédure non exécutée
- Optimisation 2 : Elément orphelin
- Optimisation 3Â : Nettoyage du projet
- Audit dynamique
- Conclusion
Tuto - Optimiser un projet WEBDEV
Leçon 1 - Audits du projet Ce que vous allez apprendre : - Qu'est-ce qu'un audit et à quoi ça sert ?
- Lancer et analyser l'audit statique.
- Lancer et analyser l'audit dynamique.
 15 mn WEBDEV met à votre disposition plusieurs outils permettant d'optimiser un site. Vous pouvez ainsi améliorer les performances de votre site et éviter les "bugs" grossiers avant de déployer votre site. Ce tuto présente l'utilisation de plusieurs de ces outils. Dans cette première leçon nous verrons comment utiliser les différents audits mis à votre disposition et dans la leçon suivante, nous verrons comment utiliser l'analyseur de performances. Pour mieux manipuler ces fonctionnalités, nous avons préparé un projet à optimiser ! Les audits apportent une série de fonctionnalités permettant : - d'améliorer automatiquement la qualité et les performances d'un projet,
- de suivre plus précisément ses conditions de mise en exploitation.
Deux types d'audits sont disponibles : - L'audit statique. L'audit statique consiste en une analyse détaillée d'un projet et de ses éléments. Cet audit est effectué directement depuis l'éditeur de projet.
- L'audit dynamique. L'audit dynamique est une analyse du comportement d'un projet pendant son exécution. Cet audit peut être réalisé en mode test ou directement dans l'environnement de production.
Nous allons tout de suite tester ces audits sur le projet "WW_Optimisation". Ouverture du projet Ce tuto manipule le projet "WW_Optimisation". Pour ouvrir cet exemple : - Affichez la page d'accueil de WEBDEV (Ctrl + <).
- Dans la page d'accueil, cliquez sur "Tutoriel" puis dans la zone "Tuto - Optimiser un projet WEBDEV", double-cliquez sur "Optimiser un projet - Exercice".
 Avertissement
Cet exemple sera utilisé dans les différentes leçons de ce tuto.
L'audit statique est une fonctionnalité de l'environnement permettant d'analyser les sources d'un projet pour détecter différents problèmes et proposer des améliorations. Pour lancer l'audit statique sur le projet "WW_Optimisation" : - Dans le ruban, sous le volet "Projet", dans le groupe "Audit et performances", déroulez "Audit statique" et sélectionnez "Déclencher l'audit statique".
- L'assistant se lance. Nous allons définir la cible de l'audit statique.
- Sélectionnez l'option "Lancer l'audit statique sur le projet complet".
- Terminez l'assistant.
- Le rapport d'audit est affiché :
 L'audit statique se compose de : - du rapport d'audit (que nous allons voir en détail).
- de l'analyse de la bibliothèque de l'application.
Pour plus de détails, consultez Audit statique. Examinons avec attention les points présentés par ce rapport. Optimisation 1 : Procédure non exécutée Dans notre projet, l'audit nous indique qu'une procédure n'est jamais exécutée. Il arrive fréquemment dans des projets importants, de créer une ou plusieurs procédures pour réaliser un traitement, puis suite à une réorganisation du code, la procédure n'est plus utilisée mais reste dans le projet. La présence de procédures non utilisées alourdit inutilement les ressources distribuées aux utilisateurs finaux. Pour traiter ce problème : - Cliquez sur le bouton [...] pour obtenir plus de renseignements. La fenêtre listant les codes morts apparaît.
- La procédure "ProcédureObsolète" n'est jamais appelée. Cette fenêtre permet de :
- spécifier que la procédure est tout de même utilisée (bouton "Marquer comme utile"). Dans ce cas, la procédure ne sera plus prise en compte lors de l'audit.
- supprimer la procédure si elle est réellement inutilisée (bouton "Supprimer").
- voir la procédure (bouton "Voir").
- rechercher les cas d'utilisation dans les chaînes par exemple (bouton "Rechercher").
- Dans notre cas, cette procédure est réellement inutilisée, cliquez sur "Supprimer".
- Une fenêtre s'affiche demandant la confirmation de la suppression. Confirmez la suppression en cliquant sur le bouton "Supprimer".
- Fermez la fenêtre du code mort (utilisez la croix en haut à droite).
Dans la fenêtre de l'audit statique, cliquez sur le bouton "Rafraîchir" pour mettre à jour le rapport d'audit. Optimisation 2 : Elément orphelin L'audit nous indique que notre projet contient un élément orphelin. Comme pour les procédures exécutées, il arrive fréquemment de créer des fenêtres, des états afin d'effectuer un test rapide, de les enregistrer et de les oublier. La présence d'éléments orphelins dans l'exécutable alourdit inutilement les ressources distribuées aux utilisateurs finaux. Pour traiter ce problème : - Cliquez sur le bouton [...] pour obtenir plus de renseignements. La fenêtre listant les éléments orphelins apparaît.
- La page "PAGE_Page_Inutilisee" n'est jamais appelée. La fenêtre listant les éléments orphelins permet de :
- spécifier que l'élément est tout de même utilisé (bouton "Marquer comme utile"). Dans ce cas, la page de notre exemple ne sera plus prise en compte lors de l'audit. Cette option peut être intéressante par exemple dans le cas d'une page de test spécifique au développement.
- supprimer la page si elle est réellement inutilisée (bouton "Supprimer").
- voir la page (bouton "Voir").
- rechercher les cas d'utilisation dans les chaînes par exemple (bouton "Rechercher").
- Dans notre cas, cette page "PAGE_Page_Inutilisee" est réellement inutilisée, cliquez sur "Supprimer".
- Fermez la fenêtre des éléments orphelins (utilisez la croix en haut à droite).
Dans la fenêtre de l'audit statique, cliquez sur le bouton "Rafraîchir" pour mettre à jour le rapport d'audit. Optimisation 3 : Nettoyage du projet Notre projet contient plusieurs fichiers inutilisés. Il est possible de nettoyer le projet pour ne conserver que les éléments nécessaires. L'installation client n'est pas alourdie avec des fichiers non utilisés : images, fichiers externes, etc. Pour traiter ce problème : - Cliquez sur le bouton [...] pour obtenir plus de renseignements.
- L'assistant de nettoyage de projet se lance. Cet assistant indique les fichiers inutilisés qui peuvent être supprimés.
- Passez à l'étape suivante.
- Indiquez le type de nettoyage à réaliser. Il est possible de :
- créer un fichier zip avec les fichiers inutiles.
- déplacer les fichiers inutiles dans un répertoire spécifique.
- Validez l'option proposée par défaut et passez à l'étape suivante.
- Terminez l'assistant.
Nous avons optimisé notre projet en suivant tous les conseils de l'audit statique. L'audit statique permet d'avoir un état général sur les sources de votre projet. Notre conseil : lancez-le régulièrement ! Maintenant, voyons ce qui se passe en exécution en lançant l'audit dynamique. L'audit dynamique permet d'analyser l'exécution de l'application. L'audit permettra de déceler des problèmes tels que : - Consommation excessive de mémoire,
- Lenteurs des algorithmes utilisés,
- Erreurs "masquées" lors de l'exécution,
- etc.
Un audit dynamique peut être effectué dans un environnement de test ou sur une application en production. Le projet "WW_Optimisation" contient une page spécifique provoquant des erreurs pouvant être détectées par l'audit dynamique. Nous allons lancer l'audit dynamique en même temps que le test du projet.
Pour lancer l'audit dynamique sur le projet "WW_Optimisation" : - Dans le ruban, sous le volet "Projet", dans le groupe "Mode test", déroulez "Mode test" et sélectionnez "Déboguer le projet avec l'audit activé". Le test du projet se lance.
- Cliquez sur le bouton "PAGE DE TEST DE L'AUDIT DYNAMIQUE".
- Cliquez sur les différents boutons présents dans la page.
- A la fin de chaque traitement, un message sous forme de toast est affiché pour indiquer que le traitement est terminé.
Remarque : Attendez l'affichage du toast avant de cliquer sur un nouveau bouton. - Pour l'option "Assertion et Exception", une assertion est affichée : cliquez "Continuer" pour voir apparaître le message sous forme de toast.
- Arrêtez le test du site.
- La fenêtre de compte-rendu de l'audit dynamique s'affiche.
Examinons cette fenêtre : - La partie haute de cette fenêtre permet de choisir le mode d'affichage des données. Il est possible de :
- choisir un affichage chronologique (respectant l'ordre d'arrivée des événements) ou un affichage synthétique, permettant de regrouper les différents types de problèmes. Lors d'un affichage chronologique, une frise chronologique permet de voir la position et l'importance des problèmes.
- choisir le type de problème à afficher (erreur, assertion, etc.). Il est ainsi par exemple possible de se concentrer uniquement sur les erreurs graves.
- La partie basse de cette fenêtre affiche les différents événements survenus pouvant poser problème dans l'application.
Dans cet exemple, l'audit dynamique détecte plusieurs problèmes : - Une instruction SELON dont aucun CAS n'est exécuté,
- Une assertion déclenchée,
- Une exception déclenchée,
- L'affectation d'un fichier image qui n'existe pas à un champ Image. Pour chaque problème, un bouton "..." permet d'accéder au détail de l'événement enregistré. Si l'événement est relié à une ligne de code particulière, le bouton
 permet d'ouvrir directement l'éditeur de code à l'emplacement correspondant afin de corriger le problème.
Avertissement
Cette leçon présentant uniquement le fonctionnement de l'audit dynamique, nous ne corrigerons pas toutes les erreurs détectées.
Fermez la fenêtre de l'audit dynamique. L'audit statique et l'audit dynamique sont des outils importants, vous permettant de comprendre rapidement les problèmes ou ralentissements de votre application. Ces deux outils sont également directement accessible via le tableau de bord de votre projet. La leçon suivante va nous permettre d'utiliser un outil complémentaire : l'analyseur de performances. Pour aller plus loin : L'audit dynamique d'un projet peut également être effectué lorsque le site est déployé. Il est possible d'utiliser la fonction dbgActiveAudit pour déclencher l'audit dynamique. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|