SpringBoot項目的建立流程(初步)

小夥伴們在學習的過程當中大概也發現了這兩個框架須要咱們手動配置的地方很是多,不過作JavaEE開發的小夥伴們確定也據說過「約定大於配置」這樣一句話,就是說系統,類庫,框架應該假定合理的默認值,而非要求提供沒必要要的配置,但是使用Spring或者SpringMVC的話依然有許多這樣的東西須要咱們進行配置,這樣不只徒增工做量並且在跨平臺部署時容易出問題。OK,因爲這些已經存在的問題,Spring Boot應運而生,使用Spring Boot可讓咱們快速建立一個基於Spring的項目,而讓這個Spring項目跑起來咱們只須要不多的配置就能夠了。Spring Boot主要有以下核心功能:java

1.獨立運行的Spring項目web

Spring Boot能夠以jar包的形式來運行,運行一個Spring Boot項目咱們只須要經過java -jar xx.jar類運行。很是方便。spring

2.內嵌Servlet容器瀏覽器

Spring Boot能夠內嵌Tomcat,這樣咱們無需以war包的形式部署項目。tomcat

3.提供starter簡化Maven配置安全

使用Spring或者SpringMVC咱們須要添加大量的依賴,而這些依賴不少都是固定的,這裏Spring Boot 經過starter可以幫助咱們簡化Maven配置。springboot

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

OK,關於SpringBoot更詳細的優缺點小夥伴們也能夠自行搜索,我這裏再也不羅列,咱們仍是來看看代碼。bash

項目建立

初次接觸,咱們先來看看如何建立一個Spring Boot項目,這裏以IntelliJ IDEA爲例,其餘的IDE工具小夥伴們自行搜索建立方式:app

首先建立一個項目,建立時選擇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)
  • 1

定製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了,以下: 
這裏寫圖片描述

相關文章
相關標籤/搜索