如何使用 Cordova 命令行界面创建签名的 APK 文件？

Posted 2023-04-19

【中文标题】如何使用 Cordova 命令行界面创建签名的 APK 文件？

【英文标题】：How to create a signed APK file using Cordova command line interface?

【发布时间】：2014-12-14 11:35:19

【问题描述】：

我创建了一个名为checkStatus 的示例应用程序。现在我想创建一个签名的 APK 文件。所以我可以将它安装在不同的设备上进行测试。

为此，我在 Google 上搜索并找到了这个documentation。

根据文档，我切换到我的项目目录并运行以下命令：

keytool -genkey -v -keystore key-name.keystore -alias alias-name -keyalg RSA -keysize 2048 -validity 10000

运行上述命令后，我在projectRoot/key-name.keystore 处获得了一个名为key-name.keystore 的文件。

然后我将该文件复制粘贴到projectRoot/platforms/android/key-name.keystore。

之后，我创建了一个名为ant.properties 的文件并将其保存在projectRoot/platforms/android。

我在文件中写了如下代码：

key.store=projectRoot/key-name.keystore
key.alias=myApp

之后，我运行以下命令释放

Cordova builds android --release

它抛出以下错误：

 /home/projectRoot/platforms/android/cordova/node_modules/q/q.js:126
                throw e;
                      ^
Error code 1 for command: ant with args: release,-f,/home/projectRoot/platforms/android/build.xml,-Dout.dir=ant-build,-Dgen.absolute.dir=ant-gen

 Error: /home/projectRoot/platforms/android/cordova/build: Command failed with exit code 8
at ChildProcess.whenDone (/usr/lib/node_modules/cordova/node_modules/cordova-lib/src/cordova/superspawn.js:135:23)
at ChildProcess.EventEmitter.emit (events.js:98:17)
at maybeClose (child_process.js:753:16)
at Process.ChildProcess._handle.onexit (child_process.js:820:5)

所以这次我修改了ant.properties文件中的key.store值，如下所示。

 key.store=/home/projectRoot/platforms/android/key-name.keystore

我再次运行了cordova build android --release 命令。它会引发同样的错误。

谁能告诉我我做错了什么？

【问题讨论】：

从cordova 5开始，流程有点变化：ilee.co.uk/Sign-Releases-with-Cordova-Android/…

两个链接都失效了。

【参考方案1】：

第 1 步：

D:\projects\Phonegap\Example> cordova plugin rm org.apache.cordova.console --save

添加--save，以便从config.xml 文件中删除插件。

第 2 步：

要生成适用于 Android 的发布版本，我们首先需要对platforms/android 中的AndroidManifest.xml 文件进行一些小改动。编辑文件并更改行：

<application android:debuggable="true" android:hardwareAccelerated="true" android:icon="@drawable/icon" android:label="@string/app_name">

并将android:debuggable 更改为false：

<application android:debuggable="false" android:hardwareAccelerated="true" android:icon="@drawable/icon" android:label="@string/app_name">

从 cordova 6.2.0 开始，完全删除 android:debuggable 标记。这是cordova的解释：

“HardcodedDebugMode”类型问题的说明： 最好从清单中省略 android:debuggable 属性。 如果你这样做了，那么工具会自动插入 android:debuggable=true 在构建 APK 以在模拟器或设备上进行调试时。当你 执行发布构建，例如导出 APK，它会自动设置 它为假。

另一方面，如果您在清单文件中指定特定值， 那么工具将始终使用它。这可能会导致意外发布 带有调试信息的应用。

第 3 步：

现在我们可以告诉 cordova 生成我们的发布版本：

D:\projects\Phonegap\Example> cordova build --release android

然后，我们可以在platforms/android/ant-build 中找到我们未签名的 APK 文件。在我们的示例中，文件为 platforms/android/ant-build/Example-release-unsigned.apk

第四步：

