四、SpringBoot属性配置文件详解

最新推荐文章于 2024-08-11 23:49:08 发布
原创 最新推荐文章于 2024-08-11 23:49:08 发布 · 1.1k 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文介绍SpringBoot中的配置方式，包括如何使用properties文件、YAML文件、环境变量等进行配置，并探讨了配置属性的覆盖顺序及如何使用@Value和@ConfigurationProperties进行属性绑定。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

外化配置

在Spring Boot使用过程中，最直观的感受就是没有了原来自己整合Spring应用时繁多的XML配置内容，替代它的是在pom.xml中引入模块化的Starter POMs，其中各个模块都有自己的默认配置，所以如果不是特殊应用场景，就只需要在application.properties中完成一些属性配置就能开启各模块的应用。

Spring Boot允许外化（externalize）你的配置，这样你能够在不同的环境下使用相同的代码。你可以使用properties文件，YAML文件，环境变量和命令行参数来外化配置。使用@Value注解，可以直接将属性值注入到你的beans中，并通过Spring的Environment抽象或绑定到结构化对象来访问。

Spring Boot使用一个非常特别的PropertySource次序来允许对值进行合理的覆盖，需要以下面的次序考虑属性：

  1. 命令行参数
  2. 来自于java:comp/env的JNDI属性
  3. Java系统属性（System.getProperties()）
  4. 操作系统环境变量
  5. 只有在random.*里包含的属性会产生一个RandomValuePropertySource
  6. 在打包的jar外的应用程序配置文件（application.properties，包含YAML和profile变量）
  7. 在打包的jar内的应用程序配置文件（application.properties，包含YAML和profile变量）
  8. 在@Configuration类上的@PropertySource注解
  9. 默认属性（使用SpringApplication.setDefaultProperties指定）

配置随机值

application.properties文件中添加

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.number.less.than.ten=${random.int(10)}
my.number.in.range=${random.int[1024,65536]}

random.int*语法是OPEN value (,max) CLOSE，此处OPEN，CLOSE可以是任何字符，并且value，max是整数。如果提供
max，那么value是最小的值，max是最大的值（不包含在内）。

Application属性文件

SpringApplication将从以下位置加载application.properties文件，并把它们添加到Spring Environment中：

  1. 当前目录下的一个/config子目录
  2. 当前目录
  3. 一个classpath下的/config包
  4. classpath根路径（root）

这个列表是按优先级排序的（列表中位置高的将覆盖位置低的）。
你可以使用YAML（’.yml’）文件替代’.properties’。

如果不喜欢将application.properties作为配置文件名，你可以通过指定spring.config.name环境属性来切换其他的名称。你也可以使用spring.config.location环境属性来引用一个明确的路径（目录位置或文件路径列表以逗号分割）。

如果spring.config.location包含目录（相对于文件），那它们应该以/结尾（在加载前，spring.config.name产生的名称将被追加到后面）。不管spring.config.location是什么值，默认的搜索路径classpath:,classpath:/config,file:,file:config/总会被使用。
以这种方式，你可以在application.properties中为应用设置默认值，然后在运行的时候使用不同的文件覆盖它，同时保留默认
配置。

属性占位符

当application.properties里的值被使用时，它们会被存在的Environment过滤，所以你能够引用先前定义的值（比如，系统属性）。

app.name=MyApp
app.description=${app.name} is a Spring Boot application

YAML代替Properties

YAML是JSON的一个超集，也是一种方便的定义层次配置数据的格式。
Spring框架提供两个便利的类用于加载YAML文档，YamlPropertiesFactoryBean会将YAML作为Properties来加载，
YamlMapFactoryBean会将YAML作为Map来加载。

这里写图片描述

YAML缺点

YAML文件不能通过@PropertySource注解加载。所以，在这种情况下，如果需要使用@PropertySource注解的方式加载值，那就要使用properties文件。

类型安全的配置属性：

package com.lf.config;

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

import java.util.List;

/**
 * Created by LF on 2017/4/11.
 */
