SpringBoot(二) 主程序詳解和配置文件如何配置

SpringBoot主程序詳解

/**
 *  @SpringBootApplication 來標注一個主程序類，說明這是一個Spring Boot應用
 */
@SpringBootApplication
public class HelloWorldMainApplication {

    public static void main(String[] args) {

        // Spring應用啟動起來
        SpringApplication.run(HelloWorldMainApplication.class,args);
    }
}

上段程序是一個SpringBoot主程序，入口方法。

@SpringBootApplication：Spring Boot應用標注在某個類上說明這個類是SpringBoot的主配置類，SpringBoot就應該運行這個類的main方法來啟動SpringBoot應用；

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

 

@SpringBootConfiguration：Spring Boot的配置類，標注在某個類上，表示這是一個Spring Boot的配置類。

@EnableAutoConfiguration：開啟自動配置功能。

​@EnableAutoConfigurationImportSelector：導入哪些組件的選擇器。將所有需要導入的組件以全類名的方式返回；這些組件就會被添加到容器中。有了自動配置類，免去了我們手動編寫配置注入功能組件等的工作。

​ SpringBoot 配置

 Spring Boot使用了一個全局的配置文件application.properties，放在src/main/resources目錄下或者類路徑的/config下。

 Sping Boot的全局配置文件的作用：修改SpringBoot自動配置的默認值。SpringBoot在底層都會給我們自動配置好。

 名稱是固定的：application.properties  或者 application.yml

　　　　yml是YAML（YAML Ain’t Markup Language）語言。它是以數據為中心的語言，它比json、xml更適合做配置文件。

配置實例：

　　　　

<!--  xml形式配置  -->
<server>
  <port>8081</port>
</server>

<!-- properties形式配置  -->
server.port=8081


<!--  yml形式配置  -->
server:
  port: 8081

 

 YML語法   自定義屬性

1.基本語法

　　書寫形式 k:  v    ==>    表示一對鍵值對（冒號和v之間的空格必須有）；

　　　　以空格的縮進來控制層級關系；只要是左對齊的一列數據，都是同一個層級的。

　　　　屬性值的英文大小寫敏感。

server:
    port: 8081
    path: /hello

2.字面量

普通的值（數字，字符串，布爾）:   k: v  ==> v 直接編寫數字，字符串，布爾等值。如果是字符串添加雙引號，則不會進行轉義。使用單引號會進行轉義。

對象： k : v

friends:
    lastName: zhangsan
    age: 20

//也可以和ajax一樣編寫
friends: {lastName: zhangsan,age: 18}

 

數組（list、set等）：

pets:
 - cat
 - dog
 - pig

//或者

pets: [cat,dog,pig]

3.使用配置文件中的值

//配置文件
person:
    lastName: hello
    age: 18
    boss: false
    maps: {k1: 11,k2: 12}
    list:
      - lisi
      - wangwu
    dog:
      name: 小狗
      age: 12



/**
 * 將配置文件中配置的每一個屬性的值，映射到這個組件中
 * @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定.
 *      prefix = "person"：配置文件中哪個下面的所有屬性進行一一映射
 *
 * 只有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private List<Object> list;
    private Dog dog;
}


//pom.xml文件添加屬性
<!--導入配置文件處理器，配置文件進行綁定就會有提示-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <optional>true</optional>
    </dependency>

 還需要在spring Boot入口類加上@EnableConfigurationProperties並指明要加載哪個bean，如果不寫ConfigBean.class，在建好的類那邊添加。最后在Controller中引入ConfigBean使用即可。注意使用自動注入的注解。

在1.5的版本之后，需要添加@Configuration和@PropertySource(“classpath:xxxxxx.properties”)后才可以讀取。

/**
 * 將配置文件中配置的每一個屬性的值，映射到這個組件中
 * @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定；
 *      prefix = "person"：配置文件中哪個下面的所有屬性進行一一映射
 *
 * 只有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默認從全局配置文件中獲取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {}

 

4.使用配置文件生成隨機數

在配置文件中${random} 可以用來生成各種不同類型的隨機值，例如 生成 int 值、long 值或者 string 字符串。

secret=${random.value}
number=${random.int}
longnumber=${random.long}
uuid=${random.uuid}

 @Value和@Validated

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定
松散綁定（松散語法）	支持	不支持
SpEL	不支持	支持
JSR303數據校驗	支持	不支持
復雜類型封裝	支持	不支持

配置文件yml還是properties他們都能獲取到值。

書寫形式： @Value("${配置文件中的key}")。注意key要全稱。

例如：@Value("${person.age}")，@Value("${person.dog.name}")

　　　計算： @Value("#{12*2}")  ==>  對應的值就是24

 

數據校驗：@Valiadated注解自動校驗。

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
   //lastName必須是郵箱格式
    @Email
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

 

配置文件讀取優先級

application.properties和application.yml文件可以放在一下四個位置：

• 外置，在相對於應用程序運行目錄的/congfig子目錄里。
• 外置，在應用程序運行的目錄里
• 內置，在config包內
• 內置，在Classpath根目錄

按照優先級排序，src/main/resources/config下application.properties覆蓋src/main/resources下application.properties中相同的屬性

另外，如果在相同優先級位置同時有application.properties和application.yml，那么application.yml里面的屬性就會覆蓋application.properties里的屬性。

Profile多環境配置

當應用程序需要部署到不同運行環境時，一些配置細節通常會有所不同，尤其是開發過程中的開發環境和生產環境的配置文件。
如果按照以前的做法，就是每次發布的時候替換掉配置文件，這樣太麻煩了，Spring Boot的Profile就給我們提供了解決方案，命令帶上參數就搞定。

在Spring Boot中多環境配置文件名需要滿足application-{profile}.properties的格式，其中{profile}對應你的環境標識，比如：

application-test.properties：開發環境
application-prod.properties：生產環境

想要使用對應的環境，只需要在application.properties中使用spring.profiles.active屬性來設置，值對應上面提到的{profile}，也就是上述代碼的test、prod這2個。

server:
  port: 8081
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  profiles: test


---

server:
  port: 8084
spring:
  profiles: prod  #指定屬於哪個環境