spring boot 配置文件加载的加载和使用

添加配置信息

在实际开发中,应用程序的配置文件可能会变得非常复杂,属性的数量也会很多。为了更好地组织和管理属性,可以使用Spring Boot的属性分组功能。

  • application.properties
    可以在application.properties中增加配置
upload.file.path=/tmp
upload.file.types=jpg,png,ico
upload.file.maxLength=10240 # 10KB
  • application.yml
    也可以在application.yml中增加配置
upload:
  file:
    path: /tmp
    types: jpg,png,ico
    maxLength: 10240 # 10KB

以上两种配置方式作用是相同的,都定义了一个upload.file的分组。

properties与YAML格式的配置作用相同,但YAML使用缩进来表示层级关系,更加易读、易维护,也更加灵活。对于复杂配置,推荐使用YAML,但对于简单的配置项,也可以使用properties。

使用@ConfigurationProperties注入属性

声明一个JavaBean

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Data
@Configuration
@ConfigurationProperties(prefix = "upload.file")
/**
 * @Description 文件上传相关的配置
 * @Author HaleyHu
 * @Date 2024/12/5 16:20
 */
public class UploadFileConfig {
    private String path;
    private String types;
    private long maxLength;
}

使用这些属性

@RestController
/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 16:21
 */
public class HelloController {
    @Autowired
    private UploadFileConfig config;
    
    @GetMapping("/hello")
    public String hello() {
        System.out.println(config);
        return "Hello Spring Boot!";
    }
}

使用@Value注入属性

@Value也能从配置文件中获取属性的值,需要逐个属性进行绑定。

@RestController
/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 16:21
 */
public class HelloController {
    @Value("${upload.file.path}")
    private String path;
    @Value("${upload.file.types}")
    private String types;
    @Value("${upload.file.maxLength}")
    private int maxLength;

    @GetMapping("/hello")
    public String hello() {
        System.out.println("path: " + path + ", types: " + types + ", maxLength: " + maxLength);
        return "Hello Spring Boot!";
    }
}

运行效果:
在这里插入图片描述

两种方式对比分析

  • 使用位置不同
    @ConfigurationProperties标注在JavaBean的类名上,@Value标注在JavaBean的属性上。
  • 功能有差异
    @ConfigurationProperties用于批量绑定配置文件中的配置,@Value只能一个一个地指定需要绑定的位置,绑定粒度更小。
  • 复杂类型封装
    @ConfigurationProperties支持所有类型的封装,如Map/List/Set以及对象等;@Value只支持基本数据类型的封装,如字符串、布尔值、整数值等。
  • 应用场景不同
    如果只是获取配置文件中的某项值,推荐使用@Value注解;如果专门编写一个JavaBean来和配置文件映射,建议使用@ConfigurationProperties注解。

自定义配置

添加自定义配置

# user.properties
name=Tom
age=25

加载并使用配置信息

/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 16:33
 */
@PropertySource("classpath:user.properties")
@RestController
public class PropertyController {
    @Value("${name}")
    private String name;

    @Value("${age}")
    private int age;

    @GetMapping("/property")
    public String property() {
        return name + " - " + age;
    }
}
### Spring Boot 配置文件加载顺序 Spring Boot配置文件加载机制遵循一定的优先级规则,这些规则决定了哪些配置会覆盖其他配置。以下是关于 Spring Boot 配置文件加载顺序的详细介绍: #### 默认配置文件加载顺序 Spring Boot 使用 `ConfigFileApplicationListener` 来处理外部化配置文件加载过程。默认情况下,它按照以下顺序加载配置文件[^1]: 1. **命令行参数 (Command Line Arguments)** 命令行参数具有最高优先级,可以覆盖任何其他地方定义的属性。 2. **来自 Java System Properties 的属性** 这些可以通过 `-Dproperty=value` 形式传递给 JVM。 3. **操作系统环境变量** 环境变量也可以作为配置的一部分被读取。 4. **随机数生成器中的 random.* 属性** 如果应用程序需要一些动态生成的值(如端口),可以从这里获取。 5. **servlet-config servlet-context 初始化参数** 当运行于 Servlet 容器中时,初始化参数会被考虑进来。 6. **JNDI 属性 (java:comp/env/)** JNDI 提供了一种标准的方式来访问企业级别的资源服务。 7. **Java 资源路径下的 application.properties 或者 application.yml 文件** 包括 classpath:/, classpath:/config/, file:./, file:./config/ 中的内容都会被扫描并应用。 8. **打包 jar 外部的应用程序包外的 profile-specific properties 文件** 例如:application-dev.properties。 9. **打包 jar 内部的应用程序包内的 profile-specific properties 文件** 同样支持基于不同 profiles 的定制化设置。 10. **打包 jar 外部的应用程序包外的基础 properties 文件** 如 application.properties 或 application.yml。 11. **打包 jar 内部的应用程序包内的基础 properties 文件** 即位于 resources 下的标准配置文件。 上述列表展示了从高到低的不同层次上的配置来源及其相对应的作用范围影响程度[^3]。 #### 自定义 MyBatis 配置的影响 如果项目引入了 MyBatis 并通过其自动配置功能,则可能会涉及到额外的自定义配置项。比如,在 org.mybatis.spring.boot.autoconfigure.MybatisProperties 类中定义了一些特定的关键字用于描述数据库连接池大小、SQL 映射位置等细节[^2]。这类扩展不会改变整体框架对于全局配置文件解析逻辑的行为模式,但它确实增加了局部领域内可调整选项的数量。 ```yaml mybatis: config-location: classpath:mybatis/mybatis-config.xml mapper-locations: classpath:mappers/**/*.xml ``` 以上是一个典型的 YAML 片段例子展示如何指定 MyBatis XML 文件的位置以及主配置文档地址。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值