注意：我们的密钥库 keystoreNAME-mobileapps.keystore 在这个 Git 存储库中，如果您想创建另一个，请继续执行以下步骤。

密钥生成：

语法：

keytool -genkey -v -keystore <keystoreName>.keystore -alias <Keystore AliasName> -keyalg <Key algorithm> -keysize <Key size> -validity <Key Validity in Days>

例如：

keytool -genkey -v -keystore NAME-mobileapps.keystore -alias NAMEmobileapps -keyalg RSA -keysize 2048 -validity 10000


keystore password? : xxxxxxx
What is your first and last name? :  xxxxxx
What is the name of your organizational unit? :  xxxxxxxx
What is the name of your organization? :  xxxxxxxxx
What is the name of your City or Locality? :  xxxxxxx
What is the name of your State or Province? :  xxxxx
What is the two-letter country code for this unit? :  xxx

然后密钥库已经生成，名称为 NAME-mobileapps.keystore

第 5 步：

将生成的密钥库放入

旧版科尔多瓦

D:\projects\Phonegap\Example\platforms\android\ant-build

新版科尔多瓦

D:\projects\Phonegap\Example\platforms\android\build\outputs\apk

要对未签名的 APK 进行签名，请运行 JDK 中也包含的 jarsigner 工具：

语法：

jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore <keystorename> <Unsigned APK file> <Keystore Alias name>

例如：

D:\projects\Phonegap\Example\platforms\android\ant-build> jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore NAME-mobileapps.keystore Example-release-unsigned.apk xxxxxmobileapps

或

D:\projects\Phonegap\Example\platforms\android\build\outputs\apk> jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore NAME-mobileapps.keystore Example-release-unsigned.apk xxxxxmobileapps

Enter KeyPhrase as 'xxxxxxxx'

这标志着 apk 就位。

第 6 步：

最后，我们需要运行 zip align 工具来优化 APK：

D:\projects\Phonegap\Example\platforms\android\ant-build> zipalign -v 4 Example-release-unsigned.apk Example.apk 

或

D:\projects\Phonegap\Example\platforms\android\ant-build> C:\Phonegap\adt-bundle-windows-x86_64-20140624\sdk\build-tools\android-4.4W\zipalign -v 4 Example-release-unsigned.apk Example.apk

或

D:\projects\Phonegap\Example\platforms\android\build\outputs\apk> C:\Phonegap\adt-bundle-windows-x86_64-20140624\sdk\build-tools\android-4.4W\zipalign -v 4 Example-release-unsigned.apk Example.apk

现在我们有了名为 example.apk 的最终发布二进制文件，我们可以在 Google Play Store 上发布它。

【讨论】：

好的，我接受你的想法。但是我有私人 git 存储库，我们有一个团队来开发移动应用程序。所以对我来说很舒服。

为什么删除 org.apache.cordova.console 很重要？

@cfprabhu 第 5 步抛出警告“没有提供 -tsa 或 -tsacert 并且这个 jar 没有时间戳。”。通过在命令中添加“-tsa timestamp.digicert.com”来修复它。可能对其他用户有用

在 OSX 下的 zipalign 可在 ~/Library/Android/sdk/build-tools/22.0.1/zipalign

@ThomasBormans -tsa timestamp.digicert.com 为我抛出了 NullPointerException。 -tsa http://timestamp.digicert.com 似乎修复了它

【参考方案2】：

针对 Cordova 4（及更高版本）的 @malcubierre 更新-

创建一个名为release-signing.properties 的文件并放入APPFOLDER\platforms\android 文件夹

文件内容：在 = 之后编辑除第 2 行以外的所有内容

storeFile=C:/yourlocation/app.keystore
storeType=jks
keyAlias=aliasname
keyPassword=aliaspass
storePassword=password

那么这个命令应该构建一个发布版本：

cordova build android --release

