Spring Boot2 系列教程(三)理解 Spring Boot 項目中的 parent

前面和大夥聊了 Spring Boot 項目的三種建立方式,這三種建立方式,不管是哪種,建立成功後,pom.xml 座標文件中都有以下一段引用:java

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.8.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

對於這個 parent 的做用,你是否徹底理解?有小夥伴說,不就是依賴的版本號定義在 parent 裏邊嗎?是的,沒錯,可是 parent 的做用可不單單這麼簡單哦!本文鬆哥就來和大夥聊一聊這個 parent 到底有什麼做用。git

基本功能

當咱們建立一個 Spring Boot 工程時,能夠繼承自一個 spring-boot-starter-parent ,也能夠不繼承自它,咱們先來看第一種狀況。先來看 parent 的基本功能有哪些?github

  1. 定義了 Java 編譯版本爲 1.8 。
  2. 使用 UTF-8 格式編碼。
  3. 繼承自 spring-boot-dependencies,這個裏邊定義了依賴的版本,也正是由於繼承了這個依賴,因此咱們在寫依賴時纔不須要寫版本號。
  4. 執行打包操做的配置。
  5. 自動化的資源過濾。
  6. 自動化的插件配置。
  7. 針對 application.properties 和 application.yml 的資源過濾,包括經過 profile 定義的不一樣環境的配置文件,例如 application-dev.properties 和 application-dev.yml。

請注意,因爲application.properties和application.yml文件接受Spring樣式佔位符 $ {...} ,所以 Maven 過濾更改成使用 @ .. @ 佔位符,固然開發者能夠經過設置名爲 resource.delimiter 的Maven 屬性來覆蓋 @ .. @ 佔位符。spring

源碼分析

當咱們建立一個 Spring Boot 項目後,咱們能夠在本地 Maven 倉庫中看到看到這個具體的 parent 文件,以 2.1.8 這個版本爲例,鬆哥 這裏的路徑是 C:\Users\sang\.m2\repository\org\springframework\boot\spring-boot-starter-parent\2.1.8.RELEASE\spring-boot-starter-parent-2.1.8.RELEASE.pom ,打開這個文件,快速閱讀文件源碼,基本上就能夠證明咱們前面說的功能,以下圖: app

咱們能夠看到,它繼承自 spring-boot-dependencies ,這裏保存了基本的依賴信息,另外咱們也能夠看到項目的編碼格式,JDK 的版本等信息,固然也有咱們前面提到的數據過濾信息。最後,咱們再根據它的 parent 中指定的 spring-boot-dependencies 位置,來看看 spring-boot-dependencies 中的定義: spring-boot

在這裏,咱們看到了版本的定義以及 dependencyManagement 節點,明白了爲啥 Spring Boot 項目中部分依賴不須要寫版本號了。源碼分析

不用 parent

可是並不是全部的公司都須要這個 parent ,有的時候,公司裏邊會有本身定義的 parent ,咱們的 Spring Boot 項目要繼承自公司內部的 parent ,這個時候該怎麼辦呢? 編碼

一個簡單的辦法就是咱們自行定義 dependencyManagement 節點,而後在裏邊定義好版本號,再接下來在引用依賴時也就不用寫版本號了,像下面這樣:spa

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.1.8.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

這樣寫以後,依賴的版本號問題雖然解決了,可是關於打包的插件、編譯的 JDK 版本、文件的編碼格式等等這些配置,在沒有 parent 的時候,這些通通要本身去配置。插件

總結

好了,一篇簡單的文章,向大夥展現一下 Spring Boot 項目中 parent 的做用,有問題歡迎留言討論。本文相關的案例鬆哥已經上傳到 GitHub 上了:https://github.com/lenve/javaboy-code-samples

前面和大夥聊了 Spring Boot 項目的三種建立方式,這三種建立方式,不管是哪種,建立成功後,pom.xml 座標文件中都有以下一段引用:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.8.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

對於這個 parent 的做用,你是否徹底理解?有小夥伴說,不就是依賴的版本號定義在 parent 裏邊嗎?是的,沒錯,可是 parent 的做用可不單單這麼簡單哦!本文鬆哥就來和大夥聊一聊這個 parent 到底有什麼做用。

基本功能

當咱們建立一個 Spring Boot 工程時,能夠繼承自一個 spring-boot-starter-parent ,也能夠不繼承自它,咱們先來看第一種狀況。先來看 parent 的基本功能有哪些?

  1. 定義了 Java 編譯版本爲 1.8 。
  2. 使用 UTF-8 格式編碼。
  3. 繼承自 spring-boot-dependencies,這個裏邊定義了依賴的版本,也正是由於繼承了這個依賴,因此咱們在寫依賴時纔不須要寫版本號。
  4. 執行打包操做的配置。
  5. 自動化的資源過濾。
  6. 自動化的插件配置。
  7. 針對 application.properties 和 application.yml 的資源過濾,包括經過 profile 定義的不一樣環境的配置文件,例如 application-dev.properties 和 application-dev.yml。

請注意,因爲application.properties和application.yml文件接受Spring樣式佔位符 $ {...} ,所以 Maven 過濾更改成使用 @ .. @ 佔位符,固然開發者能夠經過設置名爲 resource.delimiter 的Maven 屬性來覆蓋 @ .. @ 佔位符。

源碼分析

當咱們建立一個 Spring Boot 項目後,咱們能夠在本地 Maven 倉庫中看到看到這個具體的 parent 文件,以 2.1.8 這個版本爲例,鬆哥 這裏的路徑是 C:\Users\sang\.m2\repository\org\springframework\boot\spring-boot-starter-parent\2.1.8.RELEASE\spring-boot-starter-parent-2.1.8.RELEASE.pom ,打開這個文件,快速閱讀文件源碼,基本上就能夠證明咱們前面說的功能,以下圖:

咱們能夠看到,它繼承自 spring-boot-dependencies ,這裏保存了基本的依賴信息,另外咱們也能夠看到項目的編碼格式,JDK 的版本等信息,固然也有咱們前面提到的數據過濾信息。最後,咱們再根據它的 parent 中指定的 spring-boot-dependencies 位置,來看看 spring-boot-dependencies 中的定義:

在這裏,咱們看到了版本的定義以及 dependencyManagement 節點,明白了爲啥 Spring Boot 項目中部分依賴不須要寫版本號了。

不用 parent

可是並不是全部的公司都須要這個 parent ,有的時候,公司裏邊會有本身定義的 parent ,咱們的 Spring Boot 項目要繼承自公司內部的 parent ,這個時候該怎麼辦呢?

一個簡單的辦法就是咱們自行定義 dependencyManagement 節點,而後在裏邊定義好版本號,再接下來在引用依賴時也就不用寫版本號了,像下面這樣:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.1.8.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

這樣寫以後,依賴的版本號問題雖然解決了,可是關於打包的插件、編譯的 JDK 版本、文件的編碼格式等等這些配置,在沒有 parent 的時候,這些通通要本身去配置。

總結

好了,一篇簡單的文章,向大夥展現一下 Spring Boot 項目中 parent 的做用,有問題歡迎留言討論。本文相關的案例鬆哥已經上傳到 GitHub 上了:https://github.com/lenve/javaboy-code-samples

相關文章
相關標籤/搜索