Android 7.0 PopupWindow的一个展示Bug

起因与Bug详情

前段时间有反馈过来说,在Android7.0中,PopupWindow的展示位置出了问题(最开始以为没弹出来,后来发现是位置错了),通过查谷看歌源搜码索到了可能的情况和一些文章.

但找到的文章对于问题的表述不太完整,还有一些文章根本就是搞错了原因(大量文章说位置错误是由于PopupWindow的宽高设置的太大了…醉了),后来结合源码和实际的Bug情况看到了具体的详细原因.

这个Bug的具体情况是:在使用PopupWindow调用showAtLocation方法showAsDropDown方法和update方法时,如果传入的Gravity参数不为Gravity.START|Gravity.TOP则Gravity会被设置为Gravity.START|Gravity.TOP,PopupWindow的位置即发生了改变,可以通过反射来改掉这个Bug,下面是这个Bug的详细解法

Bug原因

具体问题发生在computeGravity方法

private int computeGravity() {
    int gravity = Gravity.START | Gravity.TOP;
    if (mClipToScreen || mClippingEnabled) {
        gravity |= Gravity.DISPLAY_CLIP_VERTICAL;
    }
    return gravity;
}

可以看到返回的gravity值,在方法的一开始就被强制设置为了Gravity.START|Gravity.TOP,所以我们传入的参数并没有起到任何作用,而这个Bug只有API版本24,Android 7.0的SDK是这样,无责任猜想可能是Android系统开发的某位大哥,在写分屏相关的UI代码的时候,出于测试方便或者什么的,直接将这里写死了╮(╯_╰)╭
不过我们可以通过反射来改成正确的代码.

如何解决

首先查看一下都哪里用到了这个computeGravity,然后通过搜索看到,分别是1418行的createPopupLayoutParams方法里出现了

p.gravity = computeGravity();

以及在1096行和2081行的两个update方法内部出现了同样的一行代码

final int newGravity = computeGravity();

由于懒在实际使用中并没有通过update来更新PopupWindow的位置,并且也只是用了showAtLocation,所以暂没有对update和showAsDropDown进行反射来重写方法,只重写了showAtLocation,理论上讲,createPopupLayoutParams同时被showAtLocation和showAsDropDown方法用到了,且这是一个私有方法,所以需要分别重写showAtLocation和showAsDropDown方法以及两个update方法

这里提供出一个修改方案,import和package已去掉,如果要使用请自行添加,这里特别说明一下TransitionManager.endTransitions(mDecorView);,这行代码在IDE中很可能会报错标红,原因是使用了高版本API (Android M SDK 23)而没有进行版本判断,但实际上可以不用理会,因为目前这个Bug只有7.0这一个版本出现了,所以我在方法的最开始进行了当前Android版本的判断,如果不是版本号24的7.0版本,直接执行super.showAtLocation调用原PopupWindow的方法,之后return掉了这个方法,毕竟反射也是会带来额外一丢丢的性能和内存占用.如果不想让他报红可以选择改成if else的形式.

public class NougatPopupWindow extends PopupWindow {
    public NougatPopupWindow(View contentView, int width, int height, boolean focusable) {
        super(contentView, width, height, focusable);
    }
    @Override
    public void showAtLocation(View parent, int gravity, int x, int y) {
        if (Build.VERSION.SDK_INT != 24) {
            super.showAtLocation(parent, gravity, x, y);
            return;
        }
        Object obj = getParam("mContentView");
        View mContentView = (View) obj;
        if (isShowing() || mContentView == null) {
            return;
        }
        obj = getParam("mDecorView");
        ViewGroup mDecorView = (ViewGroup) obj;
        //RequireAPI M but if SDK_INT != N,super.showAtLocation and returned;
        TransitionManager.endTransitions(mDecorView);
        execMethod("detachFromAnchor", new Class[]{}, new Object[]{});
        setParam("mIsShowing", true);
        setParam("mIsDropdown", false);
        obj = execMethod("createPopupLayoutParams", new Class[]{IBinder.class}, new Object[]{parent.getWindowToken()});
        final WindowManager.LayoutParams p = (WindowManager.LayoutParams) obj;
        p.gravity = computeGravity(gravity);
        execMethod("preparePopup",new Class[]{WindowManager.LayoutParams.class},new Object[]{p});
        if (gravity != Gravity.NO_GRAVITY) {
            p.gravity = gravity;
        }
        p.x = x;
        p.y = y;
        execMethod("invokePopup",new Class[]{WindowManager.LayoutParams.class},new Object[]{p});
    }
    private Object getParam(String paramName) {
        if (TextUtils.isEmpty(paramName)) {
            return null;
        }
        try {
            Field field = PopupWindow.class.getDeclaredField(paramName);
            field.setAccessible(true);
            return field.get(this);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
    private void setParam(String paramName, Object obj) {
        if (TextUtils.isEmpty(paramName)) {
            return;
        }
        try {
            Field field = PopupWindow.class.getDeclaredField(paramName);
            field.setAccessible(true);
            field.set(this, obj);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    private Object execMethod(String methodName, Class[] cls, Object[] args) {
        if (TextUtils.isEmpty(methodName)) {
            return null;
        }
        try {
            Method method = getMethod(PopupWindow.class, methodName, cls);
            method.setAccessible(true);
            return method.invoke(this, args);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
    private Method getMethod(Class clazz, String methodName,
                             final Class[] classes) throws NoSuchMethodException {
        Method method = null;
        try {
            method = clazz.getDeclaredMethod(methodName, classes);
        } catch (NoSuchMethodException e) {
            try {
                method = clazz.getMethod(methodName, classes);
            } catch (NoSuchMethodException ex) {
                if (clazz.getSuperclass() == null) {
                    return method;
                } else {
                    method = getMethod(clazz.getSuperclass(), methodName,
                            classes);
                }
            }
        }
        return method;
    }
    private int computeGravity(int mGravity) {
        setParam("mGravity", mGravity);
        int gravity = mGravity == Gravity.NO_GRAVITY ? Gravity.START | Gravity.TOP : mGravity;
        Object obj = getParam("mIsDropdown");
        boolean mIsDropdown = (boolean) obj;
        obj = getParam("mClipToScreen");
        boolean mClipToScreen = (boolean) obj;
        obj = getParam("mClippingEnabled");
        boolean mClippingEnabled = (boolean) obj;
        if (mIsDropdown && (mClipToScreen || mClippingEnabled)) {
            gravity |= Gravity.DISPLAY_CLIP_VERTICAL;
        }
        return gravity;
    }
}

文中部分内容参考了作者Kinva的文章,链接:http://www.jianshu.com/p/0df10893bf5b