-
Notifications
You must be signed in to change notification settings - Fork 243
/
introduction-to-dependency-mechanism.apt
923 lines (761 loc) · 29.2 KB
/
introduction-to-dependency-mechanism.apt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
------
Introduction to the Dependency Mechanism
------
Brett Porter
Trygve Laugstol
Karl Heinz Marbaise
------
2005-10-12
2016-06-17
------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License. You may obtain a copy of the License at
~~
~~ http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Introduction to the Dependency Mechanism
Dependency management is a core feature of Maven. Managing dependencies for a single project is easy.
Managing dependencies for multi-module projects and applications that consist of hundreds of modules
is possible. Maven helps a great deal in defining, creating, and maintaining reproducible builds
with well-defined classpaths and library versions.
Learn more about:
* {{{Transitive_Dependencies}Transitive Dependencies}}
* Excluded/Optional Dependencies
* {{{Dependency_Scope}Dependency Scope}}
* {{{Dependency_Management}Dependency Management}}
* {{{Importing_Dependencies}Importing Dependencies}}
* {{{bill-of-materials-bom-poms}Bill of Materials (BOM) POMs}}
* {{{System_Dependencies}System Dependencies}}
[]
* {Transitive Dependencies}
Maven avoids the need to discover and
specify the libraries that your own dependencies require by including transitive dependencies automatically.
This feature is facilitated by reading the project files of your dependencies from the remote repositories
specified. In general, all dependencies of those projects are used in your project, as are any that the
project inherits from its parents, or from its dependencies, and so on.
There is no limit to the number of levels that dependencies can be gathered from. A problem arises
only if a cyclic dependency is discovered.
With transitive dependencies, the graph of included libraries can quickly grow quite large. For this reason,
there are additional features that limit which dependencies are included:
* <Dependency mediation>
- this determines what version of an artifact will be chosen when multiple
versions are encountered as dependencies. Maven picks the "nearest definition". That is,
it uses the version of the closest dependency to your project in the tree of dependencies.
You can always guarantee a version by declaring it explicitly in your project's POM.
Note that if two dependency versions are at the same depth in the dependency tree,
the first declaration wins.
* "nearest definition" means that the version used will be the closest one to your project in the tree of dependencies. Consider this tree of dependencies:
----
A
├── B
│ └── C
│ └── D 2.0
└── E
└── D 1.0
----
In text, dependencies for A, B, and C are defined as A -> B -> C -> D 2.0 and A -> E -> D 1.0,
then D 1.0 will be used when building A because the path from A to D through E is shorter.
You could explicitly add a dependency to D 2.0 in A to force the use of D 2.0, as shown here:
----
A
├── B
│ └── C
│ └── D 2.0
├── E
│ └── D 1.0
│
└── D 2.0
----
* <Dependency management>
- this allows project authors to directly specify the versions of artifacts to be used when they are encountered
in transitive dependencies or in dependencies where no version has been specified. In the example in
the preceding section a dependency was directly added to A even though it is not directly used by A. Instead,
A can include D as a dependency in its dependencyManagement section and directly control which version of
D is used when, or if, it is ever referenced.
* <Dependency scope>
- this allows you to only include dependencies appropriate for the current stage
of the build. This is described in more detail below.
* <Excluded dependencies>
- If project X depends on project Y, and project Y depends on project Z, the owner of project X can explicitly exclude project Z
as a dependency, using the "exclusion" element.
* <Optional dependencies>
- If project Y depends on project Z, the owner of project Y can mark project Z
as an optional dependency, using the "optional" element. When project X depends on project Y, X will
depend only on Y and not on Y's optional dependency Z. The owner of project X may then
explicitly add a dependency on Z, at her option. (It may be helpful to think of optional
dependencies as "excluded by default.")
[]
Although transitive dependencies can implicitly include desired dependencies, it is a good practice to explicitly
specify the dependencies your source code uses directly. This best practice proves its value especially
when the dependencies of your project change their dependencies.
For example, assume that your project A specifies a
dependency on another project B, and project B specifies a dependency on project C. If you are directly using components
in project C, and you don't specify project C in your project A, it may cause build failure when project B suddenly
updates/removes its dependency on project C.
Another reason to directly specify dependencies is that it provides better
documentation for your project: one can learn more information by just reading the POM file in your project, or by executing <<mvn dependency:tree>>.
Maven also
provides {{{/plugins/maven-dependency-plugin/analyze-mojo.html}dependency:analyze}} plugin goal
for analyzing the dependencies: it helps making this best practice more achievable.
* {Dependency Scope}
Dependency scope is used to limit the transitivity of a dependency and to determine when a dependency is
included in a classpath.
There are 6 scopes:
* <<compile>>\
This is the default scope, used if none is specified. Compile dependencies are available
in all classpaths of a project. Furthermore, those dependencies are propagated to dependent projects.
* <<provided>>\
This is much like <<<compile>>>, but indicates you expect the JDK or a container to provide the dependency at runtime.
For example, when building a web application for the Java Enterprise Edition, you would set the dependency on the
Servlet API and related Java EE APIs to scope <<<provided>>> because the web container provides those classes.
A dependency with this scope is added to the classpath used for compilation and test, but not the
runtime classpath. It is not transitive.
* <<runtime>>\
This scope indicates that the dependency is not required for compilation, but is for
execution. Maven includes a dependency with this scope in the runtime and test classpaths,
but not the compile classpath.
* <<test>>\
This scope indicates that the dependency is not required for normal use of the application, and
is only available for the test compilation and execution phases. This scope is not transitive.
Typically this scope is used for test libraries such as JUnit and Mockito.
It is also used for non-test libraries such as Apache Commons IO if those libraries are used in
unit tests (src/test/java) but not in the model code (src/main/java).
* <<system>>\
This scope is similar to <<<provided>>> except that you have to provide the JAR
which contains it explicitly. The artifact is always available and is not
looked up in a repository.
* <<import>>\
This scope is only supported on a dependency of type <<<pom>>> in the <<<\<dependencyManagement\>>>> section. It
indicates the dependency is to be replaced with the effective list of dependencies in the specified POM's
<<<\<dependencyManagement\>>>> section. Since they are replaced, dependencies with a scope of <<<import>>> do not
actually participate in limiting the transitivity of a dependency.
[]
Each of the scopes (except for <<<import>>>) affects transitive dependencies in different ways, as is demonstrated in the table below.
If a dependency is set to the scope in the left column, a transitive dependency of that dependency with the
scope across the top row results in a dependency in the main project with the scope listed at the
intersection. If no scope is listed, it means the dependency is omitted.
*----------+------------+----------+----------+------+
| | compile | provided | runtime | test
*----------+------------+----------+----------+------+
| compile | compile(*) | - | runtime | -
*----------+------------+----------+----------+------+
| provided | provided | - | provided | -
*----------+------------+----------+----------+------+
| runtime | runtime | - | runtime | -
*----------+------------+----------+----------+------+
| test | test | - | test | -
*----------+------------+----------+----------+------+
<<(*) Note:>>
it is intended that this should be runtime scope instead, so that all compile dependencies must
be explicitly listed. However, if a library you depend on extends a class from another
library, both must be available at compile time. For this reason, compile time dependencies remain
as compile scope even when they are transitive.
* {Dependency Management}
The dependency management section is a mechanism for centralizing dependency information. When you have
a set of projects that inherit from a common parent, it's possible to put all information about the dependency
in the common POM and have simpler references to the artifacts in the child POMs. The mechanism is best
illustrated through some examples. Given these two POMs which extend the same parent:
Project A:
+----+
<project>
...
<dependencies>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-a</artifactId>
<version>1.0</version>
<exclusions>
<exclusion>
<groupId>group-c</groupId>
<artifactId>excluded-artifact</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-b</artifactId>
<version>1.0</version>
<type>bar</type>
<scope>runtime</scope>
</dependency>
</dependencies>
</project>
+----+
Project B:
+----+
<project>
...
<dependencies>
<dependency>
<groupId>group-c</groupId>
<artifactId>artifact-b</artifactId>
<version>1.0</version>
<type>war</type>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-b</artifactId>
<version>1.0</version>
<type>bar</type>
<scope>runtime</scope>
</dependency>
</dependencies>
</project>
+----+
These two example POMs share a common dependency and each has one non-trivial dependency. This information
can be put in the parent POM like this:
+----+
<project>
...
<dependencyManagement>
<dependencies>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-a</artifactId>
<version>1.0</version>
<exclusions>
<exclusion>
<groupId>group-c</groupId>
<artifactId>excluded-artifact</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>group-c</groupId>
<artifactId>artifact-b</artifactId>
<version>1.0</version>
<type>war</type>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-b</artifactId>
<version>1.0</version>
<type>bar</type>
<scope>runtime</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
+----+
Then the two child POMs become much simpler:
+----+
<project>
...
<dependencies>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-a</artifactId>
</dependency>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-b</artifactId>
<!-- This is not a jar dependency, so we must specify type. -->
<type>bar</type>
</dependency>
</dependencies>
</project>
+----+
+----+
<project>
...
<dependencies>
<dependency>
<groupId>group-c</groupId>
<artifactId>artifact-b</artifactId>
<!-- This is not a jar dependency, so we must specify type. -->
<type>war</type>
</dependency>
<dependency>
<groupId>group-a</groupId>
<artifactId>artifact-b</artifactId>
<!-- This is not a jar dependency, so we must specify type. -->
<type>bar</type>
</dependency>
</dependencies>
</project>
+----+
<<NOTE:>> In two of these dependency references, we had to specify the \<type/\>
element. This is because the minimal set of information for matching a dependency
reference against a dependencyManagement section is actually
<<\{groupId, artifactId, type, classifier\}>>. In many cases, these dependencies
will refer to jar artifacts with no classifier. This allows us to shorthand the
identity set to <<\{groupId, artifactId\}>>, since the default for the type field
is <<<jar>>>, and the default classifier is null.
A second, and very important use of the dependency management section is to control the versions
of artifacts used in transitive dependencies. As an example consider these projects:
Project A:
+----+
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>maven</groupId>
<artifactId>A</artifactId>
<packaging>pom</packaging>
<name>A</name>
<version>1.0</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>test</groupId>
<artifactId>a</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>b</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>c</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>d</artifactId>
<version>1.2</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
+----+
Project B:
+----+
<project>
<parent>
<artifactId>A</artifactId>
<groupId>maven</groupId>
<version>1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>maven</groupId>
<artifactId>B</artifactId>
<packaging>pom</packaging>
<name>B</name>
<version>1.0</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>test</groupId>
<artifactId>d</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>test</groupId>
<artifactId>a</artifactId>
<version>1.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>c</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies>
</project>
+----+
When maven is run on project B, version 1.0 of artifacts a, b, c, and d will be used regardless of
the version specified in their POM.
* a and c both are declared as dependencies of the project so version 1.0 is used due to
dependency mediation. Both also have runtime scope since it is directly specified.
* b is defined in B's parent's dependency management section and since dependency management
takes precedence over dependency mediation for transitive dependencies, version 1.0 will be
selected should it be referenced in a or c's POM. b will also have compile scope.
* Finally, since d is specified in B's dependency management section, should d be a dependency
(or transitive dependency) of a or c, version 1.0 will be chosen - again because dependency
management takes precedence over dependency mediation and also because the current POM's
declaration takes precedence over its parent's declaration.
[]
<<NOTE:>> The dependency management won't affect the (transitive) dependencies of any <plugins>
used in the same effective POM but only the (transitive) project dependencies.
The reference information about the dependency management tags is available from the
{{{../../ref/current/maven-model/maven.html#class_DependencyManagement}project descriptor reference}}.
** {Importing Dependencies}
The examples in the previous section describe how to specify managed dependencies through inheritance. However,
in larger projects it may be impossible to accomplish this since a project can only inherit from a single parent.
To accommodate this, projects can import managed dependencies from other projects. This is accomplished by declaring a
POM artifact as a dependency with a scope of "import".
Project B:
+----+
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>maven</groupId>
<artifactId>B</artifactId>
<packaging>pom</packaging>
<name>B</name>
<version>1.0</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>maven</groupId>
<artifactId>A</artifactId>
<version>1.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>d</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>test</groupId>
<artifactId>a</artifactId>
<version>1.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>c</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies>
</project>
+----+
Assuming A is the POM defined in the preceding example, the end result would be the same. All of A's managed dependencies
would be incorporated into B except for d since it is defined in this POM.
Project X:
+----+
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>maven</groupId>
<artifactId>X</artifactId>
<packaging>pom</packaging>
<name>X</name>
<version>1.0</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>test</groupId>
<artifactId>a</artifactId>
<version>1.1</version>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>b</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
+----+
Project Y:
+----+
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>maven</groupId>
<artifactId>Y</artifactId>
<packaging>pom</packaging>
<name>Y</name>
<version>1.0</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>test</groupId>
<artifactId>a</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>test</groupId>
<artifactId>c</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
+----+
Project Z:
+----+
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>maven</groupId>
<artifactId>Z</artifactId>
<packaging>pom</packaging>
<name>Z</name>
<version>1.0</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>maven</groupId>
<artifactId>X</artifactId>
<version>1.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>maven</groupId>
<artifactId>Y</artifactId>
<version>1.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
+----+
In the example above Z imports the managed dependencies from both X and Y. However, both X and Y contain dependency a. Here,
version 1.1 of a would be used since X is declared first and a is not declared in Z's dependencyManagement.
This process is recursive. For example, if X imports another POM, Q, when Z is processed it will simply appear that all
of Q's managed dependencies are defined in X.
** {Bill of Materials (BOM) POMs}
Imports are most effective when used for defining a "library" of related artifacts that are generally part of a
multiproject build. It is fairly common for one project to use one or more artifacts from these libraries.
However, it has sometimes been difficult to keep the versions in the project using the artifacts in synch
with the versions distributed in the library. The pattern below illustrates how a "bill of materials" (BOM) can be
created for use by other projects.
The root of the project is the BOM POM. It defines the versions of all the artifacts that will be created
in the library. Other projects that wish to use the library should import this POM into the dependencyManagement
section of their POM.
+----+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.test</groupId>
<artifactId>bom</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
<properties>
<project1Version>1.0.0</project1Version>
<project2Version>1.0.0</project2Version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.test</groupId>
<artifactId>project1</artifactId>
<version>${project1Version}</version>
</dependency>
<dependency>
<groupId>com.test</groupId>
<artifactId>project2</artifactId>
<version>${project2Version}</version>
</dependency>
</dependencies>
</dependencyManagement>
<modules>
<module>parent</module>
</modules>
</project>
+----+
The parent subproject has the BOM POM as its parent. It is a normal multiproject pom.
+----+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.test</groupId>
<version>1.0.0</version>
<artifactId>bom</artifactId>
</parent>
<groupId>com.test</groupId>
<artifactId>parent</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.1.1</version>
</dependency>
</dependencies>
</dependencyManagement>
<modules>
<module>project1</module>
<module>project2</module>
</modules>
</project>
+----+
Next are the actual project POMs.
+----+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.test</groupId>
<version>1.0.0</version>
<artifactId>parent</artifactId>
</parent>
<groupId>com.test</groupId>
<artifactId>project1</artifactId>
<version>${project1Version}</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
</dependency>
</dependencies>
</project>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.test</groupId>
<version>1.0.0</version>
<artifactId>parent</artifactId>
</parent>
<groupId>com.test</groupId>
<artifactId>project2</artifactId>
<version>${project2Version}</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</dependency>
</dependencies>
</project>
+----+
The project that follows shows how the library can now be used in another project without having to
specify the dependent project's versions.
+----+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.test</groupId>
<artifactId>use</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.test</groupId>
<artifactId>bom</artifactId>
<version>1.0.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.test</groupId>
<artifactId>project1</artifactId>
</dependency>
<dependency>
<groupId>com.test</groupId>
<artifactId>project2</artifactId>
</dependency>
</dependencies>
</project>
+----+
Finally, when creating projects that import dependencies, beware of the following:
* Do not attempt to import a POM that is defined in a submodule of the current POM.
Attempting to do that will result in the build failing since it won't be able to locate the POM.
* Never declare the POM importing a POM as the parent (or grandparent, etc) of the target POM.
There is no way to resolve the circularity and an exception will be thrown.
* When referring to artifacts whose POMs have transitive dependencies, the project needs to specify versions
of those artifacts as managed dependencies. Not doing so results in a build failure since the
artifact may not have a version specified. (This should be considered a best practice in any case as it
keeps the versions of artifacts from changing from one build to the next).
[]
Starting from Maven 4.0, a new specific BOM packaging has been introduced.
It allows defining a BOMs which are not used as parent in a project leveraging
the newer 4.1.0 model, while still providing full compatibility with Maven 3.X
clients and projects. This BOM packaging is translated into a more usual POM
packaging at installation / deployment time, leveraging the build/consumer POM
feature from Maven 4. This thus provides full compatibility with Maven 3.x.
+----+
<project xmlns="http://maven.apache.org/POM/4.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.1.0 http://maven.apache.org/xsd/maven-4.1.0.xsd">
<parent>
<groupId>com.test</groupId>
<version>1.0.0</version>
<artifactId>parent</artifactId>
</parent>
<groupId>com.test</groupId>
<artifactId>bom</artifactId>
<version>1.0.0</version>
<packaging>bom</packaging>
<properties>
<project1Version>1.0.0</project1Version>
<project2Version>1.0.0</project2Version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.test</groupId>
<artifactId>project1</artifactId>
<version>${project1Version}</version>
</dependency>
<dependency>
<groupId>com.test</groupId>
<artifactId>project2</artifactId>
<version>${project2Version}</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
+----+
* {System Dependencies}
<<<Important note: This is deprecated.>>>
Dependencies with the scope <system> are always available and are not looked
up in repository. They are usually used to tell Maven about dependencies which
are provided by the JDK or the VM. Thus, system dependencies are especially
useful for resolving dependencies on artifacts which are now provided by the
JDK, but were available as separate downloads earlier. Typical examples are
the JDBC standard extensions or the Java Authentication and Authorization
Service (JAAS).
A simple example would be:
+----+
<project>
...
<dependencies>
<dependency>
<groupId>javax.sql</groupId>
<artifactId>jdbc-stdext</artifactId>
<version>2.0</version>
<scope>system</scope>
<systemPath>${java.home}/lib/rt.jar</systemPath>
</dependency>
</dependencies>
...
</project>
+----+
If your artifact is provided by the JDK's <<<tools.jar>>>, the system path
would be defined as follows:
+----+
<project>
...
<dependencies>
<dependency>
<groupId>sun.jdk</groupId>
<artifactId>tools</artifactId>
<version>1.5.0</version>
<scope>system</scope>
<systemPath>${java.home}/../lib/tools.jar</systemPath>
</dependency>
</dependencies>
...
</project>
+----+