二、SpringBoot3 配置文件

最新推荐文章于 2024-10-15 15:56:26 发布
最新推荐文章于 2024-10-15 15:56:26 发布
阅读量1.1k 收藏 28
点赞数 23
分类专栏： # SpringBoot3 实战 文章标签： 统一配置管理概述 属性配置文件使用 YAML 配置文件使用 批量配置文件注入 多环境配置和使用
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/GXL_1012/article/details/136950689
版权
本文详细介绍了在SpringBoot项目中如何使用属性配置文件（application.properties和YAML），包括文件结构、读取方式以及如何利用多环境配置（如开发、测试、生产）来适应不同环境的需求。
摘要由CSDN通过智能技术生成

本章概要

  • 统一配置管理概述
  • 属性配置文件使用
  • YAML 配置文件使用
  • 批量配置文件注入
  • 多环境配置和使用

2.1 统一配置管理概述

SpringBoot工程下，进行统一的配置管理，你想设置的任何参数（端口号、项目根路径、数据库连接信息等等)都集中到一个固定位置和命名的配置文件（application.properties或application.yml）中！
配置文件应该放置在Spring Boot工程的src/main/resources目录下。这是因为src/main/resources目录是Spring Boot默认的类路径（classpath），配置文件会被自动加载并可供应用程序访问。

在这里插入图片描述

功能配置参数说明：
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties

细节总结：

  • 集中式管理配置。统一在一个文件完成程序功能参数设置和自定义参数声明 。
  • 位置：resources文件夹下，必须命名application后缀 .properties、.yaml、.yml。
  • 如果同时存在application.properties | application.yml(.yaml) , properties的优先级更高。
  • 配置基本都有默认值。

在这里插入图片描述

2.2 属性配置文件使用

  1. 配置文件

在resource文件夹下面新建application.properties配置文件

# application.properties 为统一配置文件
# 内部包含: 固定功能的key,自定义的key
# 此处的配置信息,我们都可以在程序中@Value等注解读取

# 固定的key
# 启动端口号
server.port=80 

# 自定义
spring.jdbc.datasource.driverClassName=com.mysql.cj.jdbc.driver
spring.jdbc.datasource.url=jdbc:mysql:///springboot_01
spring.jdbc.datasource.username=root
spring.jdbc.datasource.password=root
  1. 读取配置文件
