Hoàn thiện chất lượng code là mục tiêu mà hầu hết các nhà phát triển phần mềm đều chia sẻ và mặc dù mục đích rất đơn giản nhưng chiến lược để đạt được mục tiêu đó có thể phức tạp. Cách thức và nội dung bạn đo lường là những yếu tố chính trong việc cải thiện kết quả của quá trình xem xét.
Điều này đặc biệt đúng đối với những nhóm áp dụng nguyên tắc cải tiến liên tục, liên tục chú ý đến sự xuất sắc về mặt kỹ thuật và phản ánh thường xuyên. Với hơn 20 năm kinh nghiệm phát triển phần mềm, JetBrains đã thu thập những hiểu biết sâu sắc để chia sẻ về những số liệu nào có thể hiệu quả nhất cho các nhóm.
6 Thước đo chất lượng code cho lập trình viên
-
Độ phức tạp theo chu kỳ (CYC)
CYC là thước đo độ phức tạp luồng code của chương trình dựa trên số lượng đường dẫn độc lập thông qua mã nguồn. Đây là một thước đo quan trọng đối với chất lượng code vì khi độ phức tạp tăng lên, code sẽ trở nên khó hiểu, khó kiểm tra và bảo trì hơn. Nếu bạn đang theo cách tiếp cận Agile thì tính bền vững và khả năng bảo trì là chìa khóa. Đây là nơi CYC có thể cung cấp cho bạn cái nhìn sâu sắc về những điểm bạn có thể cần đơn giản hóa.
Hãy xem xét ví dụ đơn giản sau về một đoạn mã chỉ thực thi các câu lệnh một cách tuần tự, không có bất kỳ điều kiện hoặc nhánh nào:
public int sum(int a, int b) {
System.out.println(“Adding two numbers: ” + a + ” + ” + b);
return a + b;
}
Vì không có nhánh trong code nên với bất kỳ sự kết hợp nào các giá trị tham số, tất cả các câu lệnh trong hàm sẽ được thực thi. Do đó, kết quả CYC cho mã này là 1.
Nếu chúng tôi đưa ra câu lệnh có điều kiện để kiểm tra đầu vào, CYC sẽ tăng gấp đôi vì mã của chúng tôi sẽ chứa hai đường dẫn thực thi có thể có thay vì một nhánh duy nhất:
public int sum(int a, int b) {
if(a < 0) throw new IllegalArgumentException(“Parameter a should be positive“);
System.out.println(“Adding two numbers: ” + a + ” + ” + b);
return a + b;
}
Thêm một điều kiện khác để kiểm tra tham số thứ hai sẽ tăng kết quả CYC lên 3:
Bất kỳ câu lệnh điều kiện hoặc khối vòng lặp nào cũng sẽ thêm vào chỉ số CYC của một phương thức, do đó góp phần vào số lượng thử nghiệm cần thiết để thực thi thông qua tất cả các nhánh code.
Mặc dù giá trị CYC cao không cho biết ngay rằng chất lượng code có vấn đề, lỗi hoặc bị hỏng nhưng đó chắc chắn là dấu hiệu cho thấy mã có thể khó bảo trì, khiến mã dễ bị hỏng hơn khi có những thay đổi mới. IntelliJ IDEA có thể thông báo cho bạn về các phương thức quá phức tạp ngay trong trình chỉnh sửa. Ngưỡng kiểm tra Overly complex method có thể được cấu hình trong Settings | Editor | Inspections:
Cách kích hoạt tính năng kiểm tra này cho toàn bộ dự án của bạn
Nếu bạn đang sử dụng Qodana để phân tích mã phía máy chủ (để theo dõi chất lượng code cho toàn bộ nhóm chứ không chỉ cục bộ), bạn có thể tự động kiểm tra CYC. Chọn Recommended profile và kiểm tra xem nó có được bật cho ngôn ngữ bạn đang code hay không.
Giải thích kết quả
Trong bài trình bày của mình về “Các thước đo chất lượng phần mềm để xác định rủi ro, cho Bộ An ninh Nội địa”, Tom McCabe Jr. nói rằng nếu giá trị thước đo CYC của một phương pháp nhỏ hơn 10 thì mã được coi là đủ đơn giản.
Nếu số liệu vượt quá 50, mã được coi là quá phức tạp và không thể kiểm tra được. Tuy nhiên, trên thực tế, bạn nên nhắm đến các giá trị dưới 6 và đặt cảnh báo nếu kết quả trên 10. Điều này cho thấy rằng đã đến lúc đơn giản hóa hàm để ngăn độ phức tạp tăng lên.
Phạm vi đề xuất của chúng tôi cho điểm CYC như sau:
1–5 – Mã đơn giản, dễ kiểm tra và gỡ lỗi
6–10 – Phức tạp hơn, rủi ro vừa phải
10–20 – Rủi ro cao, hãy cẩn thận
20+ – Code rất phức tạp, khó hiểu và khó bảo trì
-
Tỷ lệ trùng lặp code
Tỷ lệ phần trăm trùng lặp code giúp bạn xác định số lượng code giống nhau hoặc tương tự xuất hiện ở nhiều vị trí trong cơ sở code. Đây là một số liệu quan trọng vì mức độ trùng lặp code cao có thể dẫn đến tăng cường bảo trì, nguy cơ xuất hiện lỗi cao hơn và giảm khả năng đọc code.
Với Qodana, kiểm tra trùng lặp được bật theo mặc định, nhưng bạn cũng có thể định cấu hình phát hiện trùng lặp trong IntelliJ IDEA và các IDE khác như WebStorm và Rider.
Giải thích kết quả
Tốt nhất, bạn nên giữ tỷ lệ sao chép code của mình thấp hơn 5%. Điều này có thể giúp bạn tránh việc tái cấu trúc không cần thiết. Đảm bảo giám sát việc sao chép code liên tục, cục bộ hoặc ở phía máy chủ bằng các công cụ như Qodana.
-
Phạm vi code (kiểm tra)
Viết các trường hợp kiểm thử với phạm vi bao phủ tối đa có thể giúp bạn xác minh rằng phần mềm của bạn thực thi như mong đợi trước khi kiểm thử thủ công. Với việc thử nghiệm hiệu quả hơn, bạn có thể sẽ đưa được sản phẩm chất lượng cao ra thị trường nhanh hơn.
Ngoài ra, phạm vi kiểm tra code sẽ tăng cường khả năng bảo trì và có thể cảnh báo bạn về mã dư thừa, vì nó được đo lường dựa trên giả định rằng phạm vi kiểm tra cao hơn dẫn đến ít lỗi code hơn.
Phương pháp phổ biến nhất để đánh giá phạm vi kiểm tra code là đo bằng số dòng code:
Tỷ lệ phần trăm bao phủ code = (số dòng code được thuật toán kiểm tra / tổng số dòng code trong một thành phần hệ thống) * 100
Tuy nhiên, có hai chiến lược khác:
1) Đo lường bằng câu lệnh
2) Đo theo nhánh, được kết nối tốt hơn với số liệu độ phức tạp chu kỳ, vì độ phức tạp cho biết bạn cần triển khai bao nhiêu thử nghiệm để bao quát mã.
Đánh giá mức độ bao phủ của code
Nếu bạn có bản quyền phần mềm Qodana Ultimate hoặc Ultimate Plus, với Qodana cho JVM, JS hoặc PHP, bạn có thể chạy thử nghiệm mức độ bao phủ code trong hồ sơ qodana.recommends hoặc qodana.starter của mình.
-
Số lượng lỗi có thể xảy ra
Chất lượng code tốt nhất khi lỗi code càng gần bằng 0 và phân tích code có khả năng gắn cờ tất cả các loại lỗi. Một ví dụ là NullPointerExceptions, được nêu ra khi chúng tôi đang cố gắng thực hiện một thao tác trong đó cần có một đối tượng. Đây thường là kết quả của việc sử dụng một phương thức trên một phiên bản đối tượng rỗng khi chạy hoặc cố gắng truy cập các biến của phiên bản đó.
Điều quan trọng để đảm bảo chất lượng code là phải phát hiện sớm những vấn đề này để tránh phát hành phiên bản có lỗi của sản phẩm, đặc biệt vì bạn có thể không nhận thấy ngay chúng trong code của mình hoặc thậm chí trong quá trình đánh giá ngang hàng. Qodana có thể dễ dàng giải quyết các vấn đề liên quan đến việc xử lý tài nguyên không chính xác, chẳng hạn như kết nối cơ sở dữ liệu không được đóng an toàn sau khi sử dụng.
-
Code smells
Việc đo code smells, chẳng hạn như mức sử dụng API không được dùng nữa, rất quan trọng để duy trì tình trạng hoạt động của cơ sở mã phần mềm. Mặc dù việc sử dụng API không được dùng nữa có thể được đánh giá theo cách thủ công, cho phép người đánh giá xác định và đề xuất các lựa chọn thay thế cho các API không được dùng nữa, cách tiếp cận phổ biến nhất là sử dụng các công cụ phân tích mã tĩnh như Qodana.
-
Số lượng lỗ hổng
Các lỗ hổng trong code đề cập đến các điểm yếu hoặc vấn đề về bảo mật có thể dẫn đến vi phạm bảo mật, rò rỉ dữ liệu hoặc các vấn đề khác liên quan đến bảo mật.
Ngay cả một lỗ hổng cũng có thể dẫn đến vi phạm an ninh nghiêm trọng. Chúng ta chỉ cần xem xét các ví dụ về X (trước đây là Twitter), CloudFlare và AWS, những nền tảng đã bị ảnh hưởng nghiêm trọng bởi lỗ hổng Log4J. Những lỗ hổng này có thể biểu hiện dưới nhiều dạng khác nhau, chẳng hạn như lỗ hổng bảo mật, lỗi cấu hình, sự cố kiểm soát truy cập, lỗ hổng phụ thuộc, v.v…
Ở trên, bạn có thể thấy quá trình kiểm tra chất lượng code trong Qodana Cloud sẽ gắn cờ các phần phụ thuộc dễ bị tổn thương. Bạn cũng có thể kiểm tra giấy phép phụ thuộc bằng dữ liệu Qodana.
Ảnh
Sau khi xác định số lượng lỗ hổng trong mã của mình, bạn có thể đánh giá lỗ hổng nào trong số đó là nghiêm trọng và có nguy cơ cao nhất. Từ đó, bạn có thể bắt đầu giải quyết các vấn đề có mức độ ưu tiên cao nhất ngay lập tức và lưu những vấn đề ít quan trọng hơn vào Đường cơ sở để giải quyết sau.
Đơn giản hóa việc đo lường chất lượng code bằng phân tích mã tĩnh
Số liệu về chất lượng code giúp hướng dẫn bạn hướng tới mã sạch hơn, hiệu quả hơn và dễ bảo trì hơn. Các số liệu này cung cấp cái nhìn toàn diện về tình trạng của dự án theo thời gian, mang lại cho bạn lợi thế chiến lược trong việc cải thiện sản phẩm của mình và cộng tác theo nhóm.
Nếu bạn đang muốn triển khai các số liệu này vào quy trình phân phối của mình, Qodana có thể trợ giúp. Nó hoàn toàn phù hợp với bất kỳ quy trình CI/CD nào, mang lại cho toàn bộ nhóm của bạn một nguồn thông tin đáng tin cậy duy nhất về chất lượng code. Trên hết, kết quả quét của nó có sẵn trong IDE JetBrains, cho phép bạn khắc phục sự cố nhanh chóng.
Ưu đãi: Mua Jetbrains giảm 50% khi mua tại ViHoth
Bảng giá phần mềm JetBrains mới nhất áp dụng từ 1.10.2022 Chúng tôi vẫn luôn nỗ lực để mang đến cho cộng đồng và người dùng các sản phẩm với dịch vụ hỗ trợ tốt và mức giá tối thiểu.
Liên hệ ViHoth Corporation, đại lý phân phối ủy quyền của JetBrains tại Việt Nam khi bạn cần tư vấn, báo giá, mua phần mềm bản quyền JetBrains.
Hotline: 0982 018 497 – Email: media@vihoth.com
Nguồn: JetBrains
Dịch: ViHoth Solutions