快捷導(dǎo)航

SpringBoot項(xiàng)目打成War包部署的方法步驟

更新時(shí)間：2024年10月11日 11:46:00 作者：歐陽(yáng)嘯天

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

簡(jiǎn)介

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

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

因此，部署War包時(shí)請(qǐng)注意使用Tomcat9.0版本?。?！

操作步驟

1、修改pom文件

首先，要將SpringBoot項(xiàng)目打成War包，我們要在pom文件中添加如下配置，以標(biāo)識(shí)要將項(xiàng)目打成War包：

<packaging>war</packaging>

如下圖所示：

接下來(lái)，我們需要配置最終打成的War的名稱，該配置需要在pom文件中build標(biāo)簽中，添加如下配置項(xiàng)：

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

如果不配置這一項(xiàng)，包的名稱會(huì)帶有版本號(hào)，而且會(huì)比較長(zhǎng)，因此還是推薦進(jìn)行此項(xiàng)配置。

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

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

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

2、配置SpringBootServletInitializer

修改SpringBoot項(xiàng)目的啟動(dòng)類，使其繼承 SpringBootServletInitializer

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

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

@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進(jìn)行打包了，可以使用Maven命令打包，當(dāng)然也可以使用Idea的Maven面板直接打包，如下圖所示：

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

外部依賴包問(wèn)題

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

POM文件中添加配置如下：

<!--人大金倉(cāng)驅(qū)動(dòng)-->
  <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、外部依賴打進(jìn)SpringBoot JAR包中

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

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

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

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

此時(shí)，再進(jìn)行打包，人大金倉(cāng)的依賴包就會(huì)打進(jìn)JAR包中。

2、外部依賴打進(jìn)SpringBoot War包中

那么如何將外部依賴打進(jìn)War包呢？其實(shí)也很簡(jiǎn)單，需要在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的錯(cuò)誤-->
        <failOnMissingWebXml>false</failOnMissingWebXml>
        <!--外部依賴jar包打進(jìn)到當(dāng)前項(xiàng)目增加以下屬性配置即可-->
        <webResources>
            <webResource>
                <directory>${pom.basedir}/libs/</directory>
                <targetPath>WEB-INF/lib/</targetPath>
                <includes>
                    <include>**/*.jar</include>
                </includes>
            </webResource>
        </webResources>
    </configuration>
</plugin>

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