Hướng dẫn sử dụng CheckStyle trong Eclipse

CheckStyle là một trong những plugin phổ biến nhất trong Eclipse, giúp chúng ta kiểm tra coding convention (quy tắc viết mã) dựa trên những quy tắc đã được định nghĩa trước đó.

Download và cài đặt plugin CheckStyle

Các bạn xem hướng dẫn ở bài viết Các plugin Eclipse thường dùng.

Định nghĩa những quy tắc

Mặc định CheckStyle dùng bộ quy ước đã được định nghĩa sẵn từ Google, tuy nhiên bạn cũng có thể tạo ra những quy ước riêng cho mình, tùy theo đặc thù của dự án.
Đầu tiên chúng ta sẽ tạo 1 configuration file có tên là [GPCoder]_CheckStyle_v1.0.xml với nội dung như sau:

Các bạn có thể download đoạn xml trên ở cuối bài viết.

Tham khảo thêm document của CheckStyle để xem cách định nghĩa các quy tắt kiểm tra khác.

Áp dụng những quy tắc vào dự án

Vào menu Window -> Preferences  -> CheckStyle.

New -> chọn External Configuration File và browse đến file config [GPCoder]_CheckStyle_v1.0.xml

Sau đó chọn Set as Default để áp dụng bộ quy tắc này cho các project trong Eclipse workspace hiện tại

Nhấn Apply và Close.

Kiểm tra source code với CheckStyle

Ví dụ: kiểm tra checkstyle với đoạn code bên dưới

package com.gpcoder.CheckStyle;

public class CheckStyleTest {
	 
  public static final int SO_THU_NHAT = 4;
  public static final int SO_THU_HAI = 11;

  public static void main(String[] args) {
    CheckStyleTest main = new CheckStyleTest();
    System.out.println("Uoc chung lon nhat cua " + SO_THU_NHAT + " va " + SO_THU_HAI + " la " + main.timUocChungLonNhatCuaHaiSo(SO_THU_NHAT, SO_THU_HAI)); // NOSONAR
    System.out.println("Boi chung nho nhat cua " + SO_THU_NHAT + " va " + SO_THU_HAI + " la " + main.TimBCNN(SO_THU_NHAT, SO_THU_HAI)); // NOSONAR
  }
  

  private int timUocChungLonNhatCuaHaiSo(int soThuNhat, int soThuHai) {
    if (soThuHai == 0) { 
      return soThuNhat; 
    }

    if (soThuNhat == 0) {
      return soThuHai;
    }

    if (soThuHai > soThuNhat) {
      return timUocChungLonNhatCuaHaiSo(soThuNhat, soThuHai % soThuNhat);
    }

    return timUocChungLonNhatCuaHaiSo(soThuHai, soThuNhat % soThuHai);
  }
  
  public int TimBCNN(int a, int b) {
        return (a * b) / timUocChungLonNhatCuaHaiSo(a, b);
  }
}

Nhấn chuột phải vào file Java, package hoặc Project cần kiểm tra, sau đó chọn CheckStyle -> Check code with CheckStyle

Những đoạn code vi phạm các quy tắc trên sẽ được hightlight như hình bên dưới:

Bạn có thể rê chuột lên dòng vi phạm checkstyle (dòng hiển thị Warning màu vàng) để xem gợi ý cách fix lỗi checkstyle.

Trên đây là những hướng dẫn cơ bản nhất trong việc sử dụng plugin CheckStyle. Hi vọng có thể giúp ích cho các bạn trong việc kiểm tra và tránh những lỗi về coding convention trong dự án. Các bạn có thể tìm hiểu các tính năng khác trên trang document của CheckStyle.

Bài viết tiếp theo tôi sẽ hướng dẫn các bạn sử dụng một plugin rất hay trong việc phát hiện lỗi code và gợi ý cho các bạn sửa lỗi, đó là plugin sonarlint.

Chuyên mục: IDE, Tools Được gắn thẻ: Eclipse

Bình luận

bình luận