SpringBoot配置文件

最新推荐文章于 2024-06-04 11:29:03 发布

HashMap黑龙江分Map

最新推荐文章于 2024-06-04 11:29:03 发布

阅读量1.4k

点赞数 1

分类专栏： SpringBoot 文章标签： SpringBoot

本文链接：https://blog.csdn.net/yz357823669/article/details/83963027

版权

SpringBoot 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

SpringBoot使用一个全局的配置文件，配置文件名是固定的

application.properties
application.yml

我们首先说一下yml 文件的用法

1.yml

基本语法

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

person:
#我们可以配置普通的字面值,字符串不需要加引号
  name: yangzhao
#加双引号 输出 basektball 换行 is my
  favorite: "basektball\n is my "
#加单引号 who is \n my hate
  hate: 'who is \n my hate'
  birth: 2017/10/10
#支持占位符 ${random.value}、${random.int}、${random.long}、${random.uuid}
  age: ${random.int}
#数组可用下面两种写法
#  address:
#    - heilongjiang
#    - anhui
#    - zhejiang
  address: [heilongjian,zj,ah]
#Map 写法
  childrens:
    son: zzz
    gitl: yyy
#对象的写法
#支持占位符,person.test:hello 如果person.test 没有值,则使用默认值hello
  dog:
    name: xiaogou
    age: ${random.int}
#  dog: {name: hello,age: 2}

那我们的配置文件中的值如何与我们的java bean 绑定呢?

1.1 数据绑定

1.1.1 ConfigurationProperties

我们可以加上Component注解与ConfigurationProperties注解,并在ConfigurationProperties注解中声明我们要绑定默认的配置文件中属性的前缀(毕竟我们的配置文件中会写很多配置)

/**
*将配置文件中配置的每一个属性的值，映射到这个组件
*@ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
* prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
* 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能
*/
@Component
@Validated //数据校验
@ConfigurationProperties(prefix = "person")
public class Person {

    private String favorite;

    private String hate;

    private String name;
    
    //检测值是否为Email格式
    @Email
	private String email;

    private Date birth;
    
    private int age;

    private List<String> address;

    private Map<String,String> childrens;

    private Dog dog;

我们可以导入配置文件处理器，以后编写配置就有提示了

<!‐‐导入配置文件处理器，配置文件进行绑定就会有提示‐‐>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring‐boot‐configuration‐processor</artifactId>
    <optional>true</optional>
</dependency>

1.1.2 Value

我们还可以使用@Value注解对bean进行数值绑定

	//从配置文件获取值
	/**
	*相当于spring的bean配置
	*<bean class="Person">
	* <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#
	{SpEL}"></property>
	* <bean/>
	*
	*/
	@Value("${person.name}")
    private String name;

	//字面值常量
	@Value("2017/10/10")
    private Date birth;

	//支持SPEL表达式
    @Value("#{2+5}")
    private int age;

@Value获取值和@ConﬁgurationProperties获取值比较

	Value	ConﬁgurationProperties
功能	一个个指定	批量注入配置文件中的属性
松散绑定（松散语法）	不支持	支持
SpEL	支持	不支持
JSR303	不支持	支持
复杂类型封装	不支持	支持

这里说一下松散绑定与JSR303数据校验

配置文件person: lastName @Value(“last-name”) 是获取不到值得,而ConﬁgurationProperties可以

如果我们使用数据校验
配置文件person: yangzhao 而我们又使用ConﬁgurationProperties进行绑定

	@Email
    private String name;

这样会报错的

 	Property: person.name
    Value: yangzhao
    Origin: class path resource [application.yml]:2:9
    Reason: 不是一个合法的电子邮件地址

配置文件yml还是properties他们都能获取到值；

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConﬁgurationProperties；

2.@PropertySource&@ImportResource&@Bean

我们把所有的配置都写在默认的配置文件中未免过于沉重,所以我们可以使用@PropertySource 加载指定的配置文件

我们可以把我们person的配置写在person.properties文件中

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；想让Spring

的配置文件生效，加载进来；需要将@ImportResource标注在一个配置类上

我们写一个beans.xml 并在里面配置bean

<?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="com.example.demo.serivce.HelloService"></bean>
</beans>

接下来我们写测试类,看HelloService是否注册到spring容器中,

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

    @Autowired
    ApplicationContext app;

    @Test
    public void testHelloService(){
        System.out.println(app.containsBean("helloService"));
    }

}

可以看到输出false,所以正如上面所说Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别
所以我们再我们的主配置类上增加@ImportResource 注解即可,

@ImportResource(locations = "classpath:beans.xml")
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

但是SpringBoot并不推荐这么做

pringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式.在SpringBoot中我们的@Conﬁguration对应我们的Spring配

置文件,因此我们可以使用@Bean注解进行注册

我们编写配置类

@Configuration
public class AppConfig {
	//方法名即为注册bean id,返回值为实例
    @Bean
    public HelloService helloService(){
        return new HelloService();
    }

}

我们再次运行测试类,可以看到HelloService 已经注册到我们的IOC容器中了

2.多环境配置

2.1. 多Proﬁle文件

我们在主配置文件编写的时候，文件名可以是 application-{proﬁle}.properties/yml
默认使用application.properties的配置

2.2 yml支持多文档块

server:
    port: 8081
spring:
    profiles:
    active: prod
‐‐‐
server:
    port: 8083
spring:
    profiles: dev
‐‐‐
server:
    port: 8084
    spring:
profiles: prod #指定属于哪个环境

2.3 激活指定proﬁle

2.3.1 在配置文件中指定 spring.proﬁles.active=dev

