Apache Flink源码解析 （五）DataStream API

概述

这篇文章是但不仅仅是官方文档的中文翻译，还有里面每一个方法对应的Transformation和运行时对Task的影响。

Prerequisites

• 关于算子想说的有很多，在这篇文章中，把算子理解为包含了一个函数（Flink实现的或自己实现的，比如MapFunction，FilterFunction）的持续获得输入并且将结果输出出去的任务就好。

• 图中的Task表示一个节点，或者说是一个TaskManager中一个Slot执行的任务

• 流程图中红色代表这个方法在生成Transformation和实际运行时对Task产生的影响

DataStream

• Map

  DataStream<Integer> dataStream = //...dataStream.map(new MapFunction<Integer, Integer>() {    @Override
      public Integer map(Integer value) throws Exception {        return 2 * value;
      }
  });

  • Transformation: 生成一个OneInputTransformation并包含StreamMap算子

    
    

    StreamMapTransformation

  • Runtime:

    
    

    StreamMapTask

  • 消费一个元素并产出一个元素

  • 参数 MapFunction

  • 返回DataStream

  • 例子：

• FlatMap

  dataStream.flatMap(new FlatMapFunction<String, String>() {
      @Override
      public void flatMap(String value, Collector<String> out)
          throws Exception {        for(String word: value.split(" ")){
              out.collect(word);
          }
      }
  });

  • Transformation: 生成一个OneInputTransformation并包含StreamFlatMap算子

    
    

    StreamFlatMapTransformation

  • Runtime：

    
    

    StreamFlatMapTask

  • 消费一个元素并产生零到多个元素

  • 参数 FlatMapFunction

  • 返回 DataStream

  • 例子：

• Filter

  dataStream.filter(new FilterFunction<Integer>() {    @Override
      public boolean filter(Integer value) throws Exception {        return value != 0;
      }
  });

  • Transformation：生成一个OneInputTransformation并包含StreamFilter算子

    
    

    StreamFilterTransformation

  • Runtime：

    
    

    StreamFilterTask

  • 根据FliterFunction返回的布尔值来判断是否保留元素，true为保留，false则丢弃

  • 参数 FilterFunction

  • 返回DataStream

  • 例子：

• KeyBy

  dataStream.keyBy("someKey") // Key by field "someKey"dataStream.keyBy(0) // Key by the first element of a Tuple

  • Transformation: KeyBy会产生一个PartitionTransformation，并且通过KeySelector创建一个KeyGroupStreamPartitioner，目的是将输出的数据分区。此外还会把KeySelector保存到KeyedStream的属性中，在下一个Transformation创建时时将KeySelector注入进去。

    
    

    KeyByTransformation

  • Runtime: 生成StreamGraph时会将PartitionTransformation中的Partitioner 注入到StreamEdge当中，此外还会在下一个StreamNode创建过程中注入KeySelector用于提取元素的Key。之后将Partitioner注入StreamRecordWriter中用于将上一个Task的输出元素指定到某一个ResultSubParition中，此外KeySelector也被注入到下一个Task的算子当中。

    
    

    KeyBy Runtime

  • 根据指定的Key将元素发送到不同的分区，相同的Key会被分到一个分区（这里分区指的就是下游算子多个并行的节点的其中一个）。keyBy()是通过哈希来分区的。

  • 只能使用KeyedState（Flink做备份和容错的状态）

  • 参数 String，tuple的索引，覆盖了hashCode方法的POJO，不能使数组

  • 返回KeyedStream

  • 例子：

• WindowAll

  dataStream.windowAll(TumblingEventTimeWindows.of(Time.seconds(5))); // Last 5 seconds of data

  • Transformation：返回AllWindowedStream，不产生Transformation，详情见AllWindowedStream

  • Runtime：详情见AllWindowedStream

  • 将元素按照某种特性聚集在一起（如时间：滑动窗口，翻转窗口，会话窗口，又如出现次数：计数窗口）

  • 参数 WindowAssigner

  • 返回 AllWindowedStream

  • 例子：

