如果使用 SpringBoot 多模塊發佈到外部 Tomcat,可能會遇到各種各樣的問題。本文歸納了以下 8 個原則和發佈時經常出現的 4 個問題的解決方案,掌握了這些原則和解決方案,幾乎可以解決絕大數 SpringBoot 發佈問題。
SpringBoot 多模塊發佈的 8 大原則
1 在發佈模塊打包,而不是父模塊上打包
比如,以下項目目錄:
如果要發佈 api 就直接在它的模塊上打包,而不是在父模塊上打包。
2 公共調用模塊,打包類型設置為 jar 格式
公共模塊,比如 common 和 model 需要設置 packaging 為 jar 格式,在 pom.xml 配置:
<code><packaging>jar/<packaging>/<code>
3 發佈模塊打包類型設置為 war 格式
在發佈的模塊 pom.xml 中設置:
<code><packaging>war/<packaging>/<code>
4 排除內置 tomcat
在發佈的模塊 pom.xml 中設置:
<code><dependency> <groupid>org.springframework.boot/<groupid> <artifactid>spring-boot-starter-tomcat/<artifactid> <scope>provided/<scope>/<dependency>/<code>
當設置 scope=provided 時,此 jar 包不會出現在發佈的項目中,從而就排除了內置的 tomcat。
5 設置啟動類
此步驟相當於告訴 tomcat 啟動的入口在哪。需要在啟動類添加如下代碼:
<code>@SpringBootApplicationpublic 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); }}/<code>
6 如果使用攔截器一定要排除靜態文件
比如我在項目中使用了 swagger,那我就需要排除 swagger 的靜態文件,代碼如下:
<code>@Configurationpublic 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}/<code>
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> 。
- 啟動類繼承 SpringBootServletInitializer 實現 SpringApplicationBuilder 方法,具體代碼參考文中第五部分。
問題四:把 SpringBoot 項目部署到 Tomcat 7 一直提示找不到 xxx.jar 包?
答:這是因為 SpringBoot 版本太高,tomcat 版本太低的原因。如果你使用的是最新版的 SpringBoot,可以考慮把 tomcat 也升級為 tomcat 8.x+ 最新的版本,就可以解決這個問題。
最後在這裡給大家免費分享一波福利,都是視頻資料,裡面就包涵了Java高併發、分佈式、微服務、高性能、源碼分析、JVM等技術資料,感興趣的私信我回復【java】
最後祝福所有遇到瓶疾且不知道怎麼辦的Java程序員們,在往後的工作與面試中一切順利。
注:
作者:王磊的博客
鏈接:http://www.imooc.com/article/288232
閱讀更多 程序汪丶 的文章