AboutLibraries: Quản Lý Giấy Phép Kotlin Multiplatform

Thách Thức Của Việc Công Khai Giấy Phép Trong App

Bất kỳ app nào kéo vào hơn vài dependency Gradle mã nguồn mở sớm muộn cũng phải hiển thị giấy phép của chúng ở đâu đó, và một danh sách viết tay sẽ lỗi thời ngay khi có bản cập nhật version hay thêm thư viện mới. Không ai thích gõ tay danh sách đó. Khớp từng artifact với đúng mã giấy phép SPDX rồi kiểm tra lại sau mỗi lần đổi dependency đủ mất công để nhiều side project bỏ qua luôn bước này. AboutLibraries nhắm đúng khoảng trống đó cho dự án Kotlin Multiplatform và Android: plugin Gradle tự tạo lại danh sách từ dependency graph thật trên mỗi lần build, thay vì để bạn duy trì thủ công.

AboutLibraries Làm Gì

AboutLibraries là plugin Gradle đi kèm các component Compose UI, dựng nên màn hình giấy phép mã nguồn mở cho app Kotlin Multiplatform và Android. Tại thời điểm build, plugin quét dependency graph, khớp từng artifact với giấy phép tương ứng, rồi ghi kết quả vào một file JSON mà app tải qua LibrariesContainer lúc runtime. Vì việc thu thập chỉ diễn ra một lần khi build, màn hình chỉ cần render dữ liệu đã có sẵn.

Tính Năng Cốt Lõi Cho Báo Cáo Dependency

• ✓Một bộ dữ liệu và gần như một bộ Compose UI dùng chung cho Android, iOS, JVM desktop, native, Wasm, và JS, theo danh sách nền tảng trong README.
• ✓Việc thu thập diễn ra trong lúc build Gradle rồi được cache lại, nên app không quét dependency lúc runtime.
• ✓Compose UI có sẵn theo phong cách Material 2, Material 3, hoặc Wear, hoặc bạn tự xây màn hình riêng trên module core.
• ✓Plugin Gradle tách thành hai ID riêng từ version 13.x.y: plugin chính cung cấp task thủ công để sinh định nghĩa thư viện, còn plugin Android tự động gắn bước sinh đó vào quá trình build Android.
• ✓Công cụ tuân thủ giấy phép có sẵn: chế độ strict mode có thể làm build fail khi gặp giấy phép không được phép, cùng tính năng export CSV và text để báo cáo.
• ✓Task Gradle exportFunding có thể tự sinh file funding.json với một GitHub API token, cho biết dependency nào có thông tin tài trợ.
• ✓Metadata thư viện và giấy phép có thể bị ghi đè bằng file JSON đặt trong configPath đã cấu hình, gộp lại theo uniqueId trùng khớp.
• ✓LibrariesContainer nhận variant (Refined/Traditional), density (Compact/Cozy), và actionMode (Chips/Icons), nên một component phủ được nhiều kiểu hiển thị.

Ai Sẽ Hưởng Lợi Từ AboutLibraries

Team build app Kotlin Multiplatform hoặc Android chạy trên nhiều nền tảng sẽ tận dụng AboutLibraries tốt nhất, vì cùng một bộ dữ liệu sinh ra và phần lớn cùng một Compose UI phủ được Android, iOS, desktop, JS, và Wasm. Nó cũng hợp với team có yêu cầu tuân thủ, nhờ export CSV/text và strict mode giấy phép. Bỏ qua nếu dự án của bạn không dùng Gradle hay Compose, hoặc nếu chỉ có vài dependency thì một màn hình credits tĩnh viết tay đơn giản hơn việc gắn thêm một build plugin.

Tích Hợp AboutLibraries Vào Dự Án

Plugin nằm trên Gradle Plugin Portal; hãy thêm nó bằng khối plugins { } của Kotlin DSL thay vì cú pháp apply plugin cũ. Từ version 13.x.y có hai plugin ID: com.mikepenz.aboutlibraries.plugin cung cấp task Gradle thủ công để sinh định nghĩa thư viện, còn com.mikepenz.aboutlibraries.plugin.android tự động gắn bước sinh đó vào build Android; README khuyên dùng plugin chính cho phần lớn dự án, chỉ chọn bản Android khi bạn thực sự cần cú hook tự động đó. Thêm module Compose phù hợp với version Material bạn đang dùng, ví dụ implementation("com.mikepenz:aboutlibraries-compose-m3:${latestAboutLibsRelease}"), rồi tinh chỉnh hành vi collect, export, và license qua khối extension aboutLibraries { }; danh sách đầy đủ các option nằm trong file source AboutLibrariesExtension.kt được link tới, không có trong README.

Hiển Thị Giấy Phép Với Compose UI

Sau khi plugin đã sinh file metadata, tải nó bằng produceLibraries rồi đưa kết quả vào LibrariesContainer: `val libraries by produceLibraries(R.raw.aboutlibraries)`, sau đó `LibrariesContainer(libraries, Modifier.fillMaxSize())`. Một component duy nhất đó render mọi kiểu hiển thị trong phần showcase của dự án: truyền variant để chọn giao diện Refined hay Traditional, density để chọn mật độ Compact hay Cozy, và actionMode để chọn Chips hay Icons cho mỗi dòng. Chạm vào một dòng để mở chi tiết, dạng inline, dạng dialog, hoặc dạng bottom sheet, tuỳ vào detailMode bạn đặt. Nếu Material 2, Material 3, hay Wear có sẵn không hợp mắt, README chỉ ra hướng tự xây màn hình riêng trên module core.

Công Cụ Khác Để Quản Lý Giấy Phép

Câu Hỏi Thường Gặp

Trường hợp sử dụng tốt nhất

• •Thêm màn hình ghi công mã nguồn mở bắt buộc cho một app Kotlin Multiplatform chạy trên Android, iOS, và desktop từ một codebase.
• •Xuất báo cáo tuân thủ dạng CSV hoặc text cho bộ phận pháp lý thay vì tự biên soạn danh sách dependency.
• •Áp dụng danh sách giấy phép được phép ngay tại thời điểm build bằng strict mode, để một giấy phép không hợp lệ làm fail build Android thay vì lọt ra ngoài mà không ai biết.
• •Kiểm tra dependency nào có thông tin tài trợ trước khi team quyết định tài trợ ngược lại cho dự án mã nguồn mở nào.
• •Tự xây UI giấy phép hoàn toàn riêng trên module core khi các component Compose có sẵn không khớp design system của app.

Repo liên quan