Toast 源码学习

我们使用Toast的时候,通常都是这样

Toast.makeText(this, "Hello world", Toast.LENGTH_SHORT).show()

首先我们从Toast的静态方法makeText开始

public static Toast makeText(Context context, CharSequence text, 
                             @Duration int duration) {
    return makeText(context, null, text, duration);
}
public static Toast makeText(Context context, Looper looper,
        @NonNull CharSequence text, @Duration int duration) {
    //构建Toast实例
    Toast result = new Toast(context, looper);

    LayoutInflater inflate = (LayoutInflater)
                context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
    //获取默认的布局文件,就是要展示的View
    View v = inflate.inflate(com.android.internal.R.layout.transient_notification, null);
    TextView tv = (TextView)v.findViewById(com.android.internal.R.id.message);
    tv.setText(text);
    //为Toast的mNextView属性赋值
    result.mNextView = v;
    result.mDuration = duration;
    //返回创建的Toast实例
    return result;
}

Toast的构造函数

public Toast(Context context, @Nullable Looper looper) {
    mContext = context;
    //1. mTN是一个本地对象,用于进程间通信
    mTN = new TN(context.getPackageName(), looper);
    mTN.mY = context.getResources().getDimensionPixelSize(
                com.android.internal.R.dimen.toast_y_offset);
    mTN.mGravity = context.getResources().getInteger(
                com.android.internal.R.integer.config_toastDefaultGravity);
}

注意: mTN是一个本地对象,用于进程间通信

private static class TN extends ITransientNotification.Stub {
    
    final Handler mHandler;

    //...
    TN(String packageName, Looper looper) {
        //... 
        if (looper == null) {
            // Use Looper.myLooper() if looper is not specified.
            looper = Looper.myLooper();
            if (looper == null) {
                throw new RuntimeException(
                            "Can't toast on a thread that has not called Looper.prepare()");
            }
        }
        mHandler = new Handler(looper, null) {
            @Override
            public void handleMessage(Message msg) {
                switch (msg.what) {
                    case SHOW: {
                        IBinder token = (IBinder) msg.obj;
                        handleShow(token);
                        break;
                    }
                    case HIDE: {
                        handleHide();
                        // Don't do this in handleHide() because it is also invoked by
                        // handleShow()
                        mNextView = null;
                        break;
                    }
                    case CANCEL: {
                        handleHide();
                        // Don't do this in handleHide() because it is also invoked by
                        // handleShow()
                        mNextView = null;
                        try {
                            getService().cancelToast(mPackageName, TN.this);
                        } catch (RemoteException e) {
                        }
                        break;
                    }
                }
            }
        };
    }
}

注意:在TN的构造函数中,我们发现有初始化looper对象的一段逻辑。如果我们要在子线程弹出Toast的时候必须先调用Looper.prepare();来初始化一个Looper对象或者传入一个不为null的Looper对象。并且我们在这里初始化了mHandler,Toast的显示和隐藏,最终会由mHandler来处理。

Toast的show方法

public void show() {
    //mNextView不能为null
    if (mNextView == null) {
        throw new RuntimeException("setView must have been called");
    }
    //获取系统服务NotificationManagerService
    INotificationManager service = getService();
    String pkg = mContext.getOpPackageName();
    TN tn = mTN;
    tn.mNextView = mNextView;

    try {
        //将show toast的请求加入INotificationManager的toast队列
        service.enqueueToast(pkg, tn, mDuration);
    } catch (RemoteException e) {
        // Empty
    }
}

INotificationManager的enqueueToast方法。

INotificationManager的实现类是NotificationManagerService中的一个属性

