Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Apache Maven Cookbook
  • Toc
  • feedback
Apache Maven Cookbook

Apache Maven Cookbook

By : Raghuram Bharathan
4.2 (5)
close
Apache Maven Cookbook

Apache Maven Cookbook

4.2 (5)
By: Raghuram Bharathan

Overview of this book

If you are a Java developer or a manager who has experience with Apache Maven and want to extend your knowledge, then this is the ideal book for you. Apache Maven Cookbook is for those who want to learn how Apache Maven can be used for build automation. It is also meant for those familiar with Apache Maven, but want to understand the finer nuances of Maven and solve specific problems.
Table of Contents (13 chapters)
close
close
Preface
Preface
What this book covers
What you need for this book
Who this book is for
Sections
Conventions
Reader feedback
Customer support
Free Chapter
1
1. Getting Started
chevron up
1. Getting Started
Introduction
Installing Maven on Microsoft Windows
Installing Maven on Mac OS X
Installing Maven on Linux
Changing the JDK used by Maven
Creating a simple project with Maven
Building a simple project with Maven
Changing the location of the Maven repository
Running Maven behind an HTTP proxy server
Understanding the standard directory layout
2
2. IDE Integration with Maven
2. IDE Integration with Maven
Introduction
Creating a new Maven project in Eclipse
Importing an existing Maven project in Eclipse
Creating a new Maven project in NetBeans
Importing an existing Maven project in NetBeans
Creating a new Maven project in IntelliJ IDEA
Importing an existing Maven project in IntelliJ IDEA
3
3. Maven Lifecycle
3. Maven Lifecycle
Introduction
Understanding the Maven lifecycle, phases, and goals
Understanding the pom file
Understanding Maven settings
Understanding command-line options in Maven
Understanding Maven profiles
Adding a new Maven profile
Activating/deactivating a Maven profile
Using properties in Maven
Specifying source encoding for platform-independent builds
4
4. Essential Maven Plugins
4. Essential Maven Plugins
Introduction
Using the Maven Clean plugin
Using the Maven Compiler plugin
Changing the compiler used by the Maven Compiler plugin
Specifying the Java version for the Compiler plugin
Using the Maven Surefire plugin to run unit tests
Using the Maven Failsafe plugin to run integration tests
Using the Maven Resources plugin
Filtering using resources
Using Eclipse to run Maven goals
Using NetBeans to run Maven goals
Using IntelliJ IDEA to run Maven goals
5
5. Dependency Management
5. Dependency Management
Introduction
Choosing the scope of dependency
Getting a report of dependencies
Getting into dependency and avoiding dependency hell
Downloading dependencies into a folder
Understanding SNAPSHOT dependencies
Handling dependency download errors
Detecting unused/undeclared dependencies
Manually installing dependencies that are not available in a repository
Dependency management using Eclipse
Dependency management using NetBeans
Dependency management using IntelliJ IDEA
6
6. Code Quality Plugins
6. Code Quality Plugins
Introduction
Analyzing code coverage with the Maven JaCoCo plugin
Analyzing code coverage with the Maven Cobertura plugin
Analyzing code with the Maven PMD plugin
Analyzing code with the Maven Checkstyle plugin
Analyzing code with the Maven FindBugs plugin
Generating source references with the Maven JXR plugin
Analyzing code with the Maven SonarQube plugin
7
7. Reporting and Documentation
7. Reporting and Documentation
Introduction
Documenting with the Maven Site plugin
Generating Javadocs for a site
Generating source cross-reference for a site
Generating unit test reports for a site
Generating code coverage reports for a site
Generating code quality reports for a site
Generating selective reports
Deploying a site
8
8. Handling Typical Build Requirements
8. Handling Typical Build Requirements
Introduction
Including and excluding additional resources
Including and excluding source files and folders
Configuring Maven to search for plugins
Working in offline mode
Controlling the verbosity of the Maven output
Using the Maven Help plugin
Using the Maven SCM plugin
Generating changelogs for a site
9
9. Multi-module Projects
9. Multi-module Projects
Introduction
Understanding project inheritance
Understanding project aggregation
Combining inheritance and aggregation
Performing multi-module dependency management
Performing multi-module plugin management
Selectively building modules
Reporting for multi-module projects
10
10. Java Development with Maven
10. Java Development with Maven
Introduction
Building a JAR project
Generating an executable JAR
Generating a JAR of the source code
Generating a JAR of the test classes
Building a WAR project
Building an EAR project
Building a pom project
Running a web project with Jetty
Running a web project with Tomcat
11
11. Advanced Maven Usage
11. Advanced Maven Usage
Introduction
Creating an assembly
Running a custom executable
Running an ANT task
Determining updates to Maven plugin AntRun
Determining updates to Maven dependencies
Controlling the constraints
Generating unique builds
Releasing a Maven project
12
Index
Index

