部署SpringBoot Project到外置Tomcat容器

亦凉 2023-10-11 11:49 16阅读 0赞

#### 一、SpringBoot Project两种打包方式 ####

SpringBoot 项目约定优于配置，连Tomcat都自集成了，只用直接编写SpringBoot启动类，然后一键开启内置的Tomcat容器服务即可部署运行。但如果要部署到本地Tomcat或部署到某个服务器上，此时就需要剥离掉SpringBoot项目内置的Tomcat，进而将应用发布并部署到外置的Tomcat容器之中。  
![新建SpringBoot项目两种打包方式][SpringBoot]

#### 二、修改Project打包方式 ####

**1. 修改`<packaging>`**

修改项目的pom.xml配置，将打包方式由jar修改为war：

<groupId>com.foxconn.idsbg</groupId>
    <artifactId>csapp_system</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>

**2. 移除自带的嵌入式Tomcat**

修改pom.xml，移除SpringBoot自带的的嵌入式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>

**3. 添加servlet-api依赖**

pom.xml文件中添加servlet-api的依赖：

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

**4. 修改启动类，并重写初始化方法**

在SpringBoot中平常用main方法启动的方式，都有一个SpringBootApplication的启动类，类似代码如下：

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

现在需要类似于web.xml的配置方式来启动SpringBoot应用，为此需要修改 SpringBootApplication启动类，使其继承 `SpringBootServletInitializer`并重写 configure 方法：

// 修改启动类，继承 SpringBootServletInitializer 并重写 configure 方法
    @SpringBootApplication
    public class CsappSystemApplication extends SpringBootServletInitializer { 
    
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder applicationBuilder) { 
        	// 注意这里一定要指向原先用main方法执行的Application启动类
            return applicationBuilder.sources(CsappSystemApplication.class);
        }
    
        public static void main(String[] args) { 
            SpringApplication.run(CsappSystemApplication.class, args);
        }
    }

#### 三、部署到外部Tomcat容器 ####

**1. 部署到本地Tomcat**

*  配置Local Tomcat：  
    ![配置本地Tomcat][Tomcat]
 *  部署war包到Tomcat，注意发布之前 maven clean：  
    ![Local Tomcat发布war包][Local Tomcat_war]

**2. 部署到服务器Tomcat**

配置服务器Tomcat：

*  官网下载Tomcat(`.tar.gz`)上传到Linux服务器并解压重命名；
 *  修改Tomcat端口号；
 *  启动Tomcat浏览器测试是否能成功访问。

部署到服务器（Tomcat）下：

*  `mvn - clean - package`；  
    ![maven clean package][]
 *  打包成功后把target目录下生成的war包放到tomcat的webapps目录下，启动tomcat，即可自动解压部署；  
    ![SpringBoot target目录下war包][SpringBoot target_war]
 *  浏览器中输入`http://YOUR_IP:[端口号]/[打包项目名]`验证  
    ![浏览器成功访问][format_png]

#### 四、Jar包和War包 ####

Jar包：其实Jar包就是Java的类进行编译生成的class文件被压缩后的压缩包，里面就是一些class文件。当我们自己使用maven写一些java程序，进行打包生成jar包。同时在可以在其他的工程下使用，其他工程使用时需导入该jar包。

War包：其实就是一个web程序进行打包便于部署的压缩包，里面包含我们web程序需要的一些东西，其中包括web.xml的配置文件，前端的页面文件，以及依赖的jar。当部署War时，直接放到tomcat的webapps目录下，然后启动tomcat即可。

**区别：**

*  Jar包：通常是开发时要引用通用类，打成包便于存放管理；
 *  War包：是做好一个web应用后，通常是网站，打成包部署到web应用容器中（如Tomcat）。

[SpringBoot]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9xaW5pdS53Znh1bmkuY29tL3NwcmluZ2Jvb3QvJUU2JTk2JUIwJUU1JUJCJUJBU3ByaW5nQm9vdCVFOSVBMSVCOSVFNyU5QiVBRSVFNCVCOCVBNCVFNyVBNyU4RCVFNiU4OSU5MyVFNSU4QyU4NSVFNiU5NiVCOSVFNSVCQyU4Ri5wbmc?x-oss-process=image/format,png
[Tomcat]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9xaW5pdS53Znh1bmkuY29tL3NwcmluZ2Jvb3QvJUU5JTg1JThEJUU3JUJEJUFFJUU2JTlDJUFDJUU1JTlDJUIwVG9tY2F0LnBuZw?x-oss-process=image/format,png
[Local Tomcat_war]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9xaW5pdS53Znh1bmkuY29tL3NwcmluZ2Jvb3QvJUU5JTgzJUE4JUU3JUJEJUIyU3ByaW5nQm9vdCVFOSVBMSVCOSVFNyU5QiVBRSVFOCU4NyVCMyVFNiU5QyVBQyVFNSU5QyVCMFRvbWNhdC5wbmc?x-oss-process=image/format,png
[maven clean package]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9xaW5pdS53Znh1bmkuY29tL3NwcmluZ2Jvb3QvbWF2ZW4lMjBjbGVhbiUyMHBhY2thZ2UucG5n?x-oss-process=image/format,png
[SpringBoot target_war]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9xaW5pdS53Znh1bmkuY29tL3NwcmluZ2Jvb3QvU3ByaW5nQm9vdCUyMHRhcmdldCVFNyU5QiVBRSVFNSVCRCU5NSVFNCVCOCU4QndhciVFNSU4QyU4NS5wbmc?x-oss-process=image/format,png
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9xaW5pdS53Znh1bmkuY29tL3NwcmluZ2Jvb3QvJUU2JUI1JThGJUU4JUE3JTg4JUU1JTk5JUE4JUU2JTg4JTkwJUU1JThBJTlGJUU4JUFFJUJGJUU5JTk3JUFFLnBuZw?x-oss-process=image/format,png