kafka时间轮简易实现（二）

概述

上一篇主要介绍了kafka时间轮源码和原理，这篇主要介绍一下kafka时间轮简单实现和使用kafka时间轮。如果要实现一个时间轮，就要了解他的数据结构和运行原理，上一篇随笔介绍了不同种类的数据结构kafka时间轮的原理（一）。大体上也就是需要使用数组或者链表组成一个环形的结构，数组或者链表的节点保存任务，这个任务肯定需要使用抽象一些的线程类来实现它以便于后期的任务执行等。时间轮的启动和停止肯定也是一个单独的线程来保证时间轮中的任务正确执行和取消等。现在详细说一下实现过程，其实知道原理实现起来就很方便了。

时间轮的功能

本文说明的时间轮具有的功能：

1，可以添加指定时间的延时任务，每个任务都是task抽象的父类，每个任务都放在环形object类型数组中，在这个任务中可以实现自己的业务逻辑。

2，有一个触发任务，实际上是一个线程，主要作用是相当于按时遍历时间轮每个节点，查看是否到时间执行，就相当于表针运行状态触发执行任务，这里就是TriggerJob。

3，停止运行（包含强制停止和所有任务完成后停止）。

4，查看待执行任务数量。

时间轮的数据结构

本文时间轮是一个object数组，每个数组元素这里定义是个set集合，set集合可以有多个任务，时间轮的大小规则是2的指数，这样设计的目的是可以通过左移达到取模的目的，这里使用线程池ExecutorService，因为多个任务肯定从线程池快速申请，见代码：

    //时间轮默认大小2的五次方
    private static final int STATIC_RING_SIZE=64;
    //数组作为时间轮
    private Object[] ringBuffer;
    private int bufferSize;
    //线程池
    private ExecutorService executorService;
    
    //时间轮中总任务个数
    private volatile int size =0 ;
    
    //主要确定是否继续执行触发轮询时间轮的任务，相当关闭轮询时间轮的任务
    private volatile boolean stop=false;
    //使用原子类，初始化只需要一个线程执行，确定只一次初始化启动。
    private volatile AtomicBoolean start= new AtomicBoolean(false);
    //触发任务中的表针，tick 顾名思义
    private AtomicInteger tick = new AtomicInteger();
    
    //条件锁，用于stop
    private Lock lock = new ReentrantLock();
    private Condition condition = lock.newCondition();
    
    //每一个任务有一个任务id
    private AtomicInteger taskId= new AtomicInteger();
    
    //用于按照taskId查找任务取消
    private Map<Integer,Task>  taskMap= new HashMap<Integer,Task>();

时间轮的构造函数，有2个，一个默认大小。一个用户自定义大小：

    public RhettBufferWheel(ExecutorService  executorService){
        this.executorService=executorService;
        this.bufferSize=STATIC_RING_SIZE;
        this.ringBuffer= new Object[bufferSize];
    }
    
    public RhettBufferWheel(ExecutorService executorService, int bufferSize) {
        this(executorService);
        //判断bufferSize是否是2的指数
        if(!powerOf2(bufferSize)){
            throw new RuntimeException("bufferSize=[" + bufferSize + "] must be a power of 2");
        } 
        this.bufferSize = bufferSize;
        this.ringBuffer = new Object[bufferSize];
    }

时间轮的启动和停止

下面就是初始化，时间轮初始化只需要一个线程实现就行。

    public void start() {
        if (!start.get()) {
            if (start.compareAndSet(start.get(), true)) {
                logger.info("delay task is starting");
                Thread job = new Thread(new TriggerJob());
                job.setName("consumer RingBuffer thread");
                job.start();
                start.set(true);
            }

        }
    }

有启动就有停止，停止有2中情况，一是强制停止所有任务，二是使用条件队列锁挂起所有任务，关闭addTask，直到任务执行完毕后被唤醒。

    public void stop(boolean force) {
        if (force) {
            logger.info("delay task is forced stop");
            stop = true;
            executorService.shutdownNow();
        } else {
            logger.info("delay task is stopping");
            if (taskSize() > 0) {
                try {
                    lock.lock();
                    condition.await();
                    stop = true;
                } catch (InterruptedException e) {
                    logger.error("InterruptedException", e);
                } finally {
                    lock.unlock();
                }
            }
            executorService.shutdown();
        }

    }

时间轮的任务模块实现

上一节说明了时间轮的整体思路和实现。现在讲解时间轮的任务管理，先说明抽象任务类，这个类只是抽象了任务最基本的属性，任务的在时间轮的具体位置，以及时间轮的延时时间：

public abstract static class Task extends Thread{
        //时间轮的索引位置
        private int index;
        //时间轮的圈数
        private int cycleNum;
        //时间轮延时时间，到期执行时间
        private int key;
        
        @Override
        public void run(){
            
        }
        public int getIndex() {
            return index;
        }
        public void setIndex(int index) {
            this.index = index;
        }
        public int getCycleNum() {
            return cycleNum;
        }
        public void setCycleNum(int cycleNum) {
            this.cycleNum = cycleNum;
        }
        public int getKey() {
            return key;
        }
        public void setKey(int key) {
            this.key = key;
        }
        
        
    }

