Android LayoutInflater Factory 源码解析

时间 2019-11-06

标签 android layoutinflater factory 源码解析栏目 Android 繁體版

原文原文链接

在上一篇文章《Android LayoutInflater 源码解析》中咱们说到 View 的 inflate 中有一个方法 createViewFromTag，会首先尝试经过 Factory 来 CreateView。java

View view;
    if (mFactory2 != null) {
        // ① 有mFactory2，则调用mFactory2的onCreateView方法
        view = mFactory2.onCreateView(parent, name, context, attrs);
    } else if (mFactory != null) {
        // ② 有mFactory，则调用mFactory的onCreateView方法
        view = mFactory.onCreateView(name, context, attrs);
    } else {
        view = null;
    }
复制代码

正常状况下这个Factory是空的，那何时不为空，以及 LayoutInflater Factory 的具体用法，咱们今天就带着这两个问题来详细学习下。android

备注：本文基于 Android 8.1.0。bash

一、LayoutInflater.Factory 简介

LayoutInflater.Factory 中没有说明，那咱们来看下它惟一方法的说明：微信

Hook you can supply that is called when inflating from a LayoutInflater. You can use this to customize the tag names available in your XML layout files.app

翻译过来就是：经过 LayoutInflater 建立View时候的一个回调，能够经过LayoutInflater.Factory来改造 XML 中存在的 tag。ide

咱们来看下这个惟一的方法：布局

public abstract View onCreateView (String name, Context context, AttributeSet attrs)
复制代码

那么咱们就明白了，若是咱们设置了LayoutInflater Factory ，在LayoutInflater 的 createViewFromTag 方法中就会经过这个 Factory 的 onCreateView 方法来建立 View。学习

二、LayoutInflater.Factory 做用

那怎么理解上述引用的这个改造呢？举个简单的例子：好比你在 XML中写了一个 TextView标签，而后在 onCreateView 这个回调里判断若是 name 是 TextView 的话能够变成一个Button，这样的功能能够实现例如批量更换某一个控件等的用途。例子以下：ui

布局文件
<android.support.constraint.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="com.example.liuzhaofutrue.teststart.MainActivity">

    <TextView
        android:id="@+id/tv"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</android.support.constraint.ConstraintLayout>
复制代码

接下来咱们在 Java 代码中作修改：this

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        LayoutInflater.from(this).setFactory2(new LayoutInflater.Factory2() {
            @Override
            public View onCreateView(View parent, String name, Context context, AttributeSet attrs) {
                if(TextUtils.equals(name,"TextView")){
                    Button button = new Button(MainActivity.this);
                    button.setText("我替换了TextView");
                    button.setAllCaps(false);
                    return button;
                }
                return getDelegate().createView(parent, name, context, attrs);
            }

            @Override
            public View onCreateView(String name, Context context, AttributeSet attrs) {
                return null;
            }
        });

        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}
复制代码

能够看到，原本在布局文件中须要展现的是一个 TextView，可是如今却被改形成了一个 Button。

备注：其实还有一个关系密切的类 LayoutInflater.Factory2 ，与 LayoutInflater.Factory 的区别是：

LayoutInflater.Factory2 是API 11 被加进来的；
LayoutInflater.Factory2 继承自 LayoutInflater.Factory；
能够对建立 View 的 Parent 进行控制；

三、LayoutInflaterCompat

刚刚咱们说到，LayoutInflater.Factory2 是API 11 被加进来的，那么 LayoutInflaterCompat 就是拿来作兼容的类。咱们来看下它最重要的两个方法：

@Deprecated
    public static void setFactory(
            @NonNull LayoutInflater inflater, @NonNull LayoutInflaterFactory factory) {
        IMPL.setFactory(inflater, factory);
    }

    public static void setFactory2(
            @NonNull LayoutInflater inflater, @NonNull LayoutInflater.Factory2 factory) {
        IMPL.setFactory2(inflater, factory);
    }
复制代码

能够看到 setFactory 已经被标记为过期，更建议使用 setFactory2 方法。

static final LayoutInflaterCompatBaseImpl IMPL;
    static {
        if (Build.VERSION.SDK_INT >= 21) {
            IMPL = new LayoutInflaterCompatApi21Impl();
        } else {
            IMPL = new LayoutInflaterCompatBaseImpl();
        }
    }
    
    @RequiresApi(21)
    static class LayoutInflaterCompatApi21Impl extends LayoutInflaterCompatBaseImpl {
        @SuppressWarnings("deprecation")
        @Override
        public void setFactory(LayoutInflater inflater, LayoutInflaterFactory factory) {
            inflater.setFactory2(factory != null ? new Factory2Wrapper(factory) : null);
        }

        @Override
        public void setFactory2(LayoutInflater inflater, LayoutInflater.Factory2 factory) {
            inflater.setFactory2(factory);
        }
    }
复制代码

这里调用 setFactory 实际上仍是调用的 setFactory2 方法，同时将 LayoutInflaterFactory 包裹为 Factory2Wrapper。

四、LayoutInflater.setFactory 使用注意

若是咱们将LayoutInflater.setFactory 挪到 super.onCreate 的后面能够吗？ 程序居然报错了，咱们看下Log：

Process: com.example.teststart, PID: 24132
    java.lang.RuntimeException: Unable to start activity ComponentInfo{com.example.teststart/com.example.teststart.MainActivity}: java.lang.IllegalStateException: A factory has already been set on this LayoutInflater
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:2876)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:2941)
     Caused by: java.lang.IllegalStateException: A factory has already been set on this LayoutInflater
        at android.view.LayoutInflater.setFactory2(LayoutInflater.java:317)
        at com.example.teststart.MainActivity.onCreate(MainActivity.java:18)
        at android.app.Activity.performCreate(Activity.java:6765)
复制代码

说明是 LayoutInflater 已经被设置了一个 Factory，而咱们再设置的时候就会报错。咱们跟踪下 LayoutInflater.from(this).setFactory2 方法：

private boolean mFactorySet;
    public void setFactory2(Factory2 factory) {
        if (mFactorySet) {
            throw new IllegalStateException("A factory has already been set on this LayoutInflater");
        }
        if (factory == null) {
            throw new NullPointerException("Given factory can not be null");
        }
        mFactorySet = true;
        if (mFactory == null) {
            mFactory = mFactory2 = factory;
        } else {
            mFactory = mFactory2 = new FactoryMerger(factory, factory, mFactory, mFactory2);
        }
    }
复制代码

能够经过这个 mFactorySet 变量看出 setFactory2 方法只能被调用一次，重复设置则会抛出异常。那Factory2是被谁设置了呢？

咱们来看下 AppCompatActivity 的 onCreate 方法，

@Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        final AppCompatDelegate delegate = getDelegate();
        delegate.installViewFactory();
        delegate.onCreate(savedInstanceState);
        if (delegate.applyDayNight() && mThemeId != 0) {
            // If DayNight has been applied, we need to re-apply the theme for
            // the changes to take effect. On API 23+, we should bypass
            // setTheme(), which will no-op if the theme ID is identical to the
            // current theme ID.
            if (Build.VERSION.SDK_INT >= 23) {
                onApplyThemeResource(getTheme(), mThemeId, false);
            } else {
                setTheme(mThemeId);
            }
        }
        super.onCreate(savedInstanceState);
    }
复制代码

其中会调用 delegate.installViewFactory(); 最终会调用到 AppCompatDelegateImplV9 的 installViewFactory方法；

@Override
    public void installViewFactory() {
        LayoutInflater layoutInflater = LayoutInflater.from(mContext);
        if (layoutInflater.getFactory() == null) {
            LayoutInflaterCompat.setFactory2(layoutInflater, this);
        } else {
            if (!(layoutInflater.getFactory2() instanceof AppCompatDelegateImplV9)) {
                Log.i(TAG, "The Activity's LayoutInflater already has a Factory installed"
                        + " so we can not install AppCompat's");
            }
        }
    }
复制代码

能够看到：

若是 layoutInflater.getFactory() 为空，则 AppCompatActivity 会自动设置一个 Factory2，难怪咱们在 super.onCreate 以后调用会报错；
细心的小伙伴确定也明白了，为何咱们在 super.onCreate 以前设置 Factory以后，系统再次设置 Factory 的时候不会抛出异常；

备注：聪明的小伙伴确定能想到使用反射来改变修改 LayoutInflater 中的 mFactorySet 为false就能够在 super.onCreate 以后再次设置 Factory了。

五、AppCompatActivity 为何 setFactory

那么为何 AppCompatActivity 会自动设置一个 Factory呢？顺着 AppCompatDelegateImplV9 的 installViewFactory方法继续跟踪，走到了 onCreateView 方法，它最终会调用到 AppCompatViewInflater 的 createView 方法。

public final View createView(View parent, final String name, @NonNull Context context,
            @NonNull AttributeSet attrs, boolean inheritContext,
            boolean readAndroidTheme, boolean readAppTheme, boolean wrapContext) {
        View view = null;
        // We need to 'inject' our tint aware Views in place of the standard framework versions
        switch (name) {
            case "TextView":
                view = new AppCompatTextView(context, attrs);
                break;
            case "ImageView":
                view = new AppCompatImageView(context, attrs);
                break;
            case "Button":
                view = new AppCompatButton(context, attrs);
                break;
            ......
        }
        return view;
    }
复制代码

原来 AppCompatActivity 设置 Factory 是为了将一些 widget 自动变成兼容widget （例如将 TextView 变成 AppCompatTextView）以便于向下兼容新版本中的效果，在高版本中的一些 widget 新特性就是这样在老版本中也能展现的。

那若是咱们设置了本身的 Factory 岂不是就避开了系统的兼容？其实系统的兼容咱们仍然能够保存下来，由于系统是经过 AppCompatDelegate.onCreateView 方法来实现 widget 兼容的，那咱们就能够在设置 Factory 的时候先调用 AppCompatDelegate.onCreateView 方法，再来作咱们的处理。

LayoutInflater.from(this).setFactory2(new LayoutInflater.Factory2() {
        @Override
        public View onCreateView(View parent, String name, Context context, AttributeSet attrs) {
    
            // 调用 AppCompatDelegate 的createView方法
            getDelegate().createView(parent, name, context, attrs);
            // 再来执行咱们的定制化操做
            return null;
        }
    
        @Override
        public View onCreateView(String name, Context context, AttributeSet attrs) {
            return null;
        }
    });
复制代码

六、总结

LayoutInflater.Factory的意义：经过 LayoutInflater 建立 View 时候的一个回调，能够经过 LayoutInflater.Factory 来改造或定制建立 View 的过程。
LayoutInflater.setFactory 使用注意：不能在 super.onCreate 以后设置。
AppCompatActivity 为何 setFactory ？向下兼容新版本中的效果。

广告时间

今日头条各Android客户端团队招人火爆进行中，各个级别和应届实习生都须要，业务增加快、日活高、挑战大、待遇给力，各位大佬走过路过千万不要错过！

本科以上学历、非频繁跳槽（如两年两跳），欢迎加个人微信详聊：KOBE8242011