@Override
public void enqueueToast(String pkg, ITransientNotification callback, int duration)
    {
   //...
   synchronized (mToastQueue) {
   int callingPid = Binder.getCallingPid();
   long callingId = Binder.clearCallingIdentity();
   try {
         ToastRecord record;
          int index;
          //除了android 包以外,其他应用同一时刻只能把一个toast加入队列 
          if (!isSystemToast) {//不是系统级别的toast
                index = indexOfToastPackageLocked(pkg);
           } else {
                 index = indexOfToastLocked(pkg, callback);
           }

           // 如果当前的应用已经有一个ToastRecord对象了,我们就更新这个对象
           if (index >= 0) {
                record = mToastQueue.get(index);
                record.update(duration);
                try {
                    record.callback.hide();
                } catch (RemoteException e) {

                }
                record.update(callback);
            } else {
                Binder token = new Binder();
                mWindowManagerInternal.addWindowToken(token, TYPE_TOAST, DEFAULT_DISPLAY);
                //创建一个新的ToastRecord对象,并加入列表中
                record = new ToastRecord(callingPid, pkg, callback, duration, token);
                mToastQueue.add(record);
                //获取列表中最后一个ToastRecord对象的下标
                index = mToastQueue.size() - 1;
            }
            keepProcessAliveIfNeededLocked(callingPid);
            // 如果index是0,就显示这个toast
            if (index == 0) {
                showNextToastLocked();
            }
        } finally {
            Binder.restoreCallingIdentity(callingId);
        }
    }
}

INotificationManager的showNextToastLocked方法

void showNextToastLocked() {
    ToastRecord record = mToastQueue.get(0);
    while (record != null) {
        //...
        //1. Toast是如何显示的      
        record.callback.show(record.token);
        //2. Toast是如何消失的     
        scheduleDurationReachedLocked(record);
        return;
        //...
   }
}

Toast是如何显示的

record.callback.show(record.token);

这里record.callback是一个 ITransientNotification 类型的对象,就是我们传入的TN对象。

TN的show方法

@Override
public void show(IBinder windowToken) {
    if (localLOGV) Log.v(TAG, "SHOW: " + this);
    mHandler.obtainMessage(SHOW, windowToken).sendToTarget();
}

mHandler处理SHOW类型的消息

public void handleMessage(Message msg) {
    switch (msg.what) {
        case SHOW: {
            IBinder token = (IBinder) msg.obj;
            handleShow(token);
            break;
        }              
    }
}

public void handleShow(IBinder windowToken) {
     //...
     if (mView != mNextView) {
        // 如果必要,先移除老的View
        handleHide();
        //...
        mWM = (WindowManager)context.getSystemService(Context.WINDOW_SERVICE);
        //...
        mParams.token = windowToken;
        //...
        //注释1处,添加view
        mWM.addView(mView, mParams);
     }
}

在handleShow方法注释1处,我们看到显示toast,就是WindowManager将我们要显示的toast view添加到当前window上。

当我们将要显示的toast view添加到当前window上以后,到达了指定的时间(LENGTH_SHORT或者LENGTH_LONG)以后,我们需要把这个view移除掉。

Toast 是如何消失的

INotificationManager的showNextToastLocked方法的注释2处

scheduleDurationReachedLocked(record);

private void scheduleDurationReachedLocked(ToastRecord r){
    mHandler.removeCallbacksAndMessages(r);
    //构建一个到期的消息
    Message m = Message.obtain(mHandler, MESSAGE_DURATION_REACHED, r);
    long delay = r.duration == Toast.LENGTH_LONG ? LONG_DELAY : SHORT_DELAY;
    //发送消息
    mHandler.sendMessageDelayed(m, delay);
}

这里的mHandler是一个WorkerHandler对象。

protected class WorkerHandler extends Handler{

    public WorkerHandler(Looper looper) {
        super(looper);
    }

    @Override
    public void handleMessage(Message msg){
        switch (msg.what){
            case MESSAGE_DURATION_REACHED:
                //处理到期的消息
                handleDurationReached((ToastRecord)msg.obj);
                break;
            //...
        }
    }

    //...

}

NotificationManagerService的handleDurationReached方法

private void handleDurationReached(ToastRecord record) {
 
    synchronized (mToastQueue) {
        int index = indexOfToastLocked(record.pkg, record.callback);
        if (index >= 0) {
              cancelToastLocked(index);
        }
    }
 }
