Android package属性、package name和Application ID三者的联系及区别
  • 2017/01/12 15:39
  • 编辑:代码酱
  • 浏览:469

名词解释

  1. package属性:在AndroidManifest.xml文件中。
  2. package name:模块结构的包名。
  3. Application ID:模块defaultConfig块下的applicationId属性。

设置Application ID

每个Android应用程序都有唯一一个类似Java包名的Application ID,比如com.example.myapp。在Android设备和Google应用商店上,Application ID是您应用的唯一标识。如果您想上传应用程序的新版本,那么Application ID必须和原来相同。如果您改变了新版本应用程序的Application ID,那么Goolge应用商店会认为这是个完全不同的应用程序。所以,从您第一次上传应用程序开始,绝对不要更改Application ID

Application ID定义在模块build.gradle的applicationId属性中,如下所示:

android {
defaultConfig {
applicationId "com.example.myapp"
minSdkVersion 15
targetSdkVersion 24
versionCode 1
versionName "1.0"
}
...
}

当您在Android Studio中创建新项目的时候,您可以设置applicationId属性,这时,Application ID和package name是精确匹配的。除此之外,两者是完全独立的。当然,您可以更改package name,但是这不会影响到Application ID。反之亦然(再次提醒:在您上传应用程序之后,不要修改Application ID,不要修改Application ID,不要修改Application ID)。然而,您应该意识到,修改package name 还有另一个后果。这部分详见修改包名(下文有讲)。

尽管Application ID看起来和传统的Java包名很类似,但是Application ID的命名规则有更多的限制:

  • 最少有两段(至少一个.隔开)
  • 每段开头必须是字母
  • 所有的字符只能是字母、数字和下划线

注意:在以前,Application ID 直接绑定package name。所以,有些Android APIs在方法名或者参数名中使用“package name”,但是实际上指的是Application ID。举个栗子,Context.getPackageName()方法返回Application ID。所以没必要在您应用程序代码之外分享真正的package name。

警告:如果你使用WebView,考虑使用您的package name作为您Application ID的前缀,否则,您可能遇见issue 211768。

修改构建版本的Application ID

当为您的应用程序构建APK时,构建工具使用build.gradle文件中的defaultConfig块中定义的Application ID标识APK(如下所示)。但是,如果你想创建不同版本的应用程序并且在Google应用商店中显示不同的信息,例如“免费版”和“专业版”。您需要构建拥有不相同Application ID的不同版本。

在这种情况下,每个构建版本应该定义不同的product flavor,且每个flavor都在productFlavors{}块内部。对于每个flavor,您可以重新定义applicationId属性,或者给默认的applicationId増加前后缀,如下所示:

android {
defaultConfig {
applicationId "com.example.myapp"
}
productFlavors {
free {
applicationIdSuffix ".free"
}
pro {
applicationIdSuffix ".pro"
}
}
}

这样定义之后,“free”的Application ID是”com.example.myapp.free“。

在构建类型上,你也可以使用后缀,如下所示:

android {
...
buildTypes {
debug {
applicationIdSuffix ".debug"
}
}
}

由于Gradle首先应用product flavor之后才应用build type,所以”free debug”版本现在的Application ID是”com.example.myapp.free.debug”。如果你想在同一部手机上同时安装debug和release两个版本,这将非常有用,因为没有两个应用程序可以拥有相同的Application ID。

记住一点,同一应用程序拥有不同的Application ID,Google应用市场将会认为这是两个应用程序。所以,如果您为了适配不同的设备配置(例如不同的API等级),并且想用相同信息去分发多个应用程序。那么对于每个版本,您必须使用相同的Application ID和不同的versionCode。

警告:为了兼容先前的SDK工具,如果你没有在build.gradle中定义applicationId属性,那么构建工具将使用AndroidManifest.xml中的package属性作为Application ID。在这种情况下,重命名package name意味着同时重命名了Application ID。

提示:如果您需要在manifest文件中引用Application ID,可以在manifest的属性中使用${applicationId}占位符。Gradle在构建时会自定替换这个标识为真正的Application ID。更多详见Inject Build Variables into the Manifest.

测试专用Application ID

默认情况下,构建工具会使用指定构建版本的Application ID(附加.test)将Application ID应用到您的instrumentation测试APK。例如,构建版本为”com.example.myapp.free”的测试应用程序真正的Application ID是“com.example.myapp.free.test“。

通常这不是必要的,你可以在defaultConfig或者productFlavor块中定义testApplicationId属性来修改Application ID。

注意:为了避免与测试应用程序命名冲突,构建工具为测试应用程序使用基于测试Application ID生成R.class的命名空间。

修改package name

虽然package name默认完全匹配Application ID,但是您仍然可以修改它。如果您想修改package name,请留意package name(项目目录结构)和AndroidManifest.xml中的package属性是完全对应的。如下所示:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.myapp"
android:versionCode="1"
android:versionName="1.0" >

对于Android构建工具来说,package属性用于两件事情:

  • 应用于您应用程序生成R.Java类的命名空间。

    例如:在上面的manifest文件中。R类是“com.example.myapp.R”

  • 用于解析AndroidManifest.xml文件中任何类的相对路径。

    例如:在上面的manifest文件中。一个activity定义为\,将会被解析为com.example.myapp.MainActivity。

因此,package属性的值应该总是和工程的package name相同。当然,你可以给工程设置子包名。这些文件必须从package属性的命名空间导入R类,并且任何定义在manifest中的组件必须增加子包名(或者写全路径)。

如果您需要完全重命名package name,请确保您已经更新package属性。直到您用Android studio的工具重命名包,之后这些自动保持同步。(如果没有保持同步,您的代码将不能正确解析R类,因为它不再是相同包下,并且manifest也将不能正确识别您的activities和其它组件)。

您必须在AndroidManifest.xml文件中置顶package属性,如果您另外添加了manifest文件,请注意,由最高优先级manifest文件提供的package name始终用于合并最终的manifest。更多:[Merge Multiple Manifest Files。

望周知:尽管您的项目可以设置package属性不等于applicationId,然并卵。构建工具在最后构建的时候将会复制Application ID并设置为您应用程序唯一的package属性的值。所以,如果您在构建成功之后检查AndroidManifest.xml文件,请不要惊讶package属性发生变化。在Android平台和Google应用商店,package属性才是真正作为您应用程序唯身份凭证。所以,一旦使用原始值构建(使用命名空间的R类解析manifest中的组件),构建工具将会丢弃package属性的值,并且使用Application ID替换。

原文链接:https://developer.android.com/studio/build/application-id.html#change_the_package_name

热门评论
推荐文章
代码酱
5805文章总数
98915总阅读量
编译作者
热门频道
收藏 待读 分享