AndroidX 踩坑指南

本文章已授权鸿洋微信公众号转载

官方文档

转 AndroidX 的原因

  • 主动原因:Support 包从 API 28 (Android 9.0)已经弃更,取而代之的是谷歌新推出的 AndroidX 的包。

  • 被动原因:现在一些第三方库都是直接依赖 AndroidX 包,由于谷歌限制 Support 包和 AndroidX 包不能共存的机制,导致我们无法直接依赖第三方库的最新版本,例如某个框架的最新版的依赖就是基于 AndroidX 包,这样就导致我们只能去依赖旧版的框架,并且后续一旦出现问题将无法直接升级框架的方式来解决,而是必须要先将项目升级到 AndroidX 才能升级框架的版本,这个时候我们就会显得很被动。

转成 AndroidX 的步骤

Studio 帮我们做了什么事?

  • 自动替换导入类和 xml 中的 View 包名
import android.support.v7.app.AppCompatActivity;
import androidx.appcompat.app.AppCompatActivity;
<android.support.v7.widget.RecyclerView />
<androidx.recyclerview.widget.RecyclerView />
  • Support 远程依赖变化
implementation 'com.android.support:appcompat-v7:28.0.0'
implementation 'com.android.support:design:28.0.0'
implementation 'androidx.appcompat:appcompat:1.0.0'
implementation 'com.google.android.material:material:1.0.0'
  • gradle.properties 配置变化
# 表示使用 AndroidX
android.useAndroidX = true
# 表示将第三方库迁移到 AndroidX
android.enableJetifier = true

坑一:找不到约束布局

  • 这个因为 AndroidX 包中并没有依赖 ConstraintLayout 库,只需要手动加入依赖即可
implementation 'androidx.constraintlayout:constraintlayout:2.0.0'

坑二:导包报错

  • 部分导包报错,只需要手动更换引用的包名即可,这里不指定包名 Studio 自动会帮我们导入默认的

坑三:第三方库的坑

  • 虽然在这次转换的过程中没有出现过这种异常,但是根据以往的经验,这两个第三方库很可能会导致编译不通过
implementation 'com.jakewharton:butterknife:9.0.0'
annotationProcessor 'com.jakewharton:butterknife-compiler:9.0.0'

implementation 'com.github.bumptech.glide:glide:4.7.1'
annotationProcessor 'com.github.bumptech.glide:compiler:4.7.1'
  • 这个是因为这两个库的旧版本依赖 Support 包导致的,所以解决的方式是将这两个库升级到最新版本即可
implementation 'com.jakewharton:butterknife:10.2.1'
annotationProcessor 'com.jakewharton:butterknife-compiler:10.2.1'

implementation 'com.github.bumptech.glide:glide:4.11.0'
annotationProcessor 'com.github.bumptech.glide:compiler:4.11.0'

坑四:替换不干净

  • Studio 只能帮我们替换显式调用的包名,而不能帮我们替换隐式调用的包名,例如通过反射填写的包名,混淆规则等等
Class.forName("android.support.design.widget.Snackbar");
Class.forName("android.support.design.widget.BottomSheetDialog");

-keep class android.support.**{*;}
  • 解决的方式也很简单,在项目中全局搜索 android.support 关键字眼,然后手动进行替换

坑五:Fragment 崩溃

  • 升级 AndroidX 后,切换 Fragment 出现 NullPointerException:androidx.fragment.app.FragmentManagerImpl.isDestroyed() 异常,经过排查是 Fragment 基类中存在这些反射的代码导致的
public abstract class BaseFragment extends Fragment {

    @Override
    public void onDetach() {
        super.onDetach();
        try {
            Field childFragmentManager = Fragment.class.getDeclaredField("mChildFragmentManager");
            childFragmentManager.setAccessible(true);
            childFragmentManager.set(this, null);
        } catch (NoSuchFieldException e) {
            throw new RuntimeException(e);
        } catch (IllegalAccessException e) {
            throw new RuntimeException(e);
        }
    }
}

坑六:WebView 崩溃

  • 升级 AndroidX 之后,Android 5.x 的设备上出现了此异常,并且这个 Bug 是必现的
android.view.InflateException: Binary XML file line #20: Error inflating class android.webkit.WebView
    at android.view.LayoutInflater.createView(LayoutInflater.java:633)
    at com.android.internal.policy.impl.PhoneLayoutInflater.onCreateView(PhoneLayoutInflater.java:55)
    at android.view.LayoutInflater.onCreateView(LayoutInflater.java:682)
    at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:741)
    at android.view.LayoutInflater.rInflate(LayoutInflater.java:806)
    at android.view.LayoutInflater.rInflate(LayoutInflater.java:809)
    at android.view.LayoutInflater.inflate(LayoutInflater.java:504)
    at android.view.LayoutInflater.inflate(LayoutInflater.java:414)
  • 经过验证是 AndroidX 1.1.0 版本导致的,这个版本的 AndroidX 和 WebView 存在冲突
implementation 'androidx.appcompat:appcompat:1.1.0'
implementation 'com.google.android.material:material:1.1.0'
  • 解决的方式大致分为以下两种,大家可以根据实际情况选择。

  • 方法一:将 AndroidX 相关依赖升级到 1.2.0 版本及以上

implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'com.google.android.material:material:1.2.0'
  • 方法二:对 WebView 进行单独修复
public class LollipopFixedWebView extends WebView {
    
    public LollipopFixedWebView(Context context) {
        super(getFixedContext(context));
    }

    public LollipopFixedWebView(Context context, AttributeSet attrs) {
        super(getFixedContext(context), attrs);
    }

    public LollipopFixedWebView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(getFixedContext(context), attrs, defStyleAttr);
    }

    @TargetApi(Build.VERSION_CODES.LOLLIPOP)
    public LollipopFixedWebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
        super(getFixedContext(context), attrs, defStyleAttr, defStyleRes);
    }

    public LollipopFixedWebView(Context context, AttributeSet attrs, int defStyleAttr, boolean privateBrowsing) {
        super(getFixedContext(context), attrs, defStyleAttr, privateBrowsing);
    }

    /**
     * 修复原生 WebView 和 AndroidX 在 Android 5.x 上面崩溃的问题
     *
     * doc:https://stackoverflow.com/questions/41025200/android-view-inflateexception-error-inflating-class-android-webkit-webview
     */
    private static Context getFixedContext(Context context) {
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP && Build.VERSION.SDK_INT < Build.VERSION_CODES.M) {
            // 为什么不用 ContextImpl,因为使用 ContextImpl 获取不到 Activity 对象,而 ContextWrapper 可以
            // 这种写法返回的 Context 是 ContextImpl,而不是 Activity 或者 ContextWrapper
            // return context.createConfigurationContext(new Configuration());
            // 如果使用 ContextWrapper 还是导致崩溃,因为 Resources 对象冲突了
            // return new ContextWrapper(context);
            // 如果使用 ContextThemeWrapper 就没有问题,因为它重写了 getResources 方法,返回的是一个新的 Resources 对象
            return new ContextThemeWrapper(context, context.getTheme());
        }
        return context;
    }
}

常见误区:FileProvider

  • 关于 FileProvider 的清单注册,没转 AndroidX 之前是这样子的
<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="${applicationId}.provider"
    android:exported="false"
    android:grantUriPermissions="true">

    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths" />
</provider>
  • 转成 AndroidX 之后的是这样子的
<provider
    android:name="androidx.core.content.FileProvider"
    android:authorities="${applicationId}.provider"
    android:exported="false"
    android:grantUriPermissions="true">

    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths" />
</provider>
  • 你可能会觉得这里是不是改漏掉了,看着着实不爽
<provider
    ....
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS" />
</provider>
  • 于是乎你顺手改成了这样,看着着实顺眼多了
<provider
    ....
    <meta-data
        android:name="androidx.core.FILE_PROVIDER_PATHS" />
</provider>
  • 结果一运行,你会发现应用运行不起来,一看日志才明白报了错
 java.lang.IllegalArgumentException: Missing android.support.FILE_PROVIDER_PATHS meta-data
    at androidx.core.content.FileProvider.parsePathStrategy(FileProvider.java:613)
    at androidx.core.content.FileProvider.getPathStrategy(FileProvider.java:579)
    at androidx.core.content.FileProvider.attachInfo(FileProvider.java:392)
  • 结果你一点进去看源码,才发现这是个雷
package androidx.core.content;

public class FileProvider extends ContentProvider {

    private static final String
            META_DATA_FILE_PROVIDER_PATHS = "android.support.FILE_PROVIDER_PATHS";

    private static PathStrategy parsePathStrategy(Context context, String authority) {
        final XmlResourceParser in = info.loadXmlMetaData(
            context.getPackageManager(), META_DATA_FILE_PROVIDER_PATHS);
        if (in == null) {
            throw new IllegalArgumentException(
                    "Missing " + META_DATA_FILE_PROVIDER_PATHS + " meta-data");
        }
    }
}
  • 这个故事告诉我们,闲着没事不要做一些骚操作,有空不如多学习

灰度小插曲

  • 发布灰度更新之后,我们在 Bugly 上面发现了一个崩溃率直线上升的 Bug
异常名称 发生次数 影响设备数
java.lang.ClassNotFoundException:
android.support.constraint.ConstraintLayout
14 7
  • 经过排查发现,是我的同事开发分支的代码是 Support 库,合并了 AndroidX 分支的代码之后没有进行复测导致的,再加上 Gradle 编译时不会去检查 Xml 文件中的 View 包名是否正确,所以才出现了这个问题。

  • 于是我们快速发了一个 Hotfix 版本进行修复,值得庆幸的是,这个 Bug 发生在账号注销界面,并不会影响到主流程,否则就是严重的事故了,望大家引以为戒。

后续情况汇报

  • 正式上线一周后的情况:一切正常,无出现崩溃和用户反馈

  • 正式上线一个月后的情况:一切正常,无出现崩溃和用户反馈

  • 正式上线三个月后的情况:一切正常,无出现崩溃和用户反馈

Android 技术讨论 Q 群:10047167

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容