Disruptor并发框架--学习笔记

Disruptor并发框架简介

Martin Fowler在自己网站上写了一篇LMAX架构的文章，在文章中他介绍了LMAX是一种新型零售金融交易平台，它能够以很低的延迟产生大量交易。这个系统是建立在JVM平台上，其核心是一个业务逻辑处理器，它能够在一个线程里每秒处理6百万订单。业务逻辑处理器完全是运行在内存中，使用事件源驱动方式。业务逻辑处理器的核心是Disruptor。

Disruptor它是一个开源的并发框架，并获得2011 Duke’s 程序框架创新奖，能够在无锁的情况下实现网络的Queue并发操作。

Disruptor是一个高性能的异步处理框架，或者可以认为是最快的消息框架（轻量的JMS），也可以认为是一个观察者模式的实现，或者事件监听模式的实现。

目前我们使用disruptor已经更新到了3.x版本，比之前的2.x版本性能更加的优秀，提供更多的API使用方式。

下载disruptor-3.3.2.jar引入我们的项目既可以开始disruptor之旅。

在使用之前，首先说明disruptor主要功能加以说明，你可以理解为他是一种高效的”生产者-消费者”模型。也就性能远远高于传统的BlockingQueue容器。

官方学习网站：http://ifeve.com/disruptor-getting-started/

（1）使用Disruptor

• 第一：建立一个Event类，用来承载数据，因为Disruptor是一个事件驱动的，所以再Disruptor中是以事件绑定数据进行传递的
• 第二：建立一个工厂Event类，用于创建Event类实例对象
• 第三：需要有一个监听事件类，用于处理数据（Event类）
• 第四：我们需要进行测试代码编写。实例化Disruptor实例，配置一系列参数。然后我们对Disruptor实例绑定监听事件类，接受并处理数据。
• 第五：在Disruptor中，真正存储数据的核心叫做RingBuffer，我们通过Disruptor实例拿到它，然后把数据生产出来，把数据加入到RingBuffer的实例对象中即可。

package com.zyh.study.disruptor.helloworld;

import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import com.lmax.disruptor.*;
import com.lmax.disruptor.dsl.Disruptor;
import com.lmax.disruptor.dsl.ProducerType;

public class Test {

    public static void main(String[] args) throws Exception {
        //创建缓冲池
        ExecutorService  executor = Executors.newCachedThreadPool();
        //创建bufferSize ,也就是RingBuffer大小，必须是2的N次方
        int ringBufferSize = 1024 * 1024; // 

        /**
        //BlockingWaitStrategy 是最低效的策略，但其对CPU的消耗最小并且在各种不同部署环境中能提供更加一致的性能表现
        WaitStrategy BLOCKING_WAIT = new BlockingWaitStrategy();
        //SleepingWaitStrategy 的性能表现跟BlockingWaitStrategy差不多，对CPU的消耗也类似，但其对生产者线程的影响最小，适合用于异步日志类似的场景
        WaitStrategy SLEEPING_WAIT = new SleepingWaitStrategy();
        //YieldingWaitStrategy 的性能是最好的，适合用于低延迟的系统。在要求极高性能且事件处理线数小于CPU逻辑核心数的场景中，推荐使用此策略；例如，CPU开启超线程的特性
        WaitStrategy YIELDING_WAIT = new YieldingWaitStrategy();
        */

        //创建disruptor
        Disruptor<Student> disruptor = new Disruptor<Student>(
                new EventFactory<Student>() {
                    @Override
                    public Student newInstance() {
                        return new Student();
                    }
                }, ringBufferSize, executor, ProducerType.SINGLE, new YieldingWaitStrategy());
        // 连接消费事件方法
        disruptor.handleEventsWith(new EventHandler<Student>(){
            @Override
            public void onEvent(Student student, long l, boolean b) throws Exception {
                System.out.println(student.toString());
            }
        });

        // 启动
        disruptor.start();

        //Disruptor 的事件发布过程是一个两阶段提交的过程：
        //发布事件
        RingBuffer<Student> ringBuffer = disruptor.getRingBuffer();

        List<Student> stus = Arrays.asList(
                new Student("xiaohuihui",26,"男"),
                new Student("mingming",29,"男"),
                new Student("fangfang",20,"女"),
                new Student("ganggang",35,"男"),
                new Student("chunchun",18,"女")

        );
        for (Student stu : stus) {
            //生产者发布数据
            ringBuffer.publishEvent(new EventTranslator<Student>() {
                @Override
                public void translateTo(Student student, long l) {
                    student.setAge(stu.getAge());
                    student.setName(stu.getName());
                    student.setSex(stu.getSex());

                }
            });
        }

        disruptor.shutdown();//关闭 disruptor，方法会堵塞，直至所有的事件都得到处理；
        executor.shutdown();//关闭 disruptor 使用的线程池；如果需要的话，必须手动关闭， disruptor 在 shutdown 时不会自动关闭；      


    }
}

