Flink源码解析系列-- WatermarkGenerator接口及其常用实现

本文的Flink源码版本为: 1.15-SNAPSHOT，读者可自行从Github clone.

Flink 提供了 WatermarkGenerator 接口用来"制造"水印:

/**
 * {@code WatermarkGenerator} 可以基于事件或者周期性的生成 watermark。
 *
 * <p><b>注意：</b>  WatermarkGenerator 将以前互相独立的 {@code AssignerWithPunctuatedWatermarks} 
 * 和 {@code AssignerWithPeriodicWatermarks} 一同包含了进来。
 */
@Public
public interface WatermarkGenerator<T> {

    /**
     * 每来一条事件数据就调用一次，可以检查或者记录事件的时间戳，或者也可以基于事件数据本身去生成 watermark。
     */
    void onEvent(T event, long eventTimestamp, WatermarkOutput output);

    /**
     * 周期性的调用，也许会生成新的 watermark，也许不会。
     *
     * <p>调用此方法生成 watermark 的间隔时间由 {@link ExecutionConfig#getAutoWatermarkInterval()} 决定。
     */
    void onPeriodicEmit(WatermarkOutput output);
}

用户可以自定义实现 WatermarkGenerator 接口完成水印的发送，同时，为了方便用户开发，Flink 提供了 NoWatermarksGenerator、BoundedOutOfOrdern