Google thực sự khuyên bạn không nên kiểm tra khoá API vào hệ thống quản lý phiên bản. Thay vào đó, bạn nên lưu trữ khoá này trong tệp secrets.properties cục bộ,
tệp này nằm trong thư mục gốc của dự án nhưng bị loại trừ khỏi hệ thống quản lý phiên bản. Sau đó, hãy sử dụng Trình bổ trợ Secrets Gradle cho Android
để đọc khoá API.
Trình bổ trợ Secrets Gradle cho Android đọc các bí mật, bao gồm cả khoá API, từ một tệp thuộc tính không được kiểm tra vào hệ thống quản lý phiên bản. Sau đó, trình bổ trợ này sẽ hiển thị các thuộc tính đó dưới dạng biến trong lớp BuildConfig do Gradle tạo và trong tệp kê khai Android.
Để xem ví dụ hoàn chỉnh về cách sử dụng Trình bổ trợ Secrets Gradle cho Android để truy cập vào khoá API, hãy xem bài viết Thiết lập dự án Android Studio.
Cài đặt và sử dụng
Cách cài đặt Trình bổ trợ Secrets Gradle cho Android và lưu trữ khoá API:
-
Trong Android Studio, hãy mở tệp
build.gradleở cấp gốc rồi thêm đoạn mã sau vào phần tửdependenciestrongbuildscript.Groovy
buildscript { dependencies { // ... classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
Kotlin
buildscript { dependencies { // ... classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1") } }
-
Mở tệp
build.gradleở cấp ứng dụng rồi thêm đoạn mã sau vào phần tửplugins.Groovy
plugins { id 'com.android.application' // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
Kotlin
plugins { id("com.android.application") // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
- Nếu bạn sử dụng Android Studio, hãy đồng bộ hoá dự án với Gradle.
-
Mở
local.propertiestrong thư mục cấp dự án, sau đó thêm đoạn mã sau. Thay thếYOUR_API_KEYbằng khoá API.PLACES_API_KEY=YOUR_API_KEY
Bước tiếp theo
- Xem trang dự án GitHub Trình bổ trợ Secrets Gradle cho Android
- Xem bài viết Thiết lập dự án Android Studio để biết ví dụ hoàn chỉnh về cách sử dụng trình bổ trợ.