SpringBoot配置文件之properties和yml的使用

 更新时间:2025年05月04日 21:43:56   作者:棕豆兔&  
这篇文章主要介绍了SpringBoot配置文件之properties和yml的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

一、配置文件的作用

配置文件主要是为了解决硬编码带来的问题, 把可能会发生改变的信息,放在一个集中的地方, 当我们启动某个程序时, 应用程序从配置文件中读取数据, 并加载运行。

使用配置文件, 可以使程序完成用户和应用程序的交互, 或者应用程序与其他应用程序的交互。

SpringBoot支持并定义了配置文件的格式,也在另一个层面达到了规范其他框架集成到SpringBoot的目的。很多项目或者框架的配置信息也放在配置文件中, 比如:

  • 项目的启动端口;
  • 数据库的连接信息(包含用户名和密码的设置);
  • 第三方系统的调用密钥等信息;
  • 用于发现和定位问题的普通日志和异常日志等。

二、配置文件的格式

Spring Boot 配置文件有以下三种:

  • application.properties
  • application.yml
  • application.yaml

yml 为yaml的简写, 实际开发中出现频率最高。yaml 和yml 的使用方式一样。

NOTE:

  • 理论上讲 .properties 和 .yml 可以并存在于一个项目中,当 .properties 和 .yml 并存时,两个配置都会加载。如果配置文件内容有冲突,则以 .properties 为主,也就是 .properties 优先级更高;
  • 虽然理论上来讲 .properties 可以和 .yml 共存,但实际的业务当中,通常会采取一种统一的配置文件格式,这样可以更好的维护(降低故障率)。

三、properties 配置文件说明

properties 配置文件是最早期的配置文件格式,也是创建 SpringBoot 项目默认的配置文件。

3.1 properties 基本语法

properties 是以键值的形式配置的,key 和 value 之间是以 "=" 连接的,如:

# 配置项⽬端⼝号
server.port=8080
#配置数据库连接信息
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?
characterEncoding=utf8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root

3.2 读取配置文件

如果在项目中,想要主动的读取配置文件中的内容,可以使用 @Value 注解来实现。 @Value 注解使用" ${} "的格式读取,如下代码所示:

properties 配置如下:

mykey.key1 = bite

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

@RestController
public class PropertiesController {
    @Value("${mykey.key1}")
    private String key1;

    @RequestMapping("/key")
    public String key(){
      return "读取到值:"+key1;
 }
}

四、yml 配置文件说明

yml 是 YAML 是缩写,它的全称 Yet Another Markup Language ,翻译就是 “另一种标记语言“。

4.1 yml基本语法

yml 是树形结构的配置文件,它的基础语法是"key: value"。key 和 value 之间使用英文冒号加空格的方式组成, 空格不可省略

基础语法举例如下:

spring:
 datasource:
  url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8&useSSL=false
  username: root
  password: root

4.2 yml 读取文件

yml 读取配置的方式和 properties 相同,使用 @Value 注解即可,实现代码如下:

yml配置:

string:
 hello: bite
@RestController
public class ReadYml {
  @Value("${string.hello}")
  private String hello;

  @RequestMapping("/ymlKey")
  public String key(){
     return "读取到值:"+hello;
  }
}

NOTE: value值加单双引号

  • 字符串默认不用加上单引号或者双引号,如果加英文的单双引号可以表示特殊的含义。
  • 单引号会转义特殊字符,使其失去特殊功能,始终是一个普通的字符串;如 \n
  • 双引号不会转义字符串里面的特殊字符, 特殊字符会表示本身的含义。

yml配置不同数据类型及null:

#以下格式不代表yml文件格式,只是作为说明

# 字符串
string.value: Hello
  
# 布尔值,true或false
boolean.value: true
boolean.value1: false

# 整数
int.value: 10

# 浮点数
float.value: 3.14159

# Null,~代表null
null.value: ~

# "" 空字符串
# 直接后⾯什么都不加就可以了, 但这种⽅式不直观, 更多的表示是使⽤引号括起来
empty.value: ''

4.3 yml使用进阶

4.3.1 配置对象

在yml文件中配置对象,如下所示:

student:
 id: 1
 name: Java
 age: 18


#或者可以采用行内写法
student: {id: 1,name: Java,age: 18}

这个时候就不能用 @Value 来读取配置中的对象了,此时要使用另一个注解@ConfigurationProperties 来读取,具体实现如下:

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@ConfigurationProperties(prefix = "student")
@Component
@Data
public class Student {
 private int id;
 private String name;
 private int age;
}

调用类实现如下:

@RestController
public class StudentController {

 @Autowired
 private Student student;
 
 @RequestMapping("/readStudent")
 public String readStudent(){
     return student.toString();
 }
}

4.3.2 配置集合

配置文件也可以配置 list 集合,如下所示:

dbtypes:
 name:
  - mysql
  - sqlserver
  - db2

集合的读取和对象一样,也是使用 @ConfigurationProperties 来读取的,具体实现如下:

@Component
@ConfigurationProperties("dbtypes")
@Data
public class ListConfig {
  private List<String> name;
}

访问集合的实现如下:

@RestController
public class ReadYml2 {

 @Autowired
 private ListConfig listConfig;

 @RequestMapping("/readList")
 public String readList(){
    return listConfig.toString();
 }
}

4.3.3 配置Map

配置文件也可以配置 Map,如下所示:

maptypes:
 map:
  k1: kk1
  k2: kk2
  k3: kk3

Map的读取和对象一样,也是使用 @ConfigurationProperties 来读取的,具体实现如下:

@Component
@ConfigurationProperties("maptypes")
@Data
public class MapConfig {
 private HashMap<String,String> map;
}

打印类的实现如下:

@RestController
public class ReadYml2 {

 @Autowired
 private MapConfig mapConfig;

 @RequestMapping("/readMap")
 public String readStudent(){
   return mapConfig.toString();
 }
}

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java中值传递和引用传递的区别

    Java中值传递和引用传递的区别

    这篇文章主要介绍了Java中值传递和引用传递的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • SpringBoot使用Spring-Data-Jpa实现CRUD操作

    SpringBoot使用Spring-Data-Jpa实现CRUD操作

    这篇文章主要为大家详细介绍了SpringBoot使用Spring-Data-Jpa实现CRUD操作,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-08-08
  • springboot]logback日志框架配置教程

    springboot]logback日志框架配置教程

    这篇文章主要介绍了springboot]logback日志框架配置,logback既可以通过application配置文件进行日志的配置,又可以通过logback-spring.xml进行日志的配置,本文给大家介绍的非常详细,需要的朋友参考下吧
    2022-04-04
  • SpringBoot+MyBatis报错:Invalid bean definition的原因排查与解决

    SpringBoot+MyBatis报错:Invalid bean definition的原因排查与

    这篇文章主要为大家详细介绍了SpringBoot+MyBatis报错:Invalid bean definition的原因排查与解决方法,文中的示例代码讲解详细,希望对大家有所帮助
    2025-09-09
  • java实现6种字符串数组的排序(String array sort)

    java实现6种字符串数组的排序(String array sort)

    这篇文章主要介绍了java实现6种字符串数组的排序(String array sort),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • Java实现线程插队的示例代码

    Java实现线程插队的示例代码

    在编写多线程的业务时,会遇到让一个线程优先于其他线程运行的情况,除了可以设置线程的优先级高于其他线程,还有更直接的方式:线程插队。本文将用Java实现线程插队,需要的可以参考一下
    2022-08-08
  • java 多线程死锁详解及简单实例

    java 多线程死锁详解及简单实例

    这篇文章主要介绍了java 多线程死锁详解及简单实例的相关资料,需要的朋友可以参考下
    2017-01-01
  • Java中实现接口限流的方案详解

    Java中实现接口限流的方案详解

    常用的接口限流方案就是计数器限流方案、时间窗口限流方案和令牌桶限流方案等,这些方案的概念大致也知道,但是实际上也没有实现过,所以本文就来自动动手实践一下吧
    2023-05-05
  • Java实体类不要使用基本类型的知识点总结

    Java实体类不要使用基本类型的知识点总结

    在本篇文章里小编给大家整理的是关于Java包装类之实体类不要使用基本类型的知识点内容,需要的朋友们可以学习下。
    2020-02-02
  • mybatis 对于生成的sql语句 自动加上单引号的情况详解

    mybatis 对于生成的sql语句 自动加上单引号的情况详解

    这篇文章主要介绍了mybatis 对于生成的sql语句 自动加上单引号的情况详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01

最新评论