本文翻译:吴嘉俊,叩丁狼高级讲师
Springboot带来的最大的好处在于不需要依赖外部容器。需要做的就是开发完成之后,直接将应用打包成一个可执行的jar文件。只需要简单的几个步骤,不需要额外安装和配置另外的软件,一个新的应用就可以快速部署起来。
但是,有时候你仍然希望你的应用能使用常规的WAR文件的方式部署。比如,你必须提交war文件来完成公司的持续集成,或者必须在公司定制的某个特殊的容器下运行。使用WAR文件部署的原因可能有多种,但常规情况下,还是建议使用一个包含内置服务器的可执行的JAR文件。
可执行的WAR文件
在你考虑双重编译来实现可执行的jar和可部署的war之前,其实你可能还有另一种选择。这种情况下,Springboot允许你鱼和熊掌兼得。你只需要按照非常简单的三个步骤即可。
- 在你的pom.xml文件中,将packing修改为war.
<packaging>war</packaging>
- 仍然在pom.xml文件中,将spring-boot-starter-tomcat依赖设置为provided。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
- 最后一步是继承SpringBootServletInitializer,并且实现其中的方法,在其中指向你应用的主运行类即可,当然,你也可以使用一个独立的类也行。下面是一个例子:
@SpringBootApplication
public class ApplicationRunner extends SpringBootServletInitializer {
public static void main(String[] args) {
SpringApplication.run(ApplicationRunner.class, args);
}
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(ApplicationRunner.class);
}
}
现在,如果你使用Maven来构建你的项目,你就会得到一个可以部署的WAR文件,可以部署在任何标准的servlet服务器中。因为已经将内置的Tomcat的依赖设置为了provided,你可能认为这个依赖不会打包在WAR文件中,其实不然,所有和嵌入的Tomcat相关的jar包仍然被打包到了WAR包中的WEB-INF/lib-provided文件夹中。因为这种机制,当应用部署在正常的servlet容器中,这些jar包不会被添加到classpath下,就不会引起冲突,但是Springboot仍然可以使用他们来运行应用,就像在一个Jar文件中运行一样。
移除Provided的依赖包
但是如果你不想在WAR文件中包含这些多于的Tomcat依赖该怎么做呢?实际上,这些依赖包只是在部署阶段才会使用。为了达到这个目的,你可以创建两个独立的build profile。其中一个创建一个正常的可执行的JAR文件,另一个将应用打包到一个WAR文件中,并且剔除内置的Tomcat依赖。
- 第一步,你需要和上面的示例中一样,继承SpringBootServletInitializer。
- 第二步,修改pom.xml,将packaging修改为一个占位符,并且在profile中定义这个变量。
<packaging>${project.packaging}</packaging>
- 可能平时我们在开发过程中,用的最多的还是使用jar运行的方式,所以我们可以把默认的profile设置为jar的方式。
<profiles>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<project.packaging>jar</project.packaging>
</properties>
</profile>
</profiles>
- 最后一步,添加针对WAR文件的profile。里面的配置和之前的配置完全一致,只需要做的就是移除spring-boot-starter-tomcat这个依赖包。按照下面的示例来配置:
<profile>
<id>release</id>
<properties>
<project.packaging>war</project.packaging>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring-boot-starter-tomcat</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
</profile>
可以看到,在这个profile中,我们将packaging属性设置为了war的打包方式。接着,我们把tomcat的依赖标记为了excluded,这就可以阻止将tomcat相关依赖包打包到lib-provided文件夹中。但是,没有了这些依赖,你的应用就没法正常构建了(缺少了servlet相关依赖),所以可以看到,我们额外的定义了servlet API的依赖。因为servlet相关依赖在servlet容器中都提供了,所以这里,我们也只是将其设置为provided的。
到这里,整个操作完成。在默认情况下,没有添加额外的配置情况下,应用使用dev这个profile。如果你想打包你的发布版本,只需要激活第二个profile,即可得到一个WAR文件。完整的pom.xml文件如下:
<?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.dolszewski</groupId>
<artifactId>spring-boot-dual-build</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>${project.packaging}</packaging>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.3.3.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<properties>
<java.version>1.8</java.version>
</properties>
<profiles>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<project.packaging>jar</project.packaging>
</properties>
</profile>
<profile>
<id>release</id>
<properties>
<project.packaging>war</project.packaging>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring-boot-starter-tomcat</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
</profile>
</profiles>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
原文地址:http://dolszewski.com/spring/dual-jar-war-build-for-spring-boot/
想获取更多技术视频,请前往叩丁狼官网:http://www.wolfcode.cn/openClassWeb_listDetail.html