给配置文件赋值的几种方式

我不是女神ヾ 2023-03-04 10:29 190阅读 0赞

给配置文件赋值的几种方式，即yaml。

# yaml #

根据百度百科来看，yaml的“ml”就和html和xml的“ml”一样，也是一种标记语言，但是百度百科又说yaml它不是一种标记语言。那么，yaml他到底是不是标记语言呢？这里我们不做讨论。其实只需要知道，yaml是以数据作为中心，而不是以标记语言作为中心的。为了加深理解，我们需要创建一个项目来帮助我们理解。

1.首先，新建springboot项目，命名为springboot-yaml。（创建项目的步骤在此不做叙述）创建成功之后，我们会有如下的项目结构。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70][]

其中的src目录下的HELP.md、mvnw、mvnw.cmd和.gitignore文件，对于我们的项目来说并没有作用，所以我们选择将它们删除。

通常来说，springboot使用的是一个全局的配置文件，其作用是修改springboot自动配置的默认值，因为springboot在底层都会给我们自动配置好了，我们需要根据需要来修改默认值。配置文件的名称一般是固定的  
application.properties：其语法结构是key=value，即name=jiaomubai；

application.yaml：其语法结构是key:空格value，即name： jiaomubai。一定要注意冒号后的空格，否则报错，会产生设置无效的后果。

yaml最强大的地方在于它可以给我们的实体类赋值，即键值对，列表，数组之类。

2.在与SpringbootYamlApplication文件同级的目录下建立一个新的实体类，为了方便，我们简单的创建一个Dog的实体。创建之前记得让Dog实体单独存在于pojo包中。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 1][]

Dog.java文件：其中的构造函数和get()、set()和toString()方法都能通过Alt+Insert快捷键快捷选择。一定要记得添加上@Component。

package com.example.pojo;
    
    import org.springframework.stereotype.Component;
    
    //把这个实体类里的东西交给Spring管理，添加到Spring的组件里边
    @Component
    public class Dog {
        //Dog的一般属性，名字和年龄
        private String name;
        private int age;
        //无参构造函数
        public Dog() {
        }
        //有参构造函数
        public Dog(String name, int age) {
            this.name = name;
            this.age = age;
        }
        //各个属性的get()和set()方法
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
        public int getAge() {
            return age;
        }
        public void setAge(int age) {
            this.age = age;
        }
        //toString()方法也不要忘记
        @Override
        public String toString() {
            return "Dog{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

除此之外，为了有一个较好的对照效果和测试效果，我们在当前目录下再新建一个class文件，命名为Person，并且让Dog作为Person的一个属性。

Person.java文件：

package com.example.pojo;
    
    import java.util.Date;
    import java.util.List;
    import java.util.Map;
    
    @Component
    public class Person {
        //Person的一些基本属性，为了测试项目使用，无实际意义，可自行增删
        private String p_name;
        private int p_age;
        private String sex;
        private Date birthday;
        private List<Object> list;
        private Boolean happy;
        private Map<String,Object> map;
        private Dog dog;
    
        public Person() {
        }
    
        public Person(String p_name, int p_age, String sex, Date birthday, List<Object> list, Boolean happy, Map<String, Object> map, Dog dog) {
            this.p_name = p_name;
            this.p_age = p_age;
            this.sex = sex;
            this.birthday = birthday;
            this.list = list;
            this.happy = happy;
            this.map = map;
            this.dog = dog;
        }
    
        public String getP_name() {
            return p_name;
        }
    
        public void setP_name(String p_name) {
            this.p_name = p_name;
        }
    
        public int getP_age() {
            return p_age;
        }
    
        public void setP_age(int p_age) {
            this.p_age = p_age;
        }
    
        public String getSex() {
            return sex;
        }
    
        public void setSex(String sex) {
            this.sex = sex;
        }
    
        public Date getBirthday() {
            return birthday;
        }
    
        public void setBirthday(Date birthday) {
            this.birthday = birthday;
        }
    
        public List<Object> getList() {
            return list;
        }
    
        public void setList(List<Object> list) {
            this.list = list;
        }
    
        public Boolean getHappy() {
            return happy;
        }
    
        public void setHappy(Boolean happy) {
            this.happy = happy;
        }
    
        public Map<String, Object> getMap() {
            return map;
        }
    
        public void setMap(Map<String, Object> map) {
            this.map = map;
        }
    
        public Dog getDog() {
            return dog;
        }
    
        public void setDog(Dog dog) {
            this.dog = dog;
        }
    
        @Override
        public String toString() {
            return "Person{" +
                    "p_name='" + p_name + '\'' +
                    ", p_age=" + p_age +
                    ", sex='" + sex + '\'' +
                    ", birthday=" + birthday +
                    ", list=" + list +
                    ", happy=" + happy +
                    ", map=" + map +
                    ", dog=" + dog +
                    '}';
        }
    }

至此，项目算是搭建完毕，其最终项目结构为：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 2][]

3.接下来，我们到了给配置文赋值的时候了。首先来看第一种，即采用最简单的@Value()来赋值。如直接在Dog.java中为Dog赋值：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 3][]

