前面和大夥聊了 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 的基本功能有哪些?
- 定義了 Java 編譯版本爲 1.8 。
- 使用 UTF-8 格式編碼。
- 繼承自
spring-boot-dependencies
,這個裏邊定義了依賴的版本,也正是因爲繼承了這個依賴,所以我們在寫依賴時纔不需要寫版本號。 - 執行打包操作的配置。
- 自動化的資源過濾。
- 自動化的插件配置。
- 針對 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。
前面和大夥聊了 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 的基本功能有哪些?
- 定義了 Java 編譯版本爲 1.8 。
- 使用 UTF-8 格式編碼。
- 繼承自
spring-boot-dependencies
,這個裏邊定義了依賴的版本,也正是因爲繼承了這個依賴,所以我們在寫依賴時纔不需要寫版本號。 - 執行打包操作的配置。
- 自動化的資源過濾。
- 自動化的插件配置。
- 針對 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。