5. ETL Mavenプラグイン

ETL のExtractフェーズで使用する、Oracle SQL*Loader用のコントロールファイルの自動生成を行うMavenプラグインを提供する。

このプラグインを使用することで、入力ファイル及びワークテーブルに対応した Java Beansクラスを元に、Oracle SQL*Loader用のコントロールファイルが生成できる。 また、本プラグインはMavenプラグインとして提供するため、buildプロセス上に本プラグインを組み込むことができる。

なお、本プラグインはCSVフォーマット以外の形式には対応していない。

プラグインの実行イメージは以下のとおり。

../../_images/etl_maven_plugin.png

5.1. モジュール一覧

<plugin>
  <groupId>com.nablarch.etl</groupId>
  <artifactId>nablarch-etl-maven-plugin</artifactId>
</plugin>

補足

本プラグインは ETL 機能に依存している。適用プロジェクトでETL機能のバージョンを統一するために、プラグインのバージョン番号をnablarch-bomのバージョン番号と一致させること。

設定例を以下に示す。

<!-- 適用プロジェクトが使用するNablarchのバージョン指定 -->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.nablarch.profile</groupId>
      <artifactId>nablarch-bom</artifactId>
      <version>5u13</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<!-- pluginのバージョンをnablarch-bomと一致させる -->
<plugin>
  <groupId>com.nablarch.etl</groupId>
  <artifactId>nablarch-etl-maven-plugin</artifactId>
  <version>5u13</version>
</plugin>

5.2. 使用方法

5.2.1. コントロールファイルを生成するための設定を行う

指定したJava Beansクラスに設定された情報から、コントロールファイルを生成するために必要な情報を取得する。

Java Beansクラスから取得する情報は以下のとおり。

取得する情報 取得元
ワークテーブル名 Table のname属性より取得する。
入力ファイルの文字コード Csv のtype属性より取得する。
入力ファイルのヘッダレコードの有無 Csv のtype属性より取得する。
入力ファイルの項目の囲み文字 Csv のtype属性より取得する。
入力ファイルのフィールドの区切り文字 Csv のtype属性より取得する。
入力ファイルのレコードの区切り文字 Csv のtype属性より取得する。
入力ファイルの項目名リスト Csv のproperties属性より取得する。

Java Beansクラスの実装例を以下に示す。

ポイント
  • Java Beansクラスは、 WorkItem を継承すること。
@Entity
@Table(name = "sample_work")
@Csv(
        type = CsvType.DEFAULT,
        properties = {"userId", "name"}
)
public class Sample extends WorkItem {

    private String userId;

    private String name;

    // getter、setterは省略
}

続いて、pom.xmlにプラグインの設定を行う。

pom.xmlへの設定例を以下に示す。

ポイント
  • classes にはコントロールファイル生成対象のJava Beansクラス名をFQCNで指定する。
  • outputPath にはコントロールファイルの出力先ディレクトリを指定する。 未指定の場合は、target/etl/ctrl-file に出力される。
<plugin>
  <groupId>com.nablarch.etl</groupId>
  <artifactId>nablarch-etl-maven-plugin</artifactId>
  <version>1.0.0</version>
  <configuration>
    <!-- JavaBeansクラス名(FQCN) -->
    <classes>
      <param>sample.Bean1</param>
      <param>sample.Bean2</param>
    </classes>
    <!-- 出力先ディレクトリ -->
    <outputPath>etl/ctrl-file</outputPath>
  </configuration>
</plugin>

5.2.2. コントロールファイルを生成する

本プラグインの generate-ctrl-file ゴールを実行することでコントロールファイルが生成される。

mvn nablarch-etl:generate-ctrl-file

重要

本プラグインは、Java Beansクラスのclassファイルを元にコントロールファイルを生成する。 そのため、プラグイン実行前に必ずcompileを実施すること。

5.2.3. コンパイル時に自動的にコントロールファイルを生成する

コンパイル時に自動的に本プラグインを実行するように設定することで、 入力ファイルの仕様変更等でJava Beansクラスの定義を修正するたびに手動で本プラグインを実行する手間を省くことができる。

pom.xmlへの設定例を以下に示す。

<plugin>
  <groupId>com.nablarch.etl</groupId>
  <artifactId>nablarch-etl-maven-plugin</artifactId>
  <version>1.0.0</version>
  <configuration>
    <!-- 省略 -->
  </configuration>
  <executions>
    <execution>
      <id>generate-ctrl-file</id>
      <phase>compile</phase>
      <goals>
        <goal>generate-ctrl-file</goal>
      </goals>
    </execution>
  </executions>
</plugin>