Spring Boot详解配置文件的用途与用法

更新时间：2022年06月20日 10:02:25 作者：独一无二的哈密瓜

SpringBoot项目是一个标准的Maven项目,它的配置文件需要放在src/main/resources/下,其文件名必须为application,其存在两种文件形式,分别是properties和yaml(或者yml)文件

1. SpringBoot 配置文件

1.1 配置文件的作用

配置文件中配置了项目中重要的数据, 例如:

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

Spring Boot项目没有配置信息, 就不能连接和操作数据库, 甚至不能保存可以用于排查问题的关键日志. 所以配置文件非常重要.

1.2 配置文件的格式

在Spring Boot 中配置文件主要分为两种:

.properties (主要是key=value格式)
.yml (主要是key: value格式)

注意:

当项目中既有 .properties 和 .yml , 且两个配置文件中有相同的配置项, Spring Boot 会优先考虑 .properties , 因为 .properties 的优先级更高一些.
一个项目中允许存在两种不同的配置文件, .properties .yml, 但是在项目中建议只使用一种配置文件的格式.

1.3 properties 配置文件说明

1.3.1 properties 基本语法

properties 是以 key=value 这种格式配置的.

server.port=9090
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/2022-6-1
spring.datasource.username=root
spring.datasource.password=1234

配置文件的注释信息使用 “#”

1.3.2 读取配置文件

读取配置文件的内容, 可以使用 @Value 注解来实现

@Value 注解使用 "${}" 的格式读取.

@Component
public class Read implements InitializingBean {
    @Value("${server.port}")
    private String port;
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println();
        System.out.println(port);
        System.out.println();
    }
}

1.4 yml 配置文件说明

yml 是 YMAL 是缩写, 它的全称是 Yet Another Markup Language, 译为另一种标记语言.

1.4.1 yml 基本语法

yml 是树形结构的配置文件, 它的基础语法是 key: value, 这里的:后面跟着一个空格.

server:
port: 9090
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/2022-6-1
username: root
password: 1234

1.4.2 yml 使用进阶

# ~代表null
null.value: ~

查看一段代码

string:
str1: Hello \n World
str2: 'Hello \n World'
str3: "Hello \n World"

读取yml中的这段代码

@Component
public class Read1 implements InitializingBean {
    @Value("${string.str1}")
    private String str1;
    @Value("${string.str2}")
    private String str2;
    @Value("${string.str3}")
    private String str3;
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println();
        System.out.println("str1: "+str1);
        System.out.println("str2: "+str2);
        System.out.println("str3: "+str3);
        System.out.println();
    }
}

运行结果:

字符串加上双引号, 会执行\n 换行.

1.4.3 配置对象

yml 中配置对象

student:
id: 1
name: zhangsan
age: 18

读取配置的对象, 就需要用到另一个注解: @ConfigurationProperties

@Component
@ConfigurationProperties("student")
public class User {
    private int id;
    private String name;
    private int age;
	// 一堆getter setter
}

读取

@Component
public class Read2 implements InitializingBean {
    @Autowired
    private Student student;
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println();
        System.out.println(student);
        System.out.println();
    }
}

1.4.4 配置集合

yml 中配置集合

mylist:
colors:
- RED
- GREEN
- BLACK

读取配置集合

@Component
@ConfigurationProperties("mylist")
public class MyList {
    private List<String> colors;
    // 一堆getter 和 setter
}

打印代码

@Component
public class Read3 implements InitializingBean {
    @Autowired
    private MyList myList;
    @Override
    public void afterPropertiesSet() throws Exception {
        for (String val : myList.getColors()){
            System.out.println(val);
        }
    }
}

1.4.5 yml的另一种写法(行内写法)

配置对象

student: {id: 1,name: zhangsan,age: 18}

配置集合

mylist: {colors: [RED,GREEN,BLACK]}

1.5 properties 和 yml 比较

properties 的语法更复杂, yml 语法更简洁

yml通用性更好, 支持更多的语言, 如 Java, Go, Python等

yml支持更多的数据类型

yml格式的配置文件写的时候容易出错(在:之后有一个空格), 而properties写法传统比较复制,但不太容易出错

2. 读取 SpringBoot 配置文件的方法

2.1 使用 @Value 读取配置文件

只能读取一个

@Component
public class Read implements InitializingBean {
    @Value("${server.port}")
    private String port;
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println();
        System.out.println(port);
        System.out.println();
    }
}

2.2 使用@ConfigurationProperties

直接在类上写

@Component
@ConfigurationProperties("mylist")
public class MyList {
    private List<String> colors;
    public List<String> getColors() {
        return colors;
    }
    public void setColors(List<String> colors) {
        this.colors = colors;
    }
}

2.3 @PropertySource读取指定配置文件

jdbc.username=root2
jdbc.password=root1

@Component
@PropertySource(value = {"classpath:application.properties"})
public class JDBC implements InitializingBean {
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println(username + " " + password);
    }
}

到此这篇关于Spring Boot详解配置文件的用途与用法的文章就介绍到这了,更多相关Spring Boot配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中的ArrayList(扩容机制)详解
ArrayList作为Java中广泛使用的动态数组,其扩容机制是保证性能和内存使用平衡的关键,默认初始容量为10,扩容因子为1.5,旨在减少频繁的内存分配和数据迁移代价,同时建议使用预估计的初始化容量以减少扩容次数
2024-11-11
idea中java及java web项目的常见问题及解决
在IDEA中处理乱码问题主要涉及四个方面：文件编码设置为UTF-8、编辑器默认编码调整、Tomcat运行配置编码设置以及解决cmd中的乱码,此外,详细介绍了在IDEA中创建Web项目的步骤,包括新建Java工程、添加Web框架支持、添加Tomcat依赖库
2024-09-09
springboot注解Aspect实现方案
本文提供一种自定义注解，来实现业务审批操作的DEMO，不包含审批流程的配置功能。对springboot注解Aspect实现方案感兴趣的朋友一起看看吧
2022-01-01
SpringBoot框架的MD5加密方式
这篇文章主要介绍了SpringBoot框架的MD5加密方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
java双端队列之ArrayDequeue原理讲解
这篇文章主要为大家介绍了java双端队列之ArrayDequeue原理讲解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-06-06
MyBatis Generator去掉生成的注解
这篇文章主要介绍了MyBatis Generator去掉生成的注解的相关资料,非常不错具有一定的参考借鉴价值，需要的朋友可以参考下
2016-11-11
Spring MVC 文件、cookies的接收与REST响应详
在SpringMVC中,使用@RequestPart注解可接收文件并处理多部分请求,同时可以通过@CookieValue和HttpServletResponse来获取和设置Cookies,本文介绍Spring MVC 文件、cookies的接收与REST响应,感兴趣的朋友跟随小编一起看看吧
2024-09-09
聊聊springboot中整合log4g2的问题
这篇文章主要介绍了springboot中整合log4g2的方法,自定义文件名需要在application.yml中配置，在config中配置log4g2.xml文件，本文通过实例代码给大家介绍的非常详细，需要的朋友可以参考下
2021-11-11
Eclipse/MyEclipse转IntelliJ IDEA完全攻略(图文)
这篇文章主要介绍了Eclipse/MyEclipse转IntelliJ IDEA完全攻略(图文)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-01-01
Java实现单链表反转的多种方法总结
这篇文章主要给大家介绍了关于Java实现单链表反转的多种方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-04-04