跳到主要内容
版本:v7

安卓问题排查指南

创建一个 100% 完美的原生管理工具几乎是不可能的,迟早你会在安卓工作流的某个环节遇到各种问题。

本指南尝试记录常见的安卓问题及其可能的解决方案。

安卓工具箱

每位安卓开发者都会学习一些调试安卓问题的常用技巧,你应该将这些技巧融入你的工作流中:

善用谷歌搜索

任何时候遇到安卓、Gradle 或模拟器相关的问题,你的第一步都应该是将错误信息复制并粘贴到谷歌搜索中。

Capacitor 使用标准的安卓工具链,因此很可能你遇到的问题其他安卓开发者也曾遇到过,并且已经有解决方案。

解决方案可能很简单,比如更新依赖、运行 Gradle 同步或清理缓存。

Gradle 同步

如果你从 npm 安装了一个新插件,但在安卓构建中无法使用或看到该插件,请尝试使用 Android Studio 右上角的"Sync Project with Gradle Files"按钮(图标看起来像一头大象)。这将重新同步你的原生安卓代码以包含新的插件代码,应该能让你使用新插件。更多信息请参阅 GitHub 上的这个问题

这种方法也能帮助解决许多其他看似随机的问题,因此在遇到大多数安卓构建问题时,运行"Sync Project with Gradle Files"总是一个好的第一步。

清理/重建

清理和重建可以解决许多构建问题:

Android 清理和构建

清理缓存并重启

如果你确信已经修复了问题,但 Android Studio 或 Gradle 仍然报错,通常的解决方案是让 Android Studio 清理其缓存并重启程序。

这可以通过文件菜单轻松完成:

Android 清理缓存

错误:"package android.support.* does not exist"

当某些 Cordova 或 Capacitor 插件使用了旧的 android support 依赖,而没有使用新的 AndroidX 等效库时,会出现此错误。 你应该在插件仓库中报告此问题,以便维护者可以更新插件以使用 AndroidX 依赖。

作为临时解决方案,你也可以使用 jetifier 来修补插件:

npm install jetifier
npx jetify
npx cap sync android

错误:"Please select Android SDK"

此错误通常是由于 Gradle 需要同步,在更新依赖和更改项目设置后,你需要定期执行此操作。

要手动同步 Gradle,请从主菜单栏打开 File -> Sync Project with Gradle Files:

同步 Gradle

错误:"APK Can't be installed"

APK 无法安装到模拟器或设备上,通常是由于存在具有相同包名的现有应用。尝试运行应用时,你可能会看到类似这样的错误:

Android APK 安装失败

解决方案是删除任何旧应用,并确保你的包名在 AndroidManifest.xml 中是最新的,并且不与你正在开发的其他应用冲突。

最后,为了保险起见,请执行一次清理和重建操作。

错误:"Unable to locate a Java Runtime"

如果未设置 JAVA_HOME 环境变量,在使用 run 命令时可能会出现此错误。

要解决此问题,请将 JAVA_HOME 设置为环境变量或系统变量,使用在 Android Studio 中 Preferences > Build, Execution, Deployment, Build Tools > Gradle > Gradle JDK 下找到的路径。

Android Studio 中的 JDK 路径

在 Mac 上,可以在 .zshrc.bashrc 文件中更新,或在环境中导出。

export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home"

在 Windows 上,你可以在环境变量设置中将 JAVA_HOME 设置为系统变量。

重新创建项目

Capacitor 允许你管理自己的安卓项目。就像任何 IDE 支持的项目一样,有时事情会变得非常不同步,以至于唯一的解决方案就是重建项目。

要执行此操作,请按照以下步骤进行:

  1. 将你创建的任何源代码(例如 app/android/src 中的 Java 文件、清单文件或资源文件)复制到 app/android 之外的安全位置。
  2. 接下来,确保你运行的是最新版本的 Capacitor CLI:npm install @capacitor/cli@latest
  3. 删除安卓目录:rm -rf android/
  4. 从 Capacitor 重新创建安卓应用:npx cap add android
  5. 将保存的源文件复制回项目中

插件未实现

在安卓上,如果 Capacitor 找不到插件或无法将其代码注入到 WebView 中,则可能会发生这种情况。

首先,请确保插件已安装并出现在 package.json 中。

然后,运行 npx cap sync android

最后,使用 Android Studio 右上角的"Sync Project with Gradle Files"按钮(图标看起来像一头大象)。这将重新同步你的原生安卓代码以包含新的插件代码,应该能让你使用新插件。

另外,如果你正在从 Capacitor 1 或 2 迁移,请确保你已启用自动插件加载

如果仍然收到"Plugin not implemented"错误,请确保你没有使用 service workers,这会阻止 Capacitor 和插件代码的注入。或者,如果你想使用它们,可以尝试这个变通方案来使注入工作。

使用 Proguard

ProGuard 是一个用于压缩、混淆和减小应用大小的工具。通过在 build.gradle 中将 minifyEnabled 选项设置为 true 来启用它。在使用依赖其代码在运行时可读(例如代码反射)的插件或某些自定义原生代码时,此过程有时会导致 Capacitor 出现问题。ProGuard 扫描代码以尝试优化和缩小应用大小,有时此过程可能会删除对插件功能很重要的类或方法。

从 Capacitor v3.2.3 开始,Capacitor 包含了涵盖 Capacitor 插件核心功能、权限和活动结果的 ProGuard 规则。如果你使用的 Capacitor 版本早于 v3.2.3,请将以下规则添加到你的安卓项目的 proguard-rules.pro 文件中。这些规则应该能解决任何核心 Capacitor 功能和核心插件的问题。

如果在添加这些规则后仍然遇到问题,请尝试识别源插件或原生代码,并添加规则以覆盖特定的插件代码,例如:

-keep class com.mythirdpartyplugin.** { *; }

如果你确定是 Capacitor 插件导致了 ProGuard 问题,并且不介意所有插件都免于 ProGuard 处理,以下 ProGuard 规则将覆盖任何插件类代码:

-keep public class * extends com.getcapacitor.Plugin