SpringBoot項目的創建流程（初步）

小伙伴們在學習的過程中大概也發現了這兩個框架需要我們手動配置的地方非常多，不過做JavaEE開發的小伙伴們肯定也聽說過“約定大於配置”這樣一句話，就是說系統，類庫，框架應該假定合理的默認值，而非要求提供不必要的配置，可是使用Spring或者SpringMVC的話依然有許多這樣的東西需要我們進行配置，這樣不僅徒增工作量而且在跨平台部署時容易出問題。OK，由於這些已經存在的問題，Spring Boot應運而生，使用Spring Boot可以讓我們快速創建一個基於Spring的項目，而讓這個Spring項目跑起來我們只需要很少的配置就可以了。Spring Boot主要有如下核心功能：

1.獨立運行的Spring項目

Spring Boot可以以jar包的形式來運行，運行一個Spring Boot項目我們只需要通過java -jar xx.jar類運行。非常方便。

2.內嵌Servlet容器

Spring Boot可以內嵌Tomcat，這樣我們無需以war包的形式部署項目。

3.提供starter簡化Maven配置

使用Spring或者SpringMVC我們需要添加大量的依賴，而這些依賴很多都是固定的，這里Spring Boot 通過starter能夠幫助我們簡化Maven配置。

4.自動配置Spring 
5.准生產的應用監控 
6.無代碼生成和xml配置

OK，關於SpringBoot更詳細的優缺點小伙伴們也可以自行搜索，我這里不再羅列，我們還是來看看代碼。

項目創建

初次接觸，我們先來看看如何創建一個Spring Boot項目，這里以IntelliJ IDEA為例，其他的IDE工具小伙伴們自行搜索創建方式:

首先創建一個項目，創建時選擇Spring Initializr，然后Next，如下圖：

填寫項目信息，如下圖：

填寫項目使用到的技術，上面的Spring Boot版本建議選擇最新的穩定版，下面勾選上Web就可以了，如下圖：

最后一步，填寫工程名字點擊finish：

 
OK，第一次創建時系統會去下載需要的依賴等，耗時稍長，以后每次都會很快創建好。 
OK，項目創建成功之后接下來我們來看看這個東西要怎么樣去運行。首先我們看到在項目創建成功之后，在項目的根目錄下會有一個artifactId+Application命名規則的入口類，如下圖: 
,就是這個Test19SpringBoot2Application類，這是我們整個項目的入口類，這個類有一個@SpringBootApplication注解，這是整個Spring Boot的核心注解，它的目的就是開啟Spring Boot的自動配置。OK，那么我在這個類上再添加一個@RestController注解，使之變為一個Controller，然后里邊提供一個地址轉換方法，如下：

@RestController @SpringBootApplication public class Test19SpringBoot2Application { public static void main(String[] args) { SpringApplication.run(Test19SpringBoot2Application.class, args); } @RequestMapping(value = "/",produces = "text/plain;charset=UTF-8") String index(){ return "Hello Spring Boot!"; } }

然后點擊項目啟動按鈕運行，在IntelliJ中就是這個按鈕： 

 
啟動成功之后我們就可以直接在瀏覽器中訪問了，如下： 
 
OK，至此，我們一個簡單的Spring Boot工程已經創建出來了，並且成功的從瀏覽器中訪問到了，但是為什么它最終會跑起來呢？想必小伙伴們還有許多疑問，我們來分析下。

入口類和@SpringBootApplication注解

上文說過，我們新建一個Project系統都會幫我們創建一個名為artifactId+Application的入口類，這個類中有一個main方法，這個main方法就是一個標准的Java應用程序的入口方法。而這里的@SpringBootApplication則是一個組合注解，我們可以看看它的源碼：

@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan( excludeFilters = {@Filter( type = FilterType.CUSTOM, classes = {TypeExcludeFilter.class} )} ) public @interface SpringBootApplication { }

 

我們可以看到它組合了@SpringBootConfiguration、@EnableAutoConfiguration以及@ComponentScan，我們在開發的過程中如果不使用@SpringBootApplication，則可以組合使用這三個注解。這三個注解中，@SpringBootConfiguration實際上就是我們前面幾篇博客提到的@Configuration注解，表明這個類是一個配置類，@EnableAutoConfiguration則表示讓Spring Boot根據類路徑中的jar包依賴為當前項目進行自動配置，最后一個@ComponentScan的作用我也不贅述了，唯一要注意的是如果我們使用了@SpringBootApplication注解的話，系統會去入口類的同級包以及下級包中去掃描實體類，因此我們建議入口類的位置在groupId+arctifactID組合的包名下。

關閉特定的自動配置

在上面一小節中我們看到@ComponentScan注解是有一個過濾器的，如果我們只想要@SpringBootApplication去掃描特定的類而不是全部類，那么就可以關閉自動配置，如下：

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)

定制Banner

修改Banner

我們在啟動Spring Boot項目的時候，在控制台會默認輸出一個啟動圖案，如下： 
 
當然，這個圖案如果你需要的話是可以自己修改的，修改方式很簡單：

1.在src/main/resources下新建一個banner.txt文檔 
2.通過http://patorjk.com/software/taag網站生成需要的字符，將字符拷貝到步驟1所創建的txt文檔中，比如我這里為Hello Sang！生成字符，如下：

 
點擊左下角的選擇和拷貝按鈕，將這個字符拷貝到txt文檔中，然后再啟動項目，這個時候控制台輸出的文本就會自動改變，如下： 

關閉Banner

可以修改當然也可以關閉，關閉Banner需要我們稍微修改一下main方法中的代碼，如下：

