Mục Lục
SonarQube là gì?
SonarQube, được phát triển bởi SonarSource cách đây hơn một thập kỷ, là một nền tảng mã nguồn mở mạnh mẽ, hỗ trợ bạn kiểm tra và đảm bảo chất lượng mã nguồn của dự án. Mặc dù được viết bằng Java, SonarQube hỗ trợ đa dạng các ngôn ngữ lập trình phổ biến như PHP, Ruby, Java (bao gồm Android), C#, JavaScript, TypeScript, C/C++, Kotlin, Go, COBOL, PL/SQL, PL/I, ABAP, VB.NET, VB6, Python, RPG, Flex, Objective-C, Swift, CSS, HTML và XML. Nền tảng này sử dụng các cơ sở dữ liệu như MySQL và PostgreSQL để lưu trữ kết quả phân tích.
Tại sao nên sử dụng SonarQube trong dự án?
Code review là một phần không thể thiếu trong quy trình phát triển phần mềm, đặc biệt khi làm việc nhóm. Tuy nhiên, việc review thủ công đôi khi gặp khó khăn do hạn chế về thời gian và sự tập trung của người review. SonarQube giải quyết vấn đề này bằng cách tự động quét toàn bộ mã nguồn dự án, đánh giá dựa trên các tiêu chuẩn coding đã được thiết lập cho từng ngôn ngữ. Hơn thế nữa, SonarQube cung cấp nhiều tính năng vượt trội hơn so với việc tuân thủ coding convention thông thường:
-
Phát hiện lỗi (Bug Detection): Xác định các lỗi tiềm ẩn có thể gây ra sự cố trong quá trình hoạt động của ứng dụng.
-
Phát hiện Code Smell và Duplicate Code: Tìm ra các đoạn mã có cấu trúc không tốt, khó bảo trì và các đoạn mã trùng lặp, giúp cải thiện tính nhất quán và khả năng bảo trì của dự án.
-
Đo lường độ bao phủ của Unit Test (Unit Test Coverage): Đánh giá mức độ kiểm tra của các unit test, đảm bảo rằng các thành phần quan trọng của ứng dụng được kiểm tra kỹ lưỡng.
-
Tính toán Technical Debt: Ước tính chi phí để sửa chữa các vấn đề về chất lượng mã nguồn, giúp đưa ra quyết định về việc ưu tiên các hoạt động cải thiện chất lượng.
-
So sánh chất lượng Code theo thời gian: Theo dõi sự thay đổi về chất lượng mã nguồn giữa các lần kiểm tra, giúp đánh giá hiệu quả của các hoạt động cải thiện chất lượng.
Giao diện đăng nhập SonarQube
Hướng dẫn sử dụng SonarQube Online (SonarCloud)
Để giúp bạn làm quen với SonarQube một cách nhanh chóng, chúng ta sẽ sử dụng phiên bản online miễn phí của SonarQube, được gọi là SonarCloud.
- Truy cập SonarCloud: Truy cập trang web SonarCloud. Bạn có thể đăng nhập bằng tài khoản GitHub, Bitbucket hoặc GitLab của mình. Trong ví dụ này, chúng ta sẽ sử dụng GitHub.
Chọn nhà cung cấp dịch vụ để đăng nhập
- Chọn Repository: Sau khi đăng nhập, bạn sẽ được chuyển đến trang quản lý dự án. Chọn “Analyze new project” và chọn repository chứa project bạn muốn kiểm tra. Nếu cần, bạn cần xác nhận quyền truy cập của SonarCloud vào repository của bạn trên GitHub.
Chọn project để phân tích
- Thiết lập Phân tích: Làm theo hướng dẫn trên trang web để thiết lập phân tích. SonarCloud sẽ cung cấp các lệnh cần thiết để chạy phân tích trên máy của bạn. Ví dụ, nếu bạn đang sử dụng Maven, bạn sẽ cần chạy một lệnh tương tự như sau trong terminal của dự án:
mvn clean verify sonar:sonar
Hướng dẫn thiết lập project để phân tích
- Chạy Phân tích: Mở terminal trong thư mục gốc của project và chạy các lệnh được cung cấp.
Kết quả phân tích trên terminal
- Xem Kết quả: Sau khi quá trình phân tích hoàn tất, trang web SonarCloud sẽ tự động làm mới và hiển thị kết quả phân tích. Bạn sẽ thấy tổng quan về chất lượng mã nguồn, bao gồm số lượng lỗi, code smell, và các vấn đề khác.
Tổng quan về kết quả phân tích project
- Chi tiết Vấn đề: Bạn có thể xem chi tiết từng vấn đề bằng cách nhấp vào phần tương ứng. SonarCloud sẽ hiển thị file và dòng code chứa vấn đề, cùng với mô tả chi tiết và gợi ý cách khắc phục.
Chi tiết các vấn đề được tìm thấy
Chi tiết vị trí và mô tả lỗi trong code
- Tùy chỉnh Quy tắc: Đôi khi, bạn có thể thấy số lượng lỗi và code smell “khủng khiếp”. Đừng lo lắng! SonarQube đánh giá dựa trên tất cả các ngôn ngữ có trong dự án và các quy tắc mặc định. Bạn có thể tùy chỉnh các ngôn ngữ và quy tắc này để phù hợp với tiêu chuẩn coding của dự án.
Thống kê số lượng lỗi và code smell
Kết luận
SonarQube là một công cụ mạnh mẽ giúp bạn cải thiện chất lượng mã nguồn và giảm thiểu rủi ro trong quá trình phát triển phần mềm. Bằng cách tự động hóa quá trình kiểm tra và đánh giá mã nguồn, SonarQube giúp bạn tiết kiệm thời gian và công sức, đồng thời đảm bảo rằng dự án của bạn tuân thủ các tiêu chuẩn coding tốt nhất. Ngoài ra, SonarQube có thể tích hợp với các nền tảng khác như Jenkins để thực hiện kiểm tra liên tục (Continuous Inspection), giúp bạn phát hiện và giải quyết các vấn đề về chất lượng mã nguồn một cách nhanh chóng và hiệu quả.