Creating a simple project with Maven

Now that we have set up Maven on our favorite operating system and verified that it works fine, it is time to create a simple Java project.

Maven makes it easy to bootstrap a new project by creating a bunch of files and folders following accepted conventions.

How to do it...

Let's start creating the first simple project using Maven, by performing the following steps:

  1. Open a command prompt and change the directory to the folder in which you want to create your first Maven project.
  2. Run the following command:
    mvn archetype:generate -DgroupId=com.packt.cookbook -DartifactId=simple-project -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

    You can change the groupId and artifactId values in the preceding command as per your requirement.

  3. You will see Maven downloading a bunch of files:
    Downloading: https://repo.maven.apache.org/maven2/org/apache/maven/plugins/maven-clean-plugin/2.5/maven-clean-plugin-2.5.pom
Downloaded: https://repo.maven.apache.org/maven2/org/apache/maven/plugins/maven-clean-plugin/2.5/maven-clean-plugin-2.5.pom (4 KB at 1.4 KB/sec)
  4. Then it will start generating sources:
    [INFO] >>> maven-archetype-plugin:2.2:generate (default-cli) > generate-sources
@ standalone-pom >>>
  5. When Maven has completed generating sources, it will create the project that we want:
    [INFO] Using following parameters for creating project from Old (1.x) Archetype:
maven-archetype-quickstart:1.0
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.packt.cookbook
[INFO] Parameter: packageName, Value: com.packt.cookbook
[INFO] Parameter: package, Value: com.packt.cookbook
[INFO] Parameter: artifactId, Value: simple-project
[INFO] Parameter: basedir, Value: C:\projects\apache-maven-cookbook
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] project created from Old (1.x) Archetype in dir: C:\projects\apache-maven-cookbook\simple-project

Tip

Downloading the example code

You can download the example code files from your account at http://www.packtpub.com for all the Packt Publishing books you have purchased. If you purchased this book elsewhere, you can visit http://www.packtpub.com/support and register to have the files e-mailed directly to you.

How it works...

Did you get an while error running the preceding command to create your simple project?

One possibility is that your Maven is behind an HTTP proxy server. If so, see the Running Maven behind an HTTP proxy server recipe in this chapter.

Let's look at the folder structure that is created:

How it works...

You will notice the following things:

  • The Maven project configuration file pom.xml is created in the root of the simple-project folder. We will explore this file in detail in subsequent sections.
  • A bunch of folders are created:
    • src\main\java: This is for Java source files
    • src\test\java: This is for Java test source files
    • src\main\resources: This is for resource files for the project
    • src\test\resources: This is for resource files for the test
  • Within each of the preceding folders, a folder structure corresponding to the groupId (org.packt.cookbook) is created.

The following are essentially Maven conventions at work:

  • Maven expects all Java source files to reside in src\main\java
  • Similarly, it expects all Java test files to reside in src\test\java
  • It expects all project resources to reside in src\main\resources and test resources to reside in src\test\resources
  • It expects that source files will typically have the same package structure as the groupId parameter (though this is not mandatory)
  • Two sample classes, namely App.java and AppTest.java, are also created and it is not expected that they will be used beyond testing how Maven works

The mvn command that we used in the Creating a simple project with Maven recipe in this chapter, tries to invoke the generate goal of the archetype plugin with the specified command-line parameters.

The default Maven installation has minimal features. All features of Maven are available as Maven plugins. When given a plugin name, Maven knows where to download it from and then run it.

In this case, Maven downloads the archetype plugin. This plugin, in turn, can depend on another plugin. In this case, the latter plugin gets downloaded. This happens in a recursive fashion and, at the end of the process, all the relevant plugins required to run the specified command are downloaded.

These plugins are placed in your local repository, which is a location in your system. Once downloaded, these are never downloaded again unless deleted.

See also

  • The Running Maven behind an HTTP proxy server recipe in this chapter
End of Section 7
Next Section
bookmark search playlist download
font-size

Change the font size

margin-width

Change margin width

day-mode

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Delete Bookmark

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete