1. プロジェクトのセットアップ
  2. IDE セットアップ

IDE セットアップ

以下の章では、Flink自身の開発のためにFlinkのプロジェクトをIDEにインポートする方法を説明します。Flinkプログラムを書くことについては、Java API および Scala API クイックスタート ガイドを参照してください。

注意: IDEにバグがあるか適切にセットアップされていないかもしれないため、IDE内で何かが動作しない時はいつでも最初にMavenコマンドを使って試してください (mvn clean package -DskipTests)。

準備

開始するために、まずFlinkのソースをリポジトリからチェックアウトしてください。例えば、

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

IntelliJ IDEA

Flinkコアの開発のためにIntelliJ IDEA IDEをセットアップする方法の短いガイド。Eclipse はScala/Javaプロジェクトの混合に問題があると知られているため、ますます多くの貢献者がIntelliJ IDEAに移ってきています。

以下のドキュメントはFlinkソースと一緒にIntelliJ IDEA 2016.2.5 (https://www.jetbrains.com/idea/download/) をセットアップする段階を説明します。

Scala プラグインのインストール

IntelliJのインストールのセットアップはScalaプラグインのインストールを提供します。インストールされていない場合は、Scalaプロジェクトとファイルのサポートを有効にするために、Flinkのインポートの前にこれらの指示にしたがってください:

  1. IntelliJ プラグイン 設定 (IntelliJ IDEA -> Preferences -> Plugins) に行き、“Install Jetbrains plugin…” をクリックします。
  2. “Scala” プラグインを選択し、インストールします。
  3. IntelliJを再起動します。
  1. IntelliJ IDEA を開始し、“Import Project”を選択します。
  2. Flinkリポジトリのルートフォルダを選択します。
  3. “Import project from external model” を選択し、“Maven”を選択します。
  4. デフォルトのオプションのままで、SDKのセクションに達するまで “Next” をクリックします。
  5. SDKが無い場合、左上の “+” 記号を使って作り、“JDK”をクリックし、JDKのホームディレクトリを選択し、“OK” をクリックします。そうでなければ、単純にSDKを選択します。
  6. “Next” を再びクリックすることで続け、インポートを完了します。
  7. インポートされたFlinkの上で右クリックし、project -> Maven -> Generate Sources and Update Folders を選択します。これはローカルのMavenリポジトリ、つまり “/home/-your-user-/.m2/repository/org/apache/flink/” にFlinkのライブラリをインストールするだろうことに注意してください。別のやり方として、mvn clean package -DskipTests もIDEと連携するために必要なファイルを生成しますが、ライブラリをインストールしません。
  8. プロジェクトをビルドします (Build -> Make Project)

Checkstyle

IntelliJ は Checkstyle-IDEA プラグインを使ってIDE内のcheckstyleをサポートします。

  1. IntelliJプラグインのリポジトリから “Checkstyle-IDEA” プラグインをインストールします。
  2. Settings -> Other Settings -> Checkstyle に行くことでプラグインを設定します。
  3. “Scan Scope” を “Only Java sources (including tests)” に設定します。
  4. “Checkstyle Version”のドロップダウン内の 8.4 を選択し、applyをクリックします。このステップは重要です。スキップしないでください！
  5. “Configuration File” ペインの中で、+アイコンを使って新しい設定を追加します:
    1. “Description” を “Flink” に設定します。
    2. “Use a local Checkstyle file” を選択し、リポジトリ内の"tools/maven/checkstyle.xml" を指し示します。
    3. “Store relative to project location” についてのボックスにチェックを付け、“Next” をクリックします。
    4. “checkstyle.suppressions.file” プロパティの値を "suppressions.xml" に設定し、“Next” に続けて “Finish” をクリックします。
  6. 唯一有効な設定ファイルとして “Flink” を選択し、“Apply” および “OK” をクリックします。
  7. Checkstyle はこれで全ての Checkstyle 違反についてエディタ内で警告を出すでしょう。

一旦プラグインがインストールされると、Schemeドロップボックスの隣のSettings -> Editor -> Code Style -> Java -> Gear アイコンに行くことで"tools/maven/checkstyle.xml" を直接インポートすることができます。これは例えば自動的にインポートの配置を調整するでしょう。

Checkstyle ツール ウィンドウを開き “Check Module” ボタンをクリックすることで、モジュール全体を走査することができます。その走査ではエラーの報告があってはいけません。

注意 幾つかのモジュールは checkstyle によって完全にはカバーされません。flink-core, flink-optimizer および flink-runtime が含まれます。それでもこれらのモジュールに追加/修正したコードがそれでもやはりcheckstyle のルールに確実に準拠するようにしてください。

Eclipse

注意: 経験上、Scala IDE 3.0.3とバンドルされている古いEclipseのバージョンでの不足、あるいはScala IDE 4.4.1 のバンドルされているScalaのバージョンとのバージョンの非互換性が原因で、このセットアップはFlinkと連携しません。

代わりに IntelliJ を使うことをお勧めします (上を見てください)

上に戻る

TOP
inserted by FC2 system