SpringBoot04_配置文件相关

最新推荐文章于 2022-07-02 09:54:34 发布

ZyfgoupHah

最新推荐文章于 2022-07-02 09:54:34 发布

阅读量74

点赞数

分类专栏： spring boot 文章标签： spring boot

本文链接：https://blog.csdn.net/qq_40799202/article/details/111247666

版权

spring boot 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

配置文件

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

application.properties

语法结构 key=value

application.yaml(application.yml)

语法结构key: value （注意：后有一个空格）

**配置文件的作用：**修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！

server.port=8081

yaml

YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）

这种语言以数据作为中心，而不是以标记语言为重点！

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml

传统xml配置：

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

yaml配置：

server：
	prot: 8080

yaml基础语法

说明：语法要求严格！

1、空格不能省略

2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

字面量：普通的值 [ 数字，布尔值，字符串 ]

字面量直接写在后面就可以，字符串默认不用加上双引号或者单引号；

k: v

注意：

“ ” 双引号，会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；

比如：name: “kuang \n shen” 输出：kuang 换行 shen
‘’ 单引号，不会转义特殊字符，特殊字符最终会变成和普通字符一样输出

比如：name: ‘kuang \n shen’ 输出：kuang \n shen

在下一行来写对象的属性和值得关系，注意缩进；比如：
```
student:
name: qinjiang 
age: 3
```
行内写法
```
student: {name: qinjiang,age: 3}
```
数组（ List、set ）

用 - 值表示数组中的一个元素,比如：

注意 -后要有个空格
```
pets: 
- cat 
- dog
- pig
```
行内写法
```
pets: [cat,dog,pig]
```
修改SpringBoot的默认端口号

配置文件中添加，端口号的参数，就可以切换端口；
```
server:  
port: 8082
```

注入值到Bean中

yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！

person:
  name: zyf
  age: 21
  happy: false
  birth: 1999/03/28
  map: {v1: k1,v2: k2}
  list:
    - code
    - basketball
    - sleep
  dog:
    name: 旺财
    age: 3

dog:
  name: 小白
  age: 4

写两个实体类然后再测试类中测试是否注入成功

@Component
@Data
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private int age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> map;
    private List<Object> list;
    private Dog dog;
}


@Component
@Data
@ConfigurationProperties(prefix = "dog")
public class Dog {
    private String name;
    private int age;
}



class SpringbootstudyApplicationTests {

    @Autowired
    Person person;

    @Autowired
    Dog dog;

    @Test
    void contextLoads() {
        System.out.println(person);
       Map<String,Object> map = person.getMap();
       Set set = map.keySet();
        for (Object obj:set
             ) {
            System.out.println(obj+":"+map.get(obj));
        }

        List<Object> list = person.getList();
        System.out.println(list.size());

       for (int i=0;i<list.size();i++){
           System.out.println(list.get(i));
       }
    }

}

@ConfigurationProperties作用：将配置文件中配置的每一个属性的值，映射到这个组件中；告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应

加载指定的配置文件

**@PropertySource ：**加载指定的配置文件；

@configurationProperties：默认从全局配置文件中获取值；

1、我们去在resources目录下新建一个person.properties文件

name=kuangshen

2、然后在我们的代码中指定加载person.properties文件

@PropertySource(value = "classpath:person.properties")@Component 
//注册bean
public class Person {    
@Value("${name}")   
private String name;  
......  
}

3、再次输出测试一下：指定配置文件绑定成功！

配置文件占位符

配置文件还可以编写占位符生成随机数

person:
	name: qinjiang${random.uuid} # 随机uuid   
    age: ${random.int}  # 随机int    
    happy: false    
    birth: 2000/01/01   
    maps: {k1: v1,k2: v2}    
    lists:      
    - code    
    - girl    
    - music   
    dog:      
    name: ${person.hello:other}_旺财    //三元运算  如果person.hello不存在则使用other  
    age: 1

回顾properties配置

我们上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！那我们来唠唠其他的实现方式，道理都是相同的；写还是那样写；配置文件除了yml还有我们之前常用的properties ，我们没有讲，我们来唠唠！

【注意】properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8；

settings–>FileEncodings 中配置；

测试步骤：

1、新建一个实体类User

@Component //注册beanpublic class User {    private String name;    private int age;    private String sex;}

2、编辑配置文件 user.properties

user1.name=kuangshen
user1.age=18
user1.sex=男

3、我们在User类上使用@Value来进行注入！

@Component //注册bean
@PropertySource(value = "classpath:user.properties")
public class User {  
   //直接使用@value   
   @Value("${user.name}") //从配置文件中取值   
    private String name;   
    
    @Value("#{9*2}")  // #{SPEL} Spring表达式   
    private int age;   
    
   @Value("男")  // 字面量  
   private String sex;
}

4、Springboot测试

@SpringBootTestclass 
DemoApplicationTests {   
	@Autowired   
	User user;  

	@Test   
	public void contextLoads() {  
		System.out.println(user);   
	}
}

结果正常输出：

对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图

1、@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加

2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验，这个就是我们可以在字段是增加一层过滤器验证，可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象，使用value就不支持

结论：

配置yml和配置properties都可以获取到值，强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！

配置文件要怎么写

SpringBoot官方文档中有大量配置，如果都记住不现实

我们可以通过分析自动配置原理来学习配置文件应该怎么去写

在前面我们知道了在项目启动时会自动装配很多组件，那么在spring.factories文件我们看到有很多xxxxAutoConfiguration类（自动配置类）

这里以HttpEncodingAutoConfiguration为例子来再了解一下自动装配

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wErKIx6O-1608086633267)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506132725905.png)]

可以发现这些自动配置类都会是一个Spring的配置类 使用了@Configuration

然后还可以发现都基本有@EnableConfigurationProperties(xxxxx.class)这样的一个注解

我们进入HttpProperties类看看

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Ae18f09I-1608086633268)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506132922307.png)]

发现有前面我们测试yaml配置文件注入值到bean中时使用的注解

@ConfigurationProperties(prefix = "spring.http")

那么我们可以知道这个类的属性的值会被配置文件里的spring.http的值注入

可以发现HttpProperties有内部类Encoding 有属性charset和force等等

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7NiHEIwq-1608086633270)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506133519453.png)]

然后发现可以在配置文件中也可以配置这些值

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-plOfH3G1-1608086633271)(C:\Users\hah\AppData\Roaming\Typora\typora-user-images\image-20200506133707159.png)]

所以可以发现xxxProperties这些类里的属性与配置文件中可以配置的属性是一一对应的

再根据之前自动装配原理初探可以总结得到，这些自动配置类（xxxxAutoConfiguration）会根据当前不同的条件判断（ConditionXXXX），决定这个配置类是否生效！

一但这个配置类生效；这个配置类就会给容器中添加各种组件(组件就是注解了@Bean的)；
这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；
配置文件能配置什么就可以参照某个功能对应的这个属性类

所以当我们需要配置什么时就可以去找相对应的自动配置类然后找到对应的xxxProperties类去看有哪些属性可以进行配置

那么多的自动配置类，必须在一定的条件下才能生效；也就是说，我们加载了这么多的配置类，但不是所有的都生效了。

我们怎么知道哪些自动配置类生效？

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

#开启springboot的调试类
debug： true

Positive matches:（自动配置类启用的：正匹配）

Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）

Unconditional classes: （没有条件的类）

ZyfgoupHah

关注

0
点赞
踩
0

收藏

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

配置文件SpringBoot使用一个全局配置文件，且配置文件的名称是固定的application.properties语法结构 key=valueapplication.yaml(application.yml) 语法结构key: value （注意：后有一个空格）**配置文件的作用：**修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！server.port=8081
复制链接

扫一扫