9. Best Practices | Mastering Apache Maven 3

Sign In Start Free Trial

Book Overview & Buying
Table Of Contents

Mastering Apache Maven 3

By : Siriwardena

4.3 (3)

Mastering Apache Maven 3

4.3 (3)

By: Siriwardena

Overview of this book

If you are working with Java or Java EE projects and you want to take full advantage of Maven in designing, executing, and maintaining your build system for optimal developer productivity, then this book is ideal for you. You should be well versed with Maven and its basic functionality if you wish to get the most out of the book.

Preface

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Free Chapter

1. Apache Maven Quick Start

1. 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

2. 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

3. 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

4. Build Lifecycles

Standard lifecycles in Maven

Lifecycle bindings

Building a custom lifecycle

Lifecycle extensions

Summary

5. Maven Plugins

5. Maven Plugins

Common Maven plugins

Plugin discovery and execution

Plexus

Maven and Dependency Injection

Developing custom plugins

Summary

6. Maven Assemblies

6. Maven Assemblies

The assembly plugin

The assembly descriptor

Artifact/resource filtering

Assembly help

A runnable, standalone Maven project

Summary

7. Maven Archetypes

7. 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

8. 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

9. 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

Defining a parent module

In most of the multi-module Maven projects, there are many things that are shared across multiple modules. Dependency versions, plugins versions, properties, and repositories are only some of them. It is a common as well as a best practice to create a separate module called parent, and in its POM file, define everything in common. The packaging type of this POM file is pom. The artifact generated by the pom packaging type is itself a POM file.

The following are a few examples:

The Apache Axis2 project, available at http://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/modules/parent/
The WSO2 Carbon project, available at https://svn.wso2.org/repos/wso2/carbon/platform/trunk/parent/

Not all the projects follow this approach. Some just keep the parent POM file under the root directory (not under the parent module). The following are a couple of examples:

The Apache Synapse project, available at http://svn.apache.org/repos/asf/synapse/trunk/java/pom.xml
The Apache HBase...

CONTINUE READING

83

Tech Concepts

36

Programming languages

73

Tech Tools

Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.

Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.

50+ new titles added per month and exclusive early access to books as they are being written.

Mastering Apache Maven 3

Search

Your notes and bookmarks