• Union

  dataStream.union(otherStream1, otherStream2, ...);

  • Transformation: 从所有相关的stream中获取Transformation并注入到UnionTransformation的inputs中

    
    

    UnionTransformation

  • Runtime：这些Inputs会在下一个Transformation创建时被作为Input来穿件StreamEdge，如果上下游并行度一致则会生成ForwardPartitioner，不一致则是RebalancePartitioner。由于Partitioner是在处理下游Transformation生成的，所以这里没有图。

  • 将两个或多个datastream合并，创造一个新的流包含这些datastream的所有元素

  • 参数DataStream（一个或多个）

  • 返回UnionStream

  • 例子：

• Join

  dataStream.join(otherStream)
      .where(<key selector>).equalTo(<key selector>)
      .window(TumblingEventTimeWindows.of(Time.seconds(3)))
      .apply (new JoinFunction () {...});

  • Transformation：1. 调用join方法后生成JoinedStream，JoinedStream保存了两个input  2. 调用where方法生成一个内部类Where对象，注入KeySelector1 3. 调用equalTo生成内部类EqualTo对象，注入KeySelector2 4. 调用window升成内部静态类WithWindow，并且注入WindowAssigner（在该对象中还可以注入Trigger和Evictor 5. 最后调用apply方法将（Flat)JoinFunction注入并且用一个(Flat)JoinCoGroupFunction封装起来，而在这一步会将所有注入的对象用在coGroup上。详情见下一个Window CoGroup的解析。

  • Runtime： 与Window CoGroup相同，详情见下一个WIndow CoGroup解析

  • 将两个DataStream按照key和window join在一起

  • 参数：1. KeySelector1 2. KeySelector2 3. DataStream 4. WindowAssigner 5. JoinFunction/FlatJoinFunction

  • 返回DataStream

  • 例子：

• Window CoGroup

  dataStream.coGroup(otherStream)
      .where(0).equalTo(1)
      .window(TumblingEventTimeWindows.of(Time.seconds(3)))
      .apply (new CoGroupFunction () {...});

  • Transformation：生成一个TaggedUnion类型和unionKeySelector，里面分别包含了两个流的元素类型和两个流的KeySelector。将两个流通过map分别输出为类型是TaggedUnion的两个流（map详情见StreamMap），再Union在一起（详情见Union），再使用合并过后的流和unionKeySelector生成一个KeyedStream（详情见KeyBy），最后使用KeyedStream的window方法并传入WindowAssigner生成WindowedStream，并apply CoGroupFunction来处理（详情见WindowedStream Apply方法）。总体来说，Flink对这个方法做了很多内部的转换，最后生成了两个StreamMapTransformation，一个PartitionTransformation和一个包含了WindowOperator的OneInputTransformation。

    
    

    CoGroupTransformation

  • Runtime：参考每个Transformation对应的Runtime情况

  • 根据Key和window将两个DataStream的元素聚集在两个集合中，根据CoGroupFunction来处理这两个集合，并产出结果

  • 参数 1. DataStream 2. KeySelector1 3. KeySelector2 4. WindowAssigner 5. CoGroupFunction

  • 返回DataStream

  • 例子：

• Connect

  DataStream<Integer> someStream = //...DataStream<String> otherStream = //...ConnectedStreams<Integer, String> connectedStreams = someStream.connect(otherStream);

  • Transformation：在这一步会生成一个包含了两个DataStream的ConnectedStreams对象，不会有Transformation产生。详情见后续ConnectedStreams的API详解。

  • 将两个DataStream连接在一起，使得他们之间可以共享状态

  • 参数 DataStream

  • 返回ConnectedStreams

  • 例子：

• Split

  SplitStream<Integer> split = someDataStream.split(new OutputSelector<Integer>() {    @Override
      public Iterable<String> select(Integer value) {
          List<String> output = new ArrayList<String>();        if (value % 2 == 0) {
              output.add("even");
          }        else {
              output.add("odd");
          }        return output;
      }
  });

  • Transformation：在这一步会生成一个SplitTransformation，里面包含了OutputSelector。

    
    

    SplitTransformation

  • Runtime: 在生成StreamGraph时找到父Transformation，并将OutputSelector注入到父StreamNode中。生成JobGraph的时候在注入到对应的JobNode中，最后在运行时封装到OperatorChain的OutputCollector中并且注入算子。

    
    

    SplitRuntime

  • 按照一个规则将一个流的元素产出到两个或多个支流（每个元素可以发送到不止一个支流）

  • 参数 OutputSelector

  • 返回 SplitStream

  • 例子：

