Chọn thư viện một cách khôn ngoan

Để bật tính năng tối ưu hoá ứng dụng, bạn phải sử dụng các thư viện tương thích với tính năng tối ưu hoá Android. Nếu một thư viện không được định cấu hình để tối ưu hoá Android (ví dụ: nếu thư viện đó sử dụng phản chiếu mà không gói các quy tắc giữ lại liên quan), thì thư viện đó có thể không phù hợp với ứng dụng Android. Trang này giải thích lý do một số thư viện phù hợp hơn cho việc tối ưu hoá ứng dụng và cung cấp các mẹo chung để giúp bạn lựa chọn.

Mẹo chung khi chọn thư viện

Hãy áp dụng các mẹo sau để đảm bảo thư viện của bạn tương thích với tính năng tối ưu hoá ứng dụng.

Ưu tiên tạo mã hơn là phản chiếu

Chọn thư viện sử dụng tạo mã (codegen) thay vì phản chiếu. Với tính năng tạo mã, trình tối ưu hoá có thể xác định mã nào thực sự được dùng trong thời gian chạy và mã nào có thể bị xoá. Có thể khó biết liệu một thư viện có sử dụng tính năng tạo mã hay phản chiếu hay không, nhưng có một số dấu hiệu – hãy xem mẹo để được trợ giúp.

Để biết thêm thông tin về việc tạo mã so với phản chiếu, hãy xem phần Tối ưu hoá cho tác giả thư viện.

Kiểm tra việc sử dụng phản chiếu (nâng cao)

Bạn có thể biết liệu một thư viện có sử dụng tính năng phản chiếu hay không bằng cách kiểm tra mã của thư viện đó. Nếu thư viện sử dụng tính năng phản chiếu, hãy kiểm tra để đảm bảo thư viện đó cung cấp các quy tắc giữ lại liên quan. Thư viện có thể sử dụng sự phản chiếu nếu thực hiện những việc sau:

  • Sử dụng các lớp hoặc phương thức từ gói kotlin.reflect hoặc java.lang.reflect.
  • Sử dụng hàm Class.forName hoặc classLoader.getClass.
  • Đọc chú thích trong thời gian chạy, ví dụ: nếu chú thích lưu trữ một giá trị chú thích bằng val value = myClass.getAnnotation() hoặc val value = myMethod.getAnnotation(), sau đó thực hiện thao tác nào đó với value.
  • Gọi các phương thức bằng cách sử dụng tên phương thức dưới dạng chuỗi, như trong ví dụ sau:

    // Calls the private `processData` API with reflection
    myObject.javaClass.getMethod("processData", DataType::class.java)
    ?.invoke(myObject, data)
    

Kiểm tra các vấn đề về tối ưu hoá

