Google Play 服務有時會包含或依附開放原始碼程式庫。 為遵守開放原始碼程式庫的授權規定,開發人員必須負責為應用程式採用的開放原始碼程式庫顯示通知。
Google Play 服務提供一組工具,讓開發人員能夠以更簡單的方式,表達應用程式所用程式庫的開放原始碼軟體通知。其中一項工具是 Gradle 外掛程式,可從 POM 檔案內宣告的程式庫收集授權條款,並建立用於顯示這些條款的活動。進一步瞭解這項工具如何尋找及封裝授權資訊。
新增 Gradle 外掛程式
在根層級的建構檔案中,執行下列步驟:
- 包含 Google Maven 存放區。
- 將
oss-licenses
外掛程式新增至依附元件。
下列程式碼片段顯示以下步驟:
Kotlin DSL
build.gradle.kts
buildscript { repositories { ... google() // maven { url("https://maven.google.com") } for Gradle <= 3 } dependencies { ... classpath("com.google.android.gms:oss-licenses-plugin:0.10.6") } }
Groovy DSL
build.gradle
buildscript { repositories { ... google() // maven { url "https://maven.google.com" } for Gradle <= 3 } dependencies { ... classpath 'com.google.android.gms:oss-licenses-plugin:0.10.6' } }
在應用程式層級的建構檔案中,請在檔案頂端的 com.android.application
外掛程式現有宣告下方新增以下這行程式碼:
Kotlin DSL
應用程式/build.gradle.kts
plugins { id("com.android.application") id("com.google.android.gms.oss-licenses-plugin") }
Groovy DSL
app/build.gradle
plugins { id 'com.android.application' id 'com.google.android.gms.oss-licenses-plugin' }
您可以在 GitHub 上查看這個外掛程式的程式碼。
將程式庫新增至應用程式
在應用程式層級建構檔案的 dependencies
區段中,在 oss-licenses
程式庫中加入依附元件:
Kotlin DSL
build.gradle.kts
implementation("com.google.android.gms:play-services-oss-licenses:17.0.1")
Groovy DSL
build.gradle
implementation 'com.google.android.gms:play-services-oss-licenses:17.0.1'
顯示授權資訊
建構應用程式時,Gradle 外掛程式會處理授權,並將授權新增至應用程式的資源中。如要輕鬆顯示授權,您可以在應用程式中以適當的時間點啟動 play-services-oss-licenses
程式庫提供的活動,如以下程式碼片段所示:
Kotlin
import com.google.android.gms.oss.licenses.OssLicensesMenuActivity ... // When the user selects an option to see the licenses: startActivity(Intent(this, OssLicensesMenuActivity::class.java))
Java
import com.google.android.gms.oss.licenses.OssLicensesMenuActivity; ... // When the user selects an option to see the licenses: startActivity(new Intent(this, OssLicensesMenuActivity.class));
這項活動啟動後會顯示一份已編譯至應用程式的開放原始碼程式庫清單,包括 Google Play 服務的一部分程式庫,如圖 1 所示。使用者只要輕觸程式庫名稱,即可查看該程式庫的其他授權資訊。
圖 1. 授權選單活動會顯示應用程式可用的開放原始碼程式庫清單。
設定活動名稱
根據預設,顯示的活動標題為「開放原始碼授權」。您可以呼叫 setActivityTitle()
來自訂活動的標題,如以下程式碼片段所示:
Kotlin
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title))
Java
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));
為活動套用主題
您可以為活動套用主題,以符合應用程式其他活動使用的主題。方法是在應用程式的資訊清單檔案的 <activity>
元素中加入開放原始碼授權活動,如以下程式碼片段所示:
<application android:theme="@style/AppTheme" ...> <activity android:name="com.google.android.gms.oss.licenses.OssLicensesMenuActivity" android:theme="@style/AppTheme" /> <activity android:name="com.google.android.gms.oss.licenses.OssLicensesActivity" android:theme="@style/AppTheme" /> </application>
授權清單的決定方式
在編譯期間,Gradle 外掛程式會掃描應用程式專案的 POM 依附元件。如果 Maven POM 有對應用程式的直接依附元件,外掛程式會處理每個 <licenses>
元素,並將每個授權的連結和標題嵌入到應用程式隨附的 Android 資產中。