sbt による Scala コードベースのビルド定義

sbt によるビルド定義方法（おさらい）

　sbt でのビルド定義方法として、以下の２つの方法があります。

1. ベースディレクトリ内の拡張子が .sbt のファイルに定義
2. project ディレクトリ内の拡張子が .scala のファイルに定義

1. の方法は、基本的なビルド管理に必要な最低限の設定のみが できるようになっています。通常はこちらのみの使用で特に問題ありません。
2. の方法は、sbt をscalaコードによってさらにカスタマイズして使用したり、「プロジェクト」という 概念を使用してより便利にビルド管理ができるようになっています。

今回は 2. の scala コードによるプロジェクト管理について解説します。

プロジェクトディレクトリの構成

　sbt で Scala コードベースのビルド定義を行う場合、プロジェクトディレクトリの下の project ディレクトリ配下に拡張子 .scala のファイルを配置します。
.scalaという拡張子であれば何でも良いのですが、慣習的にはBuild.scalaという名前で作成していますので、 本連載では Build.scala というファイル名でビルド定義を行います。
project/Build.scala を配置したプロジェクトの構成は、以下の通りとなります。

.
├── bin
│      ├── sbt
│      ├── sbt-launch.jar
│      └── sbt.bat
├── project
│      └── Build.scala
└── src
        ├── main
        │      └── scala
        └── test
                └── scala

Scala コードベースのビルド定義方法

まず、設定例を示します。

import sbt._
import Keys._

object MyBuild extends Build {
  lazy val root = Project(
    id = "root",
    base = file("."),
    settings = Project.defaultSettings ++ Seq(
      name := "scala-time-sample",
      version := "0.1",
      scalaVersion := "2.9.1",
      libraryDependencies ++= Seq(
        "org.scala-tools.time" % "time_2.9.1" % "0.5"
      )
    )
  )
}

Scala コードベースで ビルド管理を行うためには、project/Build.scala ファイル内で以下のことを行います。

• sbt.Build トレイトを継承したobjectを作成
• プロジェクト定義を行う

プロジェクト定義は、名前とディレクトリとその設定を指定する必要があります。 例1 のように Project オブジェクトの apply メソッドで下記のパラメータを指定します。

build.sbt の設定が存在する場合

• ./build.sbt に設定が存在する場合、 base が file(".") で定義されたプロジェクトの settings よりも優先される
• selenium/build.sbt に設定が存在する場合、 base が file("selenium") で定義されたプロジェクトの settings よりも優先される

複数のプロジェクトを定義してみよう

ここでは、複数のプロジェクトを定義する例を示します。

import sbt._
import Keys._

object MyBuild extends Build {

  lazy val root = Project(
    id = "root",
    base = file("."),
    settings = Project.defaultSettings ++ Seq(
      name := "rootProject"
    )
  )

  lazy val sub = Project(
    id = "sub",
    base = file("sub"),
    settings = Project.defaultSettings ++ Seq(
      name := "subProject"
    )
  )
}

.
├── bin
│      ├── sbt
│      ├── sbt-launch.jar
│      └── sbt.bat
├── project
│      └── Build.scala
├── src
│      ├── main
│      │      └── scala
│      └── test
│               └── scala
└── sub
        └── src
               ├── main
               │      └── scala
               └── test
                       └── scala

プロジェクトに対する操作を行う方法

sbt ではプロジェクトごとに compile や run といったコマンドを実行します。
デフォルトでは base が file(".") となっているプロジェクトが指定されます。プロジェクトを指定してコマンドを実行したい場合は、プロジェクトを指定して実行する方法と、現在のプロジェクトを変更する方法があります。

プロジェクトを指定して実行する方法

実行したいコマンドの前にプロジェクト名＋コロン（:）を付加することで、プロジェクトを指定することができます。
sub プロジェクトのコンパイル実行する例は以下のようになります。

現在のプロジェクトを変更する方法

現在のプロジェクトを変更することで、プロジェクトに合わせたコマンドを実行できます。 sub プロジェクトに切り替えてからコンパイル実行する例は以下のようになります。

