Lint: kiến thức cơ bản, trình phân tích tĩnh cho các dự án Android

Lint là gì — trình phân tích mã tĩnh?

Android Lint là một công cụ phân tích tĩnh được bao gồm trong SDK Android và Android Studio. Lint quét mã nguồn của ứng dụng mà không thực thi nó và tìm ra các vấn đề mà trình biên dịch bỏ sót: tài nguyên không được sử dụng, bản địa hóa không chính xác, rò rỉ bộ nhớ tiềm ẩn, không tương thích API với minSdkVersion và vi phạm các khuyến nghị về hiệu suất của Google.

Phân tích tĩnh là một phương pháp xác minh phần mềm không yêu cầu thực thi mã thực tế. Không giống như trình biên dịch chỉ kiểm tra cú pháp và kiểu, trình phân tích tĩnh tìm kiếm lỗi logic, phản mẫu và sai lệch so với các phương pháp hay nhất. Lint thực hiện hơn 200 kiểm tra tích hợp theo các danh mục: tính đúng đắn, hiệu suất, bảo mật, khả năng tiếp cận, khả năng sử dụng và I18N.

Lint hoạt động ở nhiều cấp độ: Phân tích XML kiểm tra bố cục, tài nguyên (strings, colors, dimens), tệp kê khai và tệp cấu hình. Phân tích Java/Kotlin kiểm tra mã nguồn để tìm các lệnh gọi API lỗi thời, vấn đề về luồng và rò rỉ ngữ cảnh. Phân tích Gradle kiểm tra cấu hình xây dựng để tương thích phiên bản.

Cách Lint kiểm tra mã của dự án Android

Kiểm tra Lint được khởi chạy qua Android Studio (Analyze > Inspect Code) hoặc bằng lệnh Gradle: ./gradlew lint. Kết quả là báo cáo HTML trong thư mục build/reports/lint-results.html và báo cáo XML cho hệ thống CI. Lint phân tích từng tệp một cách độc lập, áp dụng một bộ quy tắc (Issues), mỗi quy tắc có ID, mô tả, danh mục và mức độ nghiêm trọng riêng.

Mức độ nghiêm trọng của Lint: Error (lỗi — chặn xây dựng), Warning (cảnh báo — ảnh hưởng đến chất lượng), Informational (thông tin — để tham khảo), Ignore (bỏ qua theo mặc định). Các mức được cấu hình trong lint.xml. Lỗi Lint có thể được cấu hình để làm hỏng bản dựng Gradle khi có mặt thông qua lintOptions.abortOnError true.

android {
    lintOptions {
        abortOnError true
        checkAllWarnings true
        baselineFile file("lint-baseline.xml")
        htmlReport true
        xmlReport true
        lintConfig file("lint.xml")
    }
}

Lint baseline — một tệp đánh dấu các cảnh báo hiện tại là có thể chấp nhận được. Được tạo bằng lệnh lint --baseline baseline.xml. Sau khi thêm baseline vào dự án, Lint chỉ báo cáo các vấn đề mới. Điều này thuận tiện cho việc giới thiệu Lint vào một dự án cũ với hàng trăm cảnh báo — nhóm sẽ sửa lỗi dần dần.

Cấu hình quy tắc Lint trong tệp cấu hình

lint.xml — một tệp cấu hình trong thư mục gốc của dự án để tùy chỉnh quy tắc Lint. Nó chỉ định các quy tắc bị bỏ qua, mức độ nghiêm trọng và ngoại lệ cho các tệp hoặc thư mục cụ thể. Tệp được tạo thủ công và áp dụng toàn cầu cho tất cả các mô-đun của dự án. Nếu không có lint.xml, tất cả các quy tắc đều hoạt động với cài đặt mặc định.

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Vô hiệu hóa kiểm tra tài nguyên không sử dụng -->
    <issue id="UnusedResources" severity="ignore" />

    <!-- Tăng mức độ nghiêm trọng của rò rỉ ngữ cảnh -->
    <issue id="StaticFieldLeak" severity="error" />

    <!-- Bỏ qua trong các tệp được tạo -->
    <issue id="MissingTranslation" severity="ignore">
        <ignore path="build/generated" />
    </issue>
</lint>

@SuppressLint — một chú thích để vô hiệu hóa Lint ở cấp phương thức hoặc lớp trong Java/Kotlin. Ví dụ: @SuppressLint("SetTextI18n") cho một phương thức nơi văn bản được đặt động trong TextView. Chú thích @RequiresApi chỉ định Cấp độ API tối thiểu cho một phương thức — Lint sẽ không đưa ra cảnh báo nếu minSdk vượt quá giá trị được chỉ định.

Chạy kiểm tra Lint trong pipeline CI/CD

Tích hợp CI của Lint là một thực tiễn tiêu chuẩn trong phát triển Android. Lệnh ./gradlew lint chạy phân tích trên tất cả các mô-đun và tạo báo cáo. Trong cấu hình CI/CD (Jenkins, GitLab CI, GitHub Actions), Lint chạy trên mọi pull request. Nếu tìm thấy lỗi, bản dựng sẽ thất bại và nhà phát triển nhận được thông báo với báo cáo HTML của Lint.

lint-check:
  script:
    - ./gradlew lint
  artifacts:
    paths:
      - app/build/reports/lint-results.html
    when: always

Báo cáo HTML Lint chứa bảng tất cả các vấn đề được tìm thấy với danh mục, ID quy tắc, tệp, dòng và mô tả. Báo cáo có sẵn trên máy chủ CI hoặc được xuất bản dưới dạng tạo phẩm xây dựng. Báo cáo XML (lint-results.xml) được sử dụng để tích hợp với các hệ thống phân tích mã (SonarQube, CodeClimate) và tự động tạo nhiệm vụ trong các trình theo dõi (Jira, YouTrack).

Lint trong pull request — cấu hình GitHub Actions hoặc GitLab CI để Lint chạy tự động khi MR/PR được tạo. Nếu Lint tìm thấy lỗi, CI trả về trạng thái thất bại và việc hợp nhất bị chặn. Điều này ngăn mã có vấn đề xâm nhập vào nhánh chính và duy trì chất lượng cơ sở mã.

Các danh mục chính của quy tắc Lint trong Android

Các danh mục Lint bao gồm tất cả các khía cạnh của phát triển Android. Google chia các quy tắc thành 12 danh mục, mỗi danh mục chịu trách nhiệm cho một loại vấn đề cụ thể. Các danh mục quan trọng nhất là Correctness, Performance, Security và Accessibility. Các nhà phát triển cần biết các kiểm tra chính của mỗi danh mục để làm việc hiệu quả với Lint.

Các quy tắc hiệu suất là hữu ích nhất trong thực tế. UnusedResources tìm tài nguyên được khai báo trong XML nhưng không được sử dụng trong mã. ViewHolder kiểm tra xem mẫu ViewHolder có được sử dụng trong bộ điều hợp RecyclerView hay không. DrawAllocation cảnh báo về việc tạo đối tượng trong phương thức onDraw. Sửa các vấn đề này giúp giảm kích thước APK và tăng tốc ứng dụng.

Các quy tắc bảo mật là bắt buộc đối với các ứng dụng đã xuất bản. ExportedContentProvider kiểm tra xem ContentProvider có được xuất mà không có bảo vệ hay không. WorldReadableFiles cảnh báo về việc tạo tệp mà tất cả ứng dụng có thể truy cập. AllowBackup kiểm tra cờ allowBackup trong tệp kê khai — nên tắt nó để bảo mật dữ liệu.