如何将spring boot项目打包成war包

声明：参考自 如何将spring boot项目打包成war包

一、修改打包形式

在 pom.xml 里设置 <packaging>war</packaging>

二、移除嵌入式tomcat插件

在 pom.xml 里找到spring-boot-starter-web依赖，在其中添加如下代码，

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 移除嵌入式tomcat插件 -->
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

三、添加servlet-api的依赖

在 pom.xml 中新增以下依赖：

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

四、修改启动类，并重写初始化方法

我们平常用 main 方法启动的方式，都有一个App的启动类，代码如下：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

我们需要类似于web.xml 的配置方式来启动 Spring 上下文了，在 Application 类的同级添加一个SpringBootStartApplication类，其代码如下:

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

/**
 * 修改启动类，继承 SpringBootServletInitializer 并重写 configure 方法
 */
public class SpringBootStartApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        // 注意这里要指向原先用main方法执行的Application启动类
        return builder.sources(Application.class);
    }
}

五、打包部署

5.1 打war包

在项目根目录下（即包含pom.xml的目录），在命令行里输入：
mvn clean package -Dmaven.test.skip=true 即可， 等待打包完成，出现 [INFO] BUILD SUCCESS 即为打包成功。

5.2 部署

然后把target目录下的war包放到 tomcat 的 webapps 目录下，启动 tomcat，即可自动解压部署。
最后在浏览器中输入

http://localhost:[端口号]/[打包项目名]/

发布成功

六、其他报错

6.1 webxml attribute is required

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-war-plugin:2.2:war (default-war) on project war-application: Error assembling WAR: webxml attribute is required (or pre-existing WEB-INF/web.xml if executing in update mode)

解决方案：
在 pom.xml 中指定 maven-war-plugins 插件的版本。

<project>
  ...
  <build>
    <plugins>
      <!-- https://maven.apache.org/plugins/maven-war-plugin/index.html -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <!-- 从 3.1.0 开始，failOnMissingWebXml 默认是 false，因此这里就是特地指定版本-->
        <version>3.1.0</version>
        <configuration>
          <warName>${project.artifactId}</warName>
          <failOnMissingWebXml>false</failOnMissingWebXml>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>