在Maven BOM(物料清单)中定义依赖关系的范围是一种好习惯吗?

时间:2017-11-20 14:55:05

标签: maven maven-bom

我有这样的pom.xml用作BOM(物料清单)。其中一个已定义的依赖项是*-test工件,用于测试使用此BOM中的库的代码。

问题是:在BOM本身中指定*-test工件仅适用于test范围是适当/良好的做法,还是应该留给BOM的用户指定如果需要,在他们项目的POM中?

<?xml version="1.0" encoding="UTF-8"?>
<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.example.mylib</groupId>
    <artifactId>mylib-bom</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>MyLib (Bill of Materials)</name>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.example.mylib</groupId>
                <artifactId>mylib-cool-library</artifactId>
                <version>${project.version}</version>
            </dependency>    
            <dependency>
                <groupId>com.example.mylib</groupId>
                <artifactId>mylib-test</artifactId>
                <version>${project.version}</version>
                <scope>test</scope> <!-- === HERE === -->
            </dependency>    
        </dependencies>
    </dependencyManagement>    
</project>

我正在研究现有项目是如何做到这一点的,例如,Spring Framework BOM确实没有明确定义任何范围。但我仍然想知道是否有一些不成文的规则或类似的东西?

1 个答案:

答案 0 :(得分:4)

最佳做法是让用户决定范围,在BOM(或父pom)中设置它。

当您在BOM中设置范围(除compile以外的任何其他设置)时,您可以更改该依赖关系的默认范围,如用户项目所示。 maven中的默认依赖关系范围是compile,因此,当您希望编译时,省略依赖关系的范围是一种常见做法。如果BOM强加了另一个范围,那么对于使用BOM的其他开发人员(或者甚至是以后的自己)来说,这可能是一个令人讨厌的惊喜。