快捷導(dǎo)航

SpringBoot項目打成War包部署的方法步驟

更新時間：2024年10月11日 11:46:00 作者：歐陽嘯天

這篇文章主要介紹了springboot項目如何打war包流程的方法,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

簡介

一般情況下，在SpringBoot項目開發(fā)完成進行服務(wù)器部署時，都是打成JAR包進行部署運行的。但是在有些情況下也需要將其打成War包使用Tomcat進行部署。本篇文章就簡單介紹一下SpringBoot如何打成War包。

注意：測試Demo的SpringBoot版本為2.7.17，根據(jù)SpringBoot官網(wǎng)，對應(yīng)的Servlet容器版本如下圖所示：

因此，部署War包時請注意使用Tomcat9.0版本?。?！

操作步驟

1、修改pom文件

首先，要將SpringBoot項目打成War包，我們要在pom文件中添加如下配置，以標識要將項目打成War包：

<packaging>war</packaging>

如下圖所示：

接下來，我們需要配置最終打成的War的名稱，該配置需要在pom文件中build標簽中，添加如下配置項：

<build>
    # 或者直接改成需要的名稱
    <finalName>${artifactId}</finalName>
</build>

如果不配置這一項，包的名稱會帶有版本號，而且會比較長，因此還是推薦進行此項配置。

然后，就是在pom文件中添加Tomcat的依賴項，如下所示：

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-tomcat</artifactId>
			<!-- scope 各配置簡單介紹
                1.test范圍是指測試范圍有效,在編譯和打包時都不會使用這個依賴
                2.compile范圍是指編譯范圍內(nèi)有效,在編譯和打包時都會將依賴存儲進去
                3.provided依賴,在編譯和測試過程中有效,最后生成的war包時不會加入 例如:
                    servlet-api,因為servlet-api在tomcat服務(wù)器已經(jīng)存在了,如果再打包會沖突
                4.runtime在運行時候依賴,在編譯時候不依賴
                5.system表示此依賴來自于外部jar, 而不是maven倉庫
                如果引入依賴未指定，默認依賴范圍是compile
            -->
   <scope>provided</scope>
</dependency>

以上配置完成后，pom文件的修改就算完成。

2、配置SpringBootServletInitializer

修改SpringBoot項目的啟動類，使其繼承 SpringBootServletInitializer

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

也可以繼承之后重寫 configure方法，如下所示，不過根據(jù)我的測試，該方法是否重寫并不影響最終效果。

@SpringBootApplication
public class DemoApplication extends SpringBootServletInitializer {

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

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(DemoApplication.class);
    }
}

修改完成之后，就可以使用Maven進行打包了，可以使用Maven命令打包，當然也可以使用Idea的Maven面板直接打包，如下圖所示：

命令執(zhí)行完畢之后即可在target目錄下看到項目打成War包。此時將War包放入到Tomcat的webapps目錄下啟動Tomcat即可。

外部依賴包問題

在SpringBoot項目中，有些依賴包無法通過Maven進行依賴，而是需要新建libs目錄進行依賴添加。比如本人在項目開發(fā)中使用了人大金倉數(shù)據(jù)庫，該數(shù)據(jù)庫的驅(qū)動包就是通過libs目錄進行添加的，如下圖所示：

POM文件中添加配置如下：

<!--人大金倉驅(qū)動-->
  <dependency>
    <groupId>com.kingbase8.jdbc</groupId>
    <artifactId>kingbase8</artifactId>
    <version>8.6.0</version>
    <scope>system</scope>
    <systemPath>${pom.basedir}/libs/kingbase8-8.6.0.jar</systemPath>
 </dependency>

1、外部依賴打進SpringBoot JAR包中

如果將上述的外部依賴打進JAR包呢？我們只需要在POM文件中的spring-boot-maven-plugin插件中添加如下配置即可：

<!--設(shè)置為true，把本地system的jar包括進來-->
<includeSystemScope>true</includeSystemScope>

完整的spring-boot-maven-plugin插件配置如下所示：

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <!--設(shè)置為true，以便把本地的system的jar也包括進來-->
        <includeSystemScope>true</includeSystemScope>
        <excludes>
            <exclude>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </exclude>
        </excludes>
    </configuration>
</plugin>

此時，再進行打包，人大金倉的依賴包就會打進JAR包中。

2、外部依賴打進SpringBoot War包中

那么如何將外部依賴打進War包呢？其實也很簡單，需要在POM文件中添加maven-war-plugin 插件，完整配置如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>3.3.2</version>
    <configuration>
        <!--failOnMissingWebXml設(shè)置為false，讓系統(tǒng)忽略缺少WEB-INF的錯誤-->
        <failOnMissingWebXml>false</failOnMissingWebXml>
        <!--外部依賴jar包打進到當前項目增加以下屬性配置即可-->
        <webResources>
            <webResource>
                <directory>${pom.basedir}/libs/</directory>
                <targetPath>WEB-INF/lib/</targetPath>
                <includes>
                    <include>**/*.jar</include>
                </includes>
            </webResource>
        </webResources>
    </configuration>
</plugin>

配置之后，再次打包，就可以將外部依賴打進War包中。