Running most of the examples in this book will not require any additional dependencies in terms of special libraries. In some cases, though, we might need to show how a Scala code is unit tested, which will require us to use a testing framework. Also, later we might present some real-life use cases in which an additional library is used. Dealing with dependencies nowadays is done using specialized tools. They usually are interchangeable, and which one to use is a personal choice. The most popular tool used with Scala projects is
SBT, but Maven
is also an option, and there are many others out there as well.
Modern IDEs provide the functionality to generate the required build configuration files, but we will give some generic examples that could be useful not only here, but in future projects. Depending on the IDE you prefer, you might need to install some extra plugins to have things up and running, and a quick Google search should help.
SBT stands for Simple Build Tool and uses the Scala syntax to define how a project is built, managing dependencies, and so on. It uses .sbt
files for this purpose. It also supports a setup based on Scala code in .scala
files, as well as a mix of both.
To download SBT, go to http://www.scala-sbt.org/download.html.
The following screenshot shows the structure of a skeleton SBT project:
It is important to show the contents of the main .sbt
files.
The version.sbt
file looks as follows:
It contains the current version that is automatically incremented if a release is made.
The assembly.sbt
file has the following contents:
It contains information about how to build the assembly JAR—a merge strategy, final JAR name, and so on. It uses a plugin called sbtassembly
(https://github.com/sbt/sbt-assembly).
The build.sbt
file is the file that contains the dependencies of the project, some extra information about the compiler, and metadata. The skeleton file looks as follows:
As you can see, here we define the Java version against which we compile some manifest information and the library dependencies.
The dependencies for our project are defined in the libraryDependencies
section of our SBT file. They have the following format:
If we decide to separate groupId
and artifactId
with %%
instead of %
, SBT will automatically use scalaVersion
and append _2.11
(for Scala 2.11.*) to artifactId
. This syntax is usually used when we include dependencies written in Scala, as the convention there requires us to have the Scala version added as part of artifactId
. We can, of course, manually append the Scala version to artifactId
and use %
.
Note
The shown dependencies will not be needed at any point in this book (the one for Spark and the Datastax one). They are here just for illustration purposes, and you can safely remove them if not needed.
SBT requires each statement to be on a new line and to be separated with a blank line from the previous one if we work with .sbt
files. When using .scala
files, we just write code in Scala.
The %%
syntax in the dependencies is a syntactic sugar, which using scalaVersion
, will replace the name of the library, for example spark-core
will become spark-core_2.11
in our case.
SBT allows the engineer to express the same things differently. One example are the preceding dependencies—instead of adding a sequence of dependencies, we can add them one by one. The final result will be the same. There is also a lot of flexibility with other parts of SBT. For more information on SBT, refer to the documentation.
The project/build.properties
defines the sbt
version to be used when building and interacting with the application under sbt
. It is as simple as the following:
Finally, there is the project/plugins.sbt
file that defines different plugins used to get things up and running. We already mentioned (sbtassembly
):
There are different plugins online that provide useful functionalities. Here are some common sbt
commands that can be run from the root folder in the terminal of this skeleton project:
Tip
Useful SBT commands
sbt
: This opens the sbt console for the current project. All of the commands that will follow can be issued from here by omitting the sbt
keyword.sbt test
: This runs the application unit tests.sbt compile
: This compiles the application.sbt assembly
: This creates an assembly of the application (a fat JAR) that can be used to run as any other Java JAR.
Maven holds its configuration in files named pom.xml
. It supports multimodule projects easily, while for sbt, there needs to be some extra work done. In Maven, each module simply has its own child pom.xml
file.
To download Maven, go to https://maven.apache.org/download.cgi.
The next screenshot shows the structure of a skeleton Maven project:
The main pom.xml
file is much longer than the preceding sbt solution. Let's have a look at its parts separately.
There is usually some metadata about the project and different properties that can be used in the POM files in the beginning:
Then, there are the dependencies:
Finally, there are the build definitions. Here, we can use various plugins to do different things with our project and give hints to the compiler. The build definitions are enclosed in the <build>
tags.
First, we specify some resources:
The first plugin we have used is scala-maven-plugin
, which is used when working with Scala and Maven:
Then, we use scalatest-maven-plugin
to enable unit testing with Scala and Maven:
Finally, we have the maven-assembly-plugin
that is used for building the fat JAR of the application:
The complete pom.xml
file is equivalent to the preceding sbt files that we presented.
As before, the Spark and Datastax dependencies are here just for illustration purposes.
Tip
Useful Maven commands
mvn clean test
: This runs the application unit testsmvn clean compile
: This compiles the applicationmvn clean package
: This creates an assembly of the application (a fat JAR) that can be used to run as any other Java JAR
In this book, we will be using Maven for dependency management and creating our projects. It is interchangeable with SBT, and our source code will not depend on which build system we choose. You can easily translate the .pom
files to .sbt
files using the skeleton that we've provided. The only difference will really be the dependencies and how they are expressed.