Spring boot專案搭建及簡單例項
Spring boot專案搭建
Spring Boot 概述
Build Anything with Spring Boot:Spring Boot is the starting point for building all Spring-based applications. Spring Boot is designed to get you up and running as quickly as possible, with minimal upfront configuration of Spring.
上面是引自官網的一段話,大概是說: Spring Boot 是所有基於 Spring 開發的專案的起點。Spring Boot 的設計是為了讓你儘可能快的跑起來 Spring 應用程式並且儘可能減少你的配置檔案。
Spring Boot 快速搭建
第一步:新建專案
選擇 Spring Initializr ,然後選擇預設的 url 點選【Next】:
然後修改一下專案的資訊:
勾選上 Web 模板:
選擇好專案的位置,點選【Finish】:
如果是第一次配置 Spring Boot 的話可能需要等待一會兒 IDEA 下載相應的 依賴包,預設建立好的專案結構如下:
專案結構還是看上去挺清爽的,少了很多配置檔案,我們來了解一下預設生成的有什麼:
- SpringbootApplication: 一個帶有 main() 方法的類,用於啟動應用程式
- SpringbootApplicationTests:一個空的 Junit 測試了,它載入了一個使用 Spring Boot 字典配置功能的 Spring 應用程式上下文
- application.properties:一個空的 properties 檔案,可以根據需要新增配置屬性
- pom.xml: Maven 構建說明檔案
第二步:HelloController
在【cn.wmyskxz.springboot】包下新建一個【HelloController】:
package cn.wmyskxz.springboot; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; /** * 測試控制器 * * @author: @健人雄 * @create: 2018-05-08-下午 16:46 */ @RestController public class HelloController { @RequestMapping("/hello") public String hello() { return "Hello Spring Boot!"; } }
- @RestController 註解: 該註解是 @Controller 和 @ResponseBody 註解的合體版
第三步:利用 IDEA 啟動 Spring Boot
我們回到 SpringbootApplication 這個類中,然後右鍵點選執行:
+ 注意:我們之所以在上面的專案中沒有手動的去配置 Tomcat 伺服器,是因為 Spring Boot 內建了 Tomcat
等待一會兒就會看到下方的成功執行的提示資訊:
可以看到我們的 Tomcat 執行在 8080 埠,我們來訪問 “/hello” 地址試一下:
可以看到頁面成功顯示出我們返回的資訊。
解析Spring Boot專案
解析 pom.xml 檔案
讓我們來看看預設生成的 pom.xml 檔案中到底有一些什麼特別:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.wmyskxz</groupId>
<artifactId>springboot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>springboot</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
我們可以看到一個比較陌生一些的標籤 <parent>
,這個標籤是在配置 Spring Boot 的父級依賴:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
有了這個,當前的專案才是 Spring Boot 專案,spring-boot-starter-parent 是一個特殊的 starter ,它用來提供相關的 Maven 預設依賴,使用它之後,常用的包依賴就可以省去 version 標籤。
應用入口類
Spring Boot 專案通常有一個名為 *Application 的入口類,入口類裡有一個 main 方法, 這個 main 方法其實就是一個標準的 Javay 應用的入口方法。
@SpringBootApplication 是 Spring Boot 的核心註解,它是一個組合註解,該註解組合了:@Configuration、@EnableAutoConfiguration、@ComponentScan; 若不是用 @SpringBootApplication 註解也可以使用這三個註解代替。
- 其中,@EnableAutoConfiguration 讓 Spring Boot 根據類路徑中的 jar 包依賴為當前專案進行自動配置,例如,添加了 spring-boot-starter-web 依賴,會自動新增 Tomcat 和
- Spring MVC 的依賴,那麼 Spring Boot 會對 Tomcat 和 Spring MVC 進行自動配置。
Spring Boot 還會自動掃描 @SpringBootApplication 所在類的同級包以及下級包裡的 Bean ,所以入口類建議就配置在 grounpID + arctifactID 組合的包名下(這裡為 cn.wmyskxz.springboot 包)
Spring Boot 的配置檔案
Spring Boot 使用一個全域性的配置檔案 application.properties 或 application.yml,放置在【src/main/resources】目錄或者類路徑的 /config 下。
Spring Boot 不僅支援常規的 properties 配置檔案,還支援 yaml 語言的配置檔案。yaml 是以資料為中心的語言,在配置資料的時候具有面向物件的特徵。
Spring Boot 的全域性配置檔案的作用是對一些預設配置的配置值進行修改。
- 簡單例項一下
我們同樣的將 Tomcat 預設埠設定為 8080 ,並將預設的訪問路徑從 “/” 修改為 “/hello” 時,使用 properties 檔案和 yml 檔案的區別如上圖。
我們直接把 .properties 字尾的檔案刪掉,使用 .yml 檔案來進行簡單的配置,然後使用 @Value 來獲取配置屬性:
重啟 Spring Boot ,輸入地址:localhost:8080/hello 能看到正確的結果:
- 注意: 我們並沒有在 yml 檔案中註明屬性的型別,而是在使用的時候定義的。
仍然可以得到正確的結果:
- 問題: 這樣寫配置檔案繁瑣而且可能會造成類的臃腫,因為有許許多多的 @Value 註解。
封裝配置資訊
我們可以把配置資訊封裝成一個類,首先在我們的 name 和 age 前加一個 student 字首,然後新建一個 StudentProperties 的類用來封裝這些資訊,並用上兩個註解:
- @Component:表明當前類是一個 Java Bean
- @ConfigurationProperties(prefix = "student"):表示獲取字首為 sutdent 的配置資訊
這樣我們就可以在控制器中使用,重啟得到正確資訊: