1. 程式人生 > >解決SpringBoot多模組釋出時99%的問題?SpringBoot釋出的8個原則和4個問題的解決方案

解決SpringBoot多模組釋出時99%的問題?SpringBoot釋出的8個原則和4個問題的解決方案

如果使用的是 SpringBoot 多模組的專案,在釋出的時候可能遇到各種各樣的問題。本文歸納了以下 8 個原則和釋出時經常出現的 4 個問題的解決方案,掌握了這些原則和解決方案,幾乎可以解決絕大數 SpringBoot 釋出問題。

SpringBoot 多模組釋出的 8 大原則

1 在釋出模組打包,而不是父模組上打包

比如,以下專案目錄:

如果要釋出 api 就直接在它的模組上打包,而不是在父模組上打包。

2 公共呼叫模組,打包型別設定為 jar 格式

公共模組,比如 common 和 model 需要設定 packaging 為 jar 格式,在 pom.xml 配置:

<packaging>jar</packaging>

3 釋出模組打包型別設定為 war 格式

在釋出的模組 pom.xml 中設定:

<packaging>war</packaging>

4 排除內建 tomcat

在釋出的模組 pom.xml 中設定:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

當設定 scope=provided 時,此 jar 包不會出現在釋出的專案中,從而就排除了內建的 tomcat。

5 設定啟動類

此步驟相當於告訴 tomcat 啟動的入口在哪。需要在啟動類新增如下程式碼:

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

6 如果使用攔截器一定要排除靜態檔案

比如我在專案中使用了 swagger,那我就需要排除 swagger 的靜態檔案,程式碼如下:

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 排除靜態檔案
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    // do something
}

7 先裝載公共模組,再發布專案

如果釋出的模組引用了本專案的其他公共模組,需要先把本專案的公共模組裝載到本地倉庫。
操作方式,雙擊父模組的 install 即可, install 成功之後,點擊發布模組的 package 生成 war 包,就完成了專案的打包,如下圖所示:

8 部署專案

有了 war 包之後,只需要把單個 war 包,放入 tomcat 的 webapps 目錄,重新啟動 tomcat 即可,如下圖所示:

專案正常執行會在 webapps 目錄下生成同名的資料夾,如下圖所示:

完成以上配置,就可以 happy 的訪問自己釋出的專案了。

可能出現的問題和解決方案

問題一:SpringBoot 配置了埠號影不影響程式釋出?

答:不影響,配置的 server.port 會被覆蓋,以 tomcat 本身的埠號為準,tomcat 埠號在 tomcat/config/server.xml  檔案中配置。

問題二:釋出報錯,不能找到其他模組或專案中的公共模組,怎麼辦?

答:因為沒有執行父節點 maven 的 install 操作,install 就是把公共模組放入本地倉庫,提供給其它專案使用。

問題三:不能找到 SpringBoot 執行的 main 類,怎麼辦?

答:因為沒有設定啟動類導致的,設定方式:

  • pom.xml 配置啟動類,配置 configuration><mainClass>com.bi.api.ApiApplication</mainClass></configuration> 。
  • 啟動類繼承 SpringBootServletInitializer 實現 SpringApplicationBuilder 方法,具體程式碼參考文中第五部分。

    問題四:把 SpringBoot 專案部署到 Tomcat 7 一直提示找不到 xxx.jar 包?

    答:這是因為 SpringBoot 版本太高,tomcat 版本太低的原因。如果你使用的是最新版的 SpringBoot,可以考慮把 tomcat 也升級為 tomcat 8.x+ 最新的版本,就可以解決這個問題。