Flink触发器Triggers

触发器（Triggers）

触发器确定窗口（由窗口分配器形成）何时准备好由窗口功能处理。每个WindowAssigner都带有一个默认触发器。如果默认触发器不适合您的需求，则可以使用trigger（...）指定自定义触发器。

trigger触发器接口有五个方法允许trigger对不同的事件做出反应：

• onElement()进入窗口的每个元素都会调用该方法。

• onEventTime()事件时间timer触发的时候被调用。

• onProcessingTime()处理时间timer触发的时候会被调用。

• onMerge()有状态的触发器相关，并在它们相应的窗口合并时合并两个触发器的状态，例如使用会话窗口。

• clear()该方法主要是执行窗口的删除操作。

关于上述方法需要注意两点：

1).前三方法决定着如何通过返回一个TriggerResult来操作输入事件。

CONTINUE:什么都不做。

FIRE:触发计算。

PURE:清除窗口的元素。

FIRE_AND_PURE:触发计算和清除窗口元素。

2). 这些方法中的任何一个都可用于为将来的操作注册处理或事件时间计时器

Fire和Purge

一旦触发器确定窗口已准备好进行处理，它将触发，即返回FIRE或FIRE_AND_PURGE。这是窗口操作员发出当前窗口结果的信号。给定一个带有ProcessWindowFunction的窗口，所有元素都将传递给ProcessWindowFunction（可能在将它们传递给逐出者之后）。具有ReduceFunction，AggregateFunction或FoldFunction的Windows只会发出其急切的聚合结果。

当触发器触发时，它可以是FIRE或FIRE_AND_PURGE。在FIRE保留窗口内容的同时，FIRE_AND_PURGE删除其内容。默认情况下，预实现的触发器仅触发FIRE，而不会清除窗口状态。

注意⚠️：
清除将仅删除窗口的内容，并将保留有关该窗口的任何潜在元信息以及任何触发状态。

默认触发器

WindowAssigner的默认触发器适用于许多用例。例如，所有事件时间窗口分配器都有一个EventTimeTrigger作为默认触发器。一旦WaterMark通过窗口的末端，该触发器便会触发。

注意⚠️：
GlobalWindow的默认触发器是NeverTrigger，它从不触发。因此，在使用GlobalWindow时，您始终必须定义一个自定义触发器。
通过使用trigger（）指定触发器，您将覆盖WindowAssigner的默认触发器。例如，如果为TumblingEventTimeWindows指定CountTrigger，
则将不再基于时间进度而是仅通过计数来获取窗口触发。现在，如果要基于时间和计数做出反应，则必须编写自己的自定义触发器。

内置和自定义触发器

Flink带有一些内置触发器。

• EventTimeTrigger基于事件时间和watermark机制来对窗口进行触发计算。

• ProcessingTimeTrigger基于处理时间触发。

• CountTrigger窗口元素数超过预先给定的限制值的话会触发计算。

• PurgingTrigger作为其它trigger的参数，将其转化为一个purging触发器。

如果需要实现自定义触发器，则应该实现Trigger类。请注意，API仍在不断发展，并可能在Flink的未来版本中更改。

import org.apache.flink.streaming.api.windowing.triggers.Trigger;
import org.apache.flink.streaming.api.windowing.triggers.TriggerResult;
import org.apache.flink.streaming.api.windowing.windows.TimeWindow;

/**
 * 

 * 
title: DataStream 触发器
 * 
@author: li.pan
 * 
Date: 2019/12/29 5:00 下午
 * 
Version: V1.0
 * 
Description: 自定义元素个数触发器
 */
public class CustomProcessingTimeTrigger extends Trigger {
    private static final long serialVersionUID = 1L;

    private CustomProcessingTimeTrigger() {}

    private static int flag = 0;
    @Override
    public TriggerResult onElement(Object element, long timestamp, TimeWindow window, TriggerContext ctx) {
        ctx.registerProcessingTimeTimer(window.maxTimestamp());
        // CONTINUE是代表不做输出，也即是，此时我们想要实现比如100条输出一次，
        // 而不是窗口结束再输出就可以在这里实现。
        if(flag > 9){
            flag = 0;
            return TriggerResult.FIRE;
        }else{
            flag++;
        }
        System.out.println("onElement : "+element);
        return TriggerResult.CONTINUE;
    }

    @Override
    public TriggerResult onEventTime(long time, TimeWindow window, TriggerContext ctx) throws Exception {
        return TriggerResult.FIRE_AND_PURGE;
    }

    @Override
    public TriggerResult onProcessingTime(long time, TimeWindow window, TriggerContext ctx) {
        return TriggerResult.FIRE_AND_PURGE;
    }

    @Override
    public void clear(TimeWindow window, TriggerContext ctx) throws Exception {
        ctx.deleteProcessingTimeTimer(window.maxTimestamp());
    }

    @Override
    public boolean canMerge() {
        return true;
    }

    @Override
    public void onMerge(TimeWindow window, OnMergeContext ctx) {
        // only register a timer if the time is not yet past the end of the merged window
        // this is in line with the logic in onElement(). If the time is past the end of
        // the window onElement() will fire and setting a timer here would fire the window twice.
        long windowMaxTimestamp = window.maxTimestamp();
        if (windowMaxTimestamp > ctx.getCurrentProcessingTime()) {
            ctx.registerProcessingTimeTimer(windowMaxTimestamp);
        }
    }

    @Override
    public String toString() {
        return "ProcessingTimeTrigger()";
    }

    /**
     * 创建一个自定义触发器对象
     */
    public static CustomProcessingTimeTrigger create() {
        return new CustomProcessingTimeTrigger();
    }

}