序言:SpringBoot 的核心理念是約定優于配置,例如在資源目錄的static放置靜態資源就能直接訪問,templates目錄放置動態頁面就能自動初始化和實現訪問,例如Thymeleaf、FreeMaker等。
一、整體結構圖
SpringBoot 官方并不要求特殊的工程結構,但在實際開發中,我們往往遵循一定的規范來組織代碼結構,例如下面的典型結構圖:
github.com/yizhiwazi
二、主要用途(必讀)
使用 Spring Initializr 構建的SpringBoot工程的各目錄,如下圖所示:
重要提示:SpringBoot 官方推薦我們使用輕量級的Jar File 格式來打包和部署工程,如果想部署War File的傳統Web項目,則必須添加webapp目錄,和進行相關初始化才能正常使用,詳情點擊:SpringBoot 添加對JSP的支持
三、關于啟動類的放置
官方文檔是有提到 main application class的,但隱藏得比較深,大概老外都覺得是共識,不過這對剛入門的新手顯然是個坑。。
在 SpringBoot 快速入門 案例中我們輕松的就完成了RestAPI的訪問,興奮感溢于言表,但很快你可能會發現一些端倪,為什么通篇找不到關于組件掃描的配置,難道這背后存在什么潛規則?
提問:為什么啟動類“約定”放在RootPackage呢?
解答:
- ① 如果將啟動類放在頂層,配合注解@SpringBootApplication 實現默認向后掃描,例如:
@SpringBootApplication
public class HelloApplication {
public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
}
}
- ② 這是為什么呢,我們繼續觀察 @SpringBootApplication 的源代碼,不難發現,作為啟動類的便攜式入口注解,其主要由三大部件組成,其中@ComponentScan 這個注解就是本案的關鍵,根據SpringBoot的內置實現,Spring從這個注解所在的位置默認向后掃描,包括常見的Controller、Service、Entity都可以掃描到。
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
public @interface SpringBootApplication {
}
- ③ 總結:將啟動類放置在RootPackage,可以隱式完成組件掃描,不需要單獨定義@ComponentScan(basePackages="com.hehe.xx"),踐行了SpringBoot 約定優于配置的核心理念。
四、關于靜態資源的放置
Spring Boot 默認“約定”從資源目錄的這些子目錄讀取靜態資源:
- src/main/resources/META-INF/resources
- src/main/resources/static (推薦)
- src/main/resources/public
舉個栗子:現在static目錄下有一張圖片,kumamon.jpg
訪問地址: http://localhost:8080/img/kumamon.jpg
注:若不同靜態目錄含有相同路徑圖片,則按上述優先級,即META-INF/resources目錄優先級最高。