之后，在测试类中完善代码，即可启动测试：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 4][]

启动测试类，等待程序运行。发现程序运行成功，显示我们赋予给的值。

![20200803155109721.png][]

尽管此种方法也能成功运行，但是这一般只适用于对象的属性较少的情况，比如我们使用的Dog及只有两个属性，这种情况下我们可以挨个给每个属性使用@Value()方法来赋值，但是当遇到属性较多的情况，比如我们的Person，此时如果继续使用@Value()方法的话，显然很费时间，那么此时第二种方法yaml就该派上用场了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 5][]

如果我们能够直接右边的这些值赋给左边的各个属性，那Person的对象就有值了，也就不用去new、去set()了。在实体类上写上@ConfigurationProperties(prefix = "person")

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 6][]

启动测试类，运行成功。

![20200803161908571.png][]

需要注意的是，为了避免报错，在Dog中我们定义了name，那么在Person中，我们最好不要再定义name了，便于区分，不然系统会报装载失败等错误。

那么，第三种方法呢？如果不使用yaml我们又该如何处理呢？此时我们使用指定配置文件方法，即@PropertySourde()方法。前面我们说过，springboot的配置文件是有具体的明明要求的，我们不能随意更改，但是如果我们还是想要使用我们自己命名的配置文件的时候，就可使用此种方法。

例：我们新建一个myself.properties文件。里面内容为自己配置的信息。此时，在java文件中就不能像yaml那样一次性装配了，需要逐个装配。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 7][]

![20200803163952109.png][]

至此，三种给配置文件赋值的方法已经介绍完毕了。

接下来我们搞一些有趣的东西。还是使用yaml第二种方法。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 8][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 9][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 10][]

我们发现，以上三种方法中，当使用@Value()方法时，特别的不方便，其实@Value()方法与@ConfigurationProperties()方法相比有太多的缺点：

<table style="width:500px;"> 
 <thead> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">&nbsp;</th> 
   <th style="text-align:center;vertical-align:middle;width:203px;">@ConfigurationProperties</th> 
   <th style="text-align:center;vertical-align:middle;width:136px;">@Value</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">功能</th> 
   <td style="text-align:center;vertical-align:middle;width:203px;">批量注入配置文件中的属性</td> 
   <td style="text-align:center;vertical-align:middle;width:136px;">逐个指定</td> 
  </tr> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">松散绑定</th> 
   <td style="text-align:center;vertical-align:middle;width:203px;">支持</td> 
   <td style="text-align:center;vertical-align:middle;width:136px;">不支持</td> 
  </tr> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">SPEL</th> 
   <td style="text-align:center;vertical-align:middle;width:203px;">不支持</td> 
   <td style="text-align:center;vertical-align:middle;width:136px;">支持</td> 
  </tr> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">JSR303数据校验</th> 
   <td style="text-align:center;vertical-align:middle;width:203px;">支持</td> 
   <td style="text-align:center;vertical-align:middle;width:136px;">不支持</td> 
  </tr> 
  <tr> 
   <th style="text-align:center;vertical-align:middle;">复杂类型封装</th> 
   <td style="text-align:center;vertical-align:middle;width:203px;">支持</td> 
   <td style="text-align:center;vertical-align:middle;width:136px;">不支持</td> 
  </tr> 
 </tbody> 
</table>

功能：关于@ConfigurationProperties和@Value的功能的不同，我们在上面的程序中已经看到了。

松散绑定：比如java文件中的firstName和配置文件中的first-name，其实是等价的，因为配置文件中“-”之后默认为大写字母。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 11][]

JSR303数据校验：其实就是在字段上加一层过滤器验证，保证数据的合法性。如，我们再给person一个新的属性email。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 12][]

