Points importants à garder à l'esprit avant une révision de code en Java

Question

Je viens de créer une application web de taille moyenne utilisant Java, un framework MVC personnalisé, javascript. Mon code sera revu avant d'être mis dans les serveurs de production (usage interne).

L'objectif principal de la construction de cette application était de résoudre un petit problème à usage interne et de comprendre le cadre MVC sur mesure utilisé par mon employeur. Donc, mon application a traversé BEAUCOUP itérations, les changements de fonctionnalités et les ajouts. Donc, en bout de ligne, le code est très très sale et c'est ma première application Java «au niveau du produit». Quelles sont vos suggestions, quelles sont les vérifications/réfractations de base que je devrais faire avant l'examen du code?

Je pense à:

1. Java les meilleures pratiques (conventions)

2. Faire le code simple à comprendre pour le développeur qui le maintiendra. (ne sera pas moi)

3. J'ai remarqué, j'ai créé des objets inutiles et hashmaps/arraylists utilisés où aurait pu facilement utiliser une autre structure de données et a réalisé la solution. Alors, cela vaut-il la peine de changer?

Mise à jour

Your Code Sucks and I Hate You: The Social Dynamics of Code Reviews

Answer 1

Si vous ne l'avez pas déjà, (en supposant que vous utilisez un IDE comme Eclipse)

• get plugins checkstyle et findbugs
• passent par leur configuration et syntoniser votre style
• les exécuter sur votre code
• résoudre tous les problèmes signalés

vous pouvez également régler le paramètre d'avertissement du compilateur d'éclipse Itse Si oui, et peut-être les rendre plus strictes dans ce qui est rapporté.

Regardez la structure du code:

• obtenir le plugin JDepend
• enquêtera sur votre structure de package

code contre les interfaces (Carte, Liste, Set) au lieu des cours de mise en œuvre (HashMap, ArrayList, TreeSet)

Complétez votre Javadoc et vérifiez qu'il est à jour après tous les refactorings.

Ajouter des tests JUnit; Si vous n'avez plus le temps de tester l'ensemble de l'application, créez au moins un test pour chaque bogue que vous trouvez et résolvez à partir de maintenant. Cela aide à "développer" un ensemble de tests au fur et à mesure.

La prochaine fois que vous concevez et construisez votre application avec l'objectif final en vue. Supposons toujours que le prochain type à maintenir votre code saura vous trouver :-)

Answer 2

tests unitaires, et ils devraient être automatisés dans le cadre de votre construction. Vous devriez déjà les avoir, mais si ce n'est pas le cas, faites-le maintenant. Cela va certainement faciliter le refactoring, tout en améliorant votre confiance générale dans le code (et le gars qui va le maintenir).

Answer 3

Enregistrement.

L'une des choses les plus négligées est l'importance de la journalisation. Vous devez avoir mis en place une méthodologie d'exploitation forestière décente. Même s'il s'agit d'une application interne, assurez-vous que les journaux de base peuvent aider les utilisateurs réguliers à trouver des problèmes et fournir une journalisation plus détaillée afin que vous (le développeur) sachiez où aller.

Answer 4

Commentez votre code, expliquez pourquoi il fait ce qu'il fait et quelles hypothèses ont été faites. Essayez de réduire la quantité d'état de mutation.

Essayez d'enlever tous les singletons que vous pourriez avoir.