解决SpringBoot多模块发布时99%的问题？SpringBoot发布的8个原则和4个问题的解决方案

素颜马尾好姑娘i 2023-10-18 20:13 76阅读 0赞

![image.png][]

如果使用 SpringBoot 多模块发布到外部 Tomcat，可能会遇到各种各样的问题。本文归纳了以下 8 个原则和发布时经常出现的 4 个问题的解决方案，掌握了这些原则和解决方案，几乎可以解决绝大数 SpringBoot 发布问题。

### SpringBoot 多模块发布的 8 大原则 ###

#### 1 在发布模块打包，而不是父模块上打包 ####

比如，以下项目目录：  
![image.png][image.png 1]  
如果要发布 `api` 就直接在它的模块上打包，而不是在父模块上打包。

#### 2 公共调用模块，打包类型设置为 jar 格式 ####

公共模块，比如 `common` 和 `model` 需要设置 `packaging` 为 `jar` 格式，在 `pom.xml` 配置：

#### 3 发布模块打包类型设置为 war 格式 ####

在发布的模块 `pom.xml` 中设置：

#### 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 包，就完成了项目的打包，如下图所示：  
![image.png][image.png 2]

#### 8 部署项目 ####

有了 war 包之后，只需要把单个 war 包，放入 tomcat 的 webapps 目录，重新启动 tomcat 即可，如下图所示：  
![image.png][image.png 3]  
项目正常运行会在 webapps 目录下生成同名的文件夹，如下图所示：  
![image.png][image.png 4]  
完成以上配置，就可以 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+ 最新的版本，就可以解决这个问题。

![公众号二维码][java-wechat-201906.jpg]

[image.png]: https://cdn.nlark.com/yuque/0/2019/png/92791/1561011534866-4cfde4da-d72e-443a-812b-27701018d0f7.png#align=left&display=inline&height=274&name=image.png&originHeight=411&originWidth=883&size=50502&status=done&width=588.6666666666666
[image.png 1]: https://cdn.nlark.com/yuque/0/2019/png/92791/1561014562851-166d5895-c24f-41e0-9950-b89f19b64924.png#align=left&display=inline&height=142&name=image.png&originHeight=213&originWidth=431&size=11156&status=done&width=287.3333333333333
[image.png 2]: https://cdn.nlark.com/yuque/0/2019/png/92791/1561015511845-b2a00a80-58bf-4015-a2c0-b129ca130ef2.png#align=left&display=inline&height=598&name=image.png&originHeight=897&originWidth=587&size=66169&status=done&width=391.3333333333333
[image.png 3]: https://cdn.nlark.com/yuque/0/2019/png/92791/1561009392452-44bea223-924e-4387-ad5b-40f4385b72ce.png#align=left&display=inline&height=275&name=image.png&originHeight=412&originWidth=611&size=63460&status=done&width=407.3333333333333
[image.png 4]: https://cdn.nlark.com/yuque/0/2019/png/92791/1561009354651-a8151f81-35bc-4eb3-9106-f644c8933e88.png#align=left&display=inline&height=205&name=image.png&originHeight=307&originWidth=590&size=38366&status=done&width=393.3333333333333
[java-wechat-201906.jpg]: http://icdn.apigo.cn/myinfo/java-wechat-201906.jpg