Android Gradle manifestPlaceholders 占位符详解

在 Android 开发中，我们经常需要在 AndroidManifest.xml 文件中配置一些值，比如应用的版本号、应用的包名、应用的权限等等。这些值一般都是硬编码在 AndroidManifest.xml 文件中，当我们需要修改这些值时，就需要手动去修改 AndroidManifest.xml 文件，这样非常不方便。为了解决这个问题，Android 提供了一种 Gradle 插件，可以让我们在构建时动态地替换 AndroidManifest.xml 中的某些值，这个插件就是 manifestPlaceholders。

manifestPlaceholders 的用法

在 build.gradle 文件中，我们可以使用 manifestPlaceholders 来定义一些占位符，然后在 AndroidManifest.xml 文件中使用这些占位符替代相应的值。例如：

android {
    defaultConfig {
        ...
        manifestPlaceholders = [
                appName: "MyApp",
                appVersionCode: 1,
                appVersionName: "1.0.0",
                packageName: "com.example.myapp"
        ]
    }
}

在上面的例子中，我们定义了四个占位符：appName、appVersionCode、appVersionName 和 packageName。然后在 AndroidManifest.xml 文件中，我们可以使用占位符来替代相应的值，例如：

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="${packageName}" >

    <application
        android:label="${appName}"
        android:versionCode="${appVersionCode}"
        android:versionName="${appVersionName}" >
        ...
    </application>

</manifest>

manifestPlaceholders 的作用

使用 manifestPlaceholders 可以带来很多好处。首先，我们可以将一些经常需要修改的值放在 build.gradle 文件中，这样可以避免手动修改 AndroidManifest.xml 文件。其次，我们可以根据不同的构建类型或变体，动态地替换 AndroidManifest.xml 中的值。例如，我们可以定义不同的占位符值，用于不同的构建类型：

android {
    buildTypes {
        release {
            manifestPlaceholders = [
                    appName: "MyApp",
                    appVersionCode: 1,
                    appVersionName: "1.0.0",
                    packageName: "com.example.myapp"
            ]
        }
        debug {
            manifestPlaceholders = [
                    appName: "MyApp (Debug)",
                    appVersionCode: 1,
                    appVersionName: "1.0.0",
                    packageName: "com.example.myapp.debug"
            ]
        }
    }
}

这样，当我们以 release 构建类型构建应用时，AndroidManifest.xml 中的值将会被替换为 release 构建类型对应的占位符值，而当我们以 debug 构建类型构建应用时，AndroidManifest.xml 中的值将会被替换为 debug 构建类型对应的占位符值。

manifestPlaceholders 的注意事项

在使用 manifestPlaceholders 时，需要注意以下几点：

1. 必须在 defaultConfig 或 buildTypes 中定义 manifestPlaceholders。如果没有定义，Gradle 将会报错。
2. 占位符的值可以是字符串、整数或布尔值。如果需要传递字符串，可以使用双引号或单引号进行包裹。
3. 如果占位符的值是布尔值，可以使用 true 或 false 来表示。
4. 占位符的名称不能包含特殊字符，只能是字母、数字、下划线和点号。
5. 在 AndroidManifest.xml 中，使用占位符时要使用 ${} 进行包裹，并且占位符的名称要和 build.gradle 中定义的一致。

总结

manifestPlaceholders 是 Android Gradle 插件提供的一个功能强大的特性，可以在构建时动态地替换 AndroidManifest.xml 中的一些值。通过使用 manifestPlaceholders，我们可以简化项目的配置，提高开发效率。希望本篇博客对大家理解和使用 manifestPlaceholders 有所帮助。

参考链接：

• Android 开发者文档 - manifestPlaceholders

本文来自极简博客，作者：星河之舟，转载请注明原文链接：Android Gradle manifestPlaceholders 占位符详解