（2）Disruptor术语

• RingBuffer：被看做Disruptor最主要的组件，然而从3.0开始RingBuffer仅仅负责存储和更新再Disruptor中流通的数据。对一些特殊的使用场景能够被用户（使用其他数据结构）完全替代。
• Sequence：Disruptor使用Sequence来表示一个特殊组件处理的序号。和Disruptor一样，每一个消费者（EventProcessor）都维持着一个Sequence。大部分的并发代码依赖这些Sequence值得运转，因此Sequence支持多种当前为AtomicLong类的特性。
• Sequencer：这是Disruptor真正的核心。实现了这个接口的两种生产者（单生产者和多生产者）均实现了所有的并发算法，为了在生产者和消费者之间进行准确快速的数据传递。
• SequenceBarrier：由Sequencer生成，并且包含了已经发布的Sequence的引用，这些Sequence源于Sequencer和一些独立的消费者的Sequence。它包含了决定是否有供消费者消费的Event的逻辑。用来权衡当消费者无法从RingBuffer里面获取事件时的处理策略。（例如：当生产者太慢，消费者太快，会导致消费者获取不到新的事件会根据该策略进行处理，默认会堵塞）
• WaitStrategy：决定一个消费者将如何等待生产者将Event置入Disruptor的策略。用来权衡当生产者无法将新的事件放进RingBuffer时的处理策略。（例如：当生产者太快，消费者太慢，会导致生成者获取不到新的事件槽来插入新事件，则会根据该策略进行处理，默认会堵塞）
• Event：从生产者到消费者过程中所处理的数据单元。Disruptor中没有代码表示Event，因为它完全是由用户定义的。
• EventProcessor：主要事件循环，处理Disruptor中的Event，并且拥有消费者的Sequence。它有一个实现类是BatchEventProcessor，包含了event loop有效的实现，并且将回调到一个EventHandler接口的实现对象。
• EventHandler：由用户实现并且代表了Disruptor中的一个消费者的接口。
• Producer：由用户实现，它调用RingBuffer来插入事件(Event)，在Disruptor中没有相应的实现代码，由用户实现。
• WorkProcessor：确保每个sequence只被一个processor消费，在同一个WorkPool中的处理多个WorkProcessor不会消费同样的sequence。
• WorkerPool：一个WorkProcessor池，其中WorkProcessor将消费Sequence，所以任务可以在实现WorkHandler接口的worker之间移交
• LifecycleAware：当BatchEventProcessor启动和停止时，于实现这个接口用于接收通知。

（3）Disruptor应用

Disruptor实际上是对RingBuffer的封装，所以我们也可以直接使用RingBuffer类

API提供的生产者接口
EventTranslator<V>与EventTranslatorOneArg<V v, Object data>，前者不能动态传参，后者可以动态传递一个参数data，V为需要创建的数据对象，data为实际数据，实现translateTo(V v, long sequeue, Object data)方法，其中v就是下一个可用事件槽里面的对象，data为传进来的真实数据，调用ringBuffer.publishEvent(EventTranslatorOneArg translator, Object data);来发布数据到RingBuffer中。

package com.zyh.study.disruptor.helloworld;

import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import com.lmax.disruptor.*;
import com.lmax.disruptor.dsl.Disruptor;
import com.lmax.disruptor.dsl.ProducerType;

public class LongEventMain {

