Book Image

Mastering Apache Maven 3

Book Image

Mastering Apache Maven 3

Overview of this book

Related Content you might be interested in

Current Title:

Small book image
Mastering Apache Maven 3
Dec, 2014 | 298 pages
No titles found
Table of Contents (16 chapters)
Credits
Credits
About the Author
About the Author
Acknowledgments
Acknowledgments
About the Reviewers
About the Reviewers
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Apache Maven Quick Start
Apache Maven Quick Start
A quick introduction
Installing Apache Maven
Configuring the heap size
Monitoring the build
Remote debugging
Convention over configuration
IDE integration
Troubleshooting
Summary
2
Demystifying Project Object Model
Demystifying Project Object Model
Project Object Model
The POM hierarchy
Super POM
POM extending and overriding
Maven coordinates
Parent POM file
Managing POM dependencies
Summary
3
Maven Configuration
Maven Configuration
Maven Wagon
Proxy authentication
Secured repositories
Encrypting credentials in settings.xml
Source Control Management systems
Local repository location
Mirrored repositories
Deploying artifacts
Enabling Maven logging
Summary
4
Build Lifecycles
Build Lifecycles
Standard lifecycles in Maven
Lifecycle bindings
Building a custom lifecycle
Lifecycle extensions
Summary
5
Maven Plugins
Maven Plugins
Common Maven plugins
Plugin discovery and execution
Plexus
Maven and Dependency Injection
Developing custom plugins
Summary
6
Maven Assemblies
Maven Assemblies
The assembly plugin
The assembly descriptor
Artifact/resource filtering

Assembly help
A runnable, standalone Maven project
Summary
7
Maven Archetypes
Maven Archetypes
Archetype quickstart
The batch mode
Archetype catalogues
The archetype plugin goals
Maven plugins with the archetype plugin
Java EE web applications with the archetype plugin
Android mobile applications with the archetype plugin
EJB archives with the archetype plugin
JIRA plugins with the archetype plugin
Spring MVC applications with the archetype plugin
Building a custom archetype
Summary
8
Maven Repository Management
Maven Repository Management
Maven repositories
The update policy
Multiple repositories
The Maven repository manager
Creating a proxy repository
Creating a virtual repository
Blocking selected artifacts
Inclusive and exclusive routing
Scheduled tasks
Artifact indexing
Nexus plugins
A repository metadata model
Summary
9
Best Practices
Best Practices
Dependency management
Defining a parent module
POM properties
Avoiding repetitive groupId and version tags and inherit from the parent POM
Following naming conventions
Maven profiles
Think twice before you write your own plugin
The Maven release plugin
The Maven enforcer plugin
Avoid using un-versioned plugins
Using exclusive and inclusive routes
Avoid having both release and snapshot repositories in the same group repository
Avoid having both proxy and hosted repositories in the same group repository
Minimizing the number of repositories
Using mirrorOf instead of changing repository URLs
Descriptive parent POM files
Documentation is your friend
Avoid overriding the default directory structure
Using SNAPSHOT versioning during development
Get rid of unused dependencies
Avoid keeping credentials in application POM files
Avoid using deprecated references
Avoid repetition – use archetypes
Avoid using maven.test.skip
Share resources – avoid duplicates
Summary
Index
Index

Convention over configuration

Convention over configuration is one of the main design philosophies behind Apache Maven. Let's go through a few examples.

A complete Maven project can be created using the following code snippet in pom.xml file:

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.packt</groupId>
  <artifactId>sample-one</artifactId>
  <version>1.0.0</version>
</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.

Note

The Maven POM file starts with the <project> element. Always define the <project/> element with the corresponding schema. Some tools can't validate the file without it.

<project xmlns=http://maven.apache.org/POM/4.0.0xmlns:xsi=………xsi:schemaLocation="…">

Copy the previous configuration element and create a pom.xml file out of it. Then, place it in a directory called chapter-01 and create the following child directories under it:

  • chapter-01/src/main/java

  • chapter-01/src/test/java

Now, you can place your Java code under chapter-01/src/main/java and test cases under chapter-01/src/test/java. Use the following command to run the Maven build:

$ mvn clean install

This little configuration is tied up with many conventions:

  • The Java source code is available at {base-dir}/src/main/java

  • Test cases are available at {base-dir}/src/test/java

  • A JAR file type of artifact is produced

  • Compiled class files are copied into {base-dir}/target/classes

  • The final artifact is copied into {base-dir}/target

  • The link http://repo.maven.apache.org/maven2is used as the repository

If someone needs to override the default, conventional behavior of Maven, that is possible too. The following sample pom.xml file shows how to override some of the preceding default values:

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.packt</groupId>
  <artifactId>sample-one</artifactId>
  <version>1.0.0</version>
  <packaging>jar</packaging>

  <build>
    <sourceDirectory>${basedir}/src/main/java</sourceDirectory>
    <testSourceDirectory>${basedir}/src/test/java
    </testSourceDirectory>
    <outputDirectory>${basedir}/target/classes
    </outputDirectory>
  </build>
</project>
Previous Section
End of Section 7
Next Section