同时实现Springboot的Jar/War部署

本文翻译:吴嘉俊,叩丁狼高级讲师

Springboot带来的最大的好处在于不需要依赖外部容器。需要做的就是开发完成之后,直接将应用打包成一个可执行的jar文件。只需要简单的几个步骤,不需要额外安装和配置另外的软件,一个新的应用就可以快速部署起来。

但是,有时候你仍然希望你的应用能使用常规的WAR文件的方式部署。比如,你必须提交war文件来完成公司的持续集成,或者必须在公司定制的某个特殊的容器下运行。使用WAR文件部署的原因可能有多种,但常规情况下,还是建议使用一个包含内置服务器的可执行的JAR文件。

可执行的WAR文件

在你考虑双重编译来实现可执行的jar和可部署的war之前,其实你可能还有另一种选择。这种情况下,Springboot允许你鱼和熊掌兼得。你只需要按照非常简单的三个步骤即可。

  1. 在你的pom.xml文件中,将packing修改为war.
<packaging>war</packaging>

  1. 仍然在pom.xml文件中,将spring-boot-starter-tomcat依赖设置为provided。
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

  1. 最后一步是继承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依赖。

  1. 第一步,你需要和上面的示例中一样,继承SpringBootServletInitializer。
  2. 第二步,修改pom.xml,将packaging修改为一个占位符,并且在profile中定义这个变量。
<packaging>${project.packaging}</packaging>

  1. 可能平时我们在开发过程中,用的最多的还是使用jar运行的方式,所以我们可以把默认的profile设置为jar的方式。
<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <project.packaging>jar</project.packaging>
        </properties>
    </profile>
</profiles>

  1. 最后一步,添加针对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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容