2.3.2命令行

java -jar spring-boot-02-conﬁg-0.0.1-SNAPSHOT.jar -–spring.proﬁles.active=dev 可以直接在测试的时候，配置传入命令行参数

2.3.3 虚拟机参数

-Dspring.proﬁles.active=dev

3 配置文件加载位置

pringboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件

–ﬁle:./conﬁg/

–ﬁle:./

–classpath:/conﬁg/

–classpath:/

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

SpringBoot会从这四个位置全部加载主配置文件；互补配置；

我们还可以通过spring.conﬁg.location来改变默认的配置文件位置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；

java -jar spring-boot-02-conﬁg-02-0.0.1-SNAPSHOT.jar –-spring.conﬁg.location=G:/application.properties

4 外部配置加载顺序

SpringBoot也可以从以下位置加载配置；优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置

4.1 命令行参数

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

java -jar spring-boot-02-conﬁg-02-0.0.1-SNAPSHOT.jar –-server.port=8087 –-server.context-path=/abc
个配置用空格分开； –配置项=值

4.2 由jar包外向jar包内进行寻找；优先加载带proﬁle,再来加载不带proﬁle(与3 结合,优先加载jar外config下的,然后同级目录的)

jar包外部的application-{proﬁle}.properties或application.yml(带spring.proﬁle)配置文件
jar包内部的application-{proﬁle}.properties或application.yml(带spring.proﬁle)配置文件
jar包外部的application.properties或application.yml(不带spring.proﬁle)配置文件
jar包内部的application.properties或application.yml(不带spring.proﬁle)配置文件

5 自动配置再分析

我们在上一篇文章简析了SpringBoot的自动配置原理,接下来我们继续探究一下

配置文件到底能写什么？怎么写？

首先我们回顾一下SpringBoot的自动配置原理

5.1 自动配置原理

SpringBoot启动的时候加载主配置类，开启了自动配置功能 @EnableAutoConﬁguration
@EnableAutoConﬁguration 作用

利用EnableAutoConﬁgurationImportSelector给容器中导入一些组件
可以查看selectImports()方法的内容；
List conﬁgurations = getCandidateConﬁgurations(annotationMetadata, attributes);获取候选的配置
而这些配置通过SpringFactoriesLoader.loadFactoryNames() 获取,
他是扫描所有jar包类路径下 META‐INF/spring.factories 
文件中EnableAutoConfiguration配置的值（把扫描到的这些文件的内容分别包装成properties类,
这些类里面的每一个属性又是和配置文件绑定的）,然后把他们添加在容器中

将类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConﬁguration的值加入到了容器中,每一个这样的 xxxAutoConﬁguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；

每一个自动配置类进行自动配置功能
以HttpEncodingAutoConﬁguration（Http编码自动配置）为例解释自动配置原理

这其中就用到了我们前面说的bean与配置文件绑定ConfigurationProperties

@Configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的
ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把
HttpEncodingProperties加入到ioc容器中
@ConditionalOnWebApplication //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果
满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类
CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing =
true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=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类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘；配置文件能配置什么就可以参照某个功能对应的这个属性类

@ConfigurationProperties(prefix = "spring.http.encoding") //从配置文件中获取指定的值和bean的属
性进行绑定
public class HttpEncodingProperties {
public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");

精髓：

SpringBoot启动会加载大量的自动配置类
我们看我们需要的功能有没有SpringBoot默认写好的自动配置类
我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）
给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值

xxxxAutoConﬁgurartion：自动配置类；给容器中添加组件

xxxxProperties:封装配置文件中相关属性

5.2 细节

@Conditional派生注解（Spring注解版原生的@Conditional作用）

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置里面的所有内容才生效；

@Conditional扩展注解 作用（判断是否满足当前指定条件） 
@ConditionalOnJava 系统的java版本是否符合要求 
@ConditionalOnBean 容器中存在指定Bean； 
@ConditionalOnMissingBean 容器中不存在指定Bean； 
@ConditionalOnExpression 满足SpEL表达式指定 
@ConditionalOnClass 系统中有指定的类 
@ConditionalOnMissingClass 系统中没有指定的类 
@ConditionalOnSingleCandidate 容器中只有一个指定的Bean，或者这个Bean是首选Bean 
@ConditionalOnProperty 系统中指定的属性是否有指定的值 
@ConditionalOnResource 类路径下是否存在指定资源文件 
@ConditionalOnWebApplication 当前是web环境 
@ConditionalOnNotWebApplication 当前不是web环境 
@ConditionalOnJndi JNDI存在指定项

自动配置类必须在一定的条件下才能生效；我们怎么知道哪些自动配置类生效；

我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效

=========================
AUTO‐CONFIGURATION REPORT
=========================
Positive matches:（自动配置类启用的）
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
DispatcherServletAutoConfiguration matched:
‐ @ConditionalOnClass found required class
'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find
unwanted class (OnClassCondition)
‐ @ConditionalOnWebApplication (required) found StandardServletEnvironment
(OnWebApplicationCondition)
Negative matches:（没有启动，没有匹配成功的自动配置类）
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
ActiveMQAutoConfiguration:
Did not match:
‐ @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory',
'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
AopAutoConfiguration:
Did not match:
‐ @ConditionalOnClass did not find required classes
'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

HashMap黑龙江分Map

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的application.propertiesapplication.yml我们首先说一下yml 文件的用法1.yml基本语法k:(空格)v：表示一对键值对（空格必须有）；以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的person:#我们可以配置普通的字面值,字符串不需要加引号 name: ...
复制链接

扫一扫