首页 > 其他分享 >Yaml和Properties

Yaml和Properties

时间:2022-08-22 23:26:12浏览次数:50  
标签:name 配置文件 person private properties Yaml yaml Properties

3、Yaml与Properties

3.1、概述

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

配置文件

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

  • application.properties

    • 语法结构 :key=value
  • application.yml

    • 语法结构 :key:空格 value

配置文件的作用 :修改SpringBoot自动配置的默认值,因为SpringBoot在底层都给我们自动配置好了;

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

server.port=8081

3.2、yaml和properties的基础语法

yaml基础语法

说明:语法要求严格!

1、空格不能省略

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

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

字面量:普通的值 [ 数字,布尔值,字符串 ]

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

k: v

注意:

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

    比如 :name: "kuang \n shen" 输出 :kuang 换行 shen

  • '' 单引号,会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出

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

#说明:语法要求严格!
#1、空格不能省略
#2、以缩进来控制层级关系,只要是左边对齐的一列数据都是同一个层级的。
#3、属性和值的大小写都是十分敏感的。

# 普通的key - value
name: yzh

# 对象、Map(键值对)
student:
  mame: yzh
  age: 3
# 行内写法
student2: {name:yzh, age: 3}

# 数组( List、set )
pets:
  - cat
  - dog
  - pig
# 行内写法
pets2: [cat, dog, pig]

properties基础语法:

# properties 只能键值对 =
name = yzh

student.name = yzh
student.age = 3

3.3、注入配置文件

yaml文件有两个后缀,.yml 或者 .yaml

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

Yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yaml

2、编写一个实体类 Dog;

@Component  //注册bean到容器中
public class Dog {
    private String name;
    private Integer age;
    
    //有参无参构造、get、set方法、toString()方法  
}

3、思考,原来是如何给bean注入属性值的!使用@Value注解,给狗狗类测试一下:

@Component //注册bean
public class Dog {
    @Value("阿黄")
    private String name;
    @Value("3")
    private Integer age;
}

4、在SpringBoot的测试类下注入狗狗输出一下;

@SpringBootTest
class DemoApplicationTests {

    @Autowired //将狗狗自动注入进来
    Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗对象
    }

}

结果成功输出,@Value注入成功,这是原来的办法。

image-20220819172646249

5、再编写一个复杂一点的实体类:Person 类

@Component //注册bean到容器中
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    
    //有参无参构造、get、set方法、toString()方法  
}

6、使用yaml配置的方式进行注入,写的时候需要注意区别和优势,先编写一个yaml配置!

person:
  name: 张三
  age: 13
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 旺财
    age: 3

7、注入数据到Person类中!

/*
@ConfigurationProperties作用:
将配置文件中配置的每一个属性的值,映射到这个组件中;
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Component //注册bean
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

8、IDEA 提示,springboot配置注解处理器没有找到,点击Open Documentation可以查看文档,找到一个依赖!

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

9、确认以上配置都OK之后,去测试类中测试一下:

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    Person person; //将person自动注入进来

    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }

}

结果:所有值全部注入成功!

注意:可以会出现值为null的情况,检查一下属性名是否一致

3.4、加载指定的配置文件

@PropertySource :加载指定的配置文件;

@configurationProperties:默认从全局配置文件中获取值;

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

name=张三

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

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

    @Value("${name}")
    private String name;
    
    //......  
}

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

3.5、配置文件占位符

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

person:
    name: 张三${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}_旺财
      age: 1

3.6、回顾properties配置

上面采用的yaml方法都是最简单的方式,开发中最常用的;也是springboot所推荐的!现在说说其他的实现方式,道理都是相同的;写还是那样写;配置文件除了yml还有我们之前常用的properties。

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

settings→Editor→FileEncodings 中配置;

image-20220819175141870

3.7、对比小结

@Value这个使用起来并不友好!需要为每个属性单独注解赋值,比较麻烦;先看个功能对比图

image-20220819175323278

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

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

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

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

结论:

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

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

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

END

标签:name,配置文件,person,private,properties,Yaml,yaml,Properties
From: https://www.cnblogs.com/lyluoye/p/16614613.html

相关文章

  • @EnableConfigurationProperties和@ConfigurationProperties用法及注意事项
    在开发过程中,我们经常看到以下2个注解:@ConfigurationProperties@EnableConfigurationProperties一、先分别介绍一下这两个注解的用法:1、@ConfigurationPropertie......
  • [Typescript] Filtering properties out
    Listallthepropswithbeginwith"query"keyinDocumenttypequeryTypes=Extract<keyofDocument,`query${string}`>typequeryyPoprDoc={[KeyinqueryT......
  • JavaSE——Properties集合
    Properties集合Properties作为Map集合的使用介绍:是一个Map体系的集合类Properties可以保存到流中或从流中加载属性列表中的每个键及其对应的值都是一个字符串基本......
  • springBoot配置文件properties和yml数组写法
    springBoot配置文件properties和yml数组写法springBoot配置文件properties和yml数组写法这里介绍一下springBoot中的两种文件配置方式中数组的使用,也就是集合。以下是......
  • MyBatis核心配置文件详解、添加properties文件
    1.mybatis-config.xml文件详解<environmentsdefault="development">environments:配置连接数据库的环境属性:default:设置默认使用环境的id。可以有多个环境,像开......
  • YAML文件语法及示例
     前言时间就像海绵里的水,只要愿挤,总还是有的。——鲁迅今天乌天黑地,就来了几点雨,上了一天课,嗓子不舒服了。来打打字,活跃活跃手。 一、YAML文件是什么 YAML是"Y......
  • ros 加载yaml问题
    mac_address:12:23device_number:001ros加载yaml时不会把第一个当作字符串,解析出来是一个数,不知道怎么计算得来的。会把第二个解析为1,如果要当作字符串传入,给对应数......
  • SpringBoot:Configuration Annotation Processor not configured&在Spring Boot中读取a
    您在使用@ConfigurationProperties注解时可以使用spring-boot-configuration-processorjar轻松地从带有注释的项目中生成自己的配置元数据文件。该jar包含一个Java注释处......
  • /opt/module/canal/conf/canal.properties
    ##########################################################commonargument###############################################################tcpbindipcanal.id......
  • /opt/module/canal/conf/example/instance.properties
    ###################################################mysqlserverId,v1.0.26+willautoGencanal.instance.mysql.slaveId=1234canal.instance.gtidon=false#positi......