解決SpringBoot多模塊發(fā)布時99%的問題

更新時間：2019年07月19日 10:37:28 作者：王磊的博客

本文歸納了以下 8 個原則和發(fā)布時經常出現的 4 個問題的解決方案，掌握了這些原則和解決方案，幾乎可以解決絕大數SpringBoot發(fā)布問題

解決SpringBoot多模塊發(fā)布時99%的問題？SpringBoot發(fā)布的8個原則和4個問題的解決方案

如果使用 SpringBoot 多模塊發(fā)布到外部 Tomcat，可能會遇到各種各樣的問題。本文歸納了以下 8 個原則和發(fā)布時經常出現的 4 個問題的解決方案，掌握了這些原則和解決方案，幾乎可以解決絕大數 SpringBoot 發(fā)布問題。

SpringBoot 多模塊發(fā)布的 8 大原則

1 在發(fā)布模塊打包，而不是父模塊上打包

比如，以下項目目錄：

如果要發(fā)布 api 就直接在它的模塊上打包，而不是在父模塊上打包。

2 公共調用模塊，打包類型設置為 jar 格式

<packaging>jar</packaging>

公共模塊，比如 common 和 model 需要設置 packaging 為 jar 格式，在 pom.xml 配置：

3 發(fā)布模塊打包類型設置為 war 格式

在發(fā)布的模塊 pom.xml 中設置：

<packaging>war</packaging>

4 排除內置 tomcat

在發(fā)布的模塊 pom.xml 中設置：

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

當設置 scope=provided 時，此 jar 包不會出現在發(fā)布的項目中，從而就排除了內置的 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 如果使用攔截器一定要排除靜態(tài)文件

比如我在項目中使用了 swagger，那我就需要排除 swagger 的靜態(tài)文件，代碼如下：

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

7 先裝載公共模塊，再發(fā)布項目

如果發(fā)布的模塊引用了本項目的其他公共模塊，需要先把本項目的公共模塊裝載到本地倉庫。
操作方式，雙擊父模塊的 install 即可， install 成功之后，點擊發(fā)布模塊的 package 生成 war 包，就完成了項目的打包，如下圖所示：