Báo cáo chất lượng mã với Maven
Bằng cách cải thiện chất lượng mã của một chương trình, người ta cũng sẽ cải thiện tính mạnh mẽ và khả năng bảo trì của nó. Hướng dẫn này sẽ hướng dẫn bạn cách tạo báo cáo chất lượng mã cho dự án Maven .
- Cách tạo trang web dự án và báo cáo với Maven
- Phân tích mã và báo cáo trình cắm cho Maven
- Cách tạo báo cáo trong Maven
- Cách xem báo cáo trong Maven
- Nguồn XRef
- Kiểm tra nguồn Xref
- Tài liệu Java
- Kiểm tra tài liệu Java
- Báo cáo chắc chắn
- Báo cáo thất bại
- Kiểu dáng
- CPD
- PMD
- FindBugs
- Lập báo cáo của bạn với SonarQube
Cách tạo trang web dự án và báo cáo với Maven
Maven cung cấp cho bạn khả năng tạo một trang web HTML mô tả dự án của bạn. Bạn có thể dùngtrang mvnlệnh để tạo trang web dự án của bạn.
Sau khi hoàn tất, hãy mở tệp đích / site / index.html để xem trang:
Trang web của dự án thường sẽ chứa thông tin kỹ thuật về kiến trúc của dự án (phần phụ thuộc, phần bổ trợ); bạn sẽ cần làm phong phú nó với dữ liệu được tạo bởi các trình cắm báo cáo của Maven (như được xác định trong tệp cấu hình dự án của bạn).
Phân tích mã và báo cáo trình cắm cho Maven
Dưới đây là một đoạn trích có thể được tích hợp vào tệp cấu hình của bạn ( pom.xml ). Nó có một vài trình cắm độc lập để phân tích và báo cáo mã. Mỗi trình cắm sẽ tạo một báo cáo cụ thể trên trang web của dự án.tổ chức org.apache.maven.plugins không org.apache.maven.plugins maven-chắc chắn Các quy tắc /android.xml / các quy tắc java / basic.xml / các quy tắc java / braces.xml / các quy tắc java / clone.xml / quy tắc java / bộ quy tắc designDB / bộ quy tắc java / tập tin trống / bộ quy tắc java / bộ tập tin quy tắc / bộ điều khiển java / bộ tập tin / bộ điều khiển java -jakarta-commons.xml quy tắc / java / log-java.xml quy tắc / java / Migrating.xml quy tắc / java / Migrating_to_13.xml quy tắc / java / quy tắc / java / naming.xml quy tắc /java/optimizes.xml quy tắc / java /rictexception.xml quy tắc / java / chuỗi quy tắc / java / sunsecure.xml codehaus.mojo findbugs-maven-plugin 3.0.0
NB Các plugin này được đưa ra làm ví dụ. Nhấp vào trình cắm để khám phá danh sách đầy đủ các trình cắm có sẵn.
Cách tạo báo cáo trong Maven
Trước khi bạn tạo trang web dự án, điều quan trọng là phải chạy thử nghiệm đơn vị và tích hợp cho từng trình cắm mới. Bạn có thể, ví dụ, sử dụngxác minh trang web mvnlệnh để tạo một trang web dự án sẽ bao gồm các kết quả của bài kiểm tra đơn vị và tích hợp .
Cách xem báo cáo trong Maven
Nhấp vào Dự án của tôi > Tài liệu dự án > Báo cáo dự án để xem các báo cáo:
Nguồn XRef
Báo cáo này sẽ cho phép bạn xem mã nguồn của dự án:
Kiểm tra nguồn Xref
Báo cáo này sẽ cho phép bạn xem phiên bản tham chiếu chéo của mã nguồn thử nghiệm của dự án.Tài liệu Java
Báo cáo này sẽ chứa tài liệu API JavaDoc :
Kiểm tra tài liệu Java
Báo cáo này sẽ chứa tài liệu API JavaDoc thử nghiệm .Báo cáo chắc chắn
Báo cáo này sẽ chứa các kết quả để thử nghiệm đơn vị :
Báo cáo thất bại
Báo cáo này sẽ chứa các kết quả để thử nghiệm tích hợp .Kiểu dáng
Báo cáo này sẽ liệt kê tất cả các vi phạm quy tắc cú pháp tiêu chuẩn trong Java:
Các quy tắc đằng sau các thông báo lỗi có thể được chỉnh sửa thông qua Cấu hình Bộ kiểm tra Kiểu kiểm tra tùy chỉnh.
CPD
Báo cáo này sẽ làm nổi bật các khối mã trùng lặp trong dự án:
Chỉnh sửa
giá trịtham số để xác định độ dài mã tối thiểu.
PMD
Báo cáo này sẽ nêu bật việc xây dựng mã kém (vi phạm Quy tắc PMD hiện tại) có thể dẫn đến lỗi:
Chỉnh sửa
tham số để thay đổi Bộ quy tắc PMD mặc định.FindBugs
Maven sẽ tạo một báo cáo mã nguồn với Thư viện FindBugs. Báo cáo mở rộng này sẽ liệt kê các lỗi có thể có trong mã của bạn: