SpringBoot配置文件详解

最新推荐文章于 2024-06-06 11:08:40 发布
最新推荐文章于 2024-06-06 11:08:40 发布
阅读量992 收藏 43
点赞数 42
分类专栏： springboot 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_62274623/article/details/132782269
版权

 

目录

一、配置文件的作用

二、配置文件的格式

三、properties 配置文件说明

3.1 properties 基本语法 

3.2 读取配置⽂件

3.23properties 配置缺点分析

四、yml 配置文件说明

yml 优点分析

4.1 yml 基本语法

4.2 yml 配置简单的数据类型及 null 

4.3 yml 配置对象 

 4.4 yml 配置 list 集合

五、properties 和 yml 的总结

六、Spring Boot 读取配置文件的方法

使用 Environment 读取配置文件

一、配置文件的作用

整个项⽬中所有重要的数据都是在配置⽂件中配置的，⽐如：

  1. 数据库的连接信息（包含⽤户名和密码的设置）；
  2. 项⽬的启动端⼝；
  3. 第三⽅系统的调⽤秘钥等信息；
  4. ⽤于发现和定位问题的普通⽇志和异常⽇志等。

想象⼀下如果没有配置信息，那么 Spring Boot 项⽬就不能连接和操作数据库，甚⾄是不能保存可以⽤于排查问题的关键⽇志，所以配置⽂件的作⽤是⾮常重要的

除了上述的内容，还有很多重要的属性都需要在配置文件中配置。如果想要查看 Spring Boot 更多系统配置项，Spring 的官网中已经整理好了这些信息。链接如下：https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties

二、配置文件的格式

Spring Boot 的配置文件主要有两种格式

  1. .properties
  2. .yml

这两个的功能是一样的，但是，这两个是不同时代的产物，properties 相当于老款的配置文件，而 yml 相当于新款的配置文件，要想使用新款的配置文件，在 /src/main/resources 目录下手动创建一个 application.yml 文件就行

要注意的是在创建 Spring Boot 项目时，项目默认会带一个 application.properties 配置文件

补充:

  1. 理论上讲 properties 可以和 yml ⼀起存在于⼀个项⽬当中，当 properties 和 yml ⼀起存在⼀个项⽬中时，如果配置⽂件中出现了同样的配置，那么这个时候会以 properties 中的配置为主，也就是 .properties 配置⽂件的优先级最⾼，但加载完 .properties ⽂件之后，也会加载 .yml ⽂件的配置信息。
  2. 虽然理论上来讲 .properties 可以和 .yml 共存，但实际的业务当中，我们通常会采取⼀种统⼀的配置⽂件格式，这样可以更好的维护（降低故障率）。

三、properties 配置文件说明

properties 配置⽂件是最早期的配置⽂件格式，也是创建 Spring Boot 项⽬默认的配置⽂件

3.1 properties 基本语法 

properties 是以键值对的形式配置的，key 和 value 之间用 = 号来连接的。key 就是要配置的属性，value 就是要设置的值。

 实例代码:

#配置端口号信息
server.port=8081
#配置数据库信息
spring.datasource.url=jdbc:mysql://localhost:3306
spring.datasource.name=root
spring.datasource.password=123456

3.2 读取配置⽂件

如果在项⽬中，想要主动的读取配置⽂件中的内容，可以使⽤ @Value 注解来实现。
@Value 注解使⽤“${}”的格式读取，如下代码所示

package com.example.demo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
@Component
public class ReadProperties {

    @Value("${server.port}")
    private String port;

    @PostConstruct
    public void doPostConstruct(){
        System.out.println("port = "+ port);
    }
}

 

@Component 在 Spring Boot 启动时候会注⼊到框架中，注⼊到框架中时会执⾏ @PostConstruct初始化⽅法，这个时候就能读取到配置信息了。 

3.23properties 配置缺点分析

properties 配置是以 key-value 的形式配置的，如下图所示：
 从上述配置key看出，properties 配置⽂件中会有很多的冗余的信息 ,想要解决这个问题，就可以使⽤ yml 配置⽂件的格式化了

四、yml 配置文件说明

yml 是 YAML 是缩写，它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语
⾔”。

yml 优点分析

  1. yml 是⼀个可读性⾼，写法简单、易于理解，它的语法和 JSON 语⾔类似。
  2. yml ⽀持更多的数据类型，它可以简单表达清单（数组）、散列表，标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
  3. yml ⽀持更多的编程语⾔，它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中

4.1 yml 基本语法

yml 是树型结构的配置文件，它的基础形式是 key: value，yml 的基础语法具有以下的规则：

  • key: value 表示键值对关系，冒号后面必须有一个空格

  • 使用空格的缩进表示层级关系，空格数目不重要，只要是左对齐的一列数据，都是同一个层级的

  • 大小写敏感

其中第⼀项的配置为正确的，key 也是⾼亮显示的，⽽第⼆项没有空格是错误的使⽤⽅式，第⼆项的key 也没有⾼亮显示。

配置数据库示例:


 

4.2 yml 配置简单的数据类型及 null 

yml 配置：


#字符串
string:
  value: hello zifuchuan

#整型
int:
  value: 10

#布尔类型
boolean:
  value: tru

读取代码： 通过 @Value 注解来读取配置中的简单数据类型和 null 

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ReadYml {

    @Value("${int.value}")
    private int val;

    @Value("${string.value}")
    private String val2;

    @Value("${boolean.value}")
    private boolean val3;

    @RequestMapping("/read")
    public void read(){
        System.out.println("整数 =>"+ val);
        System.out.println("字符串 =>"+ val2);
        System.out.println("布尔类型 =>"+ val3);
    }
}

 

在 yml 中，字符串如果使用了双引号包裹，那么特殊字符是不会转义的，比如 \n 就表示换行；而如果字符串什么都不包裹或者用单引号包裹，那么特殊字符就会自动进行转义。 

4.3 yml 配置对象 

yml 配置：

#写法一
student:
  id: 1
  name: 竹筒
  age: 250
#写法二
user: {id: 2, username: 小白, age: 2}

 读取代码：

首先需要创建一个匹配配置文件中对象的类，并且读取配置文件中的对象就不能使用 @Value 注解，而需要使用 @ConfigurationProperties 注解，该注解放在创建的类上，并且有一个 prefix 属性用于设置配置文件中对应的 key。创建的类中必须要有 Setter 和 Getter 方法。

package com.example.demo;


import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "student")
public class Student {
    private int id;
    private String name;
    private int age;

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    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;
    }
}

 通过创建的类读取到配置文件的对象后，将该类注册到 Spring 容器中，当使用时，直接通过 @Autowired 或者 @Resource 注解注入就好。

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ReadYml {


    @Autowired
    private Student student;

    @RequestMapping("/student")
    public void stu(){
        System.out.println(student.toString());
    }


}

 

 4.4 yml 配置 list 集合

yml 配置：

#集合写法一
list:
  animal6:
    - 狗
    - 猫
    - 马
#集合写法二
list2: {fruit: [苹果,香蕉,西瓜]}

读取代码：

yml 配置集合时，也需要通过 @ConfigurationProperties 注解来读取，该注解的 prefix 属性对应着上述 yml 配置的 dbtypes1 或者 dbtypes2。接下来创建一个匹配配置文件中集合的类

 千万注意(private List<String> animal6;) 这块配置的名字必须与yml中对应

package com.example.demo;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
@ConfigurationProperties(prefix = "list")
public class ListObjec {

    private List<String> animal6;

    public List<String> getAnimal6() {
        return animal6;
    }

    public void setAnimal6(List<String> animal6) {
        this.animal6 = animal6;
    }
}

 通过创建的类读取到配置文件的对象后，将该类注册到 Spring 容器中，当使用时，直接通过 @Autowired 或者 @Resource 注解注入就好。

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
public class ReadYml {

    @Resource
    private ListObjec listo;

    @RequestMapping("/list")
    public void lis() {
        System.out.println("集合为= " + listo.getAnimal6());
    }


}

五、properties 和 yml 的总结

  1.  properties 是以 key=value 的形式配置的键值类型的配置⽂件，⽽ yml 使⽤的是类似 json 格式的 树形配置⽅式进⾏配置的，yml 层级之间使⽤换⾏缩进的⽅式配置，key 和 value 之间使⽤“: ”英⽂ 冒号加空格的⽅式设置，并且空格不可省略。
  2. properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使⽤ yml 可以很好的 解决数据冗余的问题。
  3. yml 通⽤性更好，⽀持更多语⾔，如 Java、Go、Python 等，如果是云服务器开发，可以使⽤⼀份 配置⽂件作为 Java 和 Go 的共同配置⽂件。
  4. yml 虽然可以和 properties 共存，但⼀个项⽬中建议使⽤统⼀的配置类型⽂件。
  5. yml 支持更多的数据类型

六、Spring Boot 读取配置文件的方法

  • 使用 @Value 读取配置文件
  • 使用 @ConfigurationProperties 读取配置文件
  • 使用 Environment 读取配置文件

前两种上面已经使用过  下面我们来测试一下第三种

Environment 是 Spring Core 中的一个用于读取配置文件的类，将此类使用 @Autowired 或者 @Resource 注入到类中就可以使用它的 getProperty 方法来获取某个配置项的值，代码如下所示：

使用 Environment 读取配置文件

 yml配置

#写法一
student:
  id: 1
  name: 竹筒
  age: 250

读取代码：

    @Autowired
    private Environment environment;
    @RequestMapping("/readE")
    public void read3(){
        System.out.println(environment.getProperty("student.name"));
    }

 

以上就是我对SpringBoot配置文件的理解 ,如有错误还请指出

²º¹⁷旧人不必等
关注
  • 42
    点赞
  • 踩
  • 43
    收藏
    觉得还不错? 一键收藏
  • 53
    评论
