设置Background导致Padding无效问题追溯
1, 问题描述
很多同学可能都遇到过这个问题:
明明在布局文件中设置了View的padding, 然后程序中动态设置了背景, 运行后发现padding不对.
如下代码:
<TextView
android:id="@+id/text_view2"
android:layout_width="200dp"
android:layout_height="100dp"
android:layout_marginTop="20dp"
android:layout_centerHorizontal="true"
android:layout_below="@id/text_view1"
android:background="@android:color/holo_green_dark"
android:padding="20dp"
android:text="Using the Hello World guide, you’ll create a repository, start a branch,
write comments, and open a pull request"
/>
mTextView2.setBackgroundResource(R.drawable.patch9_bg);
明明加了20dp的padding值, 实际效果却是这样的:
problem
2, 问题原因
这是为什么呢, 我们通过一个简单的Demo程序来验证了下.
如标题所言, 问题就出在, 我们在代码中动态设置该View的Background.
mTextView2.setBackgroundResource(R.drawable.patch9_bg);
删除该代码, 我们再看效果:
no_problem
3, 解决方案
知道了问题原因, 其实已经就解决了一半了, 解决办法无外乎就是在调用setBackgroundResource之后再设置一遍padding值.
可参考http://stackoverflow.com/questions/10095196/whered-padding-go-when-setting-background-drawable
4, 探个究竟
正所谓知其然, 知其所以然. 本文的目的也并不是说就提出这个问题及其解决方案, 更多的是想更深层次的取了解这个问题的Root Cause. 从中了解下Google开发人员为什么会埋下这么一个"坑", 是否是有其他考量.
我们来看下setBackgroundResource做了什么:
先来看下View.java节选代码(请注意中文注释的关键代码):
public void setBackgroundResource(@DrawableRes int resid) {
if (resid != 0 && resid == mBackgroundResource) {
return;
}
Drawable d = null;
if (resid != 0) {
// 1, 通过Resource Id获取Drawable对象.
d = mContext.getDrawable(resid);
}
setBackground(d);
mBackgroundResource = resid;
}
public void setBackground(Drawable background) {
setBackgroundDrawable(background);
}
public void setBackgroundDrawable(Drawable background) {
...
if (background != null) {
// 2, 取一个存放padding值的Rect对象
// Rect是一个持有四个值(left, top, right bottom)的矩形对象.
Rect padding = sThreadLocal.get();
...
// 3, 判断用来设置background的Drawable对象是否有padding值.
// 注意, 这里将存放padding值Rect传入了.
if (background.getPadding(padding)) {
// 4, 如果background有padding值, 则改变该View的padding属性.
resetResolvedPaddingInternal();
switch (background.getLayoutDirection()) {
case LAYOUT_DIRECTION_RTL:
mUserPaddingLeftInitial = padding.right;
mUserPaddingRightInitial = padding.left;
internalSetPadding(padding.right, padding.top, padding.left, padding.bottom);
break;
case LAYOUT_DIRECTION_LTR:
default:
mUserPaddingLeftInitial = padding.left;
mUserPaddingRightInitial = padding.right;
internalSetPadding(padding.left, padding.top, padding.right, padding.bottom);
}
mLeftPaddingDefined = false;
mRightPaddingDefined = false;
}
...
} else {
/* Remove the background */
mBackground = null;
...
}
...
invalidate(true);
}
我们发现, 第3步background.getPadding(padding)是一个关键点, 来看下Drawable的此方法实现:
Drawable.java节选代码:
public abstract class Drawable {
...
/**
* Return in padding the insets suggested by this Drawable for placing
* content inside the drawable's bounds. Positive values move toward the
* center of the Drawable (set Rect.inset).
*
* @return true if this drawable actually has a padding, else false. When false is returned,
* the padding is always set to 0.
*/
public boolean getPadding(@NonNull Rect padding) {
padding.set(0, 0, 0, 0);
return false;
}
...
}
根据注释和代码, 我们发现:
- 默认返回false.
- 传入的Rect会被设值.
- Drawable是一个抽象类, 那么我们这里setBackgroundResource时通过resId生成的Drawable到底是那个Drawable呢? 它的getPadding方法会做什么处理呢?
让我们看下Drawable的子类:
Drawable classes
真的是太多, 简直无从分析.
既然我们的background是通过resource id的方式设置的, 我们再来看下Drawable Resource有哪些吧:
官方文档
以下图片节选比较常用的几种:
drawable resources
一般来说, 我们用到的最多的就是png, .9, state selector图片作为resource了.
我们来分别看下BitmapDrawable, NinePatchDrawable, StateListDrawable的getPadding实现:
可以发现, BitmapDrawable和StateListDrawable都没有重写该方法.
NinePatchDrawable的getPadding重写实现:
@Override
public boolean getPadding(Rect padding) {
final Rect scaledPadding = mPadding;
if (scaledPadding != null) {
if (needsMirroring()) {
padding.set(scaledPadding.right, scaledPadding.top,
scaledPadding.left, scaledPadding.bottom);
} else {
padding.set(scaledPadding);
}
// 当此NinePatchDrawable的mPadding的任意一方有值, 则返回true.
// 意味着会改变View的当前padding情况.
return (padding.left | padding.top | padding.right | padding.bottom) != 0;
}
return false;
}
5, 分析验证
如第四章节的分析, 我们大体可以得出结论:
- 只有设置background是.9图片时才有可能会改变原来的padding, 导致padding无效.
- 为什么说是有可能呢? 因为根据代码, 当我们的.9图片自身四边都不带padding的时候, 返回的也是false, 不会改变原来的padding值.
以上结论针对我们调研的几种常用的Drawable实现, 如有特殊的Drawable请查看其源码的getPadding实现.
那么我们来验证下我们的分析, 做一个Demo, 有三个View, 第一个使用png的普通背景, 第二个使用有padding的.9图片, 第三个使用无padding的.9图片.
mTextView1.setBackgroundResource(R.drawable.bg);
mTextView2.setBackgroundResource(R.drawable.patch9_bg);
mTextView3.setBackgroundResource(R.drawable.patch9_bg_no_padding);
效果:
compare
可以看到, 这个例子完全验证了我们的分析.
当设置Background图片资源是有padding的.9图片时才会出现导致原来的设置的padding无效的问题.
顺带提下, 何为有padding的.9图片, 如下图:
nine patch padding
我们在做.9图时, 左上是patch域(即交叉点放大适配), 下方, 右方是内容域, 如果没有全部画上, 留下的部分是不能放内容的, 就形成了Padding.
6, 结语
这个问题, 可能会让很多人苦恼, 比较难以定位, 可能只是代码调用的顺序问题.
也可以说并不困难, 因为知道其根本原因后, 规避解决起来也的确很简单.
在此, 我更多的是想借这个问题来传达一种做技术的"知其然, 知其所以然"的探索思想. 共勉之.