AndroidX终极迁移指南

AndroidX是啥？

关于这个问题直接引用官方的原话，相信大家就一目了然了。

AndroidX 是 Android 团队用于在 Jetpack 中开发、测试、打包和发布库以及对其进行版本控制的开源项目。

AndroidX 对原始 Android 支持库进行了重大改进。与支持库一样，AndroidX 与 Android 操作系统分开提供，并与各个 Android 版本向后兼容。AndroidX 完全取代了支持库，不仅提供同等的功能，而且提供了新的库。此外，AndroidX 还包括以下功能：

• AndroidX 中的所有软件包都使用一致的命名空间，以字符串 androidx 开头。支持库软件包已映射到对应的 androidx.* 软件包。有关所有旧类到新类以及旧编译工件到新编译工件的完整映射，请参阅软件包重构页面。
• 与支持库不同，AndroidX 软件包会单独维护和更新。从版本 1.0.0 开始，androidx 软件包使用严格的语义版本控制。您可以单独更新项目中的 AndroidX 库。
• 所有新支持库的开发工作都将在 AndroidX 库中进行。这包括维护原始支持库工件和引入新的 Jetpack 组件。

为什么要迁移到AndroidX？

关于这个问题很显然主要是以下几点：

1. Support库从28.0.0之后将不再更新

   不更新意味着就算你发现28.0.0里有bug官方也不会再改了，只会在androidx里改，官方依然这么任性，除非你不需要官方的support库，否则的话迟早都要升级。

2. Android Jetpack组件

   官方在jetpack中发布了很多组件来提高我们的开发效率、降低开发的复杂度。相信很多小伙伴已经爱上了jetpack组件，比如大家耳熟能详的ViewModel、LiveData、Lifecycles、Room等。当然这些好用的组件都是需要Androidx的。

3. 减少app体积

   Androidx针对混乱的support库进行了重构，将支持库拆分的更加精细，我们再也不会出现为了使用某个Api而引入整个的v4、v7库。

   例如：我们之前要使用android.support.v7.widget.RecyclerView就需要导入v7库，但androidx的话我们只需要导入androidx.recyclerview库即可。

迁移终极攻略

在进入迁移之前，要注意下几点：

1. 请使用3.2及更高版本的Android Studio。
2. 请在单独的分支中进行迁移
3. 在AndroidX迁移的时候千万不要做任何版本开发、代码重构工作，因为androidx迁移会涉及项目绝大部分的源码文件。(当然也不要过于担心影响app的原有功能，只是对support库中涉及到的包名和类名进行改动)
4. 一定要擦亮眼睛（因为就算用工具迁移，也会存在遗漏的地方，需要少量手动迁移）
5. 沉得住气、沉得住气、沉得住气（因为不同的项目依赖的三方库各不相同，会遇到不同问题，但也就那几类，不用害怕）
6. 切记：要一步步来，不要一口吃个大胖子（按步骤走，可以在错的时候更加精确的锁定哪一步错了）。

下面就正式开始了！！！

step1 升级版本

将compileSdkVersion调整为28，将项目的support库版本升级到28.0.0。

因为androidx 1.0.0版本和support库的28.0.0版本在二级制层面是等效的，也就是说这两个版本的差异之处仅限于代码包名称，一切的API都是相同的。这样你就只需要做最少的事情来解决28.0.0到androidx之前的迁移问题。

step2 开启Jetifier

在项目的gradle.properties文件内添加如下代码

android.useAndroidX=true
android.enableJetifier=true

useAndroidX=ture

android 插件会使用对应的 AndroidX 库（而非支持库）。

enableJetifier=ture

Android 插件会通过重写其二进制文件来自动迁移现有的第三方库以使用 AndroidX。

Jetifier绝对不会改变你的源码还有你生成的代码。

step3 更新依赖

将app依赖的三方库尽量都升级到支持androidx的版本，这样可以避免在迁移中发生冲突。

注意：如果你使用了kotlin，请将annotationProcessor替换为kapt

Step4 使用Android Sutdio迁移

使用 Android Studio 3.2 及更高版本，只需从菜单栏中依次选择 Refactor > Migrate to AndroidX，即可初步完成将现有项目迁移到 AndroidX的工作。

当然一般情况，这一步执行完以后还有很多support库的引用没有更换为androidx。

如果使用Android Studio比较卡，可以参考支持库映射文档将支持库替换androidx的库，然后直接执行step5操作。

Step5 使用Bash script

事先声明，这个脚本是比较暴力的查找替换脚本，使用完请做好测试工作

首先感谢Daniel Lew提供的脚本和官方提供的映射文件可以帮助我们完成AndroidStudio遗漏的部分

image

请将脚本和映射文件下载到本地后，对脚本文件进行配置

MAPPING_FILE 和 PROJECT_DIR是需要替换为您的实际路径的

MAPPING_FILE 就是官方映射文件的路径

PROJECT_DIR 就是项目目录的路径

配置完成后，直接将脚本文件拖入终端敲回车执行。

若报找不到sed之类的错误，请安装gnu-sed

# 在终端执行如下命令
brew install gnu-sed

若报permission denied，请对脚本文件进行授权

# xxx.sh为你的脚本文件路径
chmod 777 xxx.sh

Step6 收尾

前面的步骤执行完毕以后基本上没有错误，或者一些简单的小错误了。

祝大家迁移顺利。。。

参考

• 官方文档：迁移到 AndroidX
• 官方微信公众号文章：是时候迁移至 AndroidX 了
• Daniel Lew的AndroidX迁移脚本
• 官方提供的映射文件