包含開放原始碼聲明

Google Play 服務有時會包含開放原始碼程式庫,或依附於該程式庫。為遵守開放原始碼程式庫的授權規定,開發人員有責任妥善顯示應用程式所用開放原始碼程式庫的通知。

Google Play 服務包含一組工具,可讓開發人員更輕鬆地針對應用程式中使用的程式庫,提出開放原始碼軟體聲明。其中一項工具是 Gradle 外掛程式,會從內含的程式庫中 (如 POM 檔案所宣告) 收集授權條款,並建立可用於顯示這些字詞的活動。進一步瞭解這項工具如何尋找及封裝授權資訊

新增 Gradle 外掛程式

在根層級建構檔案中,執行下列操作:

  1. 加入 Google Maven 存放區
  2. 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")
  }
}

時髦 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

app/build.gradle.kts

plugins {
    id("com.android.application")
    id("com.google.android.gms.oss-licenses-plugin")
}

時髦 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")

時髦 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 資產中嵌入每個授權的連結和名稱。