SpringBoot系列之spring boot配置管理

2024-05-25 13:12

本文主要是介绍SpringBoot系列之spring boot配置管理,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

SpringBoot项目中,大部分配置都有默认值,但如果想替换默认配置的话,就可以使用application.properties或者application.yml文件。其中application.properties文件是键值对类型的文件。之前一直在使用。

一、配置文件

除了properties文件外,SpringBoot还支持YAML文件进行配置。YAML文件的扩展名为 .yml 或 .yaml ,它的基本要求如下:

  • 大小写敏感

  • 使用缩进代表层级关系

  • 相同的部分只出现一次

application

SpringBoot应用的配置参数只要在application配置文件中,它可以有不同形式的配置方式,配置文件也不是必须的,可以有多个类似的配置文件,如果不想有那么多的application配置文件,则可以使用命令行spring.config.name参数名指定其他配置文件的名称:

$java -jar demo.jar --spring.config,name=app

默认的配置文件搜索路径为:

  • optional:classpath:/classpath:/config/

  • optional:file:/;optional:file:./config/;optional:file:./config/*/

bootstrap

除了application配置文件,还要一种bootstrap配置文件,它不能独立于springboot应用生效,它属于spring cloud环境,需要引入spring cloud依赖,它的配置文件会优先于application配置文件的加载,主要用于从额外的资源中加载配置参数,通常用来加载外部配置。

对比application配置文件,bootstrap配置文件具有的特点

  • bootstrap由父allicationContext加载,比application优先加载

  • bootstrap中的参数不能被覆盖,

一般springboot应用使用application配置文件即可,除非用到了spring Cloud,并且遇到了如下场景:

再使用了外部的配置中心或者由一些固定的不能被覆盖的参数

配置文件的类型

  • .properties:  key = value 格式

  • .yml: key:value  树形格式

举例:

分别使用.properties和.yml格式的配置文件指定相应的接口和访问路径,如果不指定,则默认分别为8080和/

。properties文件

server.port = 8080server.servlet.contextPath = /javaTest

.yml格式

server  port: 8081  servelet:      contextPatj: /javaTest       使用yml格式文件说明 键冒号后一定要有空格 每个层级的缩进为两个空格

在程序开发过程中,推荐使用yml格式的配置文件,因为树状的层级关系比较清晰,且节省冗余的参数,yml配置文件能适配多个特定的环境,而使用properties格式则需要配置多个配置文件,

注:

  • yml配置文件不支持通过@propertySource注解导入配置,因为这个注解只针对properties文件,但是也有其他的解决方式,就是使用@ConfigurationProperties注解,它支持两个文件的格式,

  • yml配置文件可以通过YamlPropertiesFactionBean类被加载一个properties参数类,或者加载一个map

二、配置绑定

在spring框架中,所有已加载到spring环境中的配置都可以通过注入Environment环境Bean来获取

@Atuowiredprivate Environment env;//获取参数spring getProperty(string key);

@PropertySource注解的使用

@PropertySource注解绑定配置,仅限于在.properties配置文件,比如绑定资源目录下的config/db-cofig.propertied配置参数

import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.core.env.Environment;import org.springframework.context.annotation.PropertySource;@Configuration@PropertySource("classpath:config.properties")public class AppConfig {    @Autowired    private Environment env;    @Bean    public MyBean myBean() {        MyBean myBean = new MyBean();        myBean.setName(env.getProperty("mybean.name"));        myBean.setValue(env.getProperty("mybean.value"));        return myBean;    }}

由于@PropertySource注解不支持。yml配置文件绑定,其本身也需要结合@Value注解使用,目前不太推荐使用。

参数绑定

通过java bean提供的setter方法进行配置参数与java bean字段的绑定,首先在application。yml配置文件中添加javastack.*的配置参数

# application.ymlmybean:  name: ExampleName  value: ExampleValue
// MyBean.javapublic class MyBean {    private String name;    private String value;    // Getters and setters}// AppConfig.javaimport org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.core.env.Environment;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.PropertySource;@Configurationpublic class AppConfig {    @Autowired    private Environment env;    @Bean    @ConfigurationProperties(prefix = "mybean")    public MyBean myBean() {        return new MyBean();    }}

构造器绑定

在springboot 底层更多的还是构造器绑定.

// application.ymlmybean:  name: ExampleName  value: ExampleValue
// MyBean.javapublic class MyBean {    private String name;    private String value;    public MyBean(String name, String value) {        this.name = name;        this.value = value;    }    // Getters and setters}// AppConfig.javaimport org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.core.env.Environment;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.PropertySource;@Configurationpublic class AppConfig {    @Autowired    private Environment env;    @Bean    public MyBean myBean() {        String name = env.getProperty("mybean.name");        String value = env.getProperty("mybean.value");        return new MyBean(name, value);    }}

使用构造器绑定的方式。在MyBean类中,我们定义了带有参数的构造函数,然后在AppConfig类的myBean方法中,通过Environment对象获取配置文件中的属性值,并将其传递给MyBean对象的构造函数,实现了参数的构造器绑定。

三、SpringBoot的外部配置

在springboot中还可以将配置文件外部化,除了把配置文件放在配置文件中,还可以使用各种外部配置源:

  • properties文件

  • yaml文件

  • 环境变量

  • 命令行参数

Properties文件:

my.property=value

YAML文件:

my:  property: value

环境变量:

export MY_PROPERTY=value

命令行参数:

java -jar myapp.jar --my.property=value

当将配置文件外部化时,Spring Boot 提供了多种选项来管理应用程序的配置。这些选项可以分为两大类:静态配置和动态配置。

静态配置是指在应用程序启动时就确定的配置,比如在 properties 文件、YAML 文件中定义的属性,或者通过环境变量、命令行参数传递的值。这些配置一旦设置,通常在应用程序的生命周期内不会改变。

动态配置则是指在应用程序运行时可以动态修改的配置,例如从远程配置中心获取的配置,或者通过 JMX 等管理工具动态修改的配置。这些配置可以在应用程序运行过程中动态地进行调整,而不需要重启应用程序。

Spring Boot 支持将静态配置和动态配置结合起来,使得应用程序能够灵活地适应不同的环境和需求。通过合理地配置和管理这些配置源,可以使得应用程序更加可靠、可维护和可扩展。

这篇关于SpringBoot系列之spring boot配置管理的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1001604

相关文章

javax.net.ssl.SSLHandshakeException:异常原因及解决方案

《javax.net.ssl.SSLHandshakeException:异常原因及解决方案》javax.net.ssl.SSLHandshakeException是一个SSL握手异常,通常在建立SS... 目录报错原因在程序中绕过服务器的安全验证注意点最后多说一句报错原因一般出现这种问题是因为目标服务器

Java实现删除文件中的指定内容

《Java实现删除文件中的指定内容》在日常开发中,经常需要对文本文件进行批量处理,其中,删除文件中指定内容是最常见的需求之一,下面我们就来看看如何使用java实现删除文件中的指定内容吧... 目录1. 项目背景详细介绍2. 项目需求详细介绍2.1 功能需求2.2 非功能需求3. 相关技术详细介绍3.1 Ja

springboot项目中整合高德地图的实践

《springboot项目中整合高德地图的实践》:本文主要介绍springboot项目中整合高德地图的实践,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一:高德开放平台的使用二:创建数据库(我是用的是mysql)三:Springboot所需的依赖(根据你的需求再

spring中的ImportSelector接口示例详解

《spring中的ImportSelector接口示例详解》Spring的ImportSelector接口用于动态选择配置类,实现条件化和模块化配置,关键方法selectImports根据注解信息返回... 目录一、核心作用二、关键方法三、扩展功能四、使用示例五、工作原理六、应用场景七、自定义实现Impor

SpringBoot3应用中集成和使用Spring Retry的实践记录

《SpringBoot3应用中集成和使用SpringRetry的实践记录》SpringRetry为SpringBoot3提供重试机制,支持注解和编程式两种方式,可配置重试策略与监听器,适用于临时性故... 目录1. 简介2. 环境准备3. 使用方式3.1 注解方式 基础使用自定义重试策略失败恢复机制注意事项

SpringBoot整合Flowable实现工作流的详细流程

《SpringBoot整合Flowable实现工作流的详细流程》Flowable是一个使用Java编写的轻量级业务流程引擎,Flowable流程引擎可用于部署BPMN2.0流程定义,创建这些流程定义的... 目录1、流程引擎介绍2、创建项目3、画流程图4、开发接口4.1 Java 类梳理4.2 查看流程图4

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

Java对异常的认识与异常的处理小结

《Java对异常的认识与异常的处理小结》Java程序在运行时可能出现的错误或非正常情况称为异常,下面给大家介绍Java对异常的认识与异常的处理,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参... 目录一、认识异常与异常类型。二、异常的处理三、总结 一、认识异常与异常类型。(1)简单定义-什么是

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关

Java使用HttpClient实现图片下载与本地保存功能

《Java使用HttpClient实现图片下载与本地保存功能》在当今数字化时代,网络资源的获取与处理已成为软件开发中的常见需求,其中,图片作为网络上最常见的资源之一,其下载与保存功能在许多应用场景中都... 目录引言一、Apache HttpClient简介二、技术栈与环境准备三、实现图片下载与保存功能1.