Troubleshooting Android Issues

Creating a 100% perfect native management tool is nearly impossible, and sooner or later you’ll run into various issues with some part of the Android workflow.

This guide attempts to document common Android issues with possible solutions.

Android Toolbox

Every Android developer learns a few common techniques for debugging Android issues, and you should incorporate these into your workflow:

Google, Google, Google

Any time you encounter an issue with Android, or Gradle, or Emulators, your first step should be to copy and paste the error into a Google search.

Capacitor uses the standard Android toolkit, so chances are if you run into something, many Android developers have as well, and there’s a solution out there.

It could be as simple as updating a dependency, running Gradle sync, or invalidating caches.

Clean/Rebuild

Cleaning and rebuilding can fix a number of build issues:

Invalidate Caches/Restart

If you’re confident you fixed an issue, but Android Studio or Gradle doesn’t agree, often the solution is to have Android Studio invalidate its caches and restart the program.

That can be done easily from the File menu:

Error: “package android.support.* does not exist”

This error occurs when some Cordova or Capacitor plugin has old android support dependencies instead of using the new AndroidX equivalent. You should report the issue in the plugin repository so the maintainers can update the plugin to use AndroidX dependencies.

As a workaround, you can also patch the plugin using jetifier:

npm install jetifier
npx jetify
npx cap sync android

Error: “Unable to load native-bridge.js. Capacitor will not function!”

This error occurs when Capacitor’s native-bridge.js file was not copied to the native project.

The fix is simple: run npx cap copy android to copy this file.

Error: “Please select Android SDK”

This error is often due to Gradle needing to be synced, something you’ll need to do periodically after updating dependencies and changing project settings.

To manually sync Gradle, open File -> Sync Project with Gradle Files from the main menu bar:

Error: “APK Can’t be installed”

An APK not installing to an Emulator or Device is often due to having an existing app with the same package name. You may see an error like this when trying to run your app:

The solution is to remove any old apps and make sure your package name is up to date in AndroidManifest.xml and not conflicting with other apps you are developing.

Finally, do a clean and rebuild just in case.

Recreating your project

Capacitor lets you manage your own Android project. Like any IDE-backed project, sometimes things get so out of sync that the only solution is to rebuild the project.

To do this, follow these steps:

1. Copy any source code you created (such as Java files in app/android/src, manifest files, or resource files) into a safe location outside of app/android.
2. Next, make sure you are running an updated version of the Capacitor CLI: npm install @capacitor/cli@2
3. Remove the android directory: rm -rf android/
4. Re-create the Android app from Capacitor: npx cap add android
5. Copy your saved source files back into the project

Using Proguard

ProGuard is a tool used to shrink, obfuscate, and reduce the size of your app. It is enabled by setting the minifyEnabled option in build.gradle to true. This process can sometimes lead to issues in Capacitor when using a plugin or some custom native code that relies on its code being being readable at run time, such as code reflection. ProGuard scans code to try and optimize and shink the size of an app and sometimes this process can remove classes or methods that are important for the functionality of a plugin.

Add the following rules to your Android project’s proguard-rules.pro file. Those rules should resolve problems with any of the core Capacitor features and core plugins.

If you still encounter any issues after adding those rules, try to identify the source plugin or native code and add a rule to cover the specific plugin code, for example:

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

If you are certain a Capacitor plugin is causing the ProGuard issue the following ProGuard rule will cover any plugin class code, if you don’t mind all plugins being exempt from ProGuard processing:

-keep public class * extends com.getcapacitor.Plugin