プロジェクトの一覧と現在のプロジェクトを確認する場合は projects コマンドにより確認できます。

プロジェクト間に集約関係や依存関係を定義する

複数のプロジェクト間で、集約や依存といった関係を定義することができます。
プロジェクト定義の際に、 aggregate 指定をすると集約関係が定義できます。集約関係を定義すると、あるプロジェクトのコマンドを実行した際に、集約されている関係を持っているプロジェクトの同じコマンドを並列実行させることができます。
例. 2-1 のサンプルに対して、root プロジェクトから sub プロジェクトを集約する例は以下の通りです。

  lazy val root = Project(
    id = "root",
    base = file("."),
    settings = Project.defaultSettings ++ Seq(
      name := "rootProject"
    )
  ) aggregate(sub)

また、プロジェクト定義の際に、 deppendOn 指定をするとコードの依存関係が定義できます。依存関係を定義すると、あるプロジェクトのコンパイルを実行する際に、依存されている関係を持っているプロジェクトのコンパイルが行われます。
例. 2-1 のサンプルで、root プロジェクトに対して sub プロジェクトに依存関係を持たせる例は以下の通りです。

  lazy val root = Project(
    id = "root",
    base = file("."),
    settings = Project.defaultSettings ++ Seq(
      name := "rootProject"
    )
  ) deppendsOn(sub)

Build.scala で sbt の設定を書くとよい場合について

• Web 開発を行う場合、Web アプリケーションコードと、それに対する Selenium によるブラウザ操作によるテストを書く場合があります。sbt の場合、別プロジェクトで管理することで簡単にビルド管理できます。
• 任意の処理を行うコマンドやタスクを定義したい場合は、定義する方法があります。 その方法につきましては、次回以降の連載で解説予定です。
• 何かをコンパイルしてからこれもコンパイルしたいといった依存関係が発生する プロジェクト管理を行いたい場合は deppendsOn を使うとよいです。

まとめ

ここでは以下のことを解説しました

• scala コードベースのビルド定義によって、より自由なプロジェクト管理を行う方法
• マルチプロジェクトによるビルド定義方法
• マルチプロジェクトでビルド管理する利点

次回は、sbt プラグインの利用方法について解説します。

sbt による基本的なビルド定義方法

sbt でのビルド定義方法

　sbt でのビルド定義方法として、以下の２つの方法があります。

1. ベースディレクトリ内の拡張子が .sbt のファイルに定義
2. project ディレクトリ内の拡張子が .scala のファイルに定義

1. の方法は、基本的なビルド管理に必要な最低限の設定のみが できるようになっています。通常はこちらのみの使用で特に問題ありません。
2. の方法は、sbt をscalaコードによってさらにカスタマイズして使用したり、「プロジェクト」という 概念を使用してより便利にビルド管理ができるようになっています。

今回は 1. の .sbt ファイルを使用した基本的なプロジェクト管理について解説します。

build.sbt ファイルを使用した sbt 設定方法

　長々と説明するよりも、実際の.sbt ファイルによる設定例を示した方がわかりやすいので、 以下では実際にプロジェクト管理を行いながら具体的に説明します。

プロジェクトディレクトリの構成

build.sbt ファイルは、プロジェクトディレクトリの直下に配置します。 プロジェクトディレクトリについては、前回の連載を参考にしてください。
build.sbt ファイルを追加したプロジェクトの構成は、以下のようになります。

.
├── build.sbt
├── bin
│      ├── sbt
│      ├── sbt-launch.jar
│      └── sbt.bat
└── src
        ├── main
        │      └── scala
        └── test
                └── scala

build.sbt ファイルの基本的な設定例

　build.sbt の基本的な設定例を以下に示します。

name := "sbt-sample"

version := "0.1"

scalaVersion := "2.9.1"

上記の設定で build.sbt を保存後に sbt を起動すると、プロジェクト名が sbt-sample 、プロジェクトのバージョンが0.1 、プロジェクト内でビルド時に使用される Scala のバージョンが2.9.1に設定されて起動されます。

sbt を既に起動している場合、下記のように reload コマンドを行うことで、build.sbt などに書かれているプロジェクトの設定を読み込み直すことができます。

