欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

关于Maven构建的项目依赖范围

程序员文章站 2022-07-15 11:14:26
...

Maven可以管理内部外部依赖

一个Java项目的外部依赖可能是如Plexus,SpringFramework,或者Log4J的类库。一个内部的依赖就像在“一个简单的web应用”中描述的那样,web项目依赖于另外一个包含服务类,模型类,或者持久化逻辑的项目。


项目依赖

一个 “项目依赖”展示了一些项目依赖的栗子:

<project>
...
    <dependencies>
        <dependency>
            <groupId>org.codehaus.xfire</groupId>
            <artifactId>xfire-java5</artifactId>
            <version>1.2.5</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.12</version>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.apache.geronimo.specs</groupId>
			<artifactId>geronimo-jms_2.0_spec</artifactId>
			<version>1.0-alpha-2</version>
			<scope>provided</scope>
		</dependency>
    </dependencies>
...
</project>
  • 第一个依赖是对于来自Codehaus的XFire SOAP库的编译范围(compile)依赖。如果你的项目在编译,测试,和运行中都依赖于一个类库,你就要使用这种依赖。
  • 第二种依赖是一个对于JUnit测试范围(test)的依赖。当你只有在测试的时候才引用类库的时候,你就要使用测试范围依赖。
  • 最后一项依赖的范围是已提供的(provided)依赖。当你的开发过程只有在编译和测试时需要一个类库,而该类库在运行的时候由容器提供,那么你就需要使用已提供范围的依赖。

依赖范围

上边的栗子简要介绍了三种依赖范围: compile , test 和 provided 。

范围控制哪些依赖在哪些classpath中可用,哪些依赖包含在一个应用中。让我们详细看一下每一种范围:

  • compile(编译依赖范围)

compile 是默认的范围;如果没有提供一个范围,那该依赖的范围就是编译范围。编译范围依赖在所有的classpath中可用,同时它们也会被打包。

  • test(测试依赖范围,仅测试编译和测试运行时有效)

test 范围依赖 在一般的编译和运行时都不需要,它们只有在测试编译和测试运行阶段可用。

  • proided(外部提供的依赖范围,仅在清理、编译)

provided 依赖只有在当JDK或者一个容器已提供该依赖之后才使用。

例如:你开发了一个web应用,你可能在编译classpath中需要可用的Servlet API来编译一个servlet,但是你不会想要在打包好的WAR中包含这个Servlet API;这个Servlet API JAR由你的应用服务器或者servlet容器提供。已提供范围的依赖在编译classpath(不是运行时)可用。它们不是传递性的,也不会被打包。

  • runtime(运行时依赖范围,仅在测试和运行时有效)

runtime 依赖在运行和测试系统的时候需要,但在编译的时候不需要。

比如,你可能在编译的时候只需要JDBC API JAR,而只有在运行的时候才需要JDBC驱动实现。

  • system(系统提供的依赖范围,需要指定依赖文件路径)

system 范围依赖与 provided 类似,但必须显式的提供一个对于本地系统中JAR文件的路径。这么做是为了允许基于本地对象编译,而这些对象是系统类库的一部分。这样的构件应该是一直可用的,Maven也不会在仓库中去寻找它。

如果你将一个依赖范围设置成系统范围,你必须同时提供一个 systemPath 元素。注意该范围是不推荐使用的(你应该一直尽量去从公共或定制的Maven仓库中引用依赖)。