maven-definitive-guide.pdf

Tim O'Brien (Sonatype, Inc.), John Casey (Sonatype, Inc.), Brian Fox (Sonatype, Inc.), Bruce

Snyder (Sonatype, Inc.), Jason Van Zyl (Sonatype, Inc.), Eric Redmond ()

Copyright © 2006-2008

Copyright .......................................................................................................xii

1. Creative Commons BY-ND-NC .........................................................xii

Foreword: 0.22.0 ...........................................................................................xiv

Preface ...........................................................................................................xvi

1. How to Use this Book ........................................................................xvi

2. Your Feedback ..................................................................................xvii

1.3. A Common Interface ..........................................................................3

1.4. Universal Reuse through Maven Plugins ...........................................4

1.5. Conceptual Model of a "Project" .......................................................5

1.6. Is Maven an alternative to XYZ? ....................................................... 6

1.7. Comparing Maven with Ant ..............................................................8

1.8. Summary ..........................................................................................12

2. Installing and Running Maven ...................................................................13

2.1. Verify your Java Installation ............................................................13

2.2. Downloading Maven ........................................................................14

2.3. Installing Maven ..............................................................................14

2.5.1. User-specific Configuration and Repository .......................... 18

2.5.2. Upgrading a Maven Installation ............................................. 19

2.5.3. Upgrading from Maven 1.x to Maven 2.x ..............................20

2.6. Uninstalling Maven ..........................................................................21

2.7. Getting Help with Maven .................................................................21

ii

2.8. Using the Maven Help Plugin .......................................................... 22

2.8.1. Describing a Maven Plugin .................................................... 23

2.9. About the Apache Software License ................................................25

I. Maven by Example .....................................................................................28

3.5. Core Concepts ........................................................................... 35

3.5.1. Maven Plugins and Goals ................................................ 36

3.5.2. Maven Lifecycle .............................................................. 38

3.5.3. Maven Coordinates ......................................................... 42

3.5.4. Maven Repositories ......................................................... 45

3.5.5. Maven's Dependency Management ................................. 47

3.5.6. Site Generation and Reporting ........................................ 50

3.6. Summary ................................................................................... 51

4. Customizing a Maven Project .............................................................52

4.1. Introduction ...............................................................................52

4.6. Simple Weather Source Code ...................................................58

4.7. Add Resources .......................................................................... 64

4.8. Running the Simple Weather Program ..................................... 66

4.8.1. The Maven Exec Plugin .................................................. 67

4.8.2. Exploring Your Project Dependencies ............................ 68

4.9. Writing Unit Tests ..................................................................... 70

4.10. Adding Test-scoped Dependencies ......................................... 73

4.11. Adding Unit Test Resources ................................................... 74

Maven: The Definitive Guide

4.12. Executing Unit Tests ...............................................................76

4.12.1. Ignoring Test Failures ................................................... 77

4.12.2. Skipping Unit Tests ....................................................... 78

4.13. Building a Packaged Command Line Application .................. 79

5.4. Configuring the Jetty Plugin ..................................................... 85

5.5. Adding a Simple Servlet ........................................................... 87

5.6. Adding J2EE Dependencies ...................................................... 90

5.7. Conclusion ................................................................................. 91

6. A Multi-module Project ......................................................................92

6.1. Introduction ...............................................................................92

6.1.1. Downloading this Chapter's Example ............................. 92

6.2. The Simple Parent Project ......................................................... 92

6.3. The Simple Weather Module .................................................... 94

6.4. The Simple Web Application Module ...................................... 97

7.1.3. Technology Used in this Example ................................ 106

7.2. The Simple Parent Project ....................................................... 107

7.3. The Simple Model Module ..................................................... 108

7.4. The Simple Weather Module .................................................. 113

7.5. The Simple Persist Module ..................................................... 118

7.6. The Simple Web Application Module .................................... 126

7.7. Running the Web Application ................................................. 138

7.8. The Simple Command Module ............................................... 139

Maven: The Definitive Guide

7.9. Running the Simple Command ............................................... 146

7.10. Conclusion ............................................................................. 149

7.10.1. Programming to Interface Projects .............................. 150

8. Optimizing and Refactoring POMs ................................................... 152

8.7. Conclusion ............................................................................... 173

II. Maven Reference ..................................................................................... 174

9. The Project Object Model .................................................................175

9.1. Introduction .............................................................................175

9.2. The POM ................................................................................. 175

9.2.1. The Super POM ............................................................. 178

9.2.2. The Simplest POM ........................................................ 182

9.2.3. The Effective POM ....................................................... 183

9.2.4. Real POMs .................................................................... 183

9.3. POM Syntax ............................................................................184

9.4.4. Transitive Dependencies ............................................... 195

9.4.5. Conflict Resolution ....................................................... 197

9.4.6. Dependency Management ............................................. 199

9.5. Project Relationships ............................................................... 201

9.5.1. More on Coordinates ..................................................... 202

9.5.2. Multi-module Projects ................................................... 203

9.5.3. Project Inheritance ......................................................... 205

9.6. POM Best Practices ................................................................. 208

Maven: The Definitive Guide