Spring Boot的配置文件

目录

一、配置文件

1.properties为后缀的配置文件

1.1基本语法

1.2读取配置文件

1.3properties的优缺点

1.4加中文注释出现乱码

2.yml格式的配置文件

2.1基础语法

2.2读取配置文件

2.2.1对象存储到配置文件中

2.3yml的优缺点

2.4用不用加单引号或者双引号呢？

2.5设置不同环境的配置文件

---

一、配置文件

配置文件在项目中的权重很高，很多重要数据都是在配置文件中进行配置的。比如我们连接数据库的信息，项目的端口号等等。

配置文件中可以有注释，注释通过#来添加，yml形式的编码为UTF8所以允许有中文存在，但properties格式的编码不是UTF8，容易出现乱码，解决方法在后面。

Spring Boot提供的配置文件格式有两种：.yml(yaml)形式和.properties两种。前者是新款，后者是老款，也是Spring Boot项目默认提供的款式。

        1.两种格式的配置文件可以共存，但是当两中格式的配置文件配置了相同的东西，会用properties格式的文件。也就是因为properties配置文件的优先级比yaml格式的配置文件的优先级高。

        2.正常来讲，我们最好不要将两种格式的配置文件存放在同一项目中，维护的时候不好维护，而且最好统一起来。而且以后企业也会指定你用哪种格式的配置文件。

配置文件中的配置项分为两种：1.系统配置项，如server.port等，这个是系统给我们定义的。2.用户自定义配置（非系统配置项），这种是用户自己定义的。

1.properties为后缀的配置文件

1.1基本语法

这种配置文件是早期的配置文件，也是以键值的方式进行连接的:key=value。

#系统提供的配置
server.port=8080

#自己定义的配置

java = 106

1.2读取配置文件

通过注解@Value("${存储到配置文件中的名字来获取}")

下面代码用到两个注解，我在这大概说一下：

（1）RestController注解，这个是RestBody和Controller的结合体。RestBody这个注解就是表示返回的是一些数据而不是静态页面。

（2）PostConstruct这个注解，大家感觉眼熟了嘛？这不就是Bean生命周期那篇文章提到过的？在初始化阶段的时候，初始化的时候会调用这个注解标记的方法。

TestController类

@RestController
public class TestController {
    @Value("${java}")
    public int num;
    @PostConstruct
    public void test() {
        System.out.println(num);
    }
}


配置文件中


server.port=8080
java = 106

1.3properties的优缺点

优点：1.这个配置文件是系统默认的配置文件。

           2.properties配置项比yml的优先级高。

           3.格式简单，不容易出错。

缺点：1.写法冗余。（看下面这个图片，前面部分全部都相同，只是最后那不同，我们相同的部分却要写3次）

1.4加中文注释出现乱码

同样需要设置两个地方，全局的setting和当前项目的setting。将下面图片红色框框住的地方全部设置为UTF-8编码。

可能大家加载完以后，配置文件还是乱码，那是因为，每次项目启动的时候加载配置文件，你修改了编码方式以后，配置文件已经加载完成了，所以并没有更换为UTF-8编码方式。

可以将配置文件删除，再重新建一个就行了。

2.yml格式的配置文件

yaml格式的简写形式是yml。使用这种格式的时候一定要对空格非常敏感，因为这个对空格要求很强烈。

2.1基础语法

采用的格式是key: value（一定要注意！value和冒号之间有空格）空格不可少，如果缺少了空格，就会发生错误。

2.2读取配置文件

对于某一项的读取和properties方法一样，我们来说点不一样的。yml文件可以配置对象，也可以配置集合等。获取方式就不是@Value了而是采用@ConfigurationProperties这个注解。

2.2.1对象存储到配置文件中

两种方式存储

读取配置文件中的对象，也就是通过@ConfigurationProperties("student")来读取的。

TestController

@RestController
@Data
@ConfigurationProperties("student")
public class TestController {
    private int id;
    private int age;
    private String name;
}


TestComponent
@Component
public class TestComponent {
    @Autowired
    public TestController testController;
    @PostConstruct
    public void test() {
        System.out.println(testController);
    }
}

List和对象方式存储一样，取出来的方式也一样。

2.3yml的优缺点

优点：1.yml可读性高，写法简单，易于理解，语法和JSON类似。

           2.yml支持更多数据类型，可以简单表达数组，对象，集合等。所有基础类型它也可以进行表示。

           3.yml支持更多编程语言，可以用在Java,Golang,PHP,Python,Ruby,JS,等。

缺点:1.对于新手不太友好，因为对空格要求比较强，所以当忘记空格后容易出错。

2.4用不用加单引号或者双引号呢？

1.字符串默认不用加上单引号或者双引号。

2.单引号会转义特殊字符，特殊字符最终只是一个普通的字符串数据。

str1: 'Hello\n,world'
//输出Hello\n,world

str2: "Hello\n,world"
//输出Hello
      ,world

3.双引号不会转义字符串里面的特殊字符，特殊字符会表达出本身想表达的意思。

2.5设置不同环境的配置文件

在实际开发中，我们可能有很多不同的环境，比方说开发环境，生产环境等等，对于不同环境会对应一个配置文件，但会有一些要求：

1.每个项目中必须有个主配置文件，名称必须为application.yml(properties)。

2.不同平台的配置文件的名字必须为application-xxx.yml，只允许对xxx处进行修改。

3.我们怎么去使用不同的环境（平台）的配置文件呢？在主配置文件中进行配置。（其中的xxx就是命名的时候不同的部分，比方说一个配置文件名为application-dec.yml则在主配置文件中设置运行环境就为spring.profiles.active=dev）

spring.profiles.active=xxx