Αναφορά ποιότητας κώδικα με το Maven
Με τη βελτίωση της ποιότητας του κώδικα ενός προγράμματος, θα βελτιωθεί επίσης η ευρωστία του και η διατηρησιμότητά του . Αυτός ο οδηγός θα σας διδάξει πώς να δημιουργείτε αναφορές ποιότητας κώδικα για ένα έργο Maven .
- Πώς να δημιουργήσετε την τοποθεσία του έργου και τις αναφορές με το Maven
- Ανάλυση κώδικα και αναφορά για plug-ins για το Maven
- Πώς να δημιουργήσετε αναφορές στο Maven
- Πώς να προβάλετε αναφορές στο Maven
- Πηγή XRef
- Πηγή δοκιμής Xref
- Java Docs
- Δοκιμάστε τα Έγγραφα Java
- Έκθεση Surefire
- Αναφορά Failsafe
- Checkstyle
- CPD
- PMD
- FindBugs
- Συγκεντρώστε τις αναφορές σας με το SonarQube
Πώς να δημιουργήσετε την τοποθεσία του έργου και τις αναφορές με το Maven
Το Maven σάς δίνει τη δυνατότητα να δημιουργήσετε έναν ιστότοπο HTML που περιγράφει το έργο σας. Μπορείτε να χρησιμοποιήσετε τοmvn siteεντολή για τη δημιουργία του ιστότοπου του έργου σας.
Μόλις ολοκληρωθεί, ανοίξτε το αρχείο target / site / index.html για να προβάλετε τον ιστότοπο:
Ο χώρος του έργου θα περιέχει συνήθως τεχνικές πληροφορίες σχετικά με την αρχιτεκτονική του έργου (εξαρτήσεις, προσθήκες ...). θα πρέπει να τον εμπλουτίσετε με τα δεδομένα που παράγονται από τις προσθήκες αναφοράς της Maven (όπως ορίζονται στο αρχείο διαμόρφωσης του έργου σας ).
Ανάλυση κώδικα και αναφορά για plug-ins για το Maven
Παρακάτω υπάρχει ένα απόσπασμα που μπορεί να ενσωματωθεί στο αρχείο ρυθμίσεων ( pom.xml ). Διαθέτει μερικές αυτόνομες προσθήκες για την ανάλυση και την υποβολή αναφορών κώδικα. Κάθε προσθήκη θα δημιουργήσει μια συγκεκριμένη αναφορά στον ιστότοπο του έργου.org.apache.maven.plugins maven-failsafe-plugin 2.19.1 ενσωμάτωση-δοκιμή επαλήθευση org.apache.maven.plugins maven-jxr-plugin 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: none org.apache.maven.plugins maven-surefire-report-plugin 2.19.1 org.apache.maven.plugins maven-checkstyle-plugin 2.17 org.apache.maven.plugins maven-pmd-plugin 3.6 false true 50 κανόνες κανόνων / java /android.xml κανόνες κανόνων / java / basic.xml κανόνες κανόνων / java / links.xml κανόνες κανόνων / java / links.xml κανόνες κανόνων / java / Σχετικά με τον κώδικα / java / junit.xml κανόνες κανόνων / java / java / junits.xml κανόνες κανόνων / java / java / junits.xml κανόνες κανόνων / java / -jakarta-commons.xml κανόνες κανόνων / java / logging-java.xml κανόνες κανόνων / java / migrating.xml κανόνες κανόνων / java / migrating_to_13.xml κανόνες κανόνων / java / migrating_to_14.xml κανόνες κανόνων / java / migrating_to_15.xml rulesets / java / migrating_to_junit4.xml κανόνες κανόνων / java / naming.xml κανόνες κανόνων /java/optimizations.xml κανόνες κανόνων / java / strictexception.xml κανόνες κανόνων / java / strings.xml κανόνες κανόνων / java / sunsecure.xml κανόνες κανόνων / java / typeresolution.xml κανόνες κανόνων / java / unnecessary.xml rulesets / java / unusedcode.xml org. codehaus.mojo findbugs-maven-plugin 3.0.0
ΣΗΜΕΙΩΣΗ Αυτές οι προσθήκες δόθηκαν ως παραδείγματα. Κάντε κλικ στις προσθήκες για να ανακαλύψετε την πλήρη λίστα των διαθέσιμων προσθηκών.
Πώς να δημιουργήσετε αναφορές στο Maven
Προτού δημιουργήσετε τον ιστότοπο του έργου, είναι σημαντικό να εκτελέσετε δοκιμές μονάδας και ολοκλήρωσης για κάθε νέα προσθήκη. Μπορείτε, για παράδειγμα, να χρησιμοποιήσετε τοmvn επαληθεύει τον ιστότοποεντολή για τη δημιουργία ενός ιστότοπου έργου που θα περιλαμβάνει ήδη τα αποτελέσματα της μονάδας και τις δοκιμές ολοκλήρωσης .
Πώς να προβάλετε αναφορές στο Maven
Κάντε κλικ στο My Project > Project Documentation > Project Reports για να δείτε τις αναφορές:
Πηγή XRef
Αυτή η αναφορά θα σας επιτρέψει να δείτε τον πηγαίο κώδικα του έργου:
Πηγή δοκιμής Xref
Αυτή η αναφορά θα σας επιτρέψει να δείτε μια έκδοση αναφοράς παραπομπής του πηγαίου κώδικα δοκιμής του έργου.Java Docs
Αυτή η αναφορά θα περιέχει την τεκμηρίωση API JavaDoc :
Δοκιμάστε τα Έγγραφα Java
Αυτή η αναφορά θα περιέχει την τεκμηρίωση API Test JavaDoc .Έκθεση Surefire
Αυτή η αναφορά θα περιέχει τα αποτελέσματα για τη δοκιμή μονάδων :
Αναφορά Failsafe
Αυτή η αναφορά θα περιέχει τα αποτελέσματα για τις δοκιμές ολοκλήρωσης .Checkstyle
Αυτή η αναφορά θα απαριθμεί όλες τις παραβιάσεις των πρότυπων κανόνων σύνταξης στην Java:
Οι κανόνες πίσω από τα μηνύματα σφαλμάτων μπορούν να επεξεργαστούν μέσω μιας προσαρμοσμένης ρύθμισης Checkstyle Checker.
CPD
Αυτή η αναφορά θα επισημάνει διπλά μπλοκ κωδικών στο έργο:
Επεξεργαστείτε το
αξίαγια να ορίσετε το ελάχιστο μήκος κώδικα.
PMD
Αυτή η αναφορά θα επισημάνει την ανεπαρκή κατασκευή κώδικα (κατά παράβαση της ισχύουσας σειράς κανόνων PMD ) που ενδέχεται να οδηγήσει σε σφάλματα:
Επεξεργαστείτε το
για να αλλάξετε το προεπιλεγμένο σύνολο κανόνων PMD.FindBugs
Η Maven θα δημιουργήσει μια αναφορά πηγαίου κώδικα με τη Βιβλιοθήκη FindBugs. Αυτή η εκτεταμένη αναφορά θα αναφέρει τα πιθανά σφάλματα στον κώδικά σας: