大家知道 spring boot 项目是自带tomcat 的,但是我们有时候是需要把项目打包成war 然后放到独立的tomcat中运行的,这个时候我们就需要将它自带的tomcat给排除开,这时候我们就可以使用<scope>provided</scope>来实现,我们在pom文件中这样写:
-
<dependency>
-
<groupId>org.springframework.boot</groupId>
-
<artifactId>spring-boot-starter-tomcat</artifactId>
-
<scope>provided</scope>
-
</dependency>
provided 依赖只有在当JDK 或者一个容器已提供该依赖之后才使用。比如说,我们开发了一个web 应用,在编译
classpath 中需要可用的Servlet API 来编译一个servlet,但是我们并不需要打包好的WAR 中包含这个Servlet API,因为这个
Servlet API JAR 可以由我们的应用服务器或者servlet 容器提供。<scope>provided</scope>提供范围的依赖在编译classpath的
时候是可用的,这种依赖不是传递性的,当然也不会被打包到war当中。比如说:
-
<dependency>
-
<groupId>javax.servlet</groupId>
-
<artifactId>servlet-api</artifactId>
-
<version>3.0-alpha-1</version>
-
<!--只在编译或测试的时候使用-->
-
<scope>provided</scope>
-
</dependency>
我自己在有一次 spring boot 项目发布到独立的 tomcat 中的时候就出现了由于<scope>provided</scope>引起的问题,我在项目中使用了ehcache缓存,我在复制代码的时候多余地复制了<scope>provided</scope>进去,发布项目启动的时候启动不了,报错,找不到相关的 net.sf.ehcache 类文件,后面一查是因为多了<scope>provided</scope>,将其去掉之后运行成功,这里也做个记录。
最后,我们来看一下scope的几个属性详解:
1.compile:默认值 他表示被依赖项目需要参与当前项目的编译,还有后续的测试,运行周期也参与其中,是一个比较强的依赖。打包的时候通常需要包含进去。
2.test:依赖项目仅仅参与测试相关的工作,包括测试代码的编译和执行,不会被打包,例如:junit。
3.runtime:表示被依赖项目无需参与项目的编译,不过后期的测试和运行周期需要其参与。与compile相比,跳过了编译而已。例如JDBC驱动,适用运行和测试阶段。
4.provided:打包的时候可以不用包进去,别的设施会提供。事实上该依赖理论上可以参与编译,测试,运行等周期。相当于compile,但是打包阶段做了exclude操作。
5.system:从参与度来说,和provided相同,不过被依赖项不会从maven仓库下载,而是从本地文件系统拿。需要添加systemPath的属性来定义路径。