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;
    }
}