package com.atguigu.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceProperties {

    @Value("${spring.jdbc.datasource.driverClassName}")
    private String driverClassName;

    @Value("${spring.jdbc.datasource.url}")
    private String url;

    @Value("${spring.jdbc.datasource.username}")
    private String username;

    @Value("${spring.jdbc.datasource.password}")
    private String password;

    // 生成get set 和 toString方法
    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "DataSourceProperties{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}
  1. 测试效果

在controller注入，输出进行测试

@Autowired
private DataSourceProperties dataSourceProperties ;

@RequestMapping(path = "/hello")
public String sayHello() {
  System.out.println(dataSourceProperties);
  return "Hello Spring Boot ! " ;
}

浏览器访问路径，控制台查看效果
在这里插入图片描述

2.3 YAML 配置文件使用

  1. yaml 格式介绍

YAML（YAML Ain’t Markup Language）是一种基于层次结构的数据序列化格式，旨在提供一种易读、人类友好的数据表示方式。

与.properties文件相比，YAML格式有以下优势：

  • 层次结构：YAML文件使用缩进和冒号来表示层次结构，使得数据之间的关系更加清晰和直观。这样可以更容易理解和维护复杂的配置，特别适用于深层次嵌套的配置情况。
  • 自我描述性：YAML文件具有自我描述性，字段和值之间使用冒号分隔，并使用缩进表示层级关系。这使得配置文件更易于阅读和理解，并且可以减少冗余的标点符号和引号。
  • 注释支持：YAML格式支持注释，可以在配置文件中添加说明性的注释，使配置更具可读性和可维护性。相比之下，.properties文件不支持注释，无法提供类似的解释和说明。
  • 多行文本：YAML格式支持多行文本的表示，可以更方便地表示长文本或数据块。相比之下，.properties文件需要使用转义符或将长文本拆分为多行。
  • 类型支持：YAML格式天然支持复杂的数据类型，如列表、映射等。这使得在配置文件中表示嵌套结构或数据集合更加容易，而不需要进行额外的解析或转换。
  • 更好的可读性：由于YAML格式的特点，它更容易被人类读懂和解释。它减少了配置文件中需要的特殊字符和语法，让配置更加清晰明了，从而减少了错误和歧义。

综上所述，YAML格式相对于.properties文件具有更好的层次结构表示、自我描述性、注释支持、多行文本表示、复杂数据类型支持和更好的可读性。这些特点使YAML成为一种有力的配置文件格式，尤其适用于复杂的配置需求和人类可读的场景。然而，选择使用YAML还是.properties取决于实际需求和团队的偏好，简单的配置可以使用.properties，而复杂的配置可以选择YAML以获得更多的灵活性和可读性

  1. yaml 语法说明
  • 数据结构用树形结构呈现，通过缩进来表示层级，
  • 连续的项目（集合）通过减号-来表示
  • 键值结构里面的key/value对用冒号:来分隔。
  • YAML配置文件的扩展名是yaml或yml

例如：

# YAML配置文件示例
app_name: 我的应用程序
version: 1.0.0
author: 张三

database:
  host: localhost
  port: 5432
  username: admin
  password: password123

features:
  - 登录
  - 注册
  - 仪表盘

settings:
  analytics: true
  theme: dark
  1. 配置文件
spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql:///springboot_02
      username: root
      password: root
      
server:
  port: 80
  1. 读取配置文件

读取方式和properties一致

package com.atguigu.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceProperties {

    @Value("${spring.jdbc.datasource.driverClassName}")
    private String driverClassName;

    @Value("${spring.jdbc.datasource.url}")
    private String url;

    @Value("${spring.jdbc.datasource.username}")
    private String username;

    @Value("${spring.jdbc.datasource.password}")
    private String password;

    // 生成get set 和 toString方法
    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "DataSourceProperties{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}
  1. 测试效果

在controller注入，输出进行测试

@Autowired
private DataSourceProperties dataSourceProperties ;

@RequestMapping(path = "/hello")
public String sayHello() {
  System.out.println(dataSourceProperties);
  return "Hello Spring Boot ! " ;
}

浏览器访问路径，控制台查看效果

在这里插入图片描述

2.4 批量配置文件注入

@ConfigurationProperties是SpringBoot提供的重要注解, 他可以将一些配置属性批量注入到bean对象。

  1. 创建类，添加属性和注解

在类上通过@ConfigurationProperties注解声明该类要读取属性配置
prefix="spring.jdbc.datasource"读取属性文件中前缀为spring.jdbc.datasource的值。前缀和属性名称和配置文件中的key必须要保持一致才可以注入成功

package com.atguigu.properties;

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

@Component
@ConfigurationProperties(prefix = "spring.jdbc.datasource")
public class DataSourceConfigurationProperties {

    private String driverClassName;
    private String url;
    private String username;
    private String password;

    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "DataSourceConfigurationProperties{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}
  1. 测试效果
@RestController
public class HelloController {

    @Autowired
    private DataSourceProperties dataSourceProperties;

    @Autowired
    private DataSourceConfigurationProperties dataSourceConfigurationProperties;

    @GetMapping("/hello")
    public String hello(){
        System.out.println("dataSourceProperties = " + dataSourceProperties);
        System.out.println("dataSourceConfigurationProperties = " + dataSourceConfigurationProperties);
        return "Hello,Spring Boot 3!";
    }
}

2.5 多环境配置和使用

  1. 需求

在Spring Boot中，可以使用多环境配置来根据不同的运行环境（如开发、测试、生产）加载不同的配置。SpringBoot支持多环境配置让应用程序在不同的环境中使用不同的配置参数，例如数据库连接信息、日志级别、缓存配置等。

以下是实现Spring Boot多环境配置的常见方法：

  1. 属性文件分离：将应用程序的配置参数分离到不同的属性文件中，每个环境对应一个属性文件。例如，可以创建application-dev.properties、application-prod.properties和application-test.properties等文件。在这些文件中，可以定义各自环境的配置参数，如数据库连接信息、端口号等。然后，在application.properties中通过spring.profiles.active属性指定当前使用的环境。Spring Boot会根据该属性来加载对应环境的属性文件，覆盖默认的配置。
  2. YAML配置文件：与属性文件类似，可以将配置参数分离到不同的YAML文件中，每个环境对应一个文件。例如，可以创建application-dev.yml、application-prod.yml和application-test.yml等文件。在这些文件中，可以使用YAML语法定义各自环境的配置参数。同样，通过spring.profiles.active属性指定当前的环境，Spring Boot会加载相应的YAML文件。
  3. 命令行参数(动态)：可以通过命令行参数来指定当前的环境。例如，可以使用--spring.profiles.active=dev来指定使用开发环境的配置。

通过上述方法，Spring Boot会根据当前指定的环境来加载相应的配置文件或参数，从而实现多环境配置。这样可以简化在不同环境之间的配置切换，并且确保应用程序在不同环境中具有正确的配置。

  1. 多环境配置

创建开发、测试、生产三个环境的配置文件

application-dev.yml（开发）

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql:///dev
      username: root
      password: root

application-test.yml（测试）

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql:///test
      username: root
      password: root

application-prod.yml（生产）

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql:///prod
      username: root
      password: root
  1. 环境激活
spring:
  profiles:
    active: dev
  1. 测试效果

在这里插入图片描述

注意 :

  • 如果设置了spring.profiles.active，并且和application有重叠属性，以active设置优先。
  • 如果设置了spring.profiles.active，和application无重叠属性，application设置依然生效！
一只小熊猫呀
关注
专栏目录
【SpringBoot】47、SpringBoot中如何静态加载配置文件
Asurplus
03-24 21万+
前言 我们知道在 SpringBoot 中有默认的配置文件 application.yml 或 application.properties，我们可以通过 @ConfigurationProperties(prefix = “test”) 或 @Value("${test}") 等方式获取到配置内容，那有的时候我们需要通过静态的方式读取配置文件的内容，这种方式就不能实现了 1、创建配置文件 我们将配置文件放在根目录下，里面配置的是微信公众平台的一些信息 2、读取配置文件 package com.asurp
SpringBoot配置文件
冷兮雪的博客
06-18 4679
❤️❤️❤️前篇我们说完了SpringBoot的创建与使用，这篇讲SpringBoot的配置文件，那么SpringBoot的配置文件有什么用呢？那就到了这篇文章的主题——配置文件。
SpringBoot-3-配置文件
baidu_38126306的博客
10-18 1156
SpringBoot配置文件yaml
SpringBoot3之配置文件（学习SpringBoot3的配置这一篇足够）
哥的时代，为你保驾护航
09-21 3174
SpringBoot 帮我们简单、快速地创建一个独立的、生产级别的Spring 应用（说明：SpringBoot底层是Spring），大多数 SpringBoot 应用只需要编写少量配置即可快速整合 Spring 平台以及第三方技术！为所有 Spring 开发提供更快速、可广泛访问的入门体验。开箱即用，设置合理的默认值，但是也可以根据需求进行适当的调整。提供一系列大型项目通用的非功能性程序（如嵌入式服务器、安全性、指标、运行检查等）。
SpringBoot3核心特性-核心原理
蓝影铁哥的博客
09-18 1327
SpringBoot3核心特性-核心原理
SpringBoot3 —— 配置文件
JL_L666的博客
12-19 216
springboot是进行统一配置文件管理的，对任何的配置参数（如端口号、数据库连接信息、项目根路径…），需要集中到一个统一的配置文件，以开头，后缀名为,（ 即 application.properities 或 application.yml ）。位置：resources文件夹下，必须命名application 后缀 .properties / .yaml / .yml配置方式有两种springboot官方提供：key 固定 ，只需修改 value 即可。自定义配置① 配置文件中自定义。
springboot3配置文件介绍
最新发布
m0_56175680的博客
10-15 838
springboot启动还会扫描以下位置的application.properties和application.yml文件作为SpringBoot默认配置文件，以下Springboot加载配置文件的优先级由低到高。springboot提供了多profile的管理的功能，我们可以使用profile功能来区分不事环境的配置。SpringBoot使用一个全局的配置文件核心配置文件，配置文件名在约定的情况下名字固定，Profile的意思是配置，对于应用程序来说，不同的环境需要不同的配置，
SpringBoot 3：配置文件
weixin_40964170的博客
01-11 140
1、配置文件 1.1、properties 同以前的properties用法 1.2、yaml 简介 YAML 是 “YAML Ain’t Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。 非常适合用来做以数据为中心的配置文件 基本语法 • key: value；kv之间有空格 • 大小写敏感 • 使用缩进表示层级关系 • 缩进不允许使用tab，只允许
SpringBoot读取配置文件常用方法解析
08-18
SpringBoot读取配置文件常用方法解析 SpringBoot 读取配置文件是指在 SpringBoot 项目中读取外部配置文件的方法，用于获取配置信息。下面将介绍 SpringBoot 读取配置文件的常用方法。 传统项目读取配置方式 在没有...
【SpringBoot】03-springboot核心配置文件
m0_50964976的博客
06-02 4265
springboot的核心配置
SpringBoot的配置文件
01-07
SpringBoot配置文件类型 SpringBoot配置文件类型和作用： SpringBoot是基于约定的，所以很多配置都有默认值，但如果想使用自己的配置替换默认配置的话，就可以使用 application.properties或者application.yml...
【SpringBoot3】快速启动框架 快速入门 配置文件
Orion
03-12 921
SpringBoot3 官方文档SpringBoot底层是Spring。约定大于配置，基本不需要主动编写配置类、也不需要 XML 配置文件。简化开发，简化配置，简化整合，简化部署，简化监控，简化运维。技术&工具版本（or later）maven3.6.3 or later 3.6.3 或更高版本Tomcat10.0+Servlet9.0+JDK17+每个boot项目都有一个父项目parent的父项目是父项目，把所有常见的jar的依赖版本都声明好了。
一起来学SpringBoot | 第二篇：SpringBoot配置详解
LuisChen的博客
06-01 8835
SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程 上一篇介绍了SpringBoot由来及构建方式，通过第一章的教程我们对SpringBoot不在感到陌生，可以发现SpringBoot虽然干掉了 XML 但未做...
03-SpringBoot (三) --- 配置文件详解
qq_54103767的博客
03-27 251
继续SpringBoot的学习，这是一个专栏学习噢~
SpringBoot3
weixin_63925896的博客
03-17 392
快速启动框架：SpringBoot3实战
SpringBoot-3：SpringBoot配置
你今天真好看呀
02-21 711
文章目录四. 配置文件占位符1. 随机数2. 占位符获取之前配置的值，没有可以使用:指定默认值五. Profile1. 多Profile文件2. yml支持多文档块方式3. 激活指定的Profile六. 配置文件加载位置七. 外部配置文件加载顺序八. SpringBoot自动配置原理（精髓）1. 自动配置原理2. 细节 四. 配置文件占位符 1. 随机数 RandomValuePropertySo...
3.SpringBoot配置
mmm174的博客
02-01 837
什么是日志？如何使用日志？如何使用yml配置文件？yml和properties有什么区别？
SpringBoot_3
sinat_50855580的博客
04-23 278
SpringBoot_3 1.Spring Initializer快速创建Spring Boot项目 src/main/java----保存java源代码 src/main/resources application.properties-------Spring Boot应用的配置文件 [static]---需要自己手动创建【保存web应用程序所需的静态资源{html、css、js、img}】 [templates]--需要自己手动创建【保存模板页面】 Spring Boot默认j.
SpringBoot 三 配置文件
glass__sky的博客
11-05 519
​ SpringBoot 使用的是一个全局的配置文件，就是application.properties配置文件，这个文件的路径放在src/main/resources/目录下面或者放在类路径下面，并且这个文件名是固定的。 IDEA工具默认创建的时候创建到对应的第一个目录下面。既然是全局的配置文件，那么就可以对全局的默认配置进行修改。 在实际开发中我们用的更多的是yml后缀的配置文件。 关于这个配置文件有两种格式 application.properties application.yml yaml与y
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一只小熊猫呀

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值