Khi xem xét một thư viện mới, hãy xem qua trình theo dõi sự cố của thư viện và các cuộc thảo luận trực tuyến để kiểm tra xem có vấn đề nào liên quan đến việc rút gọn hoặc định cấu hình tối ưu hoá ứng dụng hay không. Nếu có, bạn nên thử tìm các thư viện thay thế cho thư viện đó. Lưu ý những điều sau:

  • Thư viện AndroidX và các thư viện như Hilt hoạt động hiệu quả với tính năng tối ưu hoá ứng dụng vì các thư viện này chủ yếu sử dụng codegen thay vì phản chiếu. Khi sử dụng tính năng phản chiếu, họ sẽ cung cấp các quy tắc lưu giữ tối thiểu để chỉ giữ lại mã cần thiết.
  • Thư viện chuyển đổi tuần tự thường sử dụng cơ chế phản chiếu để tránh mã nguyên mẫu khi tạo thực thể hoặc chuyển đổi tuần tự đối tượng. Thay vì các phương pháp dựa trên phản chiếu (chẳng hạn như Gson cho JSON), hãy tìm các thư viện sử dụng codegen để tránh những vấn đề này, ví dụ: bằng cách sử dụng Kotlin Serialization hoặc Moshi có codegen.
  • Nếu có thể, hãy tránh các thư viện có quy tắc giữ lại trên toàn bộ gói. Quy tắc giữ lại trên toàn gói có thể giúp giải quyết lỗi, nhưng cuối cùng, bạn nên tinh chỉnh các quy tắc giữ lại rộng để chỉ giữ lại mã cần thiết. Để biết thêm thông tin, hãy xem phần Áp dụng dần các biện pháp tối ưu hoá.
  • Trước khi phát hành một ứng dụng sử dụng thư viện bên thứ ba, hãy dùng Trình phân tích cấu hình R8 để kiểm tra các quy tắc giữ lại mà thư viện đó cung cấp. Bằng cách xem báo cáo, bạn có thể xác minh xem các quy tắc giữ lại của thư viện có quá rộng hay không, khiến R8 không thể thực hiện các hoạt động tối ưu hoá quan trọng trên toàn bộ mã nguồn của bạn. Việc kiểm tra này đảm bảo rằng các thư viện bạn chọn phù hợp với mục tiêu hiệu suất của ứng dụng và không gây ra tình trạng phình to cấu hình không cần thiết.
  • Thư viện không yêu cầu bạn sao chép và dán quy tắc lưu giữ từ tài liệu vào một tệp trong dự án, đặc biệt là không phải quy tắc lưu giữ trên toàn gói. Những quy tắc này trở thành gánh nặng bảo trì cho nhà phát triển ứng dụng về lâu dài, đồng thời khó tối ưu hoá và thay đổi theo thời gian.

Bật tính năng tối ưu hoá sau khi thêm thư viện mới

Khi bạn thêm một thư viện mới, hãy bật tính năng tối ưu hoá sau đó và kiểm tra xem có lỗi hay không. Nếu có lỗi, hãy tìm các giải pháp thay thế cho thư viện đó hoặc viết quy tắc giữ lại. Nếu thư viện không tương thích với tính năng tối ưu hoá, hãy báo cáo lỗi cho thư viện đó.

Lọc ra các quy tắc giữ lại không hợp lệ (nâng cao)

Các quy tắc giữ lại mang tính bổ sung. Điều này có nghĩa là một số quy tắc mà phần phụ thuộc thư viện bao gồm không thể bị xoá và có thể ảnh hưởng đến quá trình biên dịch các phần khác của ứng dụng. Ví dụ: nếu một thư viện bao gồm quy tắc tắt tính năng tối ưu hoá mã, thì quy tắc đó sẽ tắt tính năng tối ưu hoá cho toàn bộ dự án của bạn.

Bạn nên tránh các thư viện có quy tắc giữ lại mã mà thực sự nên xoá. Tuy nhiên, nếu phải sử dụng các quy tắc này, bạn có thể lọc chúng ra như trong đoạn mã sau:

// If you're using AGP 8.4 and higher
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreFrom("com.somelibrary:somelibrary")
        }
    }
}

// If you're using AGP 7.3-8.3
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreExternalDependencies("com.somelibrary:somelibrary")
        }
    }
}

Quy trình đề xuất cho các quy tắc chung về thư viện

