Spring Boot 2.x基礎教程：工程結構推薦

CollinPeng 發布于2019-08-19 11:38 / 869人閱讀

摘要：典型示例以下結構是比較推薦的組織方式，所有的類和其他都在之下。應用主類，該類直接位于下。默認情況下，的應用主類會自動掃描以及所有子包下的所有類來進行初始化。

Spring Boot框架本身并沒有對工程結構有特別的要求，但是按照最佳實踐的工程結構可以幫助我們減少可能會遇見的坑，尤其是Spring包掃描機制的存在，如果您使用最佳實踐的工程結構，可以免去不少特殊的配置工作。

典型示例

以下結構是比較推薦的package組織方式：

com
  +- example
    +- myproject
      +- Application.java
      |
      +- domain
      |  +- Customer.java
      |  +- CustomerRepository.java
      |
      +- service
      |  +- CustomerService.java
      |
      +- web
      |  +- CustomerController.java
      |

root package：com.example.myproject，所有的類和其他package都在root package之下。

應用主類：Application.java，該類直接位于root package下。通常我們會在應用主類中做一些框架配置掃描等配置，我們放在root package下可以幫助程序減少手工配置來加載到我們希望被Spring加載的內容

com.example.myproject.domain包：用于定義實體映射關系與數據訪問相關的接口和實現

com.example.myproject.service包：用于編寫業務邏輯相關的接口與實現

com.example.myproject.web：用于編寫Web層相關的實現，比如：Spring MVC的Controller等

上面的結構中，root package與應用主類的位置是整個結構的關鍵。由于應用主類在root package中，所以按照上面的規則定義的所有其他類都處于root package下的其他子包之后。默認情況下，Spring Boot的應用主類會自動掃描root package以及所有子包下的所有類來進行初始化。

什么意思呢？舉個例子，假設我們將com.example.myproject.web包與上面所述的root package：com.example.myproject放在同一級，像下面這樣：

com
  +- example
    +- myproject
      +- Application.java
      |
      +- domain
      |  +- Customer.java
      |  +- CustomerRepository.java
      |
      +- service
      |  +- CustomerService.java
      |
    +- web
    |  +- CustomerController.java
    |

這個時候，應用主類Application.java在默認情況下就無法掃描到com.example.myproject.web中的Controller定義，就無法初始化Controller中定義的接口。

非典型結構下的初始化

那么如果，我們一定要加載非root package下的內容怎么辦呢？

方法一：使用@ComponentScan注解指定具體的加載包，比如：

@SpringBootApplication
@ComponentScan(basePackages="com.example")
public class Bootstrap {

    public static void main(String[] args) {
        SpringApplication.run(Bootstrap.class, args);
    }

}

這種方法通過注解直接指定要掃描的包，比較直觀。如果有這樣的需求也是可以用的，但是原則上還是推薦以上面的典型結構來定義，這樣也可以少寫一些注解，代碼更加簡潔。

方法二：使用@Bean注解來初始化，比如：

@SpringBootApplication
public class Bootstrap {

    public static void main(String[] args) {
        SpringApplication.run(Bootstrap.class, args);
    }

    @Bean
    public CustomerController customerController() {
        return new CustomerController();
    }

}

這種方法在業務開發的時候并不是特別推薦，更適合用于框架封裝等場景，關于更多封裝上的技巧，后面我們在進階教程中詳細講解。

如果讀者覺得自己團隊使用的工程結構不錯，歡迎留言分享~

代碼示例

本教程配套倉庫：

Github：https://github.com/dyc87112/SpringBoot-Learning/tree/2.x

Gitee：https://gitee.com/didispace/SpringBoot-Learning/tree/2.x

如果您覺得本文不錯，歡迎Star支持，您的關注是我堅持的動力！

專欄推薦

Spring Boot從入門到精通

Spring Cloud從入門到精通

關聯內容

Spring Boot工程結構推薦 - 1.x版本

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/77609.html

Spring Boot 2.x基礎教程：快速入門

摘要：編寫一個接口創建命名為根據實際情況修改創建類，內容如下啟動主程序，使用等工具發起請求，可以看到頁面返回編寫單元測試用例打開的下的測試入口類。簡介在您第1次接觸和學習Spring框架的時候，是否因為其繁雜的配置而退卻了？在你第n次使用Spring框架的時候，是否覺得一堆反復黏貼的配置有一些厭煩？那么您就不妨來試試使用Spring Boot來讓你更易上手，更簡單快捷地構建Spring應...

tigerZH 2019-08-16 16:08 評論0 收藏0
Spring Boot 2 快速教程：WebFlux 集成 Thymeleaf（五）

摘要：數據和信息是不可分離的，數據是信息的表達，信息是數據的內涵。數據本身沒有意義，數據只有對實體行為產生影響時才成為信息。主要目標是為開發提供天然的模板，并且能在里面準確的顯示。目前是自然更加推薦。這是泥瓦匠的第105篇原創文章工程： JDK 1.8 Maven 3.5.2 Spring Boot 2.1.3.RELEASE 工程名：springboot-webflux-4-thym...

姘存按 2019-08-16 17:46 評論0 收藏0
Spring Boot 2.x 系列教程：WebFlux 系列教程大綱（一）

摘要：使用則需要及以上版本。開發使用框架七系列教程目錄系列教程大綱快速入門實踐實踐整合整合中和實踐整合中實現緩存中實現通信集成測試及部署實戰圖書管理系統 WebFlux 系列教程大綱一、背景大家都知道，Spring Framework 是 Java/Spring 應用程序跨平臺開發框架，也是 Java EE（Java Enterprise Edition）輕量級框架，其 Spring ...

jone5679 2019-08-16 16:53 評論0 收藏0
Spring Boot 2.x 系列教程：WebFlux REST API 全局異常處理 Error

摘要：挺多人咨詢的，異常處理用切面注解去實現去全局異常處理。全局異常處理類，代碼如下代碼解析如下抽象類是用來處理全局錯誤時進行擴展和實現注解標記的切面排序，值越小擁有越高的優先級，這里設置優先級偏高。本文內容為什么要全局異常處理？ WebFlux REST 全局異常處理實戰小結摘錄：只有不斷培養好習慣，同時不斷打破壞習慣，我們的行為舉止才能夠自始至終都是正確的。一、為什么要全局...

BicycleWarrior 2019-08-16 16:43 評論0 收藏0
Spring Boot 2 快速教程：WebFlux 快速入門（二）

摘要：響應式編程是基于異步和事件驅動的非阻塞程序，只是垂直通過在內啟動少量線程擴展，而不是水平通過集群擴展。三特性常用的生產的特性如下響應式編程模型適用性內嵌容器組件還有對日志消息測試及擴展等支持。摘要: 原創出處 https://www.bysocket.com 「公眾號：泥瓦匠BYSocket 」歡迎關注和轉載，保留摘要，謝謝！ 02：WebFlux 快速入門實踐文章工程： JDK...

gaara 2019-08-16 17:14 評論0 收藏0