用户自定义 Functions
This documentation is for an unreleased version of Apache Flink. We recommend you use the latest stable version.

‘用户自定义 Functions’ #

大多数操作都需要用户自定义 function。本节列出了实现用户自定义 function 的不同方式。还会介绍 Accumulators（累加器），可用于深入了解你的 Flink 应用程序。

实现接口 #

最基本的方法是实现提供的接口：

class MyMapFunction implements MapFunction<String, Integer> {
  public Integer map(String value) { return Integer.parseInt(value); }
}
data.map(new MyMapFunction());

匿名类 #

你可以将 function 当做匿名类传递：

data.map(new MapFunction<String, Integer> () {
  public Integer map(String value) { return Integer.parseInt(value); }
});

Java 8 Lambdas #

Flink 在 Java API 中还支持 Java 8 Lambdas 表达式。

data.filter(s -> s.startsWith("http://"));

data.reduce((i1,i2) -> i1 + i2);

Rich functions #

所有需要用户自定义 function 的转化操作都可以将 rich function 作为参数。例如，你可以将下面代码

class MyMapFunction implements MapFunction<String, Integer> {
  public Integer map(String value) { return Integer.parseInt(value); }
}

替换成

class MyMapFunction extends RichMapFunction<String, Integer> {
  public Integer map(String value) { return Integer.parseInt(value); }
}

并将 function 照常传递给 map transformation:

data.map(new MyMapFunction());

Rich functions 也可以定义成匿名类：

data.map (new RichMapFunction<String, Integer>() {
  public Integer map(String value) { return Integer.parseInt(value); }
});

Lambda Functions #

正如你在上面的例子中看到的，所有的操作同可以通过 lambda 表达式来描述：

val data: DataStream[String] = // [...]
data.filter { _.startsWith("http://") }

val data: DataStream[Int] = // [...]
data.reduce { (i1,i2) => i1 + i2 }
// or
data.reduce { _ + _ }

Rich functions #

所有将 lambda 表达式作为参数的转化操作都可以用 rich function 来代替。例如，你可以将下面代码

data.map { x => x.toInt }

替换成

class MyMapFunction extends RichMapFunction[String, Int] {
  def map(in: String): Int = in.toInt
}

并将 function 传递给 map transformation:

data.map(new MyMapFunction())

Rich functions 也可以定义成匿名类:

data.map (new RichMapFunction[String, Int] {
  def map(in: String): Int = in.toInt
})

Back to top

累加器和计数器 #

累加器是具有加法运算和最终累加结果的一种简单结构，可在作业结束后使用。

最简单的累加器就是计数器: 你可以使用 Accumulator.add(V value) 方法将其递增。在作业结束时，Flink 会汇总（合并）所有部分的结果并将其发送给客户端。 在调试过程中或在你想快速了解有关数据更多信息时,累加器作用很大。

Flink 目前有如下内置累加器。每个都实现了 累加器 接口。

  • IntCounter , LongCounter 和 DoubleCounter : 有关使用计数器的示例，请参见下文。
  • 直方图 : 离散数量的柱状直方图实现。在内部，它只是整形到整形的映射。你可以使用它来计算值的分布，例如，单词计数程序的每行单词的分布情况。

如何使用累加器：

首先，在需要使用累加器的用户自定义的转换 function 中创建一个累加器对象（此处是计数器）。

private IntCounter numLines = new IntCounter();

其次，你必须在 rich function 的 open() 方法中注册累加器对象。也可以在此处定义名称。

getRuntimeContext().addAccumulator("num-lines", this.numLines);

现在你可以在操作 function 中的任何位置（包括 open() 和 close() 方法中）使用累加器。

this.numLines.add(1);

最终整体结果会存储在由执行环境的 execute() 方法返回的 JobExecutionResult 对象中（当前只有等待作业完成后执行才起作用）。

myJobExecutionResult.getAccumulatorResult("num-lines");

单个作业的所有累加器共享一个命名空间。因此你可以在不同的操作 function 里面使用同一个累加器。Flink 会在内部将所有具有相同名称的累加器合并起来。

定制累加器：

要实现自己的累加器，你只需要实现累加器接口即可。如果你认为自定义累加器应随 Flink 一起提供，请尽管创建 pull request。

你可以选择实现 Accumulator 或 SimpleAccumulator 。

Accumulator<V,R> 的实现十分灵活: 它定义了将要添加的值类型 V，并定义了最终的结果类型 R。例如，对于直方图，V 是一个数字且 R 是一个直方图。 SimpleAccumulator 适用于两种类型都相同的情况，例如计数器。

Back to top