Nếu Trình phân tích cấu hình R8 cho thấy một thư viện có các quy tắc giữ lại quá rộng, hãy chỉ lọc các quy tắc đó trong bản dựng cục bộ, chứ không phải trong bản dựng chính thức. Để kiểm tra mức độ ảnh hưởng của các quy tắc đối với ứng dụng, hãy làm theo các bước sau:

  1. Cập nhật thư viện: Đảm bảo bạn đang sử dụng phiên bản mới nhất của thư viện mà Trình phân tích cấu hình R8 đã gắn cờ, vì các phiên bản mới hơn có thể cung cấp các quy tắc giữ lại hẹp hơn cho người dùng. Để tìm phiên bản mới nhất, hãy xem tài liệu của thư viện hoặc kho lưu trữ Maven của thư viện đó. Android Studio cũng gắn cờ các phiên bản mới hơn của nhiều phần phụ thuộc. Sau khi cập nhật, hãy chạy lại Trình phân tích cấu hình R8 để kiểm tra xem các quy tắc giữ lại rộng có còn hay không.
  2. Kiểm tra khả năng cải thiện tại máy: Sao chép các quy tắc người dùng đi kèm của thư viện vào tệp quy tắc lưu giữ tại máy, lọc ra các quy tắc đi kèm như trong phần Lọc ra các quy tắc lưu giữ không hợp lệ và thu hẹp các quy tắc đã sao chép. Chạy Trình phân tích cấu hình R8 trước và sau khi thu hẹp các quy tắc để so sánh điểm số về việc rút gọn, tối ưu hoá và làm rối mã nguồn của ứng dụng.
  3. Báo cáo kết quả: Gửi báo cáo lỗi cho người duy trì thư viện, trong đó có dữ liệu thực nghiệm từ báo cáo của Trình phân tích cấu hình R8 (ví dụ: cho thấy số lượng cụ thể các lớp hoặc phương thức không được tham chiếu mà quy tắc ký tự đại diện của họ giữ lại).

Nghiên cứu điển hình: Lý do Gson không hoạt động khi tối ưu hoá

Gson là một thư viện chuyển đổi tuần tự thường gây ra vấn đề khi tối ưu hoá ứng dụng vì thư viện này sử dụng nhiều phản chiếu. Đoạn mã sau đây cho thấy cách Gson thường được sử dụng, có thể gây ra sự cố trong thời gian chạy. Lưu ý rằng khi sử dụng Gson để lấy danh sách đối tượng User, bạn không gọi hàm khởi tạo hoặc truyền một factory đến hàm fromJson(). Việc tạo hoặc sử dụng các lớp do ứng dụng xác định mà không có một trong hai điều sau đây là dấu hiệu cho thấy thư viện có thể đang sử dụng phản chiếu mở:

  • Lớp ứng dụng triển khai thư viện, giao diện hoặc lớp chuẩn
  • Trình bổ trợ tạo mã như KSP
class User(val name: String)
class UserList(val users: List<User>)

// This code runs in debug mode, but crashes when optimizations are enabled
Gson().fromJson("""[{"name":"myname"}]""", User::class.java).toString()

Để hiểu cách R8 hoạt động trên Gson, hãy xem Quy tắc người dùng Gson. Khi R8 phân tích mã này và không thấy UserList hoặc User được tạo thực thể ở bất cứ đâu, thì R8 có thể đổi tên các trường hoặc xoá các hàm khởi tạo có vẻ như không được sử dụng, khiến ứng dụng của bạn gặp sự cố. Nếu đang sử dụng bất kỳ thư viện nào khác theo cách tương tự, bạn nên kiểm tra để đảm bảo rằng các thư viện đó không can thiệp vào quá trình tối ưu hoá ứng dụng. Nếu có, hãy tránh sử dụng các thư viện đó.

Sử dụng @SerializedName với các phiên bản Gson mới hơn

Để xác định các mô hình dữ liệu theo cách tương thích với quy tắc người dùng của Gson, hãy chú thích các trường của bạn bằng @SerializedName, như trong đoạn mã sau:

import com.google.gson.annotations.SerializedName

class User(@SerializedName("name") val name: String)
class UserList(@SerializedName("users") val users: List<User>)

Bằng cách sử dụng chú thích @SerializedName, bạn cho phép R8 so khớp các lớp mô hình của bạn với quy tắc giữ lại đi kèm trong Gson phiên bản 2.11.0 trở lên. R8 tự động giữ lại các trường được chú thích và hàm khởi tạo cần thiết, cho phép bạn dựa vào các quy tắc đi kèm của thư viện mà không cần phải duy trì cấu hình ProGuard theo cách thủ công trong dự án.

Xin lưu ý rằng Room, Hilt và Moshi có codegen tạo các loại do ứng dụng xác định, nhưng sử dụng codegen để tránh cần đến phản chiếu.