更新 - 这对我不起作用Cordova 10 with android 9 - 构建正在替换 release-signing.properties 文件。我必须制作一个build.json 文件并将其放入appfolder 中，与root 相同。这是内容 - 替换如上：

"android": 
    "release": 
       "keystore": "C:/yourlocation/app.keystore",
        "storePassword": "password",
        "alias": "aliasname",
        "password" : "aliaspass",
        "keystoreType": ""
    

运行它，它将在 android 文件夹中生成release-signing.properties 之一

【讨论】：

谢谢！您还可以更改属性文件的名称/位置，但您必须在 build-extras.gradle 文件中指定。相关科尔多瓦文档here.

我的应用没有更新到下一个版本，第一个版本是在 ant build(cordova 3) 中创建的。我将我的科尔多瓦升级到 6.0.0 现在第二个版本是在 gradle 构建中创建的，我按照最新的科尔多瓦文档创建签名的 apk，但我的应用程序仍然没有更新。我浏览了网络上的所有信息，但仍然在某个地方出错。请帮助我@Dunc

@Naveen 我正在使用 Cordova 5.2.0，其他版本有各种问题> 5. 如果可以的话，建议你 try that。然后，如果仍有问题，我建议提出一个新问题。

仍然有问题，新版本的 apk 没有从现有应用程序中下载。 @Dunc

@Dunc 任何解决方案

【参考方案3】：

在当前的documentation 中，我们可以指定一个带有密钥库的 build.json：

     "android": 
         "debug": 
             "keystore": "..\android.keystore",
             "storePassword": "android",
             "alias": "mykey1",
             "password" : "password",
             "keystoreType": ""
         ,
         "release": 
             "keystore": "..\android.keystore",
             "storePassword": "",
             "alias": "mykey2",
             "password" : "password",
             "keystoreType": ""
         
     
 

然后，使用 --buildConfig 参数执行突击队，这样：

cordova run android --buildConfig

【讨论】：

太棒了

这个json应该存在于哪个目录？

cordova build android --release

将 build.json 与密钥库文件一起放在根项目文件夹中。这是我发现的最有效的无忧签名方法。

由于某种原因，我不得不将文件路径更改为“../android.keystore”。 （正斜杠）

【参考方案4】：

第一步：

转到cordova\platforms\android ant 创建一个名为ant.properties 的文件，其中包含密钥库文件信息（此密钥库可以从您最喜欢的Android SDK、工作室...生成）：

key.store=C:\\yourpath\\Yourkeystore.keystore
key.alias=youralias

第二步：

转到cordova路径并执行：

cordova build android --release

注意：系统将提示您询问您的密钥库和密钥密码

YourApp-release.apk 将出现在\cordova\platforms\android\ant-build

【讨论】：

从cordova 5开始，流程有点变化：ilee.co.uk/Sign-Releases-with-Cordova-Android/…

使用 Cordova 5 名称文件“release-signing.properties”而不是“ant.properties”；所有其他步骤与@malcubierre 描述的完全一样

没有从 cordova 6.0.0 中的现有应用程序下载新版本的 apk。我关注了所有文档仍然没有解决我的问题你能帮我吗@MarioOrlandi

【参考方案5】：

在 cordova 6.2.0 中，它有一种创建发布版本的简单方法。参考这里的其他步骤Steps 1, 2 and 4

cd cordova/ #change to root cordova folder
platforms/android/cordova/clean #clean if you want
cordova build android --release -- --keystore="/path/to/keystore" --storePassword=password --alias=alias_name #password will be prompted if you have any

【讨论】：

我在使用 Cordova 6.2.0 时收到 The system cannot find the file specified 错误

您是否更换了密钥库路径？如果是这样，请在此处发布命令。

是的。这是cordova build android --release -- --keystore="C:\release.keystore" --storePassword=****** --alias=mr5

用"（双引号）括起我的密码后，它开始运行。我认为 Cordova 在解析特殊字符方面存在问题。

如果有人使用 Ionic，可以查看此文档ionicframework.com/docs/cli/cordova/build