知道了任务实现，下面我再和你们说一下任务的增删改查，任务的增加，增加是一个原子操作，所以这里实现了锁ReentrantLock。

    public int addTask(Task task){
        int key= task.getKey();
        int id;
        try {
            lock.lock();
            //通过key到期时间计算出index位置也就是数组位置
            int index = mod(key, bufferSize);
            logger.info("task's key = {},task's index ={}",key,index);
            task.setIndex(index);
            //查看这个数组集合之前是否有数据，因为每个数组对应一个set集合所以这里要区分
            Set<Task> tasks = get(index);

            if (tasks != null) {
                int cycleNum = cycleNum(key, bufferSize);
                task.setCycleNum(cycleNum);
                tasks.add(task);
            } else {
                int cycleNum = cycleNum(key, bufferSize);
                task.setIndex(index);
                task.setCycleNum(cycleNum);
                //如果需要重新建立set集合就要重新增加task外，还要set对应正确的数组位置。
                Set<Task> sets = new HashSet<>();
                sets.add(task);
                put(key, sets);
            }
            //每个任务的唯一id，统一放到hashmap中，为了查找方便，指定取消任务
            id = taskId.incrementAndGet();
            taskMap.put(id, task);
            size++;
        } finally {
            lock.unlock();
        }
        //启动时间轮
        start();

        return id;
    }

增加有一个地方需要知道一下，就是按照与运算取模。

    private int mod(int target, int mod) {
        // equals target % mod
        target = target + tick.get();
        return target & (mod - 1);
    }

    private int cycleNum(int target, int mod) {
        //equals target/mod
        return target >> Integer.bitCount(mod - 1);
    }

首先是根据延时时间 (key) 计算出所在的位置，其实就和 HashMap 一样的取模运算，只不过这里使用了位运算替代了取模，同时效率会高上不少。这样也解释了为什么数组长度一定得是 2∧n。其中的cycleNum() 自然是用于计算该任务所处的圈数，也是考虑到效率问题，使用位运算替代了除法。

任务的取消，任务取消就是用到了hashmap，按照key找到task，然后取消，取消相当于在集合中删除任务，也是需要加锁的，

    /**
     * Cancel task by taskId
     * @param id unique id through {@link #addTask(Task)}
     * @return
     */
    public boolean cancel(int id) {

        boolean flag = false;
        Set<Task> tempTask = new HashSet<>();

        try {
            lock.lock();
            Task task = taskMap.get(id);
            if (task == null) {
                return false;
            }

            Set<Task> tasks = get(task.getIndex());
            for (Task tk : tasks) {
                if (tk.getKey() == task.getKey() && tk.getCycleNum() == task.getCycleNum()) {
                    size--;
                    flag = true;
                } else {
                    tempTask.add(tk);
                }

            }
            //update origin data
            ringBuffer[task.getIndex()] = tempTask;
        } finally {
            lock.unlock();
        }

        return flag;
    }

 时间轮的指针触发任务实现

触发任务是一个单独的线程，这个是时间轮的指针，是时间轮的核心。

    private  class TriggerJob implements Runnable{
        @Override
        public void run(){
            int index=0;
            while(!stop){
                try{
                    //取出指定位置的集合，
                    Set<Task> tasks=remove(index);
                    for(Task task:tasks){
                        //这个就是真正执行定时任务了
                        executorService.submit(task);
                    }
                    //一个轮询
                    if(++index>bufferSize-1){
                        index=0;
                    }
                    //Total tick number of records
                    tick.incrementAndGet();
                    TimeUnit.SECONDS.sleep(1);
                }catch(Exception e){
                    logger.error("Exception", e);
                }
            }
            logger.info("delay task is stopped");
        }
    }

这里的remove方法需要注意，这个就是按照索引取出指定数组位置的set集合。

    private Set<Task> remove(int key) {
        Set<Task> tempTask = new HashSet<>();
        Set<Task> result = new HashSet<>();

        Set<Task> tasks = (Set<Task>) ringBuffer[key];
        if (tasks == null) {
            return result;
        }

        for (Task task : tasks) {
            if (task.getCycleNum() == 0) {
                result.add(task);

                size2Notify();
            } else {
                // decrement 1 cycle number and update origin data
                task.setCycleNum(task.getCycleNum() - 1);
                tempTask.add(task);
            }
        }

        //update origin data
        ringBuffer[key] = tempTask;

        return result;
    }

其中的 size2Notify() 倒是值得说一下，他是用于在停止任务时，主线程等待所有延时任务执行完毕的唤醒条件。这类用法几乎是所有线程间通信的常规套路，值得收入技能包。

    private void size2Notify() {
        try {
            lock.lock();
            size--;
            if (size == 0) {
                condition.signal();
            }
        } finally {
            lock.unlock();
        }
    }

简单说来就是，上文的stop时间轮中条件队列锁阻塞，这里就是唤醒所有的线程，真正的stop，因为没有任务了。

总结

看了kafka的时间轮，高大尚无比，这次也是按照晚上不错的时间轮自己实现，觉得对自己的代码和开发思路多有补益，感谢网络大神的帮助：

github源码：https://github.com/Rhett-wang-888/Java-Algorithm/blob/master/src/main/java/util/RhettBufferWheel.java

https://crossoverjie.top/2019/09/27/algorithm/time%20wheel/#more