Android 自定义Toast:轻松实现深度可定制化的Toast

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/a553181867/article/details/52254624

前言

用过系统自带的Toast的都知道，android自带的吐司比较难看，而且样式单一，最重要的是不能自由选择动画，这样的吐司很难用在一个精美的应用上，因此，我们来自行实现一个自定义的Toast：XToast，来取代系统自带的Toast。当然了，以下实现的自定义Toast是与系统Toast有区别的，下面会提到。

使用方式&预览

我们来看看怎么使用XToast，通过提供的一系列的set方法，可自行设置XToast的各种属性、样式等:

XToast.create(MainActivity.this)
        .setText("Testing:This is a XToast....")
        .setAnimation(AnimationUtils.ANIMATION_DRAWER) //抽屉式效果
        .setDuration(XToast.XTOAST_SHORT)
        .setOnDisappearListener(new XToast.OnDisappearListener() {
            @Override
            public void onDisappear(XToast xToast) {
                Log.d("cylog","The XToast has disappeared..");
            }
        }).show();

接着这是实现的效果：
首先这是一个抽屉式效果的Toast：

这是一个缩放效果的Toast:

原理简述

其实实现原理很简单，是通过添加View来实现的，因为Toast实际上就是一个View，通过控制、修改View的不同属性，然后通过不同的动画效果使其更加生动绚丽地展现出来。

实现

首先，我们新建名为XToast.java文件，这也是我们的主要的类，

public class XToast  {

    private Context mContext;
    private View mView;
    private ViewGroup mViewGroup;
    private ViewGroup mViewRoot;
    private GradientDrawable mToastBackgound;
    private LayoutInflater mInflater;
    private TextView mTextView;
    private String message;
    private AnimatorSet mShowAnimatorSet;
    private AnimatorSet mHideAnimatorSet;
    private int mShowAnimationType;
    private int mHideAnimationType;
    private int mDuration;
    private int mBackgroundColor;
    private OnDisappearListener mOnDisappearListener;

    public static final int XTOAST_LONG = 3500;
    public static final int XTOAST_SHORT = 2000;

    public interface OnDisappearListener{
        void onDisappear(XToast xToast);
    }

    public XToast(Context context)
    {
        this.mContext = context;
        this.mInflater = LayoutInflater.from(context);
    }

    public XToast(Context context,String message)
    {
        this.mContext = context;
        this.message = message;
        this.mInflater = LayoutInflater.from(context);
    }

    public static XToast create(Context context){
        return new XToast(context);
    }

    public static XToast create(Context context,String message){
        return new XToast(context,message);
    }

    //省略一系列的set和get方法
    //...
    public boolean isShowing() {
        return mView != null && mView.isShown();
    }

    private void initViews() {
        mViewRoot = (ViewGroup) ((Activity)mContext).findViewById(android.R.id.content);
        mViewGroup = new LinearLayout(mContext);
        FrameLayout.LayoutParams mViewGroupParams = new FrameLayout.LayoutParams(FrameLayout.LayoutParams.WRAP_CONTENT, FrameLayout.LayoutParams.WRAP_CONTENT);
        mViewGroupParams.gravity = Gravity.BOTTOM | Gravity.CENTER;
        mViewGroupParams.bottomMargin = 200;
        mViewGroup.setLayoutParams(mViewGroupParams);
        mViewRoot.addView(mViewGroup);

        //如果用户没有使用自己的View，那么使用默认的mView
        if(mView == null){
            mView = mInflater.inflate(R.layout.xtoast_normal,mViewGroup,false);
            mToastBackgound = (GradientDrawable) mView.getBackground();
            mTextView = (TextView) mView.findViewById(R.id.message);
            mTextView.setText(message);
            if(mBackgroundColor != 0){
                mToastBackgound.setColor(mBackgroundColor);
            }
        }

        //对mView的大小进行测量
        int widthMeasureSpec = View.MeasureSpec.makeMeasureSpec((1<<30) -1, View.MeasureSpec.AT_MOST);
        int heightMeasureSpec = View.MeasureSpec.makeMeasureSpec((1<<30) -1,View.MeasureSpec.AT_MOST);
        mView.measure(widthMeasureSpec,heightMeasureSpec);

    }

