Android 记一次解决问题的过程

之前我写过一篇文章，介绍我在GitHub开源的滑动控件ConsecutiveScroller是如何实现布局吸顶功能的。有兴趣的朋友可以去看一下：Android滑动布局ConsecutiveScrollerLayout实现布局吸顶功能。文章介绍了ConsecutiveScrollerLayout是如何通过计算布局的滑动距离，给吸顶view设置y轴偏移量，让它悬停在顶部。不过当view悬停在顶部时，它会与后面的view重叠而被覆盖。这是由于Android布局的显示层级，两个view重叠时，后添加的会将先添加的覆盖。而我们希望的是当吸顶view与其他view重叠时，吸顶view能显示在最上层，覆盖后面的view。当时我的解决方法是给吸顶view设置translationZ，让它的显示图层高于其他的view，这样它就不会被其他view覆盖了。这样做的确很好的解决了view重叠显示的问题，不过美中不足的是，translationZ是Android 5.0才支持的方法，5.0以下的手机无法使用这个方法设置view的显示图层高度。这使得ConsecutiveScrollerLayout的吸顶功能只能在Android 5.0以上的手机才能使用，这大大的限制了它的适用范围。如果我们的项目是支持5.0以下的，那么我们不可能让吸顶的功能只在5.0以上的手机有效，而不管5.0以下的手机。所以我需要找到一种方法，让5.0以下的手机也能正常使用吸顶的功能。

分析问题

5.0以下不能使用吸顶，是因为setTranslationZ()方法是5.0方法是5.0以后有的，那么Android是否提供了向下兼容的方法呢？于是我找到了ViewCompat.setTranslationZ()方法。

    public static void setTranslationZ(@NonNull View view, float translationZ) {
        if (VERSION.SDK_INT >= 21) {
            view.setTranslationZ(translationZ);
        }
    }

真是让人失望，它只是判断了以下版本，让5.0以下不至于报错，其实它什么都没做。既然连Android本身都没有对5.0以下做处理，显然让view的Z轴向下兼容是不大可能的。

回归问题本身，我们希望吸顶view显示在界面的最上层，不被其他view所覆盖。Android界面上显示的所有内容都是绘制在一张画布(Canvas)上面的，同一个区域，如果被绘制多次，先绘制的内容会被后绘制的内容覆盖。而view的绘制顺序是先添加的先绘制，后添加的后绘制，所以当view重叠时，后面的view会覆盖前面的view。只要保证吸顶的view在其他view之后绘制，吸顶view就会显示在其他view之上，不会被其他view覆盖。那么有没有方法能保证吸顶view最后绘制？最简单直接的方法当然是让吸顶view最后添加，但问题是view的添加顺序不仅会影响绘制顺序，同样也会影响view的排列和显示位置。而我们想要的是改变view的绘制顺序，不改变view的显示位置。所以这种方法显然也是不行的。有什么方法可以在不改变view的添加顺序的情况下，改变它的绘制顺序呢？我们知道布局在measure、layout和draw的过程中，都会遍历它的子view，分发测量、布局、绘制的流程。如果我们在布局draw之前修改子view的顺序，draw之后恢复，那么是否就保证了只改变view的绘制顺序。

解决方案 1.0

ViewGroup的子view保存在mChildren数组中。

private View[] mChildren;

由于它是private的，要获取和修改它，需要通过反射来执行。

