一、項目創建
1、IDEA創建springboot項目
1.1、File-->new-->project
注意:IDEA需要選擇最終版本的,社區版本的沒有spring initializ選項。
SDK選擇Java默認,URL選擇默認。
1.2、配置名稱
1.3、選擇常用到的技術,因為做的是web項目,所以這里只選擇web。
1.4、項目解釋
1.DemoApplication類,是整個項目的入口類,這個類有一個@SpringBootApplication注解,這是spring boot的核心注解。它的目的就是開啟Spring Boot的自動配置。OK,那么我在這個類上再添加一個@RestController注解,使之變為一個Controller,然后里邊提供一個地址轉換方法,如下:
1 package com.hsbc.demo; 2 3 import org.springframework.boot.SpringApplication; 4 import org.springframework.boot.autoconfigure.SpringBootApplication; 5 import org.springframework.web.bind.annotation.RequestMapping; 6 import org.springframework.web.bind.annotation.RestController; 7 8 @RestController 9 @SpringBootApplication 10 public class DemoApplication { 11 12 public static void main(String[] args) { 13 SpringApplication.run(DemoApplication.class, args); 14 } 15 @RequestMapping(value = "/",produces = "text/plain;charset=UTF-8") 16 String index(){ 17 return "Hello Spring Boot!"; 18 } 19 }
1.5、運行項目,瀏覽器輸入localhost:8080
至此,一個簡單的springboot項目已經建立。
入口類和@SpringBootApplication注解
上文說過,我們新建一個Project系統都會幫我們創建一個名為artifactId+Application的入口類,這個類中有一個main方法,這個main方法就是一個標准的Java應用程序的入口方法。而這里的@SpringBootApplication則是一個組合注解,我們可以看看它的源碼:
1 @Target({ElementType.TYPE}) 2 @Retention(RetentionPolicy.RUNTIME) 3 @Documented 4 @Inherited 5 @SpringBootConfiguration 6 @EnableAutoConfiguration 7 @ComponentScan( 8 excludeFilters = {@Filter( 9 type = FilterType.CUSTOM, 10 classes = {TypeExcludeFilter.class} 11 )} 12 ) 13 public @interface SpringBootApplication { 14 15 }
我們可以看到它組合了@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 xian!生成字符,如下:
點擊左下角的選擇和拷貝按鈕,將這個字符拷貝到txt文檔中,然后再啟動項目,這個時候控制台輸出的文本就會自動改變,如下:
關閉Banner
可以修改當然也可以關閉,關閉Banner需要我們稍微修改一下main方法中的代碼,如下:
1 public static void main(String[] args) { 2 SpringApplicationBuilder builder = new SpringApplicationBuilder(Test19SpringBoot2Application.class); 3 //修改Banner的模式為OFF 4 builder.bannerMode(Banner.Mode.OFF).run(args); 5 }
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中添加如下代碼:
1 server.tomcat.uri-encoding=UTF-8 2 spring.http.encoding.charset=UTF-8 3 spring.http.encoding.enabled=true 4 spring.http.encoding.force=true 5 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直接注入就行了,如下:
1 @Value(value = "${book.author}") 2 private String bookAuthor; 3 @Value("${book.name}") 4 private String bookName; 5 @Value("${book.pinyin}") 6 private String bookPinYin;
修改index方法,使之返回這些值:
1 @RequestMapping(value = "/",produces = "text/plain;charset=UTF-8") 2 String index(){ 3 return "Hello Spring Boot! The BookName is "+bookName+";and Book Author is "+bookAuthor+";and Book PinYin is "+bookPinYin; 4 }
然后在瀏覽器中訪問,結果如下:
類型安全的配置
剛剛說的這種方式我們在實際項目中使用的時候工作量略大,因為每個項目要注入的變量的值太多了,這種時候我們可以使用基於類型安全的配置方式,就是將properties屬性和一個Bean關聯在一起,這樣使用起來會更加方便。我么來看看這種方式怎么實現。
1.在src/main/resources文件夾下創建文件book.properties
文件內容如下:
book.name=紅樓夢 book.author=曹雪芹 book.price=28
2.創建Book Bean,並注入properties文件中的值
代碼如下:
1 @Component 2 @ConfigurationProperties(prefix = "book",locations = "classpath:book.properties") 3 public class BookBean { 4 private String name; 5 private String author; 6 private String price; 7 8 public String getName() { 9 return name; 10 } 11 12 public void setName(String name) { 13 this.name = name; 14 } 15 16 public String getAuthor() { 17 return author; 18 } 19 20 public void setAuthor(String author) { 21 this.author = author; 22 } 23 24 public String getPrice() { 25 return price; 26 } 27 28 public void setPrice(String price) { 29 this.price = price; 30 } 31 }
注入出現這個問題:
prefix是指前綴,location指定要注入文件的位置。
本次出現問題是因為spring boot1.5以上版本@ConfigurationProperties取消location注解。
以下解決方法是對於常規遇到此問題的建議:
1、出現spring boot Configuration Annotation Proessor not found in classpath的提示是在用了@ConfigurationProperties這個注解時,所以問題出現在ConfigurationProperties注解。
2、根據提示的not found in classpath,查詢此注解的使用關於怎么指定classpath,進而查詢location,spring boot1.5以上版本@ConfigurationProperties取消location注解
3、解決方案:
在配置類中采用@Component的方式注冊為組件,然后使用@PropertySource來指定自定義的資源目錄.(本人測試用@Service代替@Component也可以的)
有以下三種解決方案:
第一種:在resource中創建author.properties,並指明@PropertySource(“author.properties”) ,即默認在resource下找此文件,找到返回一個值,找不到則報錯,報文件找不到,打不開。
第二種: 在resource下創建config文件夾,把author.properties放在config下,訪問方式為:@PropertySource(“classpath:config/book.properties”)
第三種: 直接寫在application.properties中(不建議這么做,但如果時全局變量提倡這種方法),當寫在此文件中時,不需要指明資源文件路勁,只需要指明前綴即可。如下:
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(); }
在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了,如下:
轉自:https://blog.csdn.net/u012702547/article/details/53740047