从源码构建 Flink

This page covers how to build Flink 1.12-SNAPSHOT from sources.

In order to build Flink you need the source code. Either download the source of a release or clone the git repository.

In addition you need Maven 3 and a JDK (Java Development Kit). Flink requires at least Java 8 to build.

NOTE: Maven 3.3.x can build Flink, but will not properly shade away certain dependencies. Maven 3.2.5 creates the libraries properly. To build unit tests use Java 8u51 or above to prevent failures in unit tests that use the PowerMock runner.

To clone from git, enter:

git clone https://github.com/apache/flink

The simplest way of building Flink is by running:

mvn clean install -DskipTests

This instructs Maven (mvn) to first remove all existing builds (clean) and then create a new Flink binary (install).

To speed up the build you can skip tests, QA plugins, and JavaDocs:

mvn clean install -DskipTests -Dfast

先决条件

  1. 构建Flink

    如果您想构建一个可用于pip安装的PyFlink包,您需要先构建Flink工程,如构建Flink中所述。

  2. Python的版本为3.5, 3.6 或者 3.7.

     $ python --version
     # the version printed here must be 3.5, 3.6 or 3.7
    
  3. 构建PyFlink的Cython扩展模块(可选的)

    为了构建PyFlink的Cython扩展模块,您需要C编译器。在不同操作系统上安装C编译器的方式略有不同:

    • Linux Linux操作系统通常预装有GCC。否则,您需要手动安装。例如,您可以在Ubuntu或Debian上使用命令sudo apt-get install build-essential安装。

    • Mac OS X 要在Mac OS X上安装GCC,您需要下载并安装 Xcode命令行工具,该工具可在Apple的开发人员页面中找到。

    您还需要使用以下命令安装依赖项:

     $ python -m pip install -r flink-python/dev/dev-requirements.txt
    

安装

进入Flink源码根目录,并执行以下命令,构建PyFlink的源码发布包和wheel包:

cd flink-python; python setup.py sdist bdist_wheel

构建好的源码发布包和wheel包位于./flink-python/dist/目录下。它们均可使用pip安装,比如:

python -m pip install dist/*.tar.gz

Dependency Shading

Flink shades away some of the libraries it uses, in order to avoid version clashes with user programs that use different versions of these libraries. Among the shaded libraries are Google Guava, Asm, Apache Curator, Apache HTTP Components, Netty, and others.

The dependency shading mechanism was recently changed in Maven and requires users to build Flink slightly differently, depending on their Maven version:

Maven 3.1.x and 3.2.x It is sufficient to call mvn clean install -DskipTests in the root directory of Flink code base.

Maven 3.3.x The build has to be done in two steps: First in the base directory, then in the distribution project:

mvn clean install -DskipTests
cd flink-dist
mvn clean install

Note: To check your Maven version, run mvn --version.

Back to top

Hadoop Versions

Please see the Hadoop integration section on how to handle Hadoop classes and versions.

Scala Versions

Info Users that purely use the Java APIs and libraries can ignore this section.

Flink has APIs, libraries, and runtime modules written in Scala. Users of the Scala API and libraries may have to match the Scala version of Flink with the Scala version of their projects (because Scala is not strictly backwards compatible).

Since version 1.7 Flink builds with Scala version 2.11 (default) and 2.12.

To build FLink against Scala 2.12, issue the following command:

mvn clean install -DskipTests -Dscala-2.12

Back to top

Encrypted File Systems

If your home directory is encrypted you might encounter a java.io.IOException: File name too long exception. Some encrypted file systems, like encfs used by Ubuntu, do not allow long filenames, which is the cause of this error.

The workaround is to add:

<args>
    <arg>-Xmax-classfile-name</arg>
    <arg>128</arg>
</args>

in the compiler configuration of the pom.xml file of the module causing the error. For example, if the error appears in the flink-yarn module, the above code should be added under the <configuration> tag of scala-maven-plugin. See this issue for more information.

Back to top