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 xây dựng thư viện và API Compose, hãy làm theo các phương pháp hay nhất để giúp mã của bạn 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 đưa ra 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: Liệt kê các mẫu, phương pháp hay nhất và nguyên tắc về kiểu quy định cho mọi hệ thống sử dụng trình biên dịch và thời gian chạy 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 dựa trên các tính năng thời gian chạy của Compose
    • Nguyên tắc đối với các API sử dụng và mở rộng bộ công cụ giao diện người dùng Compose
    • 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: Cung cấp 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 các chủ đề sau:
    • Tạo và phân lớp thành phần
    • Đặt tên cho một thành phần mới
    • Biểu thị phần phụ thuộc của thành phần
    • Tham số trong thành phần @Composable
    • Làm theo các mẫu chính xác để tạo các lớp và hàm liên quan đến thành phần
    • Ghi lại các thành phần @Composable
    • Cải thiện khả năng hỗ trợ tiếp cận cho các thành phần
    • Cập nhật API thành phần trong khi vẫn giữ được 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 thuộc nhóm này nếu sử dụng Jetpack Compose trong một số phần của ứng dụng.
  • Nhà phát triển đang phát triển khung Jetpack Compose. Bạn thuộc 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 các thành phần giao diện người dùng Compose. Các thư viện thành phần Compose này có thể được cung cấp công khai hoặc dành riêng cho công ty hoặc nhóm của bạn.

Tuỳ thuộc vào nhóm của bạn, bạn có các mức độ nghiêm ngặt khác nhau cho mỗi nguyên tắc về kiểu. Ví dụ: hoạt động 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 cho khung và nguyên tắc

Chúng tôi hoan nghênh các đóng góp cho một số thư viện trong cơ sở mã androidx và các nguyên tắc về kiểu (Nguyên tắc về API Compose và Nguyê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 androidx.