    public static void main(String[] args) throws Exception {
        //创建缓冲池
        ExecutorService  executor = Executors.newCachedThreadPool();
        //创建bufferSize ,也就是RingBuffer大小，必须是2的N次方
        int ringBufferSize = 1024 * 1024; // 

        /**
        //BlockingWaitStrategy 是最低效的策略，但其对CPU的消耗最小并且在各种不同部署环境中能提供更加一致的性能表现
        WaitStrategy BLOCKING_WAIT = new BlockingWaitStrategy();
        //SleepingWaitStrategy 的性能表现跟BlockingWaitStrategy差不多，对CPU的消耗也类似，但其对生产者线程的影响最小，适合用于异步日志类似的场景
        WaitStrategy SLEEPING_WAIT = new SleepingWaitStrategy();
        //YieldingWaitStrategy 的性能是最好的，适合用于低延迟的系统。在要求极高性能且事件处理线数小于CPU逻辑核心数的场景中，推荐使用此策略；例如，CPU开启超线程的特性
        WaitStrategy YIELDING_WAIT = new YieldingWaitStrategy();
        */

        //创建disruptor
        Disruptor<Student> disruptor = new Disruptor<Student>(()->{
            return new Student();
        }, ringBufferSize, executor, ProducerType.SINGLE, new YieldingWaitStrategy());

        // 连接消费事件方法
        disruptor.handleEventsWith(new EventHandler<Student>(){
            @Override
            public void onEvent(Student student, long l, boolean b) throws Exception {
                System.out.println(student.toString());
            }
        });

        // 启动
        disruptor.start();

        //Disruptor 的事件发布过程是一个两阶段提交的过程：
        //发布事件
        RingBuffer<Student> ringBuffer = disruptor.getRingBuffer();

        List<Student> stus = Arrays.asList(
                new Student("xiaohuihui",26,"男"),
                new Student("mingming",29,"男"),
                new Student("fangfang",20,"女"),
                new Student("ganggang",35,"男"),
                new Student("chunchun",18,"女")
        );

        //生产者发布数据
        ringBuffer.publishEvent(new EventTranslatorOneArg<Student, List<Student>>() {
            @Override
            public void translateTo(Student student, long l, List<Student> students) {
                    student.setName(students.get(0).getName());
                    student.setAge(students.get(0).getAge());
                    student.setSex(students.get(0).getSex());
            }
        },stus);

//      for (Student stu : stus) {
//          //生产者发布数据
//          ringBuffer.publishEvent(new EventTranslator<Student>() {
//              @Override
//              public void translateTo(Student student, long l) {
//                  student.setAge(stu.getAge());
//                  student.setName(stu.getName());
//                  student.setSex(stu.getSex());
//
//              }
//          });
//      }

        disruptor.shutdown();//关闭 disruptor，方法会堵塞，直至所有的事件都得到处理；
        executor.shutdown();//关闭 disruptor 使用的线程池；如果需要的话，必须手动关闭， disruptor 在 shutdown 时不会自动关闭；      

    }
}

API提供的消费者接口

1. WorkerPool ：
   WorkerPool<Order>(RingBuffer<V> ringBuffer, SequenceBarrier sequenceBarrier, ExceptionHandler<? super V> exceptionHandler, WorkHandler<? super V>... workHandlers)其中RingBuffer为数据缓冲区，sequenceBarrier是消费者与生产者之间的协调策略，API默认提供了一个实现类ProcessingSequenceBarrier，可以通过RingBuffer.newBarrier(Sequence... sequencesToTrack);来获取，exceptionHandler为异常处理函数，当handler发生异常时回调该函数，workHandlers为实现了EventHandler接口的消息业务处理类，可以有多个。
   WorkerPool启动的方法是 WorkerPool.start(Executor executor)

2. BatchEventProcessor ：
   BatchEventProcessor<V>(RingBuffer extends DataProvider, SequenceBarrier sequenceBarrier, EventHandler<? super V> eventHandler) 其中RingBuffer为数据缓冲区，sequenceBarrier是消费者与生产者之间的协调策略，API默认提供了一个实现类ProcessingSequenceBarrier，可以通过RingBuffer.newBarrier(Sequence... sequencesToTrack);来获取，eventHandler为实现了EventHandler接口的消息业务处理类。
   BatchEventProcessor启动的方法是 Executor.submit(BatchEventProcessor batchEventProcessor)

注意
SequenceBarrier是用来协调消费者和生成者之间效率的策略类，所以要想Barrier生效，必须要将消费者消费的Seuence传递给RingBuffer，然后由RingBuffer进行协调：ringBuffer.addGatingSequences(BatchEventProcessor.getSequence()); 多消费者时使用BatchEventProcessor.getWorkerSequences()（这两个方法WorkerPool同样适用）。这是在直接使用RingBuffer时需要进行的处理，如果通过Disruptor去进行调用，在调用handleEventsWith注册消费者方法时会自动添加该处理。

Disruptor注册消费者的方法是：

Disruptor.handleEventsWith(final EventHandler<? super T>... handlers)

Disruptor提供了一些复杂的并行运行方式。

1、生产者A生成的数据同时被B,C两个消费者消费，两者都消费完成之后再由消费者D对两者同时消费。（注意ABC以及下面提到的消息处理类必须要实现EventHandler接口）

EventHandlerGroup<Trade> handlerGroup = 
        disruptor.handleEventsWith(A, B);
//声明在C1,C2完事之后执行JMS消息发送操作 也就是流程走到C3 
handlerGroup.then(C);

2、生产者A生成的数据同时被B1,C2两个消费者消费，而B消耗完毕之后由B2处理，C1处理完成之后由C2处理，B2与C2两者都消费完成之后再由消费者D对两者同时消费。其中B1与B2,C1与C2是并行执行的。

