Spring Boot 部署浅析（jar or war）

Posted 2022-11-25 sinte-beuve

对于传统的 ssm 或者 ssh 项目的部署，一般会打包成war包，或者是一个编译好的文件夹，再放到 tomcat 的 webapps 目录下，如果是 war 包，会自动解压出来。而 Spring Boot 默认会内嵌一个 Tomcat，因此即便是 web 项目也可以直接打包成 jar 包，直接 java -jar 运行就可以了。

用 Spring Initialzr 创建的 web 项目（选择打包成 jar），只会有一个 spring-boot-starter-web 依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

跟进去可以发现 这个依赖包括了 spring-boot-starter-tomcat 这个（内嵌tomcat的依赖包）。如果使用内部的 tomcat 部署，那么不需要对代码进行修改，直接 run xxApplication下的 Main 方法。

如果创建的是 war 的 web 项目，默认会多一个 ServletInitializer 文件，maven 会多一个 spring-boot-starter-tomcat 依赖。war 的项目，既可以用 Main 方法启动，也可以用外部的 tomcat 启动。

这样看来没有任何问题，如果之前建工程用的是 jar，最终需要用外部 tomcat 部署的，只需要进行如下修改：

// 1. 添加一个 ServletInitializer.java
// 2. Maven 中添加<packaging>war</packaging>。（默认是 jar）
// 3. 添加 spring-boot-starter-tomcat 依赖。（测试过，不加也没关系，但是既然 Spring Initialzr 创建时就自带了，还是加上好了）

如果你用的是 JSP，或许会有一些小问题。

一般博客都会写，如果需要用到 JSP，需要添加个依赖 tomcat-embed-jasper：

<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
    <scope>provided</scope>
</dependency>

需要特别注意的是：

1. 虽然 spring-boot-starter-web 内嵌 tomcat，但是，内嵌的 spring-boot-starter-tomcat 仅仅包含了 tomcat-embed-core，而不包含 tomcat-embed-jasper。因此需要单独添加该依赖。
2. 使用外部 tomcat 部署，并且用到了 JSP 的，需要有以下配置：

<!--  把 web 中内嵌的 tomcat 去掉。（防止和外部 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>

<!--  注意 tomcat-embed-jasper 的scope。（在编译测试的时候需要这个依赖的参与，但是在部署的时候 tomcat本身就有，这里也是防止冲突） -->
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
    <scope>provided</scope>
</dependency>

总结

1. 默认目前一般都直接打成 jar 包进行部署。
2. 如果需要部署 war 包的，最简单的方法就是 pom 中加上war，以及添加 ServletInitializer 文件（必须）。
3. 如果有需要 JSP 的，添加 tomcat-embed-jasper 和其他需要的依赖。
4. 至于上文中或者其他博客上提到的，需要在 web 包中排除 tomcat，或者 jasper 的 scope 必须是 provided，其实经过测试，改了和没改都一样。（没发生冲突的话，无关紧要；出错了，特别注意这里两个地方就可以了）

参考文献

• springboot embedded tomcat and tomcat-embed-jasper
• Spring Boot：内置tomcat启动和外部tomcat部署总结