1. 程式人生 > >二、Spring Boot 配置文件

二、Spring Boot 配置文件

rand .so property lns 通過 gda object boot.s handle

1、配置文件

Spring Boot使用一個全局的配置文件,配置文件名是固定的

  • application.properties

  • applicatioin.yml

配置文件的作用:修改Spring Boot自動配置的默認值;Spring Boot在底層都給我們配置好;

YAML(YAML Ain‘t Markup Language)

YAML A Markup Language:是一個標記語言

YAML isn‘t Markup Language:不是一個標記語言;

標記語言:

以前的配置文件;大多都使用的是xxx.xml文件;

YAML:以數據為中心,比json、xml等更適合做配置文件;

YAML:配置例子

server:
  port: 8081

xml:

<server>
    <port>8081</port>
</server>

2、YAML語法

2.1 基本語法

K:(空格)v :表示一對鍵值對(空格必須有);

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

server:
  port: 8081
  path:/hello

2.2 值 的寫法

字面量:普通的值(數字,字符串,布爾)

k:v :字面量直接寫;

字符串默認不用加上單引號或者雙引號;

“ ”:雙引號;不會轉義字符串裏面的特殊字符;特殊字符會作為本身表示的意思

name:"zhangsan \n lisi" : 輸出: zhang san 換行 list

‘ ‘ : 單引號:會轉義特殊字符,特殊字符最終只是一個普通的字符串數據

name:‘zhangsan \n list‘ : 輸出 : zhangsan \n list

對象、Map(屬性和值)(鍵值對):

k: v :在下一行來寫對象的屬性和值的關系;註意縮進

對象還是k: v的方式

friends:
  lastName: zhangsan
  age: 20

行內寫法

friends: {lastName: zhangsan,age: 20}

數組(List、Set)

用- 值表示數組中的一個元素

pets:
  - cat
  - dog
  - pig

行內寫法

pets: [cat,dog,pig]

3、配置文件註入

配置文件

person:
  lastName: zhangsan
  age: 20
  boss: false
  birth: 2018/08/25
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - zhaoliu
  dog:
    name: 小狗
    age: 2

javaBean:

/**
 * 將配置文件中的每一個屬性值 ,映射到這個組件中
 * @ConfigurationProperties 告訴Spring Boot將本類中的所有屬性和配置文件中相關的配置進行綁定
 *
 * 只有這個組件是容器中組件,才能使用容器提供的@ConfigurationProperties 功能
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
     private String lastName;
     private Integer age;
     private Boolean boss;
     private Date birth;

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

我們可以導入配置文件處理器,以後編寫配置就的提示了

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

3.1 properties配置文件在idea中默認utf-8可能會亂碼

調整

技術分享圖片

3.2 @Value獲取值 和@ConfigurationProperties獲取值比較

技術分享圖片

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

如果說,我們只是在某個業務邏輯中需要獲取一下配置文件中的某項值,可以使用@Value;

如果說,我們專門寫了一個JavaBean來配置文件進行映射,我們就直接使用@ConfigurationProperties;

3.3 配置文件註入值數據校驗

加入@Validated

加入@Email校驗是否是郵箱

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

3.4 @PropertySource & @ImportResource & @Bean

@PropertySource:加載指定的配置文件

/**
 * 將配置文件中的每一個屬性值 ,映射到這個組件中
 *
 * @ConfigurationProperties 告訴Spring Boot將本類中的所有屬性和配置文件中相關的配置進行綁定
 * <p>
 * 只有這個組件是容器中組件,才能使用容器提供的@ConfigurationProperties 功能
 * @ConfigurationProperties(prefix = "person")默認從全局配置文件中獲取值;
 */
@Component
@ConfigurationProperties(prefix = "person")
@PropertySource(value = "classpath:person.properties")
//@Validated
public class Person {
    //lastName必須是郵箱格式
    //@Email
    // @Value("${person.last-name}")
    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;

@ImportResource:導入Spring的配置文件,讓配置文件裏面的內容生效;

Spring Boot裏面沒有Spring的配置文件,我們自己編寫的配置文件,也不能自動識別;

想讓Spring的配置文件生效,加載進行;@ImportResource標註在一個配置類上;

@ImportResource(locations = {"classpath:bean.xml"})
導入spring的配置文件讓其生效  
public class SpringBoot01ConfigApplication {

編寫Spring的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    
    <bean id="helloService" class="cn.lzc.springboot.service.HelloService"></bean>
    
</beans>

Spring Boot推薦給容器中添加組件的方式;推薦使用全註解的方式

1、配置類@Configuration ---->Spring配置文件

2、使用@Bean給容器中添加組件

/**
 * @Configuration 批明當前類是一個配置類,就是來替代之前的spring配置文件
 */
@Configuration
public class MyAppConfig {

    //將方法的返回值添加到窗口中;容器中這個組件默認的id就是方法名
    @Bean
    public HelloService helloService(){
        return new HelloService();
    }
}

4、配置文件占位符

4.1 隨機數

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

4.2 占位符獲取之前配置的值,如果沒有可以是用:指定默認值

person.last-name=張三${random.uuid}
person.age=${random.int}
person.birth=2018/08/25
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

5、Profile

5.1 多profile文件

我們可以在主配置文件編寫的時候,文件名可以是application-{profile}.properties/yml

5.2 yml支持多文檔塊方式

server:
  port: 8080
spring:
  profiles:
    active: test
---
server:
     port: 8081
spring:
  profiles: test
---
server:
  port: 80
spring:
  profiles: dev

5.3 激活指定的profile

  • 1、在配置文件中指定spring.profiles.active=dev

  • 2、命令行:

    • java -jar spring-boot-01-config-SNAPSHOT.jar --spring.profiles.active=dev

  • 3、虛擬機參數

    -Dspring.profiles.active=dev

6、配置文件加載位置

spring boot啟動會掃描以下位置的application.properties或者application.yml文件作為spring boot的默認配置文件

–?le:./con?g/

–?le:./

–classpath:/con?g/

–classpath:/

優先級由高到低,高優先級的配置會覆蓋低優先級的配置;

Spring Boot會從這四個位置全部加載主配置文件:互補配置;

我們還可以通過spring.config.location來改變默認的配置文件的位置

項目打包好以後,我們可以使用命令行參數的形式,啟動項目的時候業指定配置文件的新位置;指定的配置文件和默認加載的這些配置文件共同起作用形成互補配置。

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

7、外部配置加載順序

SpringBoot也可以從以下位置加載配置; 優先級從高到低;高優先級的配置覆蓋低優先級的配置,所有的配置會 形成互補配置

1.命令行參數

所有的配置都可以在命令行上進行指定

java -jar spring-boot-02-con?g-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc 多個配

置用空格分開; --配置項=值

2.來自java:comp/env的JNDI屬性

3.Java系統屬性(System.getProperties())

4.操作系統環境變量

5.RandomValuePropertySource配置的random.*屬性值

由jar包外向jar包內進行尋找;

優先加載帶pro?le

6.jar包外部的application-{pro?le}.properties或application.yml(帶spring.pro?le)配置文件

7.jar包內部的application-{pro?le}.properties或application.yml(帶spring.pro?le)配置文件

再來加載不帶pro?le

8.jar包外部的application.properties或application.yml(不帶spring.pro?le)配置文件

9.jar包內部的application.properties或application.yml(不帶spring.pro?le)配置文件

10.@Con?guration註解類上的@PropertySource

11.通過SpringApplication.setDefaultProperties指定的默認屬性

所有支持的配置加載來源;

參考官方文檔

8、自動配置原理

8.1 自動配置原理

配置文件到底能寫什麽?怎麽寫?自動配置原理;

配置文件能配置的屬性參照

  • (1)Spring Boot 啟動的時候加載主配置類,開啟了自動配置功能@EnableAutoConfiguration

  • (2)@EnableAutoConfiguration作用:

    • 利用AutoConfigurationImportSelector給容器中導入一些組件

    • 可以查看selectImports()方法內容

    • List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置

SpringFactoriesLoader.loadFactoryNames()
掃描所有jar包類路徑下的 META-INF/spring.factories
把掃描到的這些文件的內容包裝成properties對象
從properties中獲取到EnableAutoConfiguration.class類(類名)對應的值,然後把他們添加到窗口中

將類路徑下 META-INF/spring.factories 裏面配置的所有EnableAutoConfiguration的值加入到容器中;

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveDataAutoConfiguration,org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,org.springframework.boot.autoconfigure.data.mongo.MongoReactiveDataAutoConfiguration,org.springframework.boot.autoconfigure.data.mongo.MongoReactiveRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,org.springframework.boot.autoconfigure.elasticsearch.jest.JestAutoConfiguration,org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration,org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration,org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration,org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.JndiDataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration,org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,org.springframework.boot.autoconfigure.mongo.MongoReactiveAutoConfiguration,org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration,org.springframework.boot.autoconfigure.reactor.core.ReactorCoreAutoConfiguration,org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration,org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration,org.springframework.boot.autoconfigure.security.reactive.ReactiveSecurityAutoConfiguration,org.springframework.boot.autoconfigure.security.reactive.ReactiveUserDetailsServiceAutoConfiguration,org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2ClientAutoConfiguration,org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration,org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration,org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration,org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration,org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration,org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration

每一個這樣的 XXXAutoConfiguration類都是容器中的一個組件,都加入到容器中,用他們來做自動配置;

  • (3)每一個自動配置類進行自動配置功能;

  • (4)以HttpEncodingAutoConfiguration(Http編碼自動配置)為例解釋自動配置原理;

@Configuration  //表示這是一個配置類,以前編寫的配置文件一樣,也可以給容器中添加組件
@EnableConfigurationProperties(HttpEncodingProperties.class)  //啟動指定類的ConfigurationProperties功能;將配置文件中對應的值和HttpEncodingProperties綁定起來;並把HttpEncodingProperties加入到容器中

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) //Spring底層@Conditional註解,根據不同的條件,如果滿足指定的條件,整個配置類裏面的配置才會生效;  判斷當前應用是否是web應用,如果是,當前配置類生效

@ConditionalOnClass(CharacterEncodingFilter.class) //判斷當前項目有沒有這個類CharacterEncodingFilter; SpringMvc中進行亂碼解決的過濾器

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)  //判斷配置文件中是否存在某個配置  spring.http.encoding.enable;如果不存在,判斷也是成立的
//即使我閃配置文件中不配置spring.http.encoding.enable=true,也是默認生效的
public class HttpEncodingAutoConfiguration {
    //他已經和spring boot的配置文件映射了
    private final HttpEncodingProperties properties;
    
    //只有一個有參構造器中情況下,參數的值就會從容器中拿到
    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
        this.properties = properties;
    }
    
    @Bean  //給容器中添加一個組件,這個組件的某些值需要從properties中獲取
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
        return filter;
    }

根據當前不同的條件判斷 ,決定這個配置類是否生效

一但這個配置類生效;這個配置類就會給容器中添加各種組件;這些組件的屬性是從對應的properties類中獲取的,這些類裏面的每一個屬性又是和配置文件綁定的。

  • (5)所有在配置文件中能配置 的屬性都是在xxxProperties類中封裝著;配置文件能配置什麽就可以參照某個功能對應的這個屬性類

@ConfigurationProperties(prefix = "spring.http.encoding")  //從配置文件中獲取指定的值和bean的屬性進行綁定
public class HttpEncodingProperties {

精髓:

  • (1)Spring Boot啟動會加載大量的自動配置類

  • (2)我們看我們需要的功能有沒有Spring Boot默認寫好的自動配置類

  • (3)我們再來看這個自動配置類中到底配置了哪些組件;(只要我們要用的組件有,我們就不用再來配置了)

  • (4)給容器中自動配置類添加組件的時候,會從properties類中獲取某些屬性,我們就可以在配置類文件中指定這些屬性的值

xxxAutoConfiguration:自動配置類;

給容器中添加組件

xxxProperties:封裝配置文件中相關屬性;

8.2 細節

8.2.1 @Conditional派生註解(Spring註解版原生的@Conditional作用)

作用:必須是@Conditional指定的條件成立,才給容器中添加組件,配置配裏面的所有內容才生效;

技術分享圖片

自動配置類必須在一定的條件下才能生效; 我們怎麽知道哪些自動配置類生效; 我們可以通過啟用 debug=true屬性;來讓控制臺打印自動配置報告,這樣我們就可以很方便的知道哪些自動配置 類生效;

二、Spring Boot 配置文件