运行肯定会报错，显示数据格式错误之类的提示，但是本人电脑报错是装载失败，不知道如何解决~以下是关于JSR303校验的一些内容：

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td colspan="2" style="border-color:#333399;text-align:center;vertical-align:middle;">空检查</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Null</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证对象是否为null</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@NotNull</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证对象是否不为null，无法检查长度为0的字符串</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@NotBlank</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">检查约束字符串是不是null，还有被Trim的长度是否大于0，只针对字符串，且会去掉前后空格</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@NotEmpty</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">检查约束元素是否为null或empty</td> 
  </tr> 
  <tr> 
   <td colspan="2" style="border-color:#333399;text-align:center;vertical-align:middle;">真假检查</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@AssertTrue</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Boolean对象是否为true</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@AssertFalse</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Boolean对象是否为false</td> 
  </tr> 
  <tr> 
   <td colspan="2" style="border-color:#333399;text-align:center;vertical-align:middle;">布尔检查</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Size(min=,max=)</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证对象（包括数组，集合，map等）的长度是否在给定的范围之内</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Length(min=,max=)</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证对象的大小是否在给定范围内</td> 
  </tr> 
  <tr> 
   <td colspan="2" style="border-color:#333399;text-align:center;vertical-align:middle;">日期检查</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Past</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Date和Calendar对象是否在当前时间之前</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Future</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Date和Calendar对象是否在当前时间之后</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Pattern</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证String对象是否符合正则表达式的规则</td> 
  </tr> 
  <tr> 
   <td colspan="2" style="border-color:#333399;text-align:center;vertical-align:middle;">数值检查（建议使用String和Integ类型）</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Min</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Number和String对象是否大于等于指定的值</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Max</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Number和String对象是否小于等于指定的值</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@DecimalMax</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">被标注的值必须不大于约束中指定的最大值。这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示，小数存在精度</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@DecimalMin</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">被标注的值必须不小于约束中指定的最大值。这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示，小数存在精度</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Digits</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证Number和String的构成是否合法</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Digits(integer=,fraction=)</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Range(min=,max)</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">检查数字是否介于Min和Max之间</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Valid</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">对递归的关联对象进行校验，如果关联对象是个集合或者数组，那么对其中的元素进行递归校验，如果是一个map，则对其中的部分值进行校验</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@CreditCardNumber</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">信用卡验证</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@Email</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">email邮箱验证</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@ScriptAssert(lang=,script=,alias=)</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;">@URL(protocol=,host=,port=,regexp=,flags=)</td> 
   <td style="border-color:#333399;text-align:center;vertical-align:middle;"> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

总结一下，什么时候该使用@ConfigurationProperties，什么时候使用@Value：

同时配置了yaml和properties都可以取到值时，强烈推荐yaml；

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

如果我们专门编写了一个JavaBean来和配置文件进行映射，就毫不犹豫的直接使用@ConfigurationProperties。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70]: /images/20230208/99e7a5dc999a4c179f6c6a0cb6555f1f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 1]: /images/20230208/e639c13f720c4c71945027e95c693cbe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 2]: /images/20230208/fab6ded39f9f42b2a22c25174e13400e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 3]: /images/20230208/0f61e15f5501411a9d0f1f83aba2a105.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 4]: /images/20230208/2a94c1033ae44e3b967ea144882c98c0.png
[20200803155109721.png]: /images/20230208/301770cc91af465e8d355dfd5d800979.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 5]: /images/20230208/bf4831b3700b421f87884396e68c2d9b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 6]: /images/20230208/3700d4cf7c1b4b02b3619bd1e9aaf589.png
[20200803161908571.png]: /images/20230208/9b541f355d8543d79c3c510c832ffa0e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 7]: /images/20230208/bf1b0fe6916d41ac801fb3adc8054020.png
[20200803163952109.png]: /images/20230208/0be35160fcbf4840a5d6a350c96b44fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 8]: /images/20230208/695de56086924d20960c3eec4db86e21.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 9]: /images/20230208/49b8ae3f1d9449a3a72f6abfe95e8457.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 10]: /images/20230208/bbc64ef89b6c465f8b08074ef20c95a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 11]: /images/20230208/350d16d01c734ff1a95abb71c730b2dc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ppYW9tdWJhaQ_size_16_color_FFFFFF_t_70 12]: /images/20230208/704339d4007d422d8122d38eb2b7deae.png