Android多线程之HandlerThread源码解析

gavinvong 2019-07-01

一、概述

先来了解一下HandlerThread的几个特性

  • HandlerThread继续于Thread,本身就是一个线程类
  • HandlerThread在内部维护了自己的Looper对象,所以可以进行Looper循环
  • 创建HandlerThread后需要先调用HandlerThread.start()方法再向其下发任务,通过run()方法来创建Looper对象
  • 通过传递HandlerThread的Looper对象给Handler对象,从而可以通过Handler来向HandlerThread下发号是任务

二、使用方式

再来看HandlerThread的使用方式

创建HandlerThread并调用start()方法,使其在子线程内创建Looper对象

HandlerThread handlerThread = new HandlerThread("HandlerThread");
    handlerThread.start();

然后以HandlerThread内部的Looper对象为参数创建一个Handler,通过Handler向子线程发送Message,以此下发耗时任务,消息的接受者与任务的处理者则由回调函数ChildCallback来完成

Handler childThreadHandler = new Handler(handlerThread.getLooper(), new ChildCallback());
    
    //Callback 运行于子线程
    private class ChildCallback implements Handler.Callback {
        @Override
        public boolean handleMessage(Message msg) {
            //在此可以进行耗时操作
            //如果需要更新UI,则需要通过主线程的Handler来完成
            return false;
        }
    }

完整的实列代码如下所示

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "MainActivity";

    //Callback 运行于子线程
    private class ChildCallback implements Handler.Callback {
        @Override
        public boolean handleMessage(Message msg) {
            //在此可以进行耗时操作
            //如果需要更新UI,则需要通过主线程的Handler来完成
            Log.e(TAG, "ChildCallback 当前线程名:" + Thread.currentThread().getName() + "   " + "当前线程ID:" + Thread.currentThread().getId());
            Log.e(TAG, "耗时任务开始");
            try {
                Thread.sleep(5000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            Log.e(TAG, "耗时任务结束");
            //通知界面更新UI
            uiHandler.sendEmptyMessage(1);
            return false;
        }
    }

    //运行于主线程的Handler,用于更新UI
    @SuppressLint("HandlerLeak")
    private Handler uiHandler = new Handler() {
        @Override
        public void handleMessage(Message msg) {
            Log.e(TAG, "uiHandler 当前线程名:" + Thread.currentThread().getName() + "   " + "当前线程ID:" + Thread.currentThread().getId());
            Toast.makeText(MainActivity.this, "耗时操作完成", Toast.LENGTH_LONG).show();
        }
    };

    //用于向子线程发布耗时任务的Handler
    private Handler childThreadHandler;

    private HandlerThread handlerThread;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        handlerThread = new HandlerThread("HandlerThread");
        handlerThread.start();
        childThreadHandler = new Handler(handlerThread.getLooper(), new ChildCallback());
        Log.e(TAG, "onCreate 当前线程名:" + Thread.currentThread().getName() + "   " + "当前线程ID:" + Thread.currentThread().getId());
    }

    public void startTask(View view) {
        childThreadHandler.sendEmptyMessage(1);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        handlerThread.quit();
        childThreadHandler.removeCallbacksAndMessages(null);
    }

}

程序运行后的日志如下所示,可以看出各个方法在调用时所处的线程

06-22 02:51:41.779 21977-21977/com.summer.myapplication E/MainActivity: onCreate 当前线程名:main   当前线程ID:2
06-22 02:51:44.927 21977-21995/com.summer.myapplication E/MainActivity: ChildCallback 当前线程名:HandlerThread   当前线程ID:497
06-22 02:51:44.928 21977-21995/com.summer.myapplication E/MainActivity: 耗时任务开始
06-22 02:51:49.930 21977-21995/com.summer.myapplication E/MainActivity: 耗时任务结束
06-22 02:51:49.930 21977-21977/com.summer.myapplication E/MainActivity: uiHandler 当前线程名:main   当前线程ID:2

三、源码分析

先看下HandlerThread的类声明

Thread的子类

public class HandlerThread extends Thread

两个构造函数,可以传入的参数分别是线程名和线程优先级

public HandlerThread(String name) {
        super(name);
        //使用默认的线程优先级
        mPriority = Process.THREAD_PRIORITY_DEFAULT;
    }

    public HandlerThread(String name, int priority) {
        super(name);
        //使用自定义的线程优先级
        mPriority = priority;
    }

看下run() 方法