• Iterate

  IterativeStream<Long> iteration = initialStream.iterate();
  DataStream<Long> iterationBody = iteration.map (/*do something*/);
  DataStream<Long> feedback = iterationBody.filter(new FilterFunction<Long>(){    @Override
      public boolean filter(Integer value) throws Exception {        return value > 0;
      }
  });
  iteration.closeWith(feedback);
  DataStream<Long> output = iterationBody.filter(new FilterFunction<Long>(){    @Override
      public boolean filter(Integer value) throws Exception {        return value <= 0;
      }
  });

  • Iterate不展开讲解

  • 通过将一个算子的输出重定向到某个输入Operator上来创个一个循环。非常适合用来持续更新一个模型。

  • 过程 DataStream IterativeStream DataStream

  • 例子：

• ExtractTimestamps

  stream.assignTimestamps (new TimeStampExtractor() {...});

  • Transformation：assignTimestamps会将TimeStampExtractor注入进刚创建的ExtractTimestampsOperator，再通过ExtractTimestampsOperator生成一个OneInputTransformation

    
    

    ExtractTimestampsTransformation

  • Runtime：

    
    

    ExtractTimestampsTask

  • 从元素中提取timestamp来用作事件时间（EventTime）。

  • 参数 TimeStampExtractor

  • 返回 DataStream

  • 例子：

• Project

  DataStream<Tuple3<Integer, Double, String>> in = // [...]DataStream<Tuple2<String, Integer>> out = in.project(2,0);

  • Transformation：生成一个OneInputTransformation并包含StreamProjection算子

    
    

    StreamProjectionTransformation

  • Runtime

    
    

    StreamProjectionTask

  • 如果元素是Tuple，直接通过index提取出Tuple中的字段组成新的Tuple，并产出结果

  • 参数 Tuple中的index（int， 一个或多个）

  • 返回 DataStream

  • 例子：

• Custom partitioning

  dataStream.partitionCustom(partitioner, "someKey");dataStream.partitionCustom(partitioner, 0);

  • Transformation：partitionCustom类似于KeyBy，不过partitioner是由自己定制并且输出的不是KeyedStream。首先会通过KeySelector和用户实现的Partitioner生成一个CustomPartitionerWrapper（StreamPartitioner），再讲它注入到PartitionTransformation。

    
    

    CustomPartitioningTransformation

  • Runtime：将Partitioner注入StreamRecordWriter中用于将上一个Task的输出元素指定到某一个ResultSubParition中

    
    

    CustomPartitioningTask

  • 通过用户定义的流分区器（Partitioner）将每个元素传输到指定的subtask

  • 参数 Partitioner， Tuple索引/POJO属性名/KeySelector

  • 返回 DataStream

  • 例子：

• Random partitioning

  dataStream.shuffle();

  • Transformation: 将partitioner换成ShufflePartitioner，其余同上

  • Runtime：同上

  • 将元素按照均匀分布打散到下游

  • 返回 DataStream

  • 例子：

• Rebalancing (Round-robin partitioning)

  dataStream.rebalance();

  • Transformation: 将partitioner换成RebalancePartitioner，其余同上

  • Runtime：同上

  • 通过轮询调度（Round-robin）将元素均匀的分配到下游

  • 返回 DataStream

  • 例子

• Rescaling

  dataStream.rescale();

  • Transformation: 将partitioner换成RescalePartitioner，其余同上

  • Runtime：同上

  • 通过轮询调度将元素从上游的task一个子集发送到下游task的一个子集

  • 返回 DataStream

  • 原理：第一个task并行度为2，第二个task并行度为6，第三个task并行度为2。从第一个task到第二个task，Src的子集Src1 和 Map的子集Map1，2，3对应起来，Src1会以轮询调度的方式分别向Map1，2，3发送记录。从第二个task到第三个task，Map的子集1，2，3对应Sink的子集1，这三个流的元素只会发送到Sink1。
    假设我们每个TaskManager有三个Slot，并且我们开了SlotSharingGroup，那么通过rescale，所有的数据传输都在一个TaskManager内，不需要通过网络。

  • rescale.png

  • 例子