【参考方案6】：

在 Mac (osx) 上，我生成了两个 .sh 文件，一个用于第一次发布，另一个用于更新：

#!/bin/sh
echo "Ionic to Signed APK ---- [e-mail] // Benjamin Rathelot\n"
printf "Project dir : "
read DIR
printf "Project key alias : "
read ALIAS
cd $DIR/
cordova build --release android
cd platforms/android/build/outputs/apk/
keytool -genkey -v -keystore my-release-key.keystore -alias $ALIAS -keyalg RSA -keysize 2048 -validity 10000
jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore my-release-key.keystore android-release-unsigned.apk $ALIAS
zipalign -v 4 android-release-unsigned.apk signedApk.apk

并更新您的应用：

#!/bin/sh
echo "Ionic to Signed APK ---- [e-mail] // Benjamin Rathelot\n"
printf "Project dir : "
read DIR
printf "Project key alias : "
read ALIAS
cd $DIR/
cordova build --release android
cd platforms/android/build/outputs/apk/
rm signedApk.apk
jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore my-release-key.keystore android-release-unsigned.apk $ALIAS
zipalign -v 4 android-release-unsigned.apk signedApk.apk

假设您位于主文件夹或应用程序文件夹顶部的文件夹中。确保正确设置 chmod 以使用此脚本。然后：

./ionicToApk.sh # or whatever depending of the name of your file, in CLI

您签名的 apk 将作为 SignedApk.apk 位于 Your App 文件夹/platforms/android/build/outputs/apk/ 中 确保使用第一个脚本定义的正确密钥别名和密码

【参考方案7】：

在 cmd 中构建 cordova release APK 文件。

KEY STORE FILE PATH：密钥库文件路径（F:/cordova/myApp/xxxxx.jks）

密钥存储密码：xxxxx

密钥商店别名：xxxxx

KEY STORE ALIAS PASSWORD：xxxxx

zipalign.exe 的路径：zipalign.exe 文件路径（C:\Users\xxxx\AppData\Local\Android\sdk\build-tools\25.0.2\zipalign）

ANDROID 未签名的 APK 名称：android-release-unsigned.apk

ANDROID 版本 APK 名称：android-release.apk

在 cmd 中运行以下步骤（以管理员身份运行）

cordova build --release android 转到 android-release-unsigned.apk 文件位置 (PROJECT\platforms\android\build\outputs\apk) jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore KEY STORE FILE PATH> ANDROID UNSIGNED APK NAME> KEY STORE ALIAS> zipalign.exe 的路径> -v 4 ANDROID 未签名的APK 名称> ANDROID 发布APK 名称>

【参考方案8】：

##Generated signed apk from commandline
#variables
APP_NAME=THE_APP_NAME
APK_LOCATION=./
APP_HOME=/path/to/THE_APP
APP_KEY=/path/to/Android_key
APP_KEY_ALIAS=the_alias
APP_KEY_PASSWORD=123456789
zipalign=$ANDROID_HOME/build-tools/28.0.3/zipalign

#the logic
cd $APP_HOME
cordova build --release android
cd platforms/android/app/build/outputs/apk/release
jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore $APP_KEY ./app-release-unsigned.apk $APP_KEY_ALIAS <<< $APP_KEY_PASSWORD
rm -rf "$APK_LOCATION/$APP_NAME.apk"
$zipalign -v 4 ./app-release-unsigned.apk "$APK_LOCATION/$APP_NAME.apk"
open $APK_LOCATION
#the end

【参考方案9】：

如果您要更新应用，请首先检查您的版本代码和版本名称。并确保您有以前的密钥库。

如果您要更新应用程序，请按照步骤 1、3、4 操作。

第 1 步：

转到您的 cordova 项目以生成我们的发布版本：

D:\projects\Phonegap\Example> cordova build --release android