public static void main(String[] args) { SpringApplicationBuilder builder = new SpringApplicationBuilder(Test19SpringBoot2Application.class); //修改Banner的模式為OFF builder.bannerMode(Banner.Mode.OFF).run(args); }

 

OK，如此修改之后當我們再次啟動Project的時候就看不到Banner了。

Spring Boot的配置文件

Spring Boot使用一個全局的配置文件application.properties或者application.yml，配置文件放在src/main/resources目錄下。properties是我們常見的一種配置文件，Spring Boot不僅支持properties這種類型的配置文件，也支持yaml語言的配置文件，我這里以properties類型的配置文件為例來看幾個案例。

1.修改Tomcat默認端口和默認訪問路徑

Tomcat默認端口是8080，我將之改為8081，默認訪問路徑是http://localhost:8080，我將之改為http://localhost:8081/helloboot,我們來看看這兩個需求要怎么樣通過簡單的配置來實現。 
很簡單，在application.properties文件中添加如下代碼：

server.context-path=/helloboot server.port=8081

 

然后再啟動Project，在瀏覽器中就得這樣來訪問了： 

常規屬性配置

在前面的博客( Spring常用配置 )中我們介紹了如何在使用Spring容器框架下注入properties文件里的值。如果我們使用了Spring Boot，這項工作將會變得更加簡單，我們只需要在application.properties中定義屬性，然后在代碼中直接使用@Value注入即可。 
如下：

book.author=羅貫中 book.name=三國演義 book.pinyin=sanguoyanyi

 

我這里專門設置了中文，因為中文不做特殊處理會亂碼，處理方式為繼續在application.properties中添加如下代碼：

server.tomcat.uri-encoding=UTF-8 spring.http.encoding.charset=UTF-8 spring.http.encoding.enabled=true spring.http.encoding.force=true spring.messages.encoding=UTF-8

 

然后 在IntelliJ IDEA中依次點擊File -> Settings -> Editor -> File Encodings 
將Properties Files (*.properties)下的Default encoding for properties files設置為UTF-8，將Transparent native-to-ascii conversion前的勾選上。（參考【Springboot 之 解決IDEA讀取properties配置文件的中文亂碼問題】【Springboot 之 解決IDEA讀取properties配置文件的中文亂碼問題】）。 
然后在變量中通過@Value直接注入就行了，如下：

    @Value(value = "${book.author}") private String bookAuthor; @Value("${book.name}") private String bookName; @Value("${book.pinyin}") private String bookPinYin;

 

修改index方法，使之返回這些值：

@RequestMapping(value = "/",produces = "text/plain;charset=UTF-8") String index(){ return "Hello Spring Boot! The BookName is "+bookName+";and Book Author is "+bookAuthor+";and Book PinYin is "+bookPinYin; }

然后在瀏覽器中訪問，結果如下： 

很簡單吧。

類型安全的配置

剛剛說的這種方式我們在實際項目中使用的時候工作量略大，因為每個項目要注入的變量的值太多了，這種時候我們可以使用基於類型安全的配置方式，就是將properties屬性和一個Bean關聯在一起，這樣使用起來會更加方便。我么來看看這種方式怎么實現。

1.在src/main/resources文件夾下創建文件book.properties

文件內容如下：

book.name=紅樓夢 book.author=曹雪芹 book.price=28

 

2.創建Book Bean,並注入properties文件中的值

代碼如下：

@Component @ConfigurationProperties(prefix = "book",locations = "classpath:book.properties") public class BookBean { private String name; private String author; private String price; public String getName() { return name; } public void setName(String name) { this.name = name; } public String getAuthor() { return author; } public void setAuthor(String author) { this.author = author; } public String getPrice() { return price; } public void setPrice(String price) { this.price = price; } }

prefix是指前綴，location指定要注入文件的位置。

3.添加路徑映射

在Controller中添加如下代碼注入Bean：

@Autowired private BookBean bookBean;

 

添加路徑映射：

@RequestMapping("/book") public String book() { return "Hello Spring Boot! The BookName is "+bookBean.getName()+";and Book Author is "+bookBean.getAuthor()+";and Book price is "+bookBean.getPrice(); }

 

運行效果如下： 

日志配置

默認情況下Spring Boot使用Logback作為日志框架，也就是我們前面幾篇博客中用到的打印日志方式，當然如果有需要我們可以手動配置日志級別以及日志輸出位置，相比於我們在Spring容器中寫的日志輸出代碼，這里的配置簡直就是小兒科了，只需要在application.properties中添加如下代碼：

logging.file=/home/sang/workspace/log.log logging.level.org.springframework.web=debug

 

上面表示配置日志輸出位置，下面配置日志級別。

Profile配置問題

在 Spring常用配置 這篇文章中，我們已經介紹了Profile的作用，已經如何在Spring框架下使用Profile，但是當時小伙伴們看到了還是稍微有點麻煩，在Spring Boot 中系統提供了更為簡潔的方式。全局Profile配置我們使用application-{profile}.properties來定義，然后在application.properties中通過spring.profiles.active來指定使用哪個Profile。OK，那么接下來我們來看一個簡單的案例。

1.在src/main/resources文件夾下定義不同環境下的Profile配置文件，文件名分別為application-prod.properties和application-dev.properties，這兩個前者表示生產環境下的配置，后者表示開發環境下的配置，如下：

application-prod.properties:

server.port=8081

application-dev.properties:

server.port=8080

 

然后在application.properties中進行簡單配置，如下：

spring.profiles.active=dev

這個表示使用開發環境下的配置。然后運行項目，我們得通過8080端口才可以訪問： 
 
如果想換為生產環境，只需要把spring.profiles.active=dev改為spring.profiles.active=prod即可，當然訪問端口這是也變為8081了，如下：