Google Play 服务有时包含或依赖于开源库。为了遵守开源库的许可要求,作为开发者,您有责任为应用使用的开源库妥善显示通知。
Google Play 服务包含一组工具,旨在让开发者能够更轻松地显示其应用中使用的库的开源软件通知。其中一种工具是 Gradle 插件,用于收集包含的库(如其 POM 文件中所声明)的许可条款,并创建可用于显示这些条款的 activity。详细了解该工具如何查找和打包许可信息。
添加 Gradle 插件
在根级 build 文件中,执行以下操作:
- 添加 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") } }
Groovy 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' } }
在应用级 build 文件中,通过在文件顶部的 com.android.application
插件现有声明下方添加以下代码行来应用该插件:
Kotlin DSL
plugins { id("com.android.application") id("com.google.android.gms.oss-licenses-plugin") }
Groovy DSL
plugins { id 'com.android.application' id 'com.google.android.gms.oss-licenses-plugin' }
您可以在 GitHub 上查看此插件的代码。
将库添加到您的应用中
在应用级 build 文件的 dependencies
部分中,添加 oss-licenses
库的依赖项:
Kotlin DSL
implementation("com.google.android.gms:play-services-oss-licenses:17.1.0")
Groovy DSL
implementation 'com.google.android.gms:play-services-oss-licenses:17.1.0'
显示许可信息
在构建应用时,Gradle 插件会处理许可并将其添加到应用的资源中。如需轻松显示许可,您可以在应用中的适当位置启动 play-services-oss-licenses
库提供的 activity,如以下代码段所示:
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));
启动后,此 activity 会显示编译到应用中的开源库的列表,包括 Google Play 服务中的库,如图 1 所示。用户可以点按库的名称,查看该库的其他许可信息。
图 1. “Licenses”菜单 activity 会显示应用使用的可供选择的开源库列表。
设置 activity 标题
默认情况下,显示的 activity 的标题为“开源许可”。您可以通过调用 setActivityTitle()
来自定义 activity 的标题,如以下代码段所示:
Kotlin
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title))
Java
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));
向 activity 应用主题
您可以向 activity 应用主题,使其与应用的其他 activity 中使用的主题一致。为此,请在应用清单文件的 <activity>
元素中添加开源许可 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 资源中。