About

ドキュメント

Javadocs

プロジェクト文書

Built by Maven

目次

概要

Domaを利用するアプリケーションを、AntもしくはMavenによってビルドする方法を示します。

2011年8月現在、JDK6のjavacにはaptに関するバグがあることが判明しています。 ここでは、このバグの回避を考慮に入れて解説します。

なお、このバグはJDK7のjavacでは解決されています。

javacのバグについて

バグは、Bug DatabaseにBug ID 6403465として登録されています。 このバグの内容は、一言で言うと、本来はコンパイルエラーでないものがエラーとして報告されるというものです。

回避方法の1つは、誤って報告されるエラーメッセージを単に無視することです。

このバグの現象は、aptにより生成されるJavaコードに依存するコードをjavacの対象にすると起こります（aptにより生成されるJavaコードと依存するコードが異なるパッケージの場合にのみ起きます）。 たとえば、javacは、以下のコードに対し間違ったエラー報告をします（EmployeeDaoImplというクラスがaptにより生成されると前提します）。 

package tutorial.service;

import tutorial.dao.EmployeeDao;
import tutorial.dao.EmployeeDaoImpl;
import tutorial.entity.Employee;

public class TutorialService {

    public Employee selectById(Integer id) {
        EmployeeDao dao = new EmployeeDaoImpl();
        return dao.selectById(id);
    }
}

javacから出力される間違ったエラー報告とは次のようなものです。 

tutorial\service\TutorialService.java:19: シンボルを見つけられません。
シンボル: クラス EmployeeDaoImpl
場所    : tutorial.dao の パッケージ
import tutorial.dao.EmployeeDaoImpl;
                   ^

このメッセージが出力されても、実際にはコンパイルは成功しています。

もう1つの回避方法は、aptにより生成されるJavaコードに直接依存するコードを書かないことです。 この方法を利用する場合、aptにより生成されるJavaコードのクラスには実行時にリフレクションを使ってアクセスする必要があります。 この場合、自前でファクトリクラスを作成するか、Seasar2やSpring Frameworkといった汎用的なDIコンテナを活用することを推奨します。

Antによるビルド

Antでビルドを行うには、あらかじめAntをインストールしてください。 Ant 1.7で動作を確認しています。

Antでビルドを行う際のポイントを示します。

  • クラスパスには、doma-x.x.x.jarを指定する
  • コンパイル前にSQLファイルをクラスが出力されるディレクトリにコピーする
  • javacの-sオプションを使い、aptで生成されるコードの出力先ディレクトリを指定する

サンプルのビルドファイルを示します。このビルドファイルは、チュートリアルの配布ファイルに含まれるものです。 チュートリアルはダウンロードページからダウンロードできます。 

<project name="doma-tutorial" default="jar" basedir=".">

    <property name="dest" value="target/build"/>
    <property name="apt_generated" value="target/apt_generated"/>
    <property name="src" value="src/main/java"/>
    <property name="resources" value="src/main/resources"/>

    <path id="classpath">
        <fileset dir="lib" includes="*.jar"/>
    </path>

    <target name="jar" depends="clean,copy,compile">
        <jar jarfile="target/doma-tutorial.jar" basedir="${dest}" />
    </target>

    <target name="clean">
        <delete dir="target" failonerror="false"/>
        <mkdir dir="target"/>
        <mkdir dir="${dest}"/>
        <mkdir dir="${apt_generated}"/>
    </target>

    <target name="compile">
        <javac fork="yes" compiler="javac1.6" debug="on" encoding="UTF-8"
            classpathref="classpath" srcdir="${src}" destdir="${dest}">
            <compilerarg line="-s ${apt_generated}" />
        </javac>
    </target>

    <target name="copy">
        <copy todir="${dest}" filtering="true">
            <fileset dir="${resources}">
                <include name="META-INF/**" />
            </fileset>
        </copy>
    </target>
</project>

javacタスク実行時にはjavacのバグによりエラーメッセージが誤って報告されますが、「BUILD SUCCESSFUL」というメッセージとともにAntの実行が終了すれば、ビルドは成功しています。

Antを使ったWebアプリケーションのビルドについては、Doma JPetStoreの配布ファイルに含まれるbuild.xmlを参考にしてください。 Doma JPetStoreはダウンロードページからダウンロードできます。

Mavenによるビルド

Mavenでビルドを行うには、あらかじめMavenをインストールしてください。 Maven 3.0.3で動作を確認しています。

Mavenでビルドを行う際のポイントを示します。

  • 依存関係の設定でdomaへの依存を指定する
  • maven-resources-pluginを使いSQLファイルのコピーを行う
  • 上記処理後、maven-processor-pluginでapt処理を行う
  • 上記処理後、maven-compiler-pluginを使いコンパイルを行う（ただし、aptの処理は行わない。つまり、compilerArgumentで-proc:noneを指定する）

サンプルのpom.xmlの抜粋を示します。pom.xmlは、チュートリアルに含まれるものです。 チュートリアルはダウンロードページからダウンロードできます。 

<plugin>
    <groupId>org.bsc.maven</groupId>
    <artifactId>maven-processor-plugin</artifactId>
    <version>2.0.5</version>
    <executions>
        <execution>
            <id>process</id>
            <goals>
                <goal>process</goal>
            </goals>
            <phase>process-resources</phase>
            <configuration>
                <outputDirectory>${project.build.directory}/apt_generated</outputDirectory>
                <failOnError>false</failOnError>
            </configuration>
        </execution>
    </executions>
</plugin>

failOnErrorにはfalseを指定してください。 javacのバグにより報告されるエラーによって処理を中断しないようにするためです。

この例では使用していませんが、aptにパラメータを渡す場合にはmaven-processor-pluginのcompilerArguments要素を使ってください。

Mavenを使ったWebアプリケーションのビルドについては、Doma JPetStoreの配布ファイルに含まれるpom.xmlを参考にしてください。 Doma JPetStoreはダウンロードページからダウンロードできます。

Gradleによるビルド

Gradle 1.6で動作確認しています。

Gradleでビルドを行う際のポイントを示します。

  • JavaクラスとSQLファイルの出力先ディレクトリを同じにする
  • コンパイルより前にSQLファイルを出力先ディレクトリにコピーする
  • 依存関係の設定でdomaへの依存を指定する

サンプルのbuild.gradleを示します。このファイルはチュートリアルに含まれています。 

apply plugin: 'java'

sourceCompatibility = targetCompatibility = 1.6
[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
// JavaクラスとSQLファイルの出力先ディレクトリを同じにする
processResources.destinationDir = compileJava.destinationDir
// コンパイルより前にSQLファイルを出力先ディレクトリにコピーするために依存関係を逆転する
compileJava.dependsOn processResources

def aptGeneratePath = 'build/apt_generated'
compileJava.options.compilerArgs = ['-s', aptGeneratePath]
new File(aptGeneratePath).mkdirs()

repositories {
  mavenLocal()
  mavenCentral()
  // domaのMavenリポジトリを指定する
  maven {url 'http://maven.seasar.org/maven2'}
}

dependencies {
  // domaへの依存を指定する
  compile 'org.seasar.doma:doma:1.31.0'
  compile 'com.h2database:h2:1.3.171'
  testCompile 'junit:junit:3.8.2'
}

Java6でビルドする場合は、javacのバグについても参照ください。

Java7以上でビルドする場合は、javacの警告についても参照ください。