然后，我们可以在platforms/android/ant-build 中找到我们未签名的APK 文件。在我们的示例中，该文件是

如果你使用了 ant-build

yourproject/platforms/android/ant-build/Example-release-unsigned.apk

或

如果你使用了 gradle-build

yourProject/platforms/android/build/outputs/apk/Example-release-unsigned.apk

第 2 步：

密钥生成：

语法：

keytool -genkey -v -keystore <keystoreName>.keystore -alias <Keystore AliasName> -keyalg <Key algorithm> -keysize <Key size> -validity <Key Validity in Days>

如果 keytool 命令无法识别，请执行此步骤

检查 keytool 可执行文件所在的目录是否在您的路径中。 （例如，在我的 Windows 7 机器上，它位于 C:\Program Files (x86)\Java\jre6\bin。）

示例：

keytool -genkey -v -keystore NAME-mobileapps.keystore -alias NAMEmobileapps -keyalg RSA -keysize 2048 -validity 10000


keystore password? : xxxxxxx
What is your first and last name? :  xxxxxx
What is the name of your organizational unit? :  xxxxxxxx
What is the name of your organization? :  xxxxxxxxx
What is the name of your City or Locality? :  xxxxxxx
What is the name of your State or Province? :  xxxxx
What is the two-letter country code for this unit? :  xxx

然后密钥库已经生成，名称为 NAME-mobileapps.keystore

第 3 步：

将生成的密钥库放入 D:\projects\Phonegap\Example\platforms\android\ant-build

要对未签名的 APK 进行签名，请运行 JDK 中也包含的 jarsigner 工具：

语法：

jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore <keystorename <Unsigned APK file> <Keystore Alias name>

如果它没有重新调整，请执行以下步骤

(1)右击“这台电脑”>右击属性>高级系统设置>环境变量>选择PATH然后编辑。

(2) 将你的 jdk bin 文件夹路径添加到环境变量中，应该是这样的：

“C:\Program Files\Java\jdk1.8.0_40\bin”。

示例：

D:\projects\Phonegap\Example\platforms\android\ant-build> jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore NAME-mobileapps.keystore Example-release-unsigned.apk xxxxxmobileapps

Enter KeyPhrase as 'xxxxxxxx'

这标志着 apk 就位。

第四步：

最后，我们需要运行 zip align 工具来优化 APK：

如果 zipalign 无法识别则

(1) 转到你的 android sdk 路径并找到 zipalign 它通常在 android-sdk\build-tools\23.0.3

(2) 将 zipalign 文件粘贴到您的生成发布 apk 文件夹中，通常位于以下路径中

你的项目/平台/android/ant-build/Example-release-unsigned.apk

D:\projects\Phonegap\Example\platforms\android\ant-build> zipalign -v 4 Example-release-unsigned.apk Example.apk 

或

D:\projects\Phonegap\Example\platforms\android\ant-build> C:\Phonegap\adt-bundle-windows-x86_64-20140624\sdk\build-tools\android-4.4W\zipalign -v 4 Example-release-unsigned.apk Example.apk

现在我们有了名为 example.apk 的最终发布二进制文件，我们可以在 Google Play Store 上发布它。

【参考方案10】：

对于 Windows，我创建了一个 build.cmd 文件：

（替换密钥库路径和别名）

对于科尔多瓦：

@echo off 
set /P spassw="Store Password: " && set /P kpassw="Key Password: " && cordova build android --release -- --keystore=../../local/my.keystore --storePassword=%spassw% --alias=tmpalias --password=%kpassw%

对于离子：

@echo off 
set /P spassw="Store Password: " && set /P kpassw="Key Password: " && ionic build --prod && cordova build android --release -- --keystore=../../local/my.keystore --storePassword=%spassw% --alias=tmpalias --password=%kpassw%

保存在ptoject的目录下，可以双击或者cmd打开。

【参考方案11】：

好消息！ cordova 10 包含带有app-release.aab 的新android 版本。