一、取值
1.1 @Value
使用@Value赋值;
- 基本数值
- 可以写SpEL; #{}
- 可以写${};取出配置文件【properties】中的值(在运行环境变量里面的值)
@Value("张三")
private String name;
@Value("#{20-2}")
private Integer age;
@Value("${person.nickName}")
private String nickName;
1.2 ConfigurationProperties
SpringBoot中新加入的取值方式
二、导入配置文件
2.1 @PropertySource
加载配置文件,配置文件中的值可以利用上述取值防止获取配置文件中的值
在XML文件中做如下配置:
<bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="location" value="classpath*:jdbc.properties" />
</bean>
也可以这样配置:
<context:property-placeholder location="classpath*:jdbc.properties" />
利用注解的方式:
@PropertySource("classpath:/dbconfig.properties")
三、配置文件的加载
3.1 默认的加载顺序
- springboot 启动会扫描以下位置的application.properties 或 application.yml (properties的优先级比yml高)文件作为Spring boot的默认配置文件
- 高优先级的配置会覆盖低优先级的配置,优先级由高到底,如下:
–file:./config/
–file:./
–classpath:/config/
–classpath:/
- SpringBoot会从这四个位置全部加载主配置文件;互补配置;
- 我们还可以通过spring.config.location来改变默认的配置文件位置
- 项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
3.2 外部配置加载顺序
SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置
1、命令行参数 ,所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-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包内进行寻找;优先加载带profile
- 6、jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
- 7、jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
再来加载不带profile
- 8、jar包外部的application.properties或application.yml(不带spring.profile)配置文件
- 9、jar包内部的application.properties或application.yml(不带spring.profile)配置文件
- 10、@Configuration注解类上的@PropertySource
- 11、通过SpringApplication.setDefaultProperties指定的默认属性 所有支持的配置加载来源;
四、自动配置的原理
4.1 原理
- 1)、SpringBoot启动的时候加载主配置类,开启了自动配置功能@EnableAutoConfiguration
2)、@EnableAutoConfiguration 作用:
- 利用EnableAutoConfigurationImportSelector给容器中导入一些组件?
- 可以查看selectImports()方法的内容;
- List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
SpringFactoriesLoader.loadFactoryNames() 扫描所有jar包类路径下 META‐INF/spring.factories
把扫描到的这些文件的内容包装成properties对象从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,
然后把他们添加在容器中将类路径下META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中;
部分内容如下:
# Initializers
org.springframework.context.ApplicationContextInitializer=
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener
# Application Listeners
org.springframework.context.ApplicationListener=
org.springframework.boot.autoconfigure.BackgroundPreinitializer
# Auto Configuration Import Listeners
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener
# Auto Configuration Import Filters
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=
org.springframework.boot.autoconfigure.condition.OnClassCondition
# 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.web.servlet.HttpEncodingAutoConfiguration,
# ......省略
每一个这样的 xxxAutoConfiguration类都是容器中的一个组件,都加入到容器中;用他们来做自动配置;
3)、每一个自动配置类进行自动配置功能;
4)、以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理;
源码如下
//表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
@Configuration
/*
* 启动指定类的ConfigurationProperties功能;
* 将配置文件中对应的值和HttpEncodingProperties绑定起来;
* 并把HttpEncodingProperties加入到ioc容器中
*/
@EnableConfigurationProperties(HttpEncodingProperties.class)
/**
* Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果
* 满足指定的条件,整个配置类里面的配置就会生效;
* 判断当前应用是否是web应用,如果是,当前配置类生效
*/
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
/*
* 判断当前项目有没有这个类 -->
* CharacterEncodingFilter,SpringMVC中进行乱码解决的过滤器;
*/
@ConditionalOnClass(CharacterEncodingFilter.class)
/*
* 判断配置文件中是否存在某个配置 spring.http.encoding.enabled;
* 如果不存在,判断也是成立的
* 即使我们配置文件中不配置spring.http.encoding.enabled=true,
* 也是默认生效的;
*/
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
//他已经和SpringBoot的配置文件映射了
private final HttpEncodingProperties properties;
//只有一个有参构造器的情况下,参数的值就会从容器中拿
public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
this.properties = properties;
}
@Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获取
@ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件?
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)、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者;配置文件能配置什么就可以参照某个功 能对应的这个属性类
//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "spring.http.encoding")
public class HttpEncodingProperties {
public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
//...省略...
}
精髓:
- 1)、SpringBoot启动会加载大量的自动配置类
- 2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;
- 3)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)
- 4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这 些属性的值;
- xxxxAutoConfigurartion:自动配置类; 给容器中添加组件
- xxxxProperties:封装配置文件中相关属性;
4.2 补充
- @Conditional派生注解(Spring注解版原生的@Conditional作用) 作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
- 自动配置类必须在一定的条件下才能生效;
- 我们怎么知道哪些自动配置类生效呢,我们可以通过启用 debug=true属性;来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置类生效,效果如下:
配置信息:
自动配置类启用的
没有启动,没有匹配成功的自动配置类