Android 你可能需要的NiceDialog
*本篇文章已授权微信公众号 guolin_blog (郭霖)独家发布
DialogFragment是Android3.0引入的,也是官方推荐来创建对话框的,兼具dialog以及Fragment的特性。接下来在DialogFragment的基础上实现我们的NiceDialog,我们实现的dialog要能够简单的使用,也要易扩展,同时支持BottomDialog,让dialog的使用更方便。
基本原理
首先要使用DialogFragment,必须实现DialogFragment的如下两个方法之一
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
return super.onCreateView(inflater, container, savedInstanceState);
}
@Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
return super.onCreateDialog(savedInstanceState);
}
如果实现onCreateDialog()
方法,则需要在其中利用AlertDialog或Dialog创建出DialogFragment,而这里我们实现onCreateView()
方法来创建DialogFragment,先创建类BaseNiceDialog
继承DialogFragment
:
public abstract class BaseNiceDialog extends DialogFragment {
public abstract int intLayoutId();
public abstract void convertView(ViewHolder holder, BaseNiceDialog dialog);
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setStyle(DialogFragment.STYLE_NO_TITLE, R.style.NiceDialog);
}
@Nullable
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
View view = inflater.inflate(intLayoutId(), container, false);
convertView(ViewHolder.create(view), this);
return view;
}
其中intLayoutId()
方法用来设置dialog的布局文件,convertView()
方法提供了ViewHolder
和BaseNiceDialog
两个类型参数以方便相关UI操作和dialog的dismiss。其中ViewHolder
是一个辅助view初始化、绑定事件等操作的工具类,具体见源码。
这样就完成了第一步,但是呢,此时如果用BaseNiceDialog来展示一个对话框,你会发现效果很不理想,因为默认的对话框有标题、背景等,我们需要将其去掉,可以通过重写DialogFragment
的onCreate()方法
,来设置相关的Style完成:
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setStyle(DialogFragment.STYLE_NO_TITLE, R.style.NiceDialog);
}
到此,通过继承BaseNiceDialog
并实现intLayoutId()
、convertView()
就可以正常使用了,但是距离我们好用的目标还差太远,为此我们提供了如下方法:
-
setDimAmount(float dimAmount)
调节DialogFragment
灰色背景深浅 -
setShowBottom(boolean showBottom)
是否在底部显示(原来就是一个属性的事儿) -
setWidth(int width)
宽度 -
setHeight(int height)
高度 -
setMargin(int margin)
距离屏幕左右的margin -
setAnimStyle(@StyleRes int animStyle)
进入退出动画 -
setOutCancel(boolean outCancel)
触摸外部是否取消
都是一些set方法,很简单。主要来看如何配置这样属性:
private void initParams() {
Window window = getDialog().getWindow();
if (window != null) {
//设置dialog进入、退出的动画
window.setWindowAnimations(animStyle);
WindowManager.LayoutParams lp = window.getAttributes();
//调节灰色背景深浅[0-1],默认0.5f
lp.dimAmount = dimAmount;
//是否在底部显示
if (showBottom) {
lp.gravity = Gravity.BOTTOM;
}
//设置dialog宽度
if (width == 0) {
lp.width = Utils.getScreenWidth(getContext()) - 2 * Utils.dp2px(getContext(), margin);
} else {
lp.width = Utils.dp2px(getContext(), width);
}
//设置dialog高度
if (height == 0) {
lp.height = WindowManager.LayoutParams.WRAP_CONTENT;
} else {
lp.height = Utils.dp2px(getContext(), height);
}
window.setAttributes(lp);
}
//是否触摸外部取消
setCancelable(outCancel);
}
主要就是通过操作Window
类以及其LayoutParams
来完成的,要让dialog在底部显示,只需要设置lp.gravity = Gravity.BOTTOM
(当然在左边、右边、顶部显示也就不是问题了,虽然需求很诡异......),其中的animStyle
是一个包含dialog进入、退出动画的Style资源,需要自行定义配置,可以参考如下形式:
<style name="EnterExitAnimation" parent="android:Animation">
<item name="android:windowEnterAnimation">@anim/enter_anim</item>
<item name="android:windowExitAnimation">@anim/exit_anim</item>
</style>
这样就可以根据需求定制dialog的进入、退出动画了。
initParams()
方法在DialogFragment
的onStart()
回调中调用,到此我们的BaseNiceDialog
核心点就介绍完毕了,很是蛮简单的。现在就可以通过如下方式来使用了:
public class MyDialog extends BaseNiceDialog {
@Override
public int intLayoutId() {
return R.layout.dialog;
}
@Override
public void convertView(ViewHolder holder, final BaseNiceDialog dialog) {
//相关View操作
}
}
new MyDialog()
.setMargin(60)
.setOutCancel(false)
.show(getSupportFragmentManager());
这样虽然方便了扩展,但是没有扩展需求的话,用起来确实有些麻烦,所以需要继续完善,可以定义一个NiceDialog
类继承BaseNiceDialog
:
public class NiceDialog extends BaseNiceDialog {
private ViewConvertListener convertListener;
public static NiceDialog init() {
return new NiceDialog();
}
@Override
public int intLayoutId() {
return layoutId;
}
@Override
public void convertView(ViewHolder holder, BaseNiceDialog dialog) {
if (convertListener != null) {
convertListener.convertView(holder, dialog);
}
}
public NiceDialog setLayoutId(@LayoutRes int layoutId) {
this.layoutId = layoutId;
return this;
}
public NiceDialog setConvertListener(ViewConvertListener convertListener) {
this.convertListener = convertListener;
return this;
}
}
代码很简单,就是重新BaseNiceDialog
的抽象方法,并提供了一个ViewConvertListener
接口:
public interface ViewConvertListener {
void convertView(ViewHolder holder, BaseNiceDialog dialog);
}
这样就能方便的进行UI操作以及控制dialog了。同时也提供了设置dialog布局文件以及绑定接口的方法,之后如果没有扩展BaseNiceDialog
的需求,就可以愉快的通过NiceDialog
类来实现想要的dialog,例如:
NiceDialog.init()
.setLayoutId(R.layout.dialog)
.setConvertListener(new ViewConvertListener() {
@Override
public void convertView(ViewHolder holder, final BaseNiceDialog dialog) {
//View相关操作
}
})
.setDimAmount(0.3f)
.setShowBottom(true)
.setAnimStyle(R.style.EnterExitAnimation)
.show(getSupportFragmentManager());
但是呢,还有问题,如果在dialog展示情况下旋转屏幕,会直接崩溃掉,因为这个过程中dialog会销毁掉导致布局文件id以及其它配置参数丢失,重新创建时因数据缺失而出现问题,所以就需要在屏幕旋转等可能导致dialog销毁重建的场景发生时,先保存需要的数据,然后在重建时恢复需要的数据,这样就能避免问题了。
具体是做法是在BaseNiceDialog
类中重写onSaveInstanceState(Bundle outState)
方法来保存数据:
@Override
public void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
outState.putInt(MARGIN, margin);
outState.putInt(WIDTH, width);
outState.putInt(HEIGHT, height);
outState.putFloat(DIM, dimAmount);
outState.putBoolean(BOTTOM, showBottom);
outState.putBoolean(CANCEL, outCancel);
outState.putInt(ANIM, animStyle);
outState.putInt(LAYOUT, layoutId);
}
并在onCreate(@Nullable Bundle savedInstanceState)
方法中恢复数据:
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if (savedInstanceState != null) {
margin = savedInstanceState.getInt(MARGIN);
width = savedInstanceState.getInt(WIDTH);
height = savedInstanceState.getInt(HEIGHT);
dimAmount = savedInstanceState.getFloat(DIM);
showBottom = savedInstanceState.getBoolean(BOTTOM);
outCancel = savedInstanceState.getBoolean(CANCEL);
animStyle = savedInstanceState.getInt(ANIM);
layoutId = savedInstanceState.getInt(LAYOUT);
}
}
这样就dialog就能正常显示,不会出现崩溃的问题了。
但是问题还没结束,由于我们在NiceDialog
类中有一个ViewConvertListener
,如果用NiceDialog
创建对话框,在屏幕发生旋转时会导致设置的ViewConvertListener
实例被释放掉,所以之前给View绑定的点击事件、View的属性配置就会失效,恢复到初始状态,所以就需要保存、恢复ViewConvertListener
的实例,所以需要修改ViewConvertListener
的实,现使其序列化,这样就能通过Bundle来保存了
public abstract class ViewConvertListener implements Parcelable {
protected abstract void convertView(ViewHolder holder, BaseNiceDialog dialog);
//省略若干代码
}
之前是通过Serializable
实现序列化,但是当dialog在前台时,如果按home键使app退回后台则会发生crash,所以通过Parcelable
实现序列化。
接下里就是在NiceDialog里做保存与恢复操作:
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if (savedInstanceState != null) {
convertListener = savedInstanceState.getParcelable("listener");
}
}
@Override
public void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
outState.putParcelable("listener", convertListener);
}
这样问题就解决了。
到这里NiceDialog
的原理就介绍完了,是不是很简单呢,一般情况我们通过NiceDialog
类就可以完成dialog的创建,如果你有更多的需求,例如给dialog传参则可以扩展BaseNiceDialog
来实现。
更多的细节和用法示例可参考Github源码:NiceDialog
最后希望对你有所帮助吧!!!