如果使用的是 SpringBoot 多模塊的項目倚舀,在發(fā)布的時候可能遇到各種各樣的問題。本文歸納了以下 8 個原則和發(fā)布時經(jīng)常出現(xiàn)的 4 個問題的解決方案痕貌,掌握了這些原則和解決方案,幾乎可以解決絕大數(shù) SpringBoot 發(fā)布問題超升。
SpringBoot多模塊發(fā)布的8大原則
1 在發(fā)布模塊打包哺徊,而不是父模塊上打包
比如,以下項目目錄:
如果要發(fā)布 api 就直接在它的模塊上打包研乒,而不是在父模塊上打包淋硝。
2 公共調(diào)用模塊雹熬,打包類型設(shè)置為jar格式
公共模塊谣膳,比如 common 和 model 需要設(shè)置 packaging 為 jar 格式,在 pom.xml 配置:
<packaging>jar</packaging>
3 發(fā)布模塊打包類型設(shè)置為war格式
在發(fā)布的模塊 pom.xml 中設(shè)置:
<packaging>war</packaging>
4 排除內(nèi)置tomcat
在發(fā)布的模塊 pom.xml 中設(shè)置:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
當設(shè)置 scope=provided 時烈菌,此 jar 包不會出現(xiàn)在發(fā)布的項目中,從而就排除了內(nèi)置的 tomcat挚赊。
5 設(shè)置啟動類
此步驟相當于告訴 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 包,就完成了項目的打包饶火,如下圖所示:
8 部署項目
有了 war 包之后,只需要把單個 war 包当辐,放入 tomcat 的 webapps 目錄鲤看,重新啟動 tomcat 即可,如下圖所示:
項目正常運行會在 webapps 目錄下生成同名的文件夾找筝,如下圖所示:
完成以上配置慷吊,就可以 happy 的訪問自己發(fā)布的項目了。
可能出現(xiàn)的問題和解決方案
問題一:SpringBoot 配置了端口號影不影響程序發(fā)布溉瓶?
答:不影響谤民,配置的 server.port 會被覆蓋疾宏,以 tomcat 本身的端口號為準,tomcat 端口號在 tomcat/config/server.xml 文件中配置兢榨。
問題二:發(fā)布報錯顺饮,不能找到其他模塊或項目中的公共模塊凌那,怎么辦?
答:因為沒有執(zhí)行父節(jié)點 maven 的 install 操作帽蝶,install 就是把公共模塊放入本地倉庫,提供給其它項目使用励稳。
問題三:不能找到 SpringBoot 運行的 main 類,怎么辦趣避?
答:因為沒有設(shè)置啟動類導(dǎo)致的新翎,設(shè)置方式:
pom.xml 配置啟動類,配置 configuration><mainClass>com.bi.api.ApiApplication</mainClass></configuration> 地啰。
啟動類繼承 SpringBootServletInitializer 實現(xiàn) SpringApplicationBuilder 方法,具體代碼參考文中第五部分岭埠。
問題四:把 SpringBoot 項目部署到 Tomcat 7 一直提示找不到 xxx.jar 包蔚鸥?
答:這是因為 SpringBoot 版本太高,tomcat 版本太低的原因株茶。如果你使用的是最新版的 SpringBoot,可以考慮把 tomcat 也升級為 tomcat 8.x+ 最新的版本蹦掐,就可以解決這個問題。