[Android FrameWork 6.0源码学习] LayoutInflater 类分析

Posted 2020-09-22

LayoutInflater是用来解析XML布局文件，然后生成对象的ViewTree的工具类。是这个工具类的存在，才能让我们写起Layout来那么省劲。

我们接下来进去刨析，看看里边的奥秘

    //调用inflate方法就可以把XML解析成View对象  
    View contentView = LayoutInflater.from(this).inflate(R.layout.activity_main, null);  

我们在使用这个类的时候，通常都是像上面这样写，首先通过from函数获取对象，在调用inflate方法，来生成相应的View Tree

    public View inflate(@LayoutRes int resource, @Nullable ViewGroup root, boolean attachToRoot) {  
            final Resources res = getContext().getResources();  
            final XmlResourceParser parser = res.getLayout(resource);  
            try {  
                return inflate(parser, root, attachToRoot);  
            } finally {  
                parser.close();  
            }  
        }  

 这个方法里边获取到了我们常用的Resources资源管理类，然后通过res对象获取了XmlResourceParser这个解析器，之后传递到下一个方法中去

public View inflate(XmlPullParser parser, @Nullable ViewGroup root, boolean attachToRoot) {  
            synchronized (mConstructorArgs) {  
                final Context inflaterContext = mContext;  
                final AttributeSet attrs = Xml.asAttributeSet(parser);  
                Context lastContext = (Context) mConstructorArgs[0];  
                mConstructorArgs[0] = inflaterContext;  
                View result = root;  
      
                try {  
                    //标准的pull解析，定义解析标记
                    int type;  
                    while ((type = parser.next()) != XmlPullParser.START_TAG &&  
                            type != XmlPullParser.END_DOCUMENT) {  
                        // Empty  
                    }  
                    //这里是一个简单的容错判断，仅仅是验证xml是否合法  
                    if (type != XmlPullParser.START_TAG) {  
                        throw new InflateException(parser.getPositionDescription()  
                                + ": No start tag found!");  
                    }  
                    //获取xml布局的根标签的名字  
                    final String name = parser.getName();  
                    //判断标签是否是<merge>，如果是merge就用rInflate去解析  
                    if (TAG_MERGE.equals(name)) {  
                        if (root == null || !attachToRoot) {  
                            throw new InflateException("<merge /> can be used only with a valid "  
                                    + "ViewGroup root and attachToRoot=true");  
                        }  
                        //回在最后讲,最后会调用他去创建view tree  
                        rInflate(parser, root, inflaterContext, attrs, false);  
                    } else {  
                        //创建View树的跟View  
                        final View temp = createViewFromTag(root, name, inflaterContext, attrs);  
                        ViewGroup.LayoutParams params = null;  
                        
                        if (root != null) {  
                            // 获取container中的LayoutParams参数  
                            params = root.generateLayoutParams(attrs);  
                            if (!attachToRoot) {  
                                //给根View设置默认的布局参数  
                                //如果root传递null，那么就会按照wrap_content的方式去加载  
                                temp.setLayoutParams(params);  
                            }  
                        }  
      
                        //解析xml剩下的所有的布局，并在根View中创建View树  
                        rInflateChildren(parser, temp, attrs, true);  
                          
                        //如果需要装饰就直接调用addView方法，把刚刚生成的 View树 添加到root容器中  
                        if (root != null && attachToRoot) {  
                            root.addView(temp, params);  
                        }  
      
                        //不需要装饰就直接return  
                        if (root == null || !attachToRoot) {  
                            result = temp;  
                        }  
                    }  
      
                } catch (XmlPullParserException e) {  
                    InflateException ex = new InflateException(e.getMessage());  
                    ex.initCause(e);  
                    throw ex;  
                } catch (Exception e) {  
                    InflateException ex = new InflateException(  
                            parser.getPositionDescription()  
                                    + ": " + e.getMessage());  
                    ex.initCause(e);  
                    throw ex;  
                } finally {  
                    // Don‘t retain static reference on context.  
                    mConstructorArgs[0] = lastContext;  
                    mConstructorArgs[1] = null;  
                }  
                return result;  
            }  
        }

 这个方法比较长，所以我直接在代码里加好了注释，这样方便阅读，仔细看完上边的代码+注释后，我来总结一下这个函数所做的事情

为了解释这个方法，我在贴一个简单的xml布局上来。这样方便理解

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/activity_main"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <TextView
        android:id="@+id/test_btn"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:background="@android:color/darker_gray"
        android:gravity="center_horizontal"
        android:paddingBottom="20dp"
        android:paddingTop="20dp"
        android:text="Hello World!" />
</RelativeLayout>

 

对应上述的XML布局来讲

我们在继续分析上边的函数，首先创建一个根View出来（RelativeLayout），就是temp对象，之后会设置好长宽属性

然后在通过rInflateChildren函数来递归解析 RelativeLayout 标签下所有的 View/ViewGroup ，然后会按照XML里下的各个View关系来生成对应的ViewTree

我们先看一下createViewFromTag方法，看看如何根据一个Tag(RelativeLayout)创建出一个View对象的

    private View createViewFromTag(View parent, String name, Context context, AttributeSet attrs) {  
            return createViewFromTag(parent, name, context, attrs, false);  
    }  

    View createViewFromTag(View parent, String name, Context context, AttributeSet attrs,  
                boolean ignoreThemeAttr) {  
            //判断传进来的标签的名字  
            if (name.equals("view")) {  
                name = attrs.getAttributeValue(null, "class");  
            }  
      
            // 设置一个主题样式  
            if (!ignoreThemeAttr) {  
                final TypedArray ta = context.obtainStyledAttributes(attrs, ATTRS_THEME);  
                final int themeResId = ta.getResourceId(0, 0);  
                if (themeResId != 0) {  
                    context = new ContextThemeWrapper(context, themeResId);  
                }  
                ta.recycle();  
            }  
            
            if (name.equals(TAG_1995)) {  
                return new BlinkLayout(context, attrs);  
            }  
      
            try {  
                View view;  
                //这里询问是否用自定义的工厂去创建View  
                if (mFactory2 != null) {  
                    view = mFactory2.onCreateView(parent, name, context, attrs);  
                } else if (mFactory != null) {  
                    view = mFactory.onCreateView(name, context, attrs);  
                } else {  
                    view = null;  
                }  
                //同样也是询问是否用自定义的工去创建View tree  
                if (view == null && mPrivateFactory != null) {  
                    view = mPrivateFactory.onCreateView(parent, name, context, attrs);  
                }  
                //如果没有set过任何factory,那么就是默认的创建方式  
                if (view == null) {  
                    final Object lastContext = mConstructorArgs[0];  
                    mConstructorArgs[0] = context;  
                    try {  
                        //这块是自定义控件还是原生控件,原生控件都有包名,所以用查找.去判断  
                        //然后调用onCreateView去创建View tree  
                        //这个是一个抽象方法,具体实现在PhoneLayoutInflater类中  
                        //然后返回具体的View对象  
                        if (-1 == name.indexOf(‘.‘)) {  
                            view = onCreateView(parent, name, attrs);  
                        } else {  
                            view = createView(name, null, attrs);  
                        }  
                    } finally {  
                        mConstructorArgs[0] = lastContext;  
                    }  
                }  
      
                return view;  
            } catch (InflateException e) {  
                throw e;  
      
            } catch (ClassNotFoundException e) {  
                final InflateException ie = new InflateException(attrs.getPositionDescription()  
                        + ": Error inflating class " + name);  
                ie.initCause(e);  
                throw ie;  
      
            } catch (Exception e) {  
                final InflateException ie = new InflateException(attrs.getPositionDescription()  
                        + ": Error inflating class " + name);  
                ie.initCause(e);  
                throw ie;  
            }  
        }  

 

这个函数的也是通过一个叫createView来创建自定义控件，用onCreateView方法来创建原生控件，这两个都是抽象方法，是由PhoneLayoutInflater来实现，我们先贴出创建对象的代码。在贴出函数代码来