// 获取mChildren
private View[] getChildren() {
    try {
        Class aClass = Class.forName("android.view.ViewGroup");
        Field field = aClass.getDeclaredField("mChildren");
        field.setAccessible(true); 
        Object resultValue = field.get(this);
        return (View[]) resultValue;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return null;
}
// 设置mChildren
private void setChildren(View[] children) {
    try {
        Class aClass = Class.forName("android.view.ViewGroup");
        Field field = aClass.getDeclaredField("mChildren");
        field.setAccessible(true); // 私有属性必须设置访问权限
        field.set(this, children);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

绘制前，修改view的排序，绘制后恢复。

// 临时变量,保存mChildren原数组
private View[] tempViews = null;

@Override
public void draw(Canvas canvas) {
   // 兼容5.0以下吸顶功能
   if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP
           && !getStickyChildren().isEmpty()) {
       tempViews = getChildren();
       if (tempViews != null) {
         // 修改mChildren
           setChildren(sortViews(tempViews.length));
       }
    }

    super.draw(canvas);

   // 兼容5.0以下吸顶功能
   if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP
           && !getStickyChildren().isEmpty() && tempViews != null) {
     // 恢复mChildren
       setChildren(tempViews);
   }
}

// 返回排序后的children数组
private View[] sortViews(int size) {
    View[] views = new View[size];
    int index = 0;
    int count = getChildCount();
    for (int i = 0; i < count; i++) {
        View child = getChildAt(i);
        // 普通view
        if (!isStickyChild(child)) {
            views[index] = child;
            index++;
        }
    }

    for (int i = 0; i < count; i++) {
        View child = getChildAt(i);
        // 吸顶view
        if (isStickyChild(child)) {
            views[index] = child;
            index++;
        }
    }
    return views;
}

修改好，运行测试一下，当view吸顶时，能正常显示在最上层，不会被下面的view覆盖了，好像问题已经完美解决了。可是当我点击界面上的控件时，新的问题出现了，我点击的view和响应的view不是同一个，事件的传递乱了。因为我们把view的绘制顺序改变了，所以我们实际看到的、操作的view，跟系统判断的可能不是同一个view了。显然这种解决方法引发了新的问题，是不可取的。

分析源码

既然通过修改mChildren的方法行不通，只能另寻方案。我尝试跟踪view的绘制源码，期待能有一些新思路。ViewGroup绘制子view的源码调用路径是：draw()–>dispatchDraw()。ViewGroup中的dispatchDraw()方法是绘制子view的关键代码，通过阅读源码，我发现了几句关键代码。

    @Override
    protected void dispatchDraw(Canvas canvas) {
        
				// step 1：获取预定义的排序列表
        final ArrayList<View> preorderedList = usingRenderNodeProperties
                ? null : buildOrderedChildList();
				
				// step 2：判断是否需要自定义排序
        final boolean customOrder = preorderedList == null && isChildrenDrawingOrderEnabled();
				
        for (int i = 0; i < childrenCount; i++) {
						// step 3：根据绘制顺序获取view下标
            final int childIndex = getAndVerifyPreorderedIndex(childrenCount, i, customOrder);
						// step 4：根据下标获取子view
            final View child = getAndVerifyPreorderedView(preorderedList, children, childIndex);
            if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE || child.getAnimation() != null) {
								// step 5：绘制子view
                more |= drawChild(canvas, child, drawingTime);
            }
        }
    }

第一步：获取预定义的排序列表。如果开启了硬件加速usingRenderNodeProperties为true，preorderedList为null。否则执行buildOrderedChildList()方法，这个方法大部分情况下也直接返回null，所以preorderedList一般都是null的。buildOrderedChildList()方法只有在没有设置硬件加速，并且子view设置了Z轴高度的情况下才不会返回null。我们知道，Android 4.0后，默认都是开启硬件加速的，而5.0前，是不支持view的Z轴的，所以只有在5.0后关闭硬件加速，并且设置了子view的Z轴，buildOrderedChildList()方法才不会返回null，这个方法就是处理这种情况的，而且它对view的排序处理跟我们下面分析的逻辑基本一样，所以这个方法我们可以忽略不看。
第二步：判断是否需要自定义排序。既然preorderedList为null，那么是否需要自定义排序的判断就是isChildrenDrawingOrderEnabled()方法，这个方法默认为false，只有设置为true，自定义的排序才生效，这是我们需要关注的第一个方法。
第三步：根据绘制顺序获取view下标。直接看代码：

    private int getAndVerifyPreorderedIndex(int childrenCount, int i, boolean customOrder) {
        final int childIndex;
        if (customOrder) {
          // 如果自定义排序，根据顺序获取view下标
            final int childIndex1 = getChildDrawingOrder(childrenCount, i);
            if (childIndex1 >= childrenCount) {
                throw new IndexOutOfBoundsException("getChildDrawingOrder() "
                        + "returned invalid index " + childIndex1
                        + " (child count is " + childrenCount + ")");
            }
            childIndex = childIndex1;
        } else {
          // 不是自定义排序，下标和顺序一致
            childIndex = i;
        }
        return childIndex;
    }

