Apache Maven

Build & PackagingBuild/Dependency ManagementJava

What it is

Apache Maven is a powerful build automation and project management tool for Java and other JVM-based languages. It provides a uniform build system, dependency management, and a project object model (POM) to define project structure, plugins, and external libraries.

Maven uses the Project Object Model (POM) to manage project configuration, dependencies, build plugins, and tasks. It supports standard lifecycles: clean, compile, test, package, verify, install, and deploy.

Installation

https://maven.apache.org/install.html

Getting started

The smallest useful thing you can do with it, and what each part means.

Creating a new Maven project

java

mvn archetype:generate -DgroupId=com.example -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Generates a basic Java project structure with POM and source folders.

Compiling a Maven project

java

mvn compile

Compiles source code and resolves dependencies defined in pom.xml.

Running tests

java

mvn test

Executes unit tests using configured testing framework (e.g., JUnit).

Advanced usage

Where the library earns its place over a simpler alternative.

Packaging a project

java

mvn package

Compiles, runs tests, and packages the project into a JAR or WAR file as defined in the POM.

Installing to local repository

java

mvn install

Installs the built artifact into the local Maven repository (~/.m2/repository) for use by other projects.

Adding dependencies

java

1234567<dependencies>
  <dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.13.0</version>
  </dependency>
</dependencies>

Declares a dependency in pom.xml so Maven downloads and manages the library automatically.

Running custom plugins

java

mvn clean verify -Pproduction

Executes custom plugins and profiles for complex builds or environment-specific tasks.

Errors and fixes

The failures you are most likely to hit, and what actually resolves them.

DependencyResolutionException: Occurs when Maven cannot resolve a dependency. Check the groupId, artifactId, version, and repository availability.
PluginExecutionException: Occurs when a Maven plugin fails during execution. Verify plugin configuration and version compatibility.
BuildFailureException: Occurs if compilation, tests, or packaging fails. Review logs, fix code or configuration issues.

Best practices

Keep POM files organized and modular using parent/child projects.
Use dependency management to handle versions consistently across modules.
Leverage Maven profiles to differentiate builds for dev, test, and production.
Use the Maven Central repository or private artifact repositories for dependencies.
Regularly update Maven plugins and dependencies to maintain compatibility.

Background

Why it exists, and what it was reacting to.

Maven was created by the Apache Software Foundation to simplify Java project builds, dependency resolution, and lifecycle management. It standardizes the build process, encourages best practices, and integrates with continuous integration tools, making it a cornerstone in modern Java development.

← All Java libraries Java guide

Apache Maven

Gradle