专栏目录
【Spring Boot】Spring Boot 配置文件详解（application.yml、application-dev.yml、application-test.yml ）
代码的魅力，根本走不出来
12-29 1万+
在 Spring Boot 中，可以通过属性文件（比如 application.yml 或 application.properties）来配置应用程序的属性。除了通过属性文件来设置激活的环境外，你还可以通过命令行参数、系统属性、环境变量等方式来指定激活的环境。上述示例展示了一些常用的配置项，但根据应用程序的需求，你可以在 application.yml 中配置各种属性。这些方式都允许在应用程序中方便地访问配置文件中的属性值，开发者可以根据具体情况选择最适合的方式。外，你还可以使用其他自定义的配置文件。
Spring Boot 配置文件
lfm1010123的博客
10-04 7442
本片博客主要介绍了，properties 文件 和 yml 文件
SpringBoot配置文件
最新发布
m0_62241955的博客
06-06 886
为了更方便简单的访问数据库，出现了一些持久层框架，其实就是对JDBC进行了更深层次的封装，让用户通过几行简单代码就可完成数据库的访问。如果采用硬编码的方式，就直接在程序中指定字体大小，所有的用户使用的都是同一个字体大小，但是不同的用户有不同的偏好，我们可以把手机字体的大小放在配置文件中，当程序启动时，读取配置，以用户设置的字体大小来显示。的问题，把可能会改变的信息，放在一个集中的地方，当我们启动某个程序时，应用程序从配置文件中读取数据，并加载运行。使用单引号会转义，就是说，\n不再表示换行了。
springboot---配置文件
lipviolet的博客
03-02 4899
Springboot中配置文件配置大全 转载于：https://blog.csdn.net/zhuzhezhuzhe1/article/details/80560306 配置 ############################################################# # mvc ############################################################# spring.mvc.async.request-timeout=
SpringBoot配置文件 —— 超详细全方位教程
dream_ready的博客
11-13 3569
这些文件通常用于存储和管理应用程序的设置，以便在运行时进行配置和自定义。配置文件可以采用不同的格式，如文本文件、JSON、XML、YAML等，具体格式取决于应用程序的需求和开发者的偏好。计算机上有数以千计的配置⽂件，我们使⽤的绝⼤多数软件，⽐如浏览器，微信，Idea，甚⾄电脑，手机，都离不开配置⽂件。我们可能永远不会直接与其中的⼤部分⽂件打交道，但它们确实以不同的形式散落在我们的计算机上，⽐如C:\Users, C:\Windows⽂件夹，以及各种 *.config, *.xml ⽂件。
SpringBoot之配置文件
从基础到源码解析的学习记录
07-10 6580
使用临时属性设置配置文件名，注意仅仅是名称，不要带扩展名使用临时属性设置配置文件路径或类路径，全路径名。
springboot配置文件的加载顺序解析
08-25
SpringBoot配置文件的加载顺序解析 本文主要介绍了SpringBoot配置文件的加载顺序解析，通过实践示例代码详细介绍了配置文件的加载顺序，帮助读者更好地理解和应用SpringBoot配置文件的加载机制。 一、SpringBoot...
详解Springboot配置文件的使用
08-30
Spring Boot配置文件的使用是构建高效、简洁的Java应用程序的关键组成部分。它允许开发者定义和管理应用的配置，以便于在不同环境间灵活切换。在Spring Boot项目中，我们可以选择使用`.properties`或`.yml`两种类型...
Spring Boot 配置文件详解(小结)
08-27
在Spring Boot框架中，配置文件起着至关重要的作用，它们允许开发者自定义Spring Boot自动配置的默认设置。本文主要关注两种常见的配置文件格式——`properties`和`yml`，尤其是`yml`的语法和从配置文件中提取值的...
springboot配置文件抽离 git管理统 配置中心详解
09-18
在本篇文章里小编给大家整理的是关于springboot配置文件抽离 git管理统 配置中心的相关知识点内容，有需要的朋友们可以学习下。
springboot配置redis过程详解
08-25
SpringBoot 配置 Redis 过程详解 springboot 配置 redis 过程详解是指在 SpringBoot 框架中如何配置和使用 Redis 数据库。本文将通过示例代码详细介绍 SpringBoot 配置 Redis 的过程，包括依赖包的引入、配置类的...
【Spring Boot】Spring Boot配置文件详情
黄小黄的博客
07-04 3810
Spring Boot是一个开源的Java框架，用于快速构建应用程序和微服务。它基于Spring Framework，通过自动化配置和约定优于配置的方式，使开发人员可以更快地启动和运行应用程序。Spring Boot提供了许多开箱即用的功能和插件，包括嵌入式Web服务器、安全性、数据访问、缓存、测试和监控等，极大地简化了开发人员的工作。本文就 SpringBoot 项目中配置文件的作用以及两种不同形式的配置文件的使用分别进行阐述。
SpringBoot配置文件是什么？该如何使用？
知识记录
03-03 8039
黑马学习笔记，本篇详细介绍SpringBoot配置文件的使用。可以学习到配置文件的优先级顺序、数据读取、语法规则以及文件分类~
Spring Boot之配置文件详解
yinyin_xiao的博客
05-24 1913
Spring Boot之配置文件详解 Spring Boot 提供了大量的自动配置，极大地简化了spring 应用的开发过程，当用户创建了一个 Spring Boot 项目后，即使不进行任何配置，该项目也能顺利的运行起来。当然，用户也可以根据自身的需要使用配置文件修改 Spring Boot 的默认设置。 SpringBoot 默认使用以下 2 种全局的配置文件，其文件名是固定的。 application.properties application.yml 其中，application.yml 是一种
springboot配置文件加载顺序详解
06-01
<h3>回答1：</h3><br/>Spring Boot 配置文件加载顺序详解：在 Spring Boot 中，加载配置文件的顺序是非常严格的，首先会加载 application.properties 文件，再加载 application.yml 文件，最后加载 application-{profile}.properties 或 application-{profile}.yml 文件，其中 {profile} 为环境的名称，如开发环境、测试环境等。在同一个文件夹下，后缀名相同的配置文件将被合并，而相同 key 的配置项，后者将覆盖前者。如果需要加载其他路径下的配置文件，可以通过在 application.properties 中指定 spring.config.location 或在启动参数中指定 --spring.config.location 进行配置。 <h3>回答2：</h3><br/> <h3>回答3：</h3><br/>

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 53
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值