Open-Source-Hinweise einschließen

Google Play Services SDKs enthalten manchmal Open-Source-Bibliotheken oder sind von solchen abhängig. Um die Lizenzanforderungen von Open-Source-Bibliotheken zu erfüllen, sind Sie als Entwickler dafür verantwortlich, die Hinweise für die Open-Source-Bibliotheken, die Ihre App verwendet, angemessen anzuzeigen.

Google Play-Dienste enthalten eine Reihe von Tools, mit denen Entwickler die Open-Source-Software-Hinweise (OSS) von Bibliotheken, die in ihren Apps verwendet werden, einfacher angeben können. Das oss-licenses-plugin und das Google Play Services-SDK für Open-Source-Lizenzen erfassen Lizenzbedingungen aus enthaltenen Bibliotheken, wie in ihren POM-Dateien deklariert, und erstellen eine Aktivität, mit der diese Bedingungen angezeigt werden können. Weitere Informationen dazu, wie das Tool Lizenzinformationen findet und zusammenstellt

Gradle-Plug-in hinzufügen

Gehen Sie in den pluginManagement Ihrer Projekteinstellungen so vor:

  1. Fügen Sie das Google Maven-Repository ein.
  2. Beheben Sie das Problem mit dem oss-licenses-Plug-in in PluginManagement.

Das folgende Code-Snippet zeigt diese Schritte:

Kotlin DSL

settings.gradle.kts

pluginManagement {   repositories {     ...     google()   }   resolutionStrategy {     eachPlugin {       if (requested.id.id == "com.google.android.gms.oss-licenses-plugin") {         useModule("com.google.android.gms:oss-licenses-plugin:0.10.6")       }     }   } }

Groovy-DSL

build.gradle

pluginManagement {   repositories {     ...     google()   }   resolutionStrategy {     eachPlugin {       if (requested.id.id == "com.google.android.gms.oss-licenses-plugin") {         useModule("com.google.android.gms:oss-licenses-plugin:0.10.6")       }     }   } }

Wenden Sie das Plug-in in der Build-Datei auf App-Ebene an, indem Sie die folgende Zeile oben in der Datei unter der vorhandenen Deklaration des com.android.application-Plug-ins einfügen:

Kotlin DSL

app/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' }

Sie können sich den Code für dieses Plug-in auf GitHub ansehen.

play-services-oss-licenses-Bibliothek zur App hinzufügen

Füge im Abschnitt dependencies der Build-Datei auf App-Ebene eine Abhängigkeit von der play-services-oss-licenses-Bibliothek hinzu:

Kotlin DSL

build.gradle.kts

implementation("com.google.android.gms:play-services-oss-licenses:17.2.2")

Groovy-DSL

build.gradle

implementation 'com.google.android.gms:play-services-oss-licenses:17.2.2'

Lizenzinformationen anzeigen

Wenn Ihre App erstellt wird, verarbeitet das Gradle-Plug-in die Lizenzen und fügt sie den Ressourcen Ihrer App hinzu. Um die Lizenz einfach anzuzeigen, können Sie an einem geeigneten Punkt in Ihrer App eine Aktivität starten, die von der play-services-oss-licenses-Bibliothek bereitgestellt wird, wie im folgenden Code-Snippet gezeigt:

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));

Wenn die Aktivität gestartet wird, wird eine Liste der Open-Source-Bibliotheken angezeigt, die in Ihre App kompiliert wurden, einschließlich der von der App verwendeten Bibliotheken (siehe Abbildung 1). Nutzer können auf den Namen einer Bibliothek tippen, um zusätzliche Lizenzinformationen für diese Bibliothek aufzurufen.

Listenansicht, in der jedes Element den Namen einer Open-Source-Bibliothek enthält

Abbildung 1. Im Menü „Lizenzen“ wird eine auswählbare Liste mit Open-Source-Bibliotheken angezeigt, die von einer App verwendet werden.

Titel der Aktivität festlegen

Standardmäßig hat die angezeigte Aktivität den Titel „Open-Source-Lizenzen“. Sie können den Titel der Aktivität anpassen, indem Sie setActivityTitle() aufrufen, wie im folgenden Code-Snippet gezeigt:

Kotlin

OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title))

Java

OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));

Design auf die Aktivität anwenden

Sie können ein Design auf die Aktivität anwenden, damit es dem Design der anderen Aktivitäten Ihrer App entspricht. Fügen Sie dazu die Open-Source-Lizenzaktivität in ein <activity>-Element in der Manifestdatei Ihrer App ein, wie im folgenden Code-Snippet gezeigt:

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

So wird die Liste der Lizenzen ermittelt

Zur Kompilierzeit scannt das Gradle-Plug-in die POM-Abhängigkeiten des Projekts Ihrer App. Wenn für eine direkte Abhängigkeit der App ein Maven-POM vorhanden ist, verarbeitet das Plug-in jedes <licenses>-Element und bettet den Link und den Titel jeder Lizenz in ein Android-Asset ein, das in Ihrer App enthalten ist.