Nguyên tắc về kiểu cho API Jetpack Compose

Nếu bạn đang viết mã Compose cho ứng dụng hoặc tạo thư viện và API Compose, hãy làm theo các phương pháp hay nhất để giúp mã có thể mở rộng, hiệu quả hơn và nhất quán với phần còn lại của hệ sinh thái.

Các tài liệu sau đây cung cấp nguyên tắc cho bất kỳ ai viết mã sử dụng Compose:

  • Nguyên tắc về API đối với Jetpack Compose: Nêu ra các mẫu, các phương pháp hay nhất và nguyên tắc về kiểu quy tắc cho mọi hệ thống sử dụng thời gian chạy và trình biên dịch Jetpack Compose. Tài liệu này bao gồm các chủ đề sau:
    • Nguyên tắc về kiểu Kotlin cho Compose, dựa trên Quy ước lập trình Kotlin
    • Hướng dẫn về các hàm và API @Composable được xây dựng dựa trên các chức năng thời gian chạy của Compose
    • Nguyên tắc đối với những API sử dụng và mở rộng bộ công cụ Compose UI
    • Các mẫu để giải quyết các trường hợp sử dụng khi thiết kế API Compose
  • Nguyên tắc về API cho các thành phần @Composable trong Jetpack Compose: Đưa ra một bộ nguyên tắc và đề xuất để tạo và sử dụng các thành phần giao diện người dùng @Composable, bao gồm những chủ đề sau:
    • Tạo và phân lớp các thành phần
    • Đặt tên cho một thành phần mới
    • Biểu thị các phần phụ thuộc của thành phần
    • Các tham số trong @Composable thành phần
    • Theo dõi các mẫu chính xác để tạo lớp và hàm liên quan đến thành phần
    • Đang ghi lại các thành phần @Composable
    • Cải thiện khả năng tiếp cận cho các thành phần
    • Cập nhật các API thành phần trong khi vẫn duy trì khả năng tương thích ngược

Đối tượng người xem

Những nguyên tắc này được viết cho 3 đối tượng sau:

  • Nhà phát triển xây dựng ứng dụng dựa trên Jetpack Compose. Bạn nằm trong nhóm này nếu sử dụng Jetpack Compose trong một phần nào đó của ứng dụng.
  • Nhà phát triển phụ trách việc phát triển khung Jetpack Compose. Bạn nằm trong nhóm này nếu đóng góp cho thư viện androidx.compose.
  • Nhà phát triển tạo thư viện dựa trên Jetpack Compose. Bạn thuộc nhóm này nếu tạo API Compose hoặc thư viện thành phần trên giao diện người dùng Compose. Các thư viện này của các thành phần Compose có thể được cung cấp công khai hoặc cục bộ cho công ty hoặc nhóm của bạn.

Tuỳ thuộc vào nhóm mà bạn tham gia, bạn sẽ có các mức nghiêm ngặt khác nhau cho từng nguyên tắc về kiểu. Ví dụ: quy trình phát triển khung Jetpack Compose thường tuân thủ nghiêm ngặt nhất các nguyên tắc này.

Để biết thêm thông tin về các yêu cầu đối với từng đối tượng nhà phát triển, hãy xem RFC2119.

Đóng góp vào khuôn khổ và nguyên tắc

Chúng tôi hoan nghênh đóng góp cho một số thư viện chọn lọc trong cơ sở mã androidx cũng như nguyên tắc về kiểu (nguyên tắc về API Composenguyên tắc về thành phần @Composable).

Để đóng góp, hãy làm theo hướng dẫn trong hướng dẫn đóng góp của androidx.