@Override
    public void run() {
        mTid = Process.myTid();
        //触发当前线程创建 Looper 对象
        Looper.prepare();
        synchronized (this) {
            //获取 Looper 对象
            mLooper = Looper.myLooper();
            //唤醒在等待的线程
            //唤醒 getLooer() 中可能还处于等待状态的线程
            notifyAll();
        }
        //设置线程优先级
        Process.setThreadPriority(mPriority);
        onLooperPrepared();
        //开启消息循环
        Looper.loop();
        mTid = -1;
    }

Looper.prepare()方法用于为当前线程创建一个Looper对象,在主线程需要依赖此Looper对象来构建一个Handler对象,通过Handler对象来向子线程下发耗时任务

之后可以看到有一个同步代码块,在当中调用了notifyAll()来唤醒等待线程,那该唤醒的又是那个线程呢?这里需要明确各个方法是运行于那个线程,run()方法肯定是运行在子线程中, 但用于想HandlerThread下发任务的Handler是初始化于主线程,因此getlooper()方法也是运行于主线程的。由于是两个不同的线程,run()方法和getLooper()的运行先后顺序是不明确的,因此getLooper()方法需要确保Looper对象不为null 时才返回,否则将一直阻塞等待Looper对象初始化完成

//获取与当前线程关联的 Looper 对象
   //因为 getLooper() 方法可能先于 run() 被调用,此时就需要先等待 Looper 对象被创建
   public Looper getLooper() {
       //如果当前线程未在运行,则返回 null 
       if (!isAlive()) {
           return null;
       }
       synchronized (this) {
           //如果当前线程已处理运行状态(已调用 start() 方法)且 Looper 对象还未创建
           //则调用 wait() 方法释放锁,等待 Looper 对象创建
           while (isAlive() && mLooper == null) {
               try {
                   wait();
               } catch (InterruptedException e) {
               }
           }
       }
       return mLooper;
   }

Looper对象初始化完成后,就需要调用Looper.loop()来开启消息循环,至此HandlerThread的初始化操作就完成了

HandlerThread的完整源码注释

package android.os;

import android.annotation.NonNull;
import android.annotation.Nullable;

/**
 * Handy class for starting a new thread that has a looper. The looper can then be 
 * used to create handler classes. Note that start() must still be called.
 */
public class HandlerThread extends Thread {

    //线程优先级
    int mPriority;

    //线程ID
    int mTid = -1;

    //当前线程持有的Looper对象
    Looper mLooper;

    //包含当前 Looper 对象的 Handler
    private @Nullable Handler mHandler;

    public HandlerThread(String name) {
        super(name);
        //使用默认的线程优先级
        mPriority = Process.THREAD_PRIORITY_DEFAULT;
    }

    public HandlerThread(String name, int priority) {
        super(name);
        //使用自定义的线程优先级
        mPriority = priority;
    }
    
    //在 Looper 循环启动前调用
    //此处是空实现,留待子类重写
    protected void onLooperPrepared() {
    }

    @Override
    public void run() {
        mTid = Process.myTid();
        //触发当前线程创建 Looper 对象
        Looper.prepare();
        synchronized (this) {
            //获取 Looper 对象
            mLooper = Looper.myLooper();
            //唤醒在等待的线程
            //唤醒 getLooer() 中可能还处于等待状态的线程
            notifyAll();
        }
        //设置线程优先级
        Process.setThreadPriority(mPriority);
        onLooperPrepared();
        //开启消息循环
        Looper.loop();
        mTid = -1;
    }
    
    //获取与当前线程关联的 Looper 对象
    //因为 getLooper() 方法可能先于 run() 被调用,此时就需要先等待 Looper 对象被创建
    public Looper getLooper() {
        //如果当前线程未在运行,则返回 null 
        if (!isAlive()) {
            return null;
        }
        synchronized (this) {
            //如果当前线程已处理运行状态(已调用 start() 方法)且 Looper 对象还未创建
            //则调用 wait() 方法释放锁,等待 Looper 对象创建
            while (isAlive() && mLooper == null) {
                try {
                    wait();
                } catch (InterruptedException e) {
                }
            }
        }
        return mLooper;
    }

    /**
     * @return a shared {@link Handler} associated with this thread
     * @hide
     */
    @NonNull
    public Handler getThreadHandler() {
        if (mHandler == null) {
            mHandler = new Handler(getLooper());
        }
        return mHandler;
    }

    //清空消息队列中所有的消息
    public boolean quit() {
        Looper looper = getLooper();
        if (looper != null) {
            looper.quit();
            return true;
        }
        return false;
    }

    //清空消息队列中所有非延时消息
    public boolean quitSafely() {
        Looper looper = getLooper();
        if (looper != null) {
            looper.quitSafely();
            return true;
        }
        return false;
    }

    /**
     * Returns the identifier of this thread. See Process.myTid().
     */
    public int getThreadId() {
        return mTid;
    }

}

相关推荐