What is Apache Maven and why do we need it?
I was going to write a blog post about Spring framework but I thought maybe it’s better to start with Maven as the first step.
With an increase in the number of Java libraries and frameworks and projects, there was a need for a standard way of describing how a piece of software should be built and what are it’s dependencies. Normally a Java project is using a lot of frameworks and tools (e.g. Logging, Database, Encryption, Math, …). We need a standard (machine-readable) way of describing these dependencies and how to compile and build the project.
Using Maven enforces a specific directory structure to your project. There is a specific directory path for your source code, runtime resource files, … Another change in your project is adding a file named pom.xml which will describe dependencies and build options.
I will explain some basic concepts in the Maven world, then will proceed to create a new project based on Maven.
An Artifact, is a JAR file which is available for use in a Java project. Artifacts can be downloaded from Maven Repository (a publicly available website), but normally this is done automatically by maven command line.
Each Artifact represents a small piece of software that can be re-used in a software project. For example, there are artifacts for logging and encryption. There are a number of Maven repositories available, but the well-known repository is the one provided by Maven itself which is available for search and browse at http://search.maven.org/. You can search for artifacts and download them. You also have a local repository which contains JAR files downloaded from remote repositories or installed locally.
Each artifact is uniquely identified by using 3 elements: group-id, artifact-id and version.
Group-id represents the name of the company or organization which has produced the artifact (e.g. org.apache.logging.log4j). Artifact-id is a unique string for the artifact (e.g. log4j) and version string (e.g. 1.2.17). When you specify your project’s dependencies, you have to write their Group-id, artifact-id and version.
You can also tell Maven to produce an artifact when compiling your project. The result will be a .jar file including metadata about the artifact. You can then install this jar file into a Maven repository and use it as a dependency in other projects.
A build lifecyle is a set of steps (phases) which Maven does to build the project. You can define your own lifecycle but the default lifecycle is used most of the time. Here is a list of most important phases in the default lifecycle:
- validate: Make sure project structure is correct and all required data are available
- compile: Compile source code files
- test: Run unit test files
- package: Package compiled files in a distributable format (e.g. JAR)
- install: Install package into the local repository.
There is also another important lifecycle named “
clean“. This lifecycle will clean-up artifacts created during build lifecycle.
You can call Maven command like tool and give the name of the phase or lifecycle to execute:
mvn clean package
Above command will run
clean lifecycle and then will run build lifecycle up to ‘
package‘ step. The target of the operation is the current directory.
Maven expects a standard project structure in your project. You have to follow this structure:
Suppose the root directory of the project is named ‘
myapp/src/main/java/com/mahdix/App.java: Source code files should reside in this location and below, according to your package names.
myapp/src/test/java/com/mahdix/Test.java: Location for test files
You will run Maven command line utility on the root directory of the project where there is
Here is the general structure of a
<project xmlns="maven.apache.org/POM/4.0.0"> <modelVersion>4.0.0</modelVersion> <groupId>com.mahdix</groupId> <artifactId>my-app</artifactId> <version>1.0</version> <packaging>jar</packaging> <name>Test Application</name> <url>mahdix.com</url> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.8.2</version> </dependency> </dependencies> </project>
Here is explanation of important parts:
modelVersion: Specifies the model version of the Maven tool we use, this should always be 4.0.0
groupId, artifactId, version: These tags specify information about the current project
dependencies: This tag lists dependencies of the project. Maven will automatically fetch, download and install required JAR files according to the dependency list provided. You just need to specify artifacts that you need.