    public void show(){

        //准备工作
        initViews();
        if(this.mShowAnimationType == 0)    
          this.mShowAnimatorSet = AnimationUtils.getShowAnimation(this,AnimationUtils.ANIMATION_DEFAULT);
        else    
          this.mShowAnimatorSet = AnimationUtils.getShowAnimation(this,mShowAnimationType);
        if(this.mHideAnimationType == 0)    
          this.mHideAnimatorSet = AnimationUtils.getHideAnimation(this, AnimationUtils.ANIMATION_DEFAULT);
        else    
          this.mHideAnimatorSet = AnimationUtils.getHideAnimation(this,mHideAnimationType);

        if(mDuration == 0)
            mDuration = XTOAST_SHORT;

        XToastHandler xToastHandler = XToastHandler.getInstance();
        xToastHandler.add(this);
    }
}

我们主要关注initViews()方法，在方法内部，我们首先通过android.R.id.content来获得一个ViewGroup的实例，这个是DecorView内部的content布局，关于DecorView的内容读者可参考我之前的文章。这里简单说明一下：DecorView是我们Activity的根布局，是Activity初始化后生成的，而我们通过setContentView()方法添加的布局会添加到DecorView之内，而上面代码我们通过findViewById(android.R.id.content)获得了DecorView的一个子元素(名为content的布局)，在后面，我们会把相应的View都添加到这个布局里面。我们继续往下看：接着新建了一个LinearLayout布局，展现消息的View就是添加到该LinearLayout布局之内的，然后把LinearLayout添加到DecorView中，换句话来说：展现消息的View外面包裹了一层LinearLayout。但是，为什么要包裹一层LinearLayout呢？为什么不直接把View添加到DecorView呢？其实，这样做的目的是为了实现抽屉式的动画效果。我们只需要对mView的translationY属性进行操作就能轻松实现抽屉式效果了，这样非常方便。

我们接着看show()方法，主要是进行一些准备工作，比如对动画效果的设置、消息时长的设置等，接着我们可以看到用了XToastHandler这个类，那么我们看看这个XToastHandler.java

public class XToastHandler extends Handler {
    private static XToastHandler mToastHandler;
    private final Queue<XToast> mQueue;

    private final static int SHOW_TOAST = 0x123;
    private final static int HIDE_TOAST = 0x456;
    private final static int SHOWNEXT_TOAST = 0X789;

    private XToastHandler()
    {
        mQueue = new LinkedList<>();
    }

    public synchronized static XToastHandler getInstance()
    {
        if(mToastHandler != null)
            return mToastHandler;
        else{
            mToastHandler = new XToastHandler();
            return mToastHandler;
        }
    }

    /**
     *  该方法把XToast添加到消息队列中
     * @param xToast
     */
    public void add(XToast xToast)
    {
        mQueue.offer(xToast);
        showNextToast();
    }

    public void showNextToast()
    {
        if(mQueue.isEmpty()) return;
        //获取队列头部的XToast
        XToast xToast = mQueue.peek();
        if(!xToast.isShowing()){
            Message message = Message.obtain();
            message.what = SHOW_TOAST;
            message.obj = xToast;
            sendMessage(message);
        }
    }

    @Override
    public void handleMessage(Message msg) {
        XToast xToast = (XToast) msg.obj;
        switch (msg.what)
        {
            case SHOW_TOAST:
                showToast(xToast);
                break;

            case HIDE_TOAST:
                hideToast(xToast);
                break;

            case SHOWNEXT_TOAST:
                showNextToast();
                break;
        }
    }

