Google Play 服務有時包含或需要使用開放原始碼程式庫。為了遵守開放原始碼程式庫的授權規定,開發人員必須負責為應用程式使用的開放原始碼程式庫妥善顯示相關聲明。
Google Play 服務包含一套工具,可讓開發人員以更輕鬆的方式,表達應用程式所用程式庫的開放原始碼軟體聲明。其中一項工具為 Gradle 外掛程式,會從所含程式庫 (如其 POM 檔案中宣告) 收集授權條款,並建立可用來顯示這些字詞的活動。進一步瞭解工具如何尋找並封裝授權資訊。
新增 Gradle 外掛程式
在根層級建構檔案中,執行以下操作:
- 包含 Google Maven 存放區。
- 將
oss-licenses
外掛程式新增至依附元件。
下列程式碼片段顯示這些步驟:
Kotlin DSL
buildscript { repositories { ... google() // maven { url("https://maven.google.com") } for Gradle <= 3 } dependencies { ... classpath("com.google.android.gms:oss-licenses-plugin:0.10.6") } }
時髦 DSL
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
plugins { id("com.android.application") id("com.google.android.gms.oss-licenses-plugin") }
時髦 DSL
plugins { id 'com.android.application' id 'com.google.android.gms.oss-licenses-plugin' }
您可以在 GitHub 上查看這個外掛程式的程式碼。
在應用程式中加入程式庫
在應用程式層級建構檔案的 dependencies
部分,新增 oss-licenses
程式庫的依附元件:
Kotlin DSL
implementation("com.google.android.gms:play-services-oss-licenses:17.1.0")
時髦 DSL
implementation 'com.google.android.gms:play-services-oss-licenses:17.1.0'
顯示授權資訊
建構應用程式時,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 資產中。