disruptor.handleEventsWith(B1, C1);
disruptor.after(B1).handleEventsWith(B2);
disruptor.after(C1).handleEventsWith(C2);
disruptor.after(B2, C2).handleEventsWith(h3);

3、生产者A生成的数据依次被A,B,C三个消费者消费

disruptor.handleEventsWith(A).handleEventsWith(B).handleEventsWith(C);

并行运行方式demo:

Main方法:

package com.zyh.study.disruptor.base;

import com.lmax.disruptor.BusySpinWaitStrategy;
import com.lmax.disruptor.EventFactory;
import com.lmax.disruptor.dsl.Disruptor;
import com.lmax.disruptor.dsl.EventHandlerGroup;
import com.lmax.disruptor.dsl.ProducerType;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

public class Main {  
    public static void main(String[] args) throws InterruptedException {  

        long beginTime=System.currentTimeMillis();  
        int bufferSize=1024;  
        ExecutorService executor=Executors.newFixedThreadPool(8);  

        Disruptor<Trade> disruptor = new Disruptor<Trade>(new EventFactory<Trade>() {  
            @Override  
            public Trade newInstance() {  
                return new Trade();  
            }  
        }, bufferSize, executor, ProducerType.SINGLE, new BusySpinWaitStrategy());  

        //菱形操作
        //使用disruptor创建消费者组C1,C2
        EventHandlerGroup<Trade> handlerGroup =
                disruptor.handleEventsWith(new Handler1(), new Handler2());
        //声明在C1,C2完事之后执行JMS消息发送操作 也就是流程走到C3
        handlerGroup.then(new Handler3());

        //顺序操作
        /**
                disruptor.handleEventsWith(new Handler1()).
                handleEventsWith(new Handler2()).
                handleEventsWith(new Handler3());
                */

        //六边形操作. 
        /**
                Handler1 h1 = new Handler1();
                Handler2 h2 = new Handler2();
                Handler3 h3 = new Handler3();
                Handler4 h4 = new Handler4();
                Handler5 h5 = new Handler5();
                disruptor.handleEventsWith(h1, h2);
                disruptor.after(h1).handleEventsWith(h4);
                disruptor.after(h2).handleEventsWith(h5);
                disruptor.after(h4, h5).handleEventsWith(h3);
                */

        disruptor.start();//启动  
        CountDownLatch latch=new CountDownLatch(1);  
        //生产者准备  
        executor.submit(new TradePublisher(latch, disruptor));

        latch.await();//等待生产者完事. 

        disruptor.shutdown();  
        executor.shutdown();  
        System.out.println("总耗时:"+(System.currentTimeMillis()-beginTime));  
    }  
}  

Handler1:

package com.zyh.study.disruptor.base;

import com.lmax.disruptor.EventHandler;

public class Handler1 implements EventHandler<Trade>{

    @Override  
    public void onEvent(Trade event, long sequence, boolean endOfBatch) throws Exception {
        System.out.println("handler1: set name");
        event.setName("h1");
        Thread.sleep(1000);    
    }
}  

Handler2:

package com.zyh.study.disruptor.base;

import com.lmax.disruptor.EventHandler;

public class Handler2 implements EventHandler<Trade> {  

    @Override  
    public void onEvent(Trade event, long sequence,  boolean endOfBatch) throws Exception {  
        System.out.println("handler2: set price");
        event.setPrice(17.0);
        Thread.sleep(1000);
    }  

}  

Handler3:

package com.zyh.study.disruptor.base;

import com.lmax.disruptor.EventHandler;

public class Handler3 implements EventHandler<Trade> {
    @Override  
    public void onEvent(Trade event, long sequence,  boolean endOfBatch) throws Exception {  
        System.out.println("handler3: name: " + event.getName() + " , price: " + event.getPrice() + ";  instance: " + event.toString());
    }  
}

Handler4:

package com.zyh.study.disruptor.base;

import com.lmax.disruptor.EventHandler;

public class Handler4 implements EventHandler<Trade> {

    @Override  
    public void onEvent(Trade event, long sequence, boolean endOfBatch) throws Exception {
        System.out.println("handler4: get name : " + event.getName());
        event.setName(event.getName() + "h4");
    }

}  

Handler5:

package com.zyh.study.disruptor.base;

import com.lmax.disruptor.EventHandler;

public class Handler5 implements EventHandler<Trade>{

    @Override  
    public void onEvent(Trade event, long sequence, boolean endOfBatch) throws Exception {
        System.out.println("handler5: get price : " + event.getPrice());
        event.setPrice(event.getPrice() + 3.0);
    }
}