    private void hideToast(final XToast xToast) {
        AnimatorSet set = xToast.getHideAnimatorSet();
        set.addListener(new Animator.AnimatorListener() {
            @Override
            public void onAnimationStart(Animator animation) {

            }

            @Override
            public void onAnimationEnd(Animator animation) {
                //如果动画结束了，移除队列头部元素以及从界面中移除mView
                xToast.getViewGroup().removeView(xToast.getView());
                xToast.getOnDisappearListener().onDisappear(xToast);
                mQueue.poll();
                sendEmptyMessage(SHOWNEXT_TOAST);
            }

            @Override
            public void onAnimationCancel(Animator animation) {

            }

            @Override
            public void onAnimationRepeat(Animator animation) {

            }
        });
        set.start();
    }

    private void showToast(XToast xToast) {

        //如果当前有XToast正在展示，直接返回
        if(xToast.isShowing()) return;
        //把mView添加到界面中，实现Toast效果
        xToast.getViewGroup().addView(xToast.getView());
        //获取动画效果
        AnimatorSet set = xToast.getShowAnimatorSet();
        set.start();

        Message message = Message.obtain();
        message.what = HIDE_TOAST;
        message.obj = xToast;
        sendMessageDelayed(message,xToast.getDuration());
    }
}

这里把XToastHandler设计成单例模式，目的是为了维护同一个XToast的消息队列。实现过程也非常简单，通过新建一个LinkedList来储存需要展现的Toast，该LinkedList是一个队列，当一个消息展示完毕后，我们会把该消息移除，下一个消息才能继续显示，这也与系统的Toast相类似，同一段时间内只会显示一条Toast。

最后我们再来看看AnimationUtils这个类，该类储存了几种不同的动画效果：

public class AnimationUtils {

    public static final int ANIMATION_DEFAULT = 0X000;
    public static final int ANIMATION_DRAWER = 0x001;
    public static final int ANIMATION_SCALE = 0x002;

    public static AnimatorSet getShowAnimation(XToast xToast,int animationType){
        switch (animationType){
            case ANIMATION_DRAWER:
                AnimatorSet drawerSet = new AnimatorSet();
                drawerSet.playTogether(
                        ObjectAnimator.ofFloat(xToast.getView(), "translationY", -xToast.getView().getMeasuredHeight(), 0),
                        ObjectAnimator.ofFloat(xToast.getView(), "alpha", 0, 1)
                );
                drawerSet.setDuration(500);
                return drawerSet;

            case ANIMATION_SCALE:
                AnimatorSet scaleSet = new AnimatorSet();
                scaleSet.playTogether(
                        ObjectAnimator.ofFloat(xToast.getView(), "scaleX", 0, 1),
                        ObjectAnimator.ofFloat(xToast.getView(), "scaleY", 0, 1)
                );
                scaleSet.setDuration(500);
                return scaleSet;

            default:
                AnimatorSet defaultSet = new AnimatorSet();
                defaultSet.play(ObjectAnimator.ofFloat(xToast.getView(), "alpha", 0, 1));
                defaultSet.setDuration(500);
                return defaultSet;
        }
    }

    //省略Hide动画...
    //...

}

可见，实现方式也比较简单，就是直接对mView的某个属性进行属性动画，比如抽屉式效果的话，我们直接操作它的translationY属性，那么它在它的父布局（上面提到的LinearLayout）的位置就会得到改变，也就实现了抽屉效果。假如，这里mView没有包裹一层布局的话，而是直接添加到DecorView中，那么直接操作translationY属性则得不到抽屉式效果，这个读者可自行验证。

那么到目前为止，该XToast也介绍得差不多了。最后再谈谈它的实现与系统Toast有什么不同之处，其实XToast是依赖于Activity而存在的，因为是把mView添加到了DecorView中，如果没有Activity则无法使用XToast，这也是不足之处，而系统Toast是独立的一个窗口，不依赖于任何组件。

最后，贴上该XToast的GitHub地址：https://github.com/chenyuAndroid/XToast ，直接使用library内的XToast即可。欢迎大家的star or fork，笔者也会继续完善XToast的。谢谢大家的阅读。