SpringBoot項目（一）

時間 2019-11-11

標籤 springboot 項目欄目 Spring 简体版

原文原文鏈接

1、項目建立

一、IDEA建立springboot項目

1.一、File-->new-->project

注意：IDEA須要選擇最終版本的，社區版本的沒有spring initializ選項。web

SDK選擇Java默認，URL選擇默認。spring

1.二、配置名稱

1.三、選擇經常使用到的技術，由於作的是web項目，因此這裏只選擇web。

1.四、項目解釋

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.五、運行項目，瀏覽器輸入localhost:8080

至此，一個簡單的springboot項目已經創建。tomcat

入口類和@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組合的包名下。springboot

關閉特定的自動配置

在上面一小節中咱們看到@ComponentScan註解是有一個過濾器的，若是咱們只想要@SpringBootApplication去掃描特定的類而不是所有類，那麼就能夠關閉自動配置，以下：app

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class) 框架

咱們在啓動Spring Boot項目的時候，在控制檯會默認輸出一個啓動圖案，以下： spring-boot

固然，這個圖案若是你須要的話是能夠本身修改的，修改方式很簡單：測試

1.在src/main/resources下新建一個banner.txt文檔
2.經過http://patorjk.com/software/taag網站生成須要的字符，將字符拷貝到步驟1所建立的txt文檔中，好比我這裏爲Hello xian！生成字符，以下：

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

能夠修改固然也能夠關閉，關閉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註解。

如下解決方法是對於常規遇到此問題的建議：

一、出現spring boot Configuration Annotation Proessor not found in classpath的提示是在用了@ConfigurationProperties這個註解時，因此問題出如今ConfigurationProperties註解。
二、根據提示的not found in classpath,查詢此註解的使用關於怎麼指定classpath,進而查詢location，spring boot1.5以上版本@ConfigurationProperties取消location註解
三、解決方案：

在配置類中採用@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: