Spring Boot 实现以 War 包的形式部署

1. 说明

Spring Boot 提供了内置的 tomcat、undertow、jetty 三种 Servlet Web 容器。让我们开箱即用,可以迅速以 Jar方式 启动一个 Web 应用。但是在某些场景中我们可能还需要将我们的 Spring Boot 容器以 War 包的形式进行传统的部署。这时我们就需要通过借助于 SpringBootServletInitializer 来实现。

SpringBootServletInitializer 是 WebApplicationInitializer 的实现,它从部署在 Web 容器上的传统 WAR 包运行 Spring Boot 应用。该类将 Servlet,Filter 和 ServletContextInitializer Bean 从应用程序上下文绑定到服务器。SpringBootServletInitializer 类还允许我们通过覆盖 SpringApplicationBuilder configure(SpringApplicationBuilder application)方法来配置由 Servlet 容器运行的应用程序。

2. Spring Boot War 部署

接下来我们来讲述详细的 Spring Boot War 部署步骤。

2.1 修改打包方式为 War

修改 Spring Boot 项目的 pom.xml 文件将打包方式修改为 war 。

默认打 jar 包 <packaging>jar</packaging>  改为打 war 包 <packaging>war</packaging>

2.2 排除 内嵌的 Web 容器

默认使用内嵌 Tomcat Web 容器。如果此前你使用了内嵌的 Jetty、Undertow ,请务必清除相关的 Starter 依赖。然后我们可以使用两种方式来处理:

方法一:
Spring Boot 内嵌的Tomcat默认已经集成在spring-boot-starter-web包里,所以我们要排除掉它。
修改pom.xml配置文件: 

排除spring-boot-starter-tomcat依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>
SpringBootServletInitializer 需要依赖 Servlet Api ,因此要加上它(另请注意 versionNumber 版本要跟你外置的 Tomcat 版本兼容)。
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>${versionNumber}</version> 
    <scope>provided</scope> 
</dependency>

方法二
我们通过引入 spring-boot-starter-tomcat 覆盖掉默认的内置 Tomcat 并设置作用范围(scope)是provided(编译、测试)。
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-tomcat</artifactId>
     <scope>provided</scope>
 </dependency>

2.3 实现 SpringBootServletInitializer 接口

方法一:

Application.java

Application继承SpringBootServletInitializer

public class Application extends SpringBootServletInitializer {
    // todo:
}

方法二:
新建 SpringBootServletInitializer 的实现类 ServletInitializer 如下:

 package cn.felord.war;
  import org.springframework.boot.builder.SpringApplicationBuilder;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
  /**
  * @author Felordcn
  */
 public class ServletInitializer extends SpringBootServletInitializer {
      @Override
     protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
         return application.sources(WarSpringBootApplication.class);
     } 
 }

2.4 编译打包
通过 maven 命令 mvn clean package 执行编译,稍等片刻,就会获得 为${artifactId}-${version}设定的war包文件 ,然后你就可以以传统的 War 部署方式运行 Spring Boot 应用了。

3..启动Tomcat

进入Tomcat中bin目录,双击startup.bat

若想按服务方式运行:进入到bin文件夹。按下shift+右击打开命令窗口,输入service.bat install service_name就可以安装服务,service_name就是给服务起的名字,可以自己命名,这边的名字是tomcat8

上图界面代表启动成功,成功后不要关闭,否则就关掉了Tomcat。

测试Tomcat是否启动成功:
在浏览器地址栏输入http://localhost:8080/

4. 部署到生产环境

将你编译好的War包文件拷贝到Tomcat的安装目录的webapps下,若包名是test.war,则在地址栏里输入localhost:8080/test,就可以正常访问系统了

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章