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

相关文章

SpringBoot启动报错的11个高频问题排查与解决终极指南

《SpringBoot启动报错的11个高频问题排查与解决终极指南》这篇文章主要为大家详细介绍了SpringBoot启动报错的11个高频问题的排查与解决,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一... 目录1. 依赖冲突:NoSuchMethodError 的终极解法2. Bean注入失败:No qu

Java异常架构Exception(异常)详解

《Java异常架构Exception(异常)详解》:本文主要介绍Java异常架构Exception(异常),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. Exception 类的概述Exception的分类2. 受检异常(Checked Exception)

使用Java实现通用树形结构构建工具类

《使用Java实现通用树形结构构建工具类》这篇文章主要为大家详细介绍了如何使用Java实现通用树形结构构建工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录完整代码一、设计思想与核心功能二、核心实现原理1. 数据结构准备阶段2. 循环依赖检测算法3. 树形结构构建4. 搜索子

Spring定时任务只执行一次的原因分析与解决方案

《Spring定时任务只执行一次的原因分析与解决方案》在使用Spring的@Scheduled定时任务时,你是否遇到过任务只执行一次,后续不再触发的情况?这种情况可能由多种原因导致,如未启用调度、线程... 目录1. 问题背景2. Spring定时任务的基本用法3. 为什么定时任务只执行一次?3.1 未启用

springboot报错Invalid bound statement (not found)的解决

《springboot报错Invalidboundstatement(notfound)的解决》本文主要介绍了springboot报错Invalidboundstatement(not... 目录一. 问题描述二.解决问题三. 添加配置项 四.其他的解决方案4.1 Mapper 接口与 XML 文件不匹配

MySQL新增字段后Java实体未更新的潜在问题与解决方案

《MySQL新增字段后Java实体未更新的潜在问题与解决方案》在Java+MySQL的开发中,我们通常使用ORM框架来映射数据库表与Java对象,但有时候,数据库表结构变更(如新增字段)后,开发人员可... 目录引言1. 问题背景:数据库与 Java 实体不同步1.1 常见场景1.2 示例代码2. 不同操作

SpringBoot使用OkHttp完成高效网络请求详解

《SpringBoot使用OkHttp完成高效网络请求详解》OkHttp是一个高效的HTTP客户端,支持同步和异步请求,且具备自动处理cookie、缓存和连接池等高级功能,下面我们来看看SpringB... 目录一、OkHttp 简介二、在 Spring Boot 中集成 OkHttp三、封装 OkHttp

JavaScript错误处理避坑指南

《JavaScript错误处理避坑指南》JavaScript错误处理是编程过程中不可避免的部分,它涉及到识别、捕获和响应代码运行时可能出现的问题,本文将详细给大家介绍一下JavaScript错误处理的... 目录一、错误类型:三大“杀手”与应对策略1. 语法错误(SyntaxError)2. 运行时错误(R

SpringBoot如何通过Map实现策略模式

《SpringBoot如何通过Map实现策略模式》策略模式是一种行为设计模式,它允许在运行时选择算法的行为,在Spring框架中,我们可以利用@Resource注解和Map集合来优雅地实现策略模式,这... 目录前言底层机制解析Spring的集合类型自动装配@Resource注解的行为实现原理使用直接使用M

JavaScript Array.from及其相关用法详解(示例演示)

《JavaScriptArray.from及其相关用法详解(示例演示)》Array.from方法是ES6引入的一个静态方法,用于从类数组对象或可迭代对象创建一个新的数组实例,本文将详细介绍Array... 目录一、Array.from 方法概述1. 方法介绍2. 示例演示二、结合实际场景的使用1. 初始化二