Migrating to AndroidX: tips, tricks, and guidance
Take advantage of the latest Jetpack has to offer.
Jetpack is a set of libraries, tools, and guidance to help you write high-quality apps more easily. Jetpack makes coding easier through best practices, limiting boilerplate code, and simplifying complex tasks. All with the goal of enabling you to focus on the code that you really care about.
AndroidX is the package name for all the libraries within Jetpack. Think of AndroidX as the open-source project used to develop, test, version, and release Jetpack libraries.
Back at I/O 2018, we announced that Support Library would be refactored into the AndroidX namespace, which was completed with Support Library 28 and the announcement of AndroidX 1.0.
Why migrate?
The time is right now to migrate from using the Android Support Library to AndroidX. There are four reasons behind this:
- The Android Support Library has reached the end of its life. 28.0 was the last release of the Android Support namespace and the namespace is no longer maintained. So, if you want bug fixes or new features that would have previously gone into the Support Library, you need to migrate to AndroidX.
- Better package management. With AndroidX, you get standardized and independent versioning, as well as better standardized naming and more frequent releases.
- Other libraries have migrated to use the AndroidX namespace libraries, including Google Play services, Firebase, Butterknife, Mockito 2, and SQLDelight among others.
- All new Jetpack libraries will be released in AndroidX namespace. So, for example, to take advantage of Jetpack Compose or CameraX, you need to migrate to the AndroidX namespace.
Preparing to migrate
Before you start to migrate to AndroidX you should:
- back up your project. If you’re using source control tools, it is still recommended that you make a backup, because migration will change many of the files in your project.
- create a new branch on which to make the migration changes.
- if possible, suspend or minimize development (at least don’t try to do refactoring or pull in new features) during the migration, as this will help reduce the number of merge conflicts that could happen.
Migrate
Throughout the migration steps focus on addressing errors, getting your app to compile, and passing all tests.
Step 1: Update to Support Library version 28
Migrating directly to AndroidX from an older version of the Support Library, say 26 or 27, isn’t recommended: not only would you need to address the namespace changes, you would also need to address the API changes between the older version and AndroidX.
It is, therefore, recommended that you update to version 28, address all of the API changes, and ensure your app compiles with version 28.
Support Library version 28 and AndroidX 1.0 are binary equivalent, meaning that only the package name changes between those two versions: all the APIs are the same. This means that you should have very little to fix when migrating from 28 to AndroidX.
Step 2: Enable Jetifier
Jetifier helps migrate third-party dependencies to use AndroidX. Jetifier will change the byte code of those dependencies to make them compatible with projects using AndroidX. However, Jetifier won’t change your source code or migrate your generated code.
To enable Jetifier in your app, add the following to your gradle.properties files:
android.useAndroidX=trueandroid.enableJetifier=true
Now, when code auto-completion import libraries, you’ll import the AndroidX version of that library instead of the old Support Library version.
Step 3. Update dependencies
Before starting the migration, you should update each third-party library — such as Butterknife, Glide, Mockito 2, and SqlDelight — to the most recent version of the library. Not doing so could result in unexplained compilation errors.
If you’re using a code generation library, Jetifier won’t modify these. So you will need to check that the code generation library is compatible with AndroidX.
If you consider skipping steps 2 and 3 here are some of the errors you could encounter:
- the third-party code you’re using is not compatible with AndroidX. In this case, a stack trace similar to the one below will show you that it’s trying to pull in the old version of the Support Library:
…Error : Program type already present: android.support.v4.app.INotificationSideChannel$Stub$Proxy |Reason: Program type already present: android.support.v4.app.INotificationSideChannel$Stub$Proxy…
- if you have a project that’s partially migrated, you might get a duplicate class error, where it’s trying to pull in the same code from both the Support Library and AndroidX. The stack trace will show you something like this:
…Duplicate class android.support.v4.app.INotificationSideChannel found in modules classes.jar (androidx.core:core:1.0.0) and classes.jar (com.android.support:support-compat:28.0.0)…
Step 4: Update your source code
You have 3 options to update your source code to use AndroidX:
- Android Studio
- manual update
- Bash script
If you use Android Studio 3.2 stable or above, you can update your source code using the Migrate to AndroidX option on the Refactor menu. This is the recommended way as Android Studio can examine your source code to make correct decisions when refactoring.
If you don’t use Android Studio or employ a more sophisticated app architecture that the Migrate to AndroidX option doesn’t cover, you should instead leverage the class mapping csv file to implement a find and replace bash script. This script should find all source code instances of the android.support classes and then replace them with their AndroidX equivalent.
More concretely, the script should take the CSV file that provides the class mapping and then run a grep command followed by a sed command to replace the package names. However, because this is a brute force approach to migration, this basic find and replace may not sufficiently or correctly complete the migration.
Additionally, the update can also be done manually.
If you decide to take the manual approach, visit the Migrate to AndroidX page, where you can find an artifact mapping that details the Support Library packages and their corresponding class mapping is AndroidX. You can also download the CSV file from this page.
And that’s it, you should now have a project that compiles and uses AndroidX.
Those pesky exceptions
While the tools and processes we’ve discussed here should guide most apps smoothly through the migration, we’ve found that there are some cases where you may need to make changes manually.
Version configuration files
You will need to manually reapply variables that define library versions. To illustrate, your build.gradle file might look like this prior to migration:
ext.versions = [ ‘drawer’ : ‘28.0.0’, ‘rview’ : ‘28.0.0’]implementation “com.android.support:drawerlayout:${versions.drawer}”implementation “com.android.support:recyclerview-v7:${versions.rview}”
Then, after running the migration tool you end up with this:
ext.versions = [ ‘drawer’ : ‘28.0.0’, ‘rview’ : ‘28.0.0’]implementation “androidx.drawerlayout:drawerlayout:1.0.0”implementation “androidx.recyclerview:recyclerview:1.0.0”
DrawerLayout and RecyclerView are using the AndroidX packages, but the version numbers are now inline. Also, the versions variable numbers have not been changed. So you’ll need to do a manual update to this:
ext.versions = [ ‘drawer’ : ‘1.0.0’, ‘rview’ : ‘1.0.0’
]implementation “androidx.drawerlayout:drawerlayout:${versions.drawer}”implementation “androidx.recyclerview:recyclerview:${versions.rview}”
ProGuard and build scripts
The migration tool doesn’t automate updates to ProGuard and any associated built scripts. So, if you’re using these and have package names in them, you’ll need to edit these manually.
Get the latest stable version
The migration tool pulls in the most recent release of the AndroidX libraries. As a result, you may end up with an alpha version of some libraries rather than the stable version. For example, the support library version before migration might be:
implementation ‘com.android.support:appcompat-v7:28.0.0’And after migration, you would be using the alpha version of the corresponding AndroidX library:
implementation ‘androidx.appcompat:appcompat:1.1.0-alpha01’So, if you prefer to use the stable version of the library, you’ll need to manually update the version:
implementation ‘androidx.appcompat:appcompat:1.0.2’More help and resources
You can find more information about this process, the tools, and issues you may encounter on the developer.android.com Migrating to AndroidX page. The page includes an overview of the AndroidX project, a migration guide, and the mapping table of the old Support Library to the new stable and alpha AndroidX versions with the CSV files you need to script your migration.
Elsewhere, there is also an article detailing the migration to AndroidX in the Plaid example project.
And finally, there is an issue tracker where you see the migration tool issues that the team is working on. You can, of course, report any issues you find with the migration tool here using the button at the top left of the page.
Final thoughts
If you haven’t upgraded to AndroidX, this is a great time to do so and take advantage of the streamlined development that the Jetpack libraries offer your apps. By following the guidance in this article you should find that, in most cases, migration is a straightforward and easy thing to do.
Do you have thoughts on AndroidX? Let us know in the comments below or tweet using #AndroidStudio and we’ll reply from @AndroidDev, where we regularly share news and tips on how to be successful on Android.
