把spring boot项目发布tomcat容器（包含发布到tomcat6的方法）

作者：袖梨 2022-06-29

spring boot因为内嵌tomcat容器，所以可以通过打包为jar包的方法将项目发布，但是如何将spring boot项目打包成可发布到tomcat中的war包项目呢？

1. 既然需要打包成war包项目，首先需要在pom.xml文件中修改打包类型，将spring boot默认的jar修改为war形式；

2. 其次spring boot的web项目中内嵌tomcat服务器，所以如果我们想要发布war包到tomcat项目，要讲spring boot中内嵌的tomcat包依赖排除，不然产生冲突，打开下面代码中的注释即可。


  org.springframework.boot
  spring-boot-starter-web

有一点想说的是，如果本地开发的时候依然想要使用spring boot内嵌tomcat进行调试，添加如下依赖即可；


  org.springframework.boot
  spring-boot-starter-tomcat
  provided

3. spring boot发布jar包web程序的入口是main函数所在的类，使用@SpringBootApplication注解。但是如果war包发布至tomcat，需要增加 SpringBootServletInitializer 子类，并覆盖它的 configure 方法，或者直接将main函数所在的类继承 SpringBootServletInitializer 子类，并覆盖它的 configure 方法。代码举例如下，

@SpringBootApplication
public class DemoApplication extends SpringBootServletInitializer {
  @Override
  protected SpringApplicationBuilder configure(
      SpringApplicationBuilder application) {
    return application.sources(DemoApplication.class);
  }
  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }
}

以上就完成了spring boot项目打包war包的所有步骤，可以发布至tomcat7及其以上版本。

但是以上流程改造完spring boot打包war包发布至tomcat6版本之后，浏览器访问项目地址会给出404的错误？为什么呢，一头雾水，经过我一番查阅资料以及实验，得出以下结论，

首先spring boot支持的servlet容器如下，可以看出spring boot最低支持的servlet版本是3.0，但是tomcat6的servlet版本是2.5，这样的话上面的流程是无法支持tomcat6发布spring boot项目的，

但是又google了一番，发现已经有人在解决这个问题了，https://github.com/dsyer/spring-boot-legacy，

标题就表明了它是为了让spring boot支持servlet2.5，刚好解决我们的痛点，使用步骤如下：

1. pom.xml中添加spring-boot-legacy的依赖，


  org.springframework.boot
  spring-boot-legacy
  1.1.0.RELEASE

2.手动替换web.xml文件。但是在发布war包中发现metricFilter提示空指针异常，我就简单粗暴的将filter过滤了，注释如下。所要替换的web.xml文件的未知如下： {工程目录}/src/main/webapp/WEB-INF/web.xml



  
    contextConfigLocation
    com.example.DemoApplication
  
  
    org.springframework.boot.legacy.context.web.SpringBootContextLoaderListener
  

  
    appServlet
    org.springframework.web.servlet.DispatcherServlet
    
      contextAttribute
      org.springframework.web.context.WebApplicationContext.ROOT
    
    1
  
  
    appServlet
    /

完成以上两个步骤就可以让spring boot项目支持tomcat6的部署了，解决。

思考：spring boot封装带来了便利性，同时也带来了出问题的解决复杂度，如果不了解原始的spring web开发模式，出现问题很难解决。即使我现在解决了支持tomcat6的spring boot支持问题，但是不太明白解决的原理，filter出现空指针是为什么？所以深入一些原理性的东西，学习技术的基础性的东西非常重要。大家可以明白的可以解释解释2.5支持的原理，以及filter空指针的异常原因。

PS：如何将Spring Boot项目打包部署到外部Tomcat

1.项目打包

项目开发结束后，需要打包部署到外部服务器的Tomcat上，主要有几种方式。

（1）生成jar包

cd 项目跟目录（和pom.xml同级）
mvn clean package
## 或者执行下面的命令
## 排除测试代码后进行打包
mvn clean package -Dmaven.test.skip=true

打包完成后jar包会生成到target目录下，命名一般是项目名+版本号.jar

启动jar包命令

java -jar target/spring-boot-scheduler-1.0.0.jar

这种方式，只要控制台关闭，服务就不能访问了。下面我们使用在后台运行的方式来启动:

nohup java -jar target/spring-boot-scheduler-1.0.0.jar &

也可以在启动的时候选择读取不同的配置文件

java -jar app.jar --spring.profiles.active=product

也可以通过IDEA的Maven工具生成，点击Lifecycle-install，生成jar

（2）生成war包

（1）修改打包类型为war：war

war

（2）添加spring-boot-starter-tomcat依赖，scope设置为provided


    org.springframework.boot
    spring-boot-starter-tomcat
    provided

（3）注册启动类

创建ServletInitializer.java，继承SpringBootServletInitializer ，覆盖configure()，把启动类Application注册进去。外部web应用服务器构建Web Application Context的时候，会把启动类添加进去。

public class ServletInitializer extends SpringBootServletInitializer {
  @Override
  protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
    return application.sources(BootdemoApplication.class);
  }
}

同样也是两种方式执行：

（1）mvn clean package -Dmaven.test.skip=true

（2）通过IDEA的Maven工具生成，点击Lifecycle-package，生成war

2.项目部署

无论是用哪种方式生成，最终都是为了进行部署，war可以直接拷到tomcat的webapps目录下，启动Tomcat即可。