void cancelToastLocked(int index) {
    ToastRecord record = mToastQueue.get(index);
    try {
        //隐藏toast
        record.callback.hide();
    } catch (RemoteException e) {
        // ...
    }

    ToastRecord lastToast = mToastQueue.remove(index);

    mWindowManagerInternal.removeWindowToken(lastToast.token, false /* removeWindows */,
                DEFAULT_DISPLAY);
    //...
    //如果队列中还有toast,就展示下一个
    if (mToastQueue.size() > 0) {
        showNextToastLocked();
    }
}

 //隐藏toast
 record.callback.hide();
 

这里record.callback是一个 ITransientNotification 类型的对象,就是我们传入的TN对象。

TN 的 hide方法

@Override
public void hide() {
    if (localLOGV) Log.v(TAG, "HIDE: " + this);
    mHandler.obtainMessage(HIDE).sendToTarget();
}

mHandler关于HIDE情况的处理

 case HIDE: {
      handleHide();
      mNextView = null;
      break;
}

public void handleHide() {
    if (mView != null) {
        // note: checking parent() just to make sure the view has
        // been added...  i have seen cases where we get here when
        // the view isn't yet added, so let's try not to crash.
        if (mView.getParent() != null) {
            //注释1处,WindowManager移除Toast的View
            mWM.removeViewImmediate(mView);
        }
        // Now that we've removed the view it's safe for the server to release
        // the resources.
        try {
            getService().finishToken(mPackageName, this);
        } catch (RemoteException e) {

        }
        mView = null;
    }
}

在注释1处,WindowManager移除Toast的View。

自定义Toast

如果想自定义Toast,可以使用Toast的setView方法设置要展示的View。如下所示:

private fun showCustomToast(text: String) {
    val view = LayoutInflater.from(this).inflate(R.layout.custom_toast, null)
    val tvMessage = view.findViewById<TextView>(R.id.toast_tv)
    tvMessage.text = text
    //注意这里没有使用Toast.makeText方法
    val toast = Toast(this)
    toast.view = view
    toast.show()
}

布局文件

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:orientation="vertical">

    <LinearLayout
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_margin="10dp"
        android:background="@color/colorPrimary">

        <TextView
            android:id="@+id/toast_tv"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginLeft="20dp"
            android:layout_marginTop="10dp"
            android:layout_marginRight="20dp"
            android:layout_marginBottom="10dp"
            android:gravity="center"
            android:textColor="#fff"
            android:textSize="18sp"
            tools:text="一段很长的测试文字" />

    </LinearLayout>

    <ImageView
        android:id="@+id/toast_iv"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:src="@drawable/ic_star" />

</RelativeLayout>

具体的例子可以参考 Android自定义Toast

参考链接:

  1. [Android] Toast问题深度剖析(一)
  2. Android自定义Toast
  3. 面试题:Toast 只能在主线程使用吗?
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容

  • Toast的作用主要是快速的展示相关信息给用户,同时又不占据太多屏幕位置,也不夺取焦点,更重要的时其调用非常简单,...
    留给时光吧阅读 308评论 1 0
  • 前言:toast再常见不过,但是一个小小的toast居然内有乾坤,呵(w)呵(t)呵(f) 源码如下: publi...
    super超_9754阅读 1,315评论 0 0
  • 一、系统自带Toast的源码分析 1. Toast的调用显示 学过Android的人都知道,弹出一个系统API吐司...
    笑说余生阅读 5,789评论 8 46
  • 【Android Handler 消息机制】 前言 在Android开发中,我们都知道不能在主线程中执行耗时的任务...
    Rtia阅读 4,829评论 1 28
  • 排队的时候你会发现一个规律:另一排总是动的比较快;当你换到另一排,你会发现,你原来站的那一排就开始动的比较快了;你...
    安小韩工作室阅读 137评论 0 1