sbt によるライブラリ依存関係の解決方法

　続いて、プロジェクトで使用するライブラリの依存関係を解決する方法を解説します。
sbt では、ライブラリの依存関係を解決する方法として、以下の2つの方法があります。

1. プロジェクトディレクトリの中にlibを作成し、その中に依存するライブラリの jar ファイルを配置する
2. sbt の設定ファイルの中で libraryDependencies を設定する

1. の方法は、 Maven などのリポジトリに登録されていない独自ライブラリなどを使用する際に使用します。（ビルドの際、自動的にクラスパスが設定されます。）

本記事では、2. の libraryDependencies を使用した方法を解説します。
この方法の場合、 Maven の設定で使用されている、POM（Project Object Model）形式のライブラリ依存解決方法がそのまま使用できます。そのため、Maven リポジトリ上に存在するJava ライブラリであれば、設定を書くだけで依存関係を解決することができます。

sbt によるライブラリ依存関係解決例（libraryDependencies設定）

例として、 scala-time というライブラリを利用して、現在から半年後の日時を出力するプログラムを作成していきます。

プロジェクトディレクトリの構成

.
├── build.sbt
├── bin
│      ├── sbt
│      ├── sbt-launch.jar
│      └── sbt.bat
└── src
        ├── main
        │      └── scala
        │               └── Main.scala
        └── test
                └── scala

name := "scala-time-sample"

version := "0.1"

scalaVersion := "2.9.1"

libraryDependencies ++= Seq(
  "org.scala-tools.time" % "time_2.9.1" % "0.5"
)

import org.scala_tools.time.Imports._
import DateTime.now

object Main extends Application {
  println(now + 6.month)
}

Maven を使用した開発から移行する際のポイント

ライブラリの依存関係解決方法の比較

maven では、pom.xml の dependencies 要素の中に記述することでライブラリの依存関係を解決します。以下に例を示します。

<dependencies>
  <dependency>
    <groupId>postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>8.4-701.jdbc4</version>
  </dependency>
  <dependency>
    <groupId>c3p0</groupId>
    <artifactId>c3p0</artifactId>
    <version>0.9.1.2</version>
  </dependency>
</dependencies>

上記のサンプルを sbt で設定する場合、以下のようになります。

libraryDependencies ++= Seq(
  "postgresql" % "postgresql" % "8.4-701.jdbc4",
  "c3p0" % "c3p0" % "0.9.1.2"
)

リポジトリ追加方法の比較

maven では、pom.xml の repositories 要素の中に記述することでライブラリ取得先のリポジトリを追加します。以下に例を示します。

<repositories>
  <repository>
    <id>maven.seasar.org</id>
    <name>The Seasar Foundation Maven2 Repository</name>
    <url>http://maven.seasar.org/maven2</url>
  </repository>
  <repository>
    <id>maven-snapshot.seasar.org</id>
    <name>The Seasar Foundation Maven2 Snapshot Repository</name>
    <url>http://maven.seasar.org/maven2-snapshot</url>
  </repository>
</repositories>

上記のサンプルを sbt で設定する場合、以下のようになります。

resolvers ++= Seq(
  "The Seasar Foundation Maven2 Repository" at "http://maven.seasar.org/maven2",
  "The Seasar Foundation Maven2 Snapshot Repository" at "http://maven.seasar.org/maven2-snapshot"
)

既存の pom.xml を使用して sbt の依存関係定義を行う方法

既に Maven でプロジェクト管理を行っている場合、以下を build.sbt に記述することで依存関係定義が取り込まれます。

externalPom()

また、pom.xml ではなく、別名で管理している場合は以下のように記述します。

externalPom(baseDirectory(_ / "custom-name.xml"))

まとめ

ここでは以下のことを解説しました

• sbt を使用したJavaライブラリの依存関係の解決方法
• sbt によるビルド定義方法の種類
• build.sbt による基本的なビルド定義方法
• Maven を使用した開発から移行する際に参考となるポイント

次回は、scala コードベースのビルド定義によって、より自由なプロジェクト管理を行う方法について解説します。