在这个方法里，如果不排序，返回的下标和顺序一样，所以默认绘制顺序就是view的添加顺序。如果需要排序，通过getChildDrawingOrder获取需要绘制的view的下标，绘制顺序由这个方法的返回值决定。

protected int getChildDrawingOrder(int childCount, int drawingPosition) {
    return drawingPosition;
}

可以看到，这个方法的返回值依然是顺序本身，所以它的默认绘制顺序也view的添加顺序。但是这个方法是protected，也就是说我们可以覆写这个方法，返回我们想要的index，改变view的绘制顺序。这是我们需要关注的第二个方法。

第四步：根据下标，调用getAndVerifyPreorderedView或者需要绘制的子view。

    private static View getAndVerifyPreorderedView(ArrayList<View> preorderedList, View[] children,
            int childIndex) {
        final View child;
        if (preorderedList != null) {
            child = preorderedList.get(childIndex);
            if (child == null) {
                throw new RuntimeException("Invalid preorderedList contained null child at index "
                        + childIndex);
            }
        } else {
            child = children[childIndex];
        }
        return child;
    }

这个方法很简单，就是根据下标或者view，如果有预定义排序，就从preorderedList中获取，否则就从children数组获取，children数组就是保存子view的数组，按添加顺序排列。

第五步：drawChild，就是调用child的draw方法绘制子view。

最终实现

现在我们知道，想要改变ViewGroup的子view绘制顺序，只有开启自定义排序，并且覆写getChildDrawingOrder方法就可以了。

在自定义ViewGroup的构造方法中调用:

// 开启自定义排序
setChildrenDrawingOrderEnabled(true);

预先处理view的排序

// 保存预先处理的排序
private final List<View> mViews = new ArrayList<>();

@Override
protected void onLayout(boolean changed, int l, int t, int r, int b) {
  
  //忽略其他的代码 
  
  	// 排序
    sortViews();
}

private void sortViews() {
    List<View> list = new ArrayList<>();
    int count = getChildCount();
    for (int i = 0; i < count; i++) {
        View child = getChildAt(i);
      // 添加非吸顶view
        if (!isStickyChild(child)) {
            list.add(child);
        }
    }

    for (int i = 0; i < count; i++) {
        View child = getChildAt(i);
      // 添加吸顶view
        if (isStickyChild(child)) {
            list.add(child);
        }
    }
    mViews.clear();
    mViews.addAll(list);
}

这里要说明一下，因为getChildDrawingOrder方法是根据绘制的顺序drawingPosition返回需要绘制的子view下标，所以我们需要提前知道最终绘制的顺序，才能根据drawingPosition找到相应的index，所以需要提前对view排序好。而把排序的时机选择在onLayout，是因为在我的需求里，子view的添加、移除、和setLayoutParams都有可能改变排序，而这些操作恰好都会重新调用父布局的onLayout方法。最后排序的方式是先添加非吸顶view，后添加吸顶view，这样保证了吸顶view在最后绘制，view重叠时也就不会被其他view覆盖了。

最后覆写getChildDrawingOrder

@Override
protected int getChildDrawingOrder(int childCount, int drawingPosition) {
    if (mViews.size() > drawingPosition) {
      // 根据drawingPosition找到子view，返回子view在ViewGroup中的index
        return indexOfChild(mViews.get(drawingPosition));
    }
    return super.getChildDrawingOrder(childCount, drawingPosition);
}

至此，我们的功能就实现好了。

写在最后

这篇文章的重点就一个getChildDrawingOrder方法，但是如果我只是想告诉大家有这么一个方法，那么完全没有必要写这篇文章。我写这篇文章的主要目的是记录这个问题的解决过程，中间会踩坑，也会有意外收获。网上有朋友吐槽，面试时面试官会问：“你遇到过哪些难题，最后时怎么解决的”。很多人都不知道怎么回答，因为所有已经被解决的问题都不是问题，而没有被解决的问题你是不会提起的。就拿我的这个问题来说，如果我早知道有这么个方法，这还是问题吗？我们往往在解决问题后就忽略了问题的解决过程，甚至是问题本身，决定原来这个问题如此简单。却不知，这个过程对我们才是最有意义和收获的。

最后说一句：从源码中寻找答案，永远是解决问题的最有效方法。