//这段代码在SystemServiceRegistry中,把服务注册到系统中,可以看到是PhoneLayoutInflater  
registerService(Context.LAYOUT_INFLATER_SERVICE, LayoutInflater.class,  
                new CachedServiceFetcher<LayoutInflater>() {  
            @Override  
            public LayoutInflater createService(ContextImpl ctx) {  
                return new PhoneLayoutInflater(ctx.getOuterContext());  
}});

 

我们用Context获取到的服务，都是通过上面的方式注册的，我们可以看到是 new 了一个PhoneLayoutInflater的对象

       private static final String[] sClassPrefixList = {  
           "android.widget.",  
           "android.webkit.",  
           "android.app."  
       };  

    @Override protected View onCreateView(String name, AttributeSet attrs) throws ClassNotFoundException {  
      
        for (String prefix : sClassPrefixList) {  
            try {  
         //这块又调用他父类的方法去创建View  
                View view = createView(name, prefix, attrs);  
                if (view != null) {  
                    return view;  
                }  
            } catch (ClassNotFoundException e) {  
                //....  
            }  
        }  
        //如果前几个包都没有满足条件的,还有最后一手,super  
        return super.onCreateView(name, attrs);  
       }  

 

onCreateView函数先遍历一下预先定义好的3个包，然后尝试用createView函数去创建，如果创建不成功，最后在调用super的onCreateView去创建，所谓的super其实就是LayoutInflater这个抽象

    //我们可以看到，这个super的方法，是直接定位android.view包的  
    protected View onCreateView(String name, AttributeSet attrs)  
                throws ClassNotFoundException {  
            return createView(name, "android.view.", attrs);  
    }  

 

super的onCreateView也是通过尝试的方式去创建，只是super中创建定义的包名是view包，在分析一下createVIew函数，就了解了由XML转变成java对象的过程了

   public final View createView(String name, String prefix, AttributeSet attrs)  
                throws ClassNotFoundException, InflateException {  
             //先判断是否已经存在实例  
            Constructor<? extends View> constructor = sConstructorMap.get(name);  
            Class<? extends View> clazz = null;  
      
            try {  
                if (constructor == null) {  
                    //这块在for循环的帮助下,去查找类,并加载  
                    clazz = mContext.getClassLoader().loadClass(  
                            prefix != null ? (prefix + name) : name).asSubclass(View.class);  
                    //这块是一个简单的过滤器,在加载的过程中用来过滤是否允许加载并创建对象  
                    if (mFilter != null && clazz != null) {  
                        boolean allowed = mFilter.onLoadClass(clazz);  
                        if (!allowed) {  
                            failNotAllowed(name, prefix, attrs);  
                        }  
                    }  
                    //通过反射创建获取构造器  
                    constructor = clazz.getConstructor(mConstructorSignature);  
                    constructor.setAccessible(true);  
                    sConstructorMap.put(name, constructor);  
                } else {  
                    //同样是对过滤器的判断,如果不设置便是空的  
                    if (mFilter != null) {  
                        Boolean allowedState = mFilterMap.get(name);  
                        if (allowedState == null) {  
                            clazz = mContext.getClassLoader().loadClass(  
                                    prefix != null ? (prefix + name) : name).asSubclass(View.class);  
                              
                            boolean allowed = clazz != null && mFilter.onLoadClass(clazz);  
                            mFilterMap.put(name, allowed);  
                            if (!allowed) {  
                                failNotAllowed(name, prefix, attrs);  
                            }  
                        } else if (allowedState.equals(Boolean.FALSE)) {  
                            failNotAllowed(name, prefix, attrs);  
                        }  
                    }  
                }  
      
                Object[] args = mConstructorArgs;  
                args[1] = attrs;//这是一个context对象  
                //创建一个View实例  
                final View view = constructor.newInstance(args);  
                //这快判断一下是否是View存根,存根就初始化设置一下加载器  
                if (view instanceof ViewStub) {  
                    final ViewStub viewStub = (ViewStub) view;  
                    viewStub.setLayoutInflater(cloneInContext((Context) args[0]));  
                }  
                //到这快就真正执行完createViewFromTag方法了,返回根View  
                return view;  
            } catch (NoSuchMethodException e) {  
                //....  
            } catch (ClassCastException e) {  
                //....  
            } catch (ClassNotFoundException e) {  
                //....  
            } catch (Exception e) {  
                //....  
            } finally {  
                //....  
            }  
        }  

 

