Trong bài này, tôi sẽ hướng dẫn các bạn sử dụng plugin SonarLint của Eclipse, plugin này giúp phát hiện các vấn đề khi viết code. SonarLint cung cấp thông tin cho bạn hiểu các vấn đề được tìm thấy và giải thích tại sao nó là một vấn đề. Đối với các bạn mới lập trình về Java hay đã có kinh nghiệm nên sử dụng plugin này để hiểu và code Java tốt hơn. Đối với các dự án Java, nên áp dụng SonarLint vào dự án như một phần trong checklist để giảm thời gian review code, các lỗi code không cần thiết, nâng chất lượng dự án tốt hơn.
Nội dung
Download và cài đặt plugin SonarLint
Các bạn xem hướng dẫn ở bài viết Các plugin Eclipse thường dùng.
Hướng dẫn sử dụng plugin SonarLint
Xem ví dụ dưới đây:
Những vấn đề trong code mà Sonarlint phát hiện được sẽ được đánh dấu màu xanh gạch dưới code và bên phải rollbar có đánh dấu màu xanh.
Các vấn đề ở đoạn code trên:
- param2: khai báo nhưng không sử dụng (Remove this unused method parameter “param2”)
- System.out: nên ghi log thay cho sử dụng System.out chỉ ghi ra console (Replace this use of System.out or System.err by a logger)
- f.delete: gợi ý bạn nên xử lý kết quả trả về từ hàm delete (Do something with the “boolean” value returned by “delete”).
- cache (Exception e): đề nghị bạn bỏ cactch hoặc thêm xử lý exception trong cache (Either remove or fill this block of code).
Khi bạn rê chuột lên chỗ màu xanh Sonarlint đánh dấu, bạn sẽ thấy gợi ý cách sữa cũng như giải thích cho bạn biết bạn sao nó là vấn đề.
Xem giải thích, mô tả thêm về vấn đề mà Sonarlint thông báo bằng cách Click vào link Open description of rule …
Chi tiết về các vấn đề (issues) được sonarlint kiểm tra các bạn có thể xem thêm ở link sau: https://rules.sonarsource.com/java
Report tất cả vấn đề trong project với SonarLint
Nhấn chuổi phải lên Project -> SonarLint -> Analyze
Kết quả report các vấn đề của SonarLint như sau:
Trên đây là những hướng dẫn cơ bản về sử dụng SonarLint. Còn rất nhiều vấn đề khác, các bạn có thể tìm hiểu thêm trong quá trình code. Nếu bạn chưa cài plugin SonarLint thì nên cài ngay bây giờ để áp dụng vào việc học Java cũng như áp dụng vào dự án. Mình đảm bảo các bạn sẽ nhận được rất nhiều điều hay từ nó.
Các bạn có thể tham khảo thêm về SonarLint trên trang chủ của nó.
Nếu bạn muốn có cái nhìn tổng quan về hệ thống, chất lượng source code, developer, các phương thức nào đang gặp vấn đề , hãy tìm hiểu thêm về SonarQube. Trong thời gian tới mình sẽ viết một bài hướng dẫn về SonarQube. Xin cảm ơn các bạn đã quan tâm và theo dõi bài viết. Hẹn gặp lại các bạn ở bài viết tiếp theo.