@Component
public class UserValue {
    @Value("${my.secret}")
    private String name;
    @Value("${my.number}")
    private int age;
    @Value("${my.bignumber}")
    private long aLong;
    @Value("${my.number.less.than.ten}")
    private int lessTen;

    @Value("${my.number.in.range}")
    private int rang;

    @Value("${com.if.user.list}")
    private List<String> list;

    public List<String> getList() {
        return list;
    }

    public void setList(List<String> list) {
        this.list = list;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public long getaLong() {
        return aLong;
    }

    public void setaLong(long aLong) {
        this.aLong = aLong;
    }

    public int getLessTen() {
        return lessTen;
    }

    public void setLessTen(int lessTen) {
        this.lessTen = lessTen;
    }

    public int getRang() {
        return rang;
    }

    public void setRang(int rang) {
        this.rang = rang;
    }
}

使用前缀配置

1.application.properties文件中添加

com.if.user.name=张三
com.if.user.age=12
com.if.user.list=12,13

2.User配置类

package com.lf.config;

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

import java.util.List;

/**
 * Created by LF on 2017/4/11.
 */
@ConfigurationProperties(prefix = "com.if.user")
public class User {

    private String name;

    private int age;

    private List<String> list;

    public List<String> getList() {
        return list;
    }

    public void setList(List<String> list) {
        this.list = list;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

3.Application文件

package com.lf;

import com.lf.config.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication

@EnableConfigurationProperties({User.class})
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

用新的配置文件

1.新建lf.properties文件

com.if.config.name=张三
com.if.config.age=12
com.if.config.list=12,13

2.需定义如下配置类

package com.lf.config;

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

import java.util.List;

/**
 * Created by LF on 2017/4/11.
 */
@ConfigurationProperties(prefix = "com.if.config")
public class Config {

    private String name;

    private int age;

    private List<String> list;

    public List<String> getList() {
        return list;
    }

    public void setList(List<String> list) {
        this.list = list;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

3.Application文件

package com.lf;

import com.lf.config.Config;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.PropertySource;

@SpringBootApplication
@PropertySource(value = "classpath:lf.properties")
@EnableConfigurationProperties({Config.class})
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
【SpringBoot】2、SpringBoot中配置文件详解
Asurplus
04-14 20万+
SpringBoot使用一个全局的配置文件，配置文件名是固定的，支持两种格式 1、两种格式（properties，yml） application.properties application.yml 由此可以看出 application.yml 文件格式的内容更为简洁，清晰，目前大部分都是 YML 格式，我们主要讲 YML 格式的配置文件 注意： 1、以空格的缩进来控制层级关系，左对齐的一列...
SpringBoot | 详解SpringBoot配置文件及其原理
最新发布
kelai_6792的博客
09-15 1584
因此AutoConfiguration配置类的作用就是不断的判断，最终决定这个配置类是否生效，如果生效的话，则给容器添加各种组件，这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的//通过@EnableConfigurationProperties注解，和SpringBoot的配置文件进行了映射//只有一个有参构造器的情况下，参数的值就会从容器中拿@Bean。
Spring Boot之配置文件详解
yinyin_xiao的博客
05-24 2093
Spring Boot之配置文件详解 Spring Boot 提供了大量的自动配置，极大地简化了spring 应用的开发过程，当用户创建了一个 Spring Boot 项目后，即使不进行任何配置，该项目也能顺利的运行起来。当然，用户也可以根据自身的需要使用配置文件修改 Spring Boot 的默认设置。 SpringBoot 默认使用以下 2 种全局的配置文件，其文件名是固定的。 application.properties application.yml 其中，application.yml 是一种
SpringBoot 实战 (三) | 配置文件详解
weixin_33911824的博客
01-28 340
微信公众号：一个优秀的废人如有问题或建议，请后台留言，我会尽力解决你的问题。 前言 如题，今天解析下 SpringBoot 的配置文件。 自定义属性加载 首先构建 SpringBoot 项目，不会的看这篇旧文 使用 IDEA 构建 Spring Boot 工程。 首先在项目根目录下加入以下自定义属性： # 防止读取乱码 spring.h...
springboot配置文件详解
weixin_30920597的博客
03-05 109
https://blog.csdn.net/myvanguard/article/details/84844583 简介 springboot的默认配置文件 application.propertiesapplication.ymlyaml是标记语言，是以数据为中心的的配置文件 server: port:8081 12342.yaml语法1.基本语法k:(空格v:表示一对键值对（空格必...
springboot配置文件的详解
m0_63040701的博客
06-07 994
SpringBoot中有两种容器对象，分别是bootstrap和application，bootstrap是应用程序的父容器，bootstrap加载优先于applicaton。SpringBoot项目中，大部分配置都有默认值，但如果想替换默认配置的话， 就可以使用application.properties或者application.yml进行配置。bootstrap配置文件主要对bootstrap容器进行配置，application配置文件是对applicaton容器进行配置。
spring boot配置文件详解
学亮编程手记
03-29 715
spring boot配置文件详解 application.properties是spring-boot的核心配置文件，这个配置文件基本可以取代我们ssm或者ssh里面的所有的xml配置文件。 当我们启动springboot工程做的第一件事就是加载application.properties属性配置文件。 application.properties虽然有时候是...
【SpringBoot】二、SpringBoot中配置文件详解.pdf
11-18
在SpringBoot中，配置文件是管理和维护应用配置的重要组成部分。本篇文章将详细解析SpringBoot中的配置文件，重点讲解YML格式的配置。 1. **配置文件格式** SpringBoot 支持两种配置文件格式：`application....
【SpringBoot】二、SpringBoot中配置文件详解.docx
11-18
SpringBoot支持多配置文件管理，通过`spring.profiles.active`属性指定当前活动的配置文件。例如，本地开发时可设置`spring.profiles.active: oauth,db-local`，而在部署到云服务器时，将此值改为`spring.profiles....
SpringBoot注入配置文件的3种方法详解
08-25
SpringBoot 注入配置文件的 3 种方法详解 SpringBoot 框架提供了多种方式来注入配置文件，下面将详细介绍三种常用的方法： 方法一：@ConfigurationProperties + @Component 使用 @ConfigurationProperties 注解...
关于springboot 配置文件中属性变量引用方式@@解析
09-16
主要介绍了关于springboot 配置文件中属性变量引用方式@@解析，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
SpringBoot配置文件详解
qq_62274623的博客
09-10 2002
SpringBoot配置文件基础详解
Spring Boot配置文件详解
weixin_65978343的博客
08-11 2002
Spring Boot配置文件详解。包括1. SpringBoot提供了2种配置文件类型：properteis 和 yml/yaml2. 默认配置文件名称：application3. 在同一级目录入如果三类文件共存，优先级为：properties > yml > yaml。常见SpringBoot注解；application.yml配置文件基本配置
SpringBoot 配置文件详解
weixin_42408447的博客
05-25 236
  springboot采纳了建立生产就绪spring应用程序的观点。 Spring Boot优先于配置的惯例，旨在让您尽快启动和运行。在一般情况下，我们不需要做太多的配置就能够让spring boot正常运行。在一些特殊的情况下，我们需要做修改一些配置，或者需要有自己的配置属性。 一.自定义属性   当我们创建一个springboot项目的时候，系统默认会为我们在src/main/Java/resources目录下创建一个application.properties。个人习惯，我会将application
SpringBoot_配置
Running_lemon的博客
02-27 337
SpringBoot配置文件YAML 配置文件 SpringBoot使用一个全局的配置文件，配置文件名是固定的：application.properties或者application.yml； 配置文件的作用：修改SpringBoot自动配置的默认值； YAML yml 是 YAML 语言的文件，以数据为中心，比 json 、xml 等更适合做配置文件； <!--xml格式--> ...
【Spring Boot】之配置文件详解
weixin_62848751的博客
02-07 1307
整个项⽬中所有重要的数据都是在配置⽂件中配置的，⽐如： - 数据库的连接信息（包含⽤户名和密码的设置）； - 项⽬的启动端⼝； - 第三⽅系统的调⽤秘钥等信息； - ⽤于发现和定位问题的普通⽇志和异常⽇志等。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值