这个函数是通过反射的方式去反射我们解析出来的Tag的构造方法，来然后再创建一个对象出来，最后通过newInstance方法，创建一个view对象出来。这样就可以把 解析出来的TAG转换成Java里的View对象了

上边这个过程看完后，我们就知道LayoutInflater是怎样把一个Tag名称，转变成Java对象的。

接下来我们分析一下，看看它是又如何递归去创建各个子View的，这个的创建过程就是rInflateChildren函数了

我们在rInflateChildren中其实也是解析到tag名称。然后通过createViewFromTag函数来创建对象。就是我们上面分析的流程

   //调用一下rInflate方法，我贴出rInflate的源码  
    final void rInflateChildren(XmlPullParser parser, View parent, AttributeSet attrs,  
                boolean finishInflate) throws XmlPullParserException, IOException {  
            rInflate(parser, parent, parent.getContext(), attrs, finishInflate);  
        }  


    void rInflate(XmlPullParser parser, View parent, Context context,  
                AttributeSet attrs, boolean finishInflate) throws XmlPullParserException, IOException {  
      
            final int depth = parser.getDepth();  
            int type;  
      
            while (((type = parser.next()) != XmlPullParser.END_TAG ||  
                    parser.getDepth() > depth) && type != XmlPullParser.END_DOCUMENT) {  
      
                if (type != XmlPullParser.START_TAG) {  
                    continue;  
                }  
                //获取xml标签名字  
                final String name = parser.getName();  
                if (TAG_REQUEST_FOCUS.equals(name)) {  
                    //调用parent的view.requestFocus方法注册焦点  
                    parseRequestFocus(parser, parent);  
                } else if (TAG_TAG.equals(name)) {  
                    //给parent设置tag,view.setTag方法  
                    parseViewTag(parser, parent, attrs);  
                } else if (TAG_INCLUDE.equals(name)) {  
                    if (parser.getDepth() == 0) {  
                        throw new InflateException("<include /> cannot be the root element");  
                    }  
                    //解析include标签,大概原理就是找到layout  
                    //用上边的rInflate createViewFromTag和rInflateChildren进行view树创建  
                    //创建好后调用parent的addView加进去  
                    parseInclude(parser, context, parent, attrs);  
                } else if (TAG_MERGE.equals(name)) {  
                    throw new InflateException("<merge /> must be the root element");  
                } else {  
                    //最后到控件部分，各种TextView,Button,ImageView啊之类的  
                    //还是那个套路,通过createViewFromTag创建View对象  
                    //这块是个递归思路  
                    final View view = createViewFromTag(parent, name, context, attrs);  
                    //获取当前标签的父View  
                    final ViewGroup viewGroup = (ViewGroup) parent;  
                    //获取布局参数  
                    final ViewGroup.LayoutParams params = viewGroup.generateLayoutParams(attrs);  
                    //继续递归,直到最底层View,然后逐步向上创建,并加到viewGroup容器中  
                    rInflateChildren(parser, view, attrs, true);  
                    viewGroup.addView(view, params);  
                }  
            //这个是View下的一个方法,加载完后会调用一下,自定义View的时候可以用到这个方法  
            //你可以重写这个方法,来find一些View对象  
            if (finishInflate) {  
                parent.onFinishInflate();  
            }  
        }  

 

 主要实现在rInflate方法中

首先呢，获取标签的名字，然后在通过createViewFromTag方法去创建对象，然后继续向下递归，查看是否还存在ViewGroup。知道所有view都解析完成，最终返回出去的view，就是一个完整的view tree

 

这块就是LayoutInflater的工作原理。如果分析有错误或者有疑问，请在评论区指出，我会在第一时间更正或解惑，谢谢支持。