• Broadcasting

  dataStream.broadcast();

  • 将元素广播到每个分区

  • 返回DataStream

  • 例子：

KeyedStream

• Reduce

  keyedStream.reduce(new ReduceFunction<Integer>() {    @Override
      public Integer reduce(Integer value1, Integer value2)
      throws Exception {        return value1 + value2;
      }
  });

  • Transformation：生成一个OneInputTransformation并包含StreamGroupedReduce算子

    
    

    KeyedReduceTransformation

  • Runtime：

    
    

    KeyedReduceTask

  • 根据ReduceFunction将元素与上一个reduce后的结果合并，产出合并之后的结果。

  • 参数 ReduceFunction

  • 返回 DataStream

  • 例子：

• Fold

  DataStream<String> result =
    keyedStream.fold("start", new FoldFunction<Integer, String>() {
      @Override
      public String fold(String current, Integer value) {        return current + "-" + value;
      }
    });

  • Transformation：将StreamGroupedReduce换成StreamGroupedFold，其余同Reduce

  • Runtime：将StreamGroupedReduce换成StreamGroupedFold，其余同Reduce

  • 根据FoldFunction和初始值，将元素与上一个fold过后的结果合并，产出合并之后的结果。

  • 参数 FoldFunction

  • 返回 DataStream

  • 例子：

• Aggregations

  keyedStream.sum(0);keyedStream.sum("key");keyedStream.min(0);keyedStream.min("key");keyedStream.max(0);keyedStream.max("key");keyedStream.minBy(0);keyedStream.minBy("key");keyedStream.maxBy(0);keyedStream.maxBy("key");

  • Transformation：StreamGroupedReduce里注入了Flink内置的Aggregation方法实现，同Reduce

  • Transformation：同Reduce

  • Flink实现的一系列聚合方法，具体作用由方法名就可以得知

  • 返回 DataStream

  • 例子：

• Window

  dataStream.window(TumblingEventTimeWindows.of(Time.seconds(5))); // Last 5 seconds of data

  • Transformation: 生成一个WindowedStream，不产生Transformation，详情见WindowedStream详解

  • Runtime：详情见WindowedStream

  • 窗口将同一个key的元素按照某种特性聚集在一起（如时间：滑动窗口，翻转窗口，会话窗口，又如出现次数：计数窗口）

  • 返回WindowedStream

  • 参数WindowAssigner

  • 例子：

• Interval Join

  // this will join the two streams so that// key1 == key2 && leftTs - 2 < rightTs < leftTs + 2keyedStream.intervalJoin(otherKeyedStream)
      .between(Time.milliseconds(-2), Time.milliseconds(2)) // lower and upper bound
      .upperBoundExclusive(true) // optional
      .lowerBoundExclusive(true) // optional
      .process(new IntervalJoinFunction() {...});

  • 给定一个时间间隔，将两个流中的元素按照key来做join

  • 满足条件e1.timestamp + lowerBound <= e2.timestamp <= e1.timestamp + upperBound

  • 参数 1. KeyedStream 2. Time: LowerBound and UpperBound 3. boolean(optional) 4. boolean(optional) 5. IntervalJoinFunction

  • 返回DataStream

  • 例子：

WindowedStream

• Apply

  windowedStream.apply (new WindowFunction<Tuple2<String,Integer>, Integer, Tuple, Window>() {    public void apply (Tuple tuple,
              Window window,
              Iterable<Tuple2<String, Integer>> values,
              Collector<Integer> out) throws Exception {        int sum = 0;        for (value t: values) {
              sum += t.f1;
          }
          out.collect (new Integer(sum));
      }
  });

  • Transformation：

    
    

    WindowApplyTransformation

  • Runtime：

    
    

    WindowApply Task

  • 使用WindowFunction对window重的元素做处理（例如聚合操作）并产出结果

  • 参数 WindowFunction

  • 返回 DataStream

  • 例子：

• Reduce

  windowedStream.reduce (new ReduceFunction<Tuple2<String,Integer>>() {
      public Tuple2<String, Integer> reduce(Tuple2<String, Integer> value1, Tuple2<String, Integer> value2) throws Exception {        return new Tuple2<String,Integer>(value1.f0, value1.f1 + value2.f1);
      }
  });

  • Transformation：基本同上，将ReduceFunction注入到WindowOperator中（具体注入方式要看有没有evictor，这边不作赘述）。

  • Runtime：同上

  • 根据ReduceFunction将窗口中的元素按照key和window合并，并产出结果

  • 参数 ReduceFunction

  • 返回DataStream

  • 例子

• Aggregations

  windowedStream.sum(0);windowedStream.sum("key");windowedStream.min(0);windowedStream.min("key");windowedStream.max(0);windowedStream.max("key");windowedStream.minBy(0);windowedStream.minBy("key");windowedStream.maxBy(0);windowedStream.maxBy("key");

  • Transformation：WindowOperator里注入了Flink内置的Aggregation方法实现，其余同上

  • Runtime：同上

  • Flink实现的一系列聚合方法，具体作用由方法名就可以得知，需要注意的是他们被分别作用在按key和window分割过后的元素集合上

  • 返回 DataStream

  • 例子：

AllWindowedStream

• Apply

  // applying an AllWindowFunction on non-keyed window streamallWindowedStream.apply (new AllWindowFunction<Tuple2<String,Integer>, Integer, Window>() {    public void apply (Window window,
              Iterable<Tuple2<String, Integer>> values,
              Collector<Integer> out) throws Exception {        int sum = 0;        for (value t: values) {
              sum += t.f1;
          }
          out.collect (new Integer(sum));
      }
  });

  • Transformation：AllWindowedStream.apply()与WindowedStream.apply()基本是一致的，只是没有KeySelector

  • Runtime：通WindowedStream.apply()

  • 使用WindowFunction对window重的元素做处理（例如聚合操作）并产出结果

  • 与WindowedStream的区别在于是否有key

  • 参数 WindowFunction

  • 返回 DataStream

  • 例子

ConnectedStreams

• CoMap, CoFlatMap

  connectedStreams.map(new CoMapFunction<Integer, String, Boolean>() {    @Override
      public Boolean map1(Integer value) {        return true;
      }    
      @Override
      public Boolean map2(String value) {        return false;
      }
  });
  connectedStreams.flatMap(new CoFlatMapFunction<Integer, String, String>() {   @Override
     public void flatMap1(Integer value, Collector<String> out) {
         out.collect(value.toString());
     }   @Override
     public void flatMap2(String value, Collector<String> out) {       for (String word: value.split(" ")) {
           out.collect(word);
         }
     }
  });

  • Transformation：ConnectedStream并不会产生Transformation，只会保存两个Input DataStream，从inputs中的DataStream获取父Transformation，并生成一个CoStream(Flat)Map算子。KeySelector依赖于父Transformation注入（如果是PartitionTransformation的话）。

    
    

    Co(Flat)MapTransformation

  • Runtime: Task会具体负责调用processElement1方法还是processElement2方法。

    
    

    CoStream(Flat)MapTask

  • 同时对两个流进行Map或FlatMap操作

  • 参数 CoMapFunction, CoFlatMapFunction

  • 返回 DataStream

  • 例子：

SplitStream

• Select

  SplitStream<Integer> split;
  DataStream<Integer> even = split.select("even");
  DataStream<Integer> odd = split.select("odd");
  DataStream<Integer> all = split.select("even","odd");

  • Transformation：生成SelectTransformation，里面包含了OutputSelector

    
    

    SelectTransformation

  • Runtime：生成StreamGraph时会将OutputNames注入到新生成的StreamEdge中，然后注入到对应的JobEdge中，最后用它来生成OutputCollector中的outputMap，发送消息时根据相应的selectedName发送到相应的下游Task

    
    

    Select Runtime

  • 根据SplitStream中OutputSelector设定的规则获取一个或多个DataStream

  • 参数 OutputNames

  • 返回 DataStream

  • 例子：

作者：铛铛铛clark
链接：https://www.jianshu.com/p/a3f43f861a42