java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot读取多个配置属性

SpringBoot整体读取多个配置属性及其相关操作方法

作者：NE_STOP

本文介绍SpringBoot中@ConfigurationProperties用于批量读取配置属性,对比@Value,涵盖其用法、配置选项、List处理及校验功能,支持宽松绑定与属性转换,需相关依赖启用,感兴趣的朋友一起看看吧

上篇文章讲到使用@Value注解每次只能读取一个配置属性，若要整体读取多个属性，或者读取具有某种结构关系的一组属性可使用@ConfigurationProperties注解来处理。

@ConfigurationProperties注解的两种用法：

看不懂没关系，下面会有代码示例。

在使用@ConfigurationProperties时可指定如下属性：

使用属性处理类获取配置属性

直接来看代码示例：

\resources\application.properties文件内容：

org.crazyit.enabled=true
org.crazyit.name=Crazy Java
org.crazyit.remoteAddress=192.168.1.188
org.crazyit.item.brand=Tesla
org.crazyit.item.comments=Good, Excellent

(使用IDEA开发属性处理类时，添加spring-boot-configuration-processor依赖，IDEA会提供“代码补全”功能。

<!-- 添加该依赖后IDEA可以提供自动补全功能 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-configuration-processor</artifactId>
   <optional>true</optional>
</dependency>

)

SpringBoot不会自动启用@ConfigurationProperties注解，启用该注解有如下方式：

@ConfigurationProperties注解修饰的属性处理类代码:

// 指定读取以org.crazyit.*开头的属性
@ConfigurationProperties(prefix = "org.crazyit", ignoreUnknownFields=false)
@Component
public class CrazyitProperties
{
    // 指定同名的实例变量和setter方法。SpringBoot会通过反射调用setter方法来完成属性值注入
   private boolean enabled;
   private String name;
   private InetAddress remoteAddress;
   private final Item item = new Item();
         // 省略getter\setter 
   public static class Item
   {
      private String brand;
      private List<String> comments = new ArrayList<>(Collections.singleton("GREAT"));
            // 省略getter\setter 
   }
}

控制器类代码示例：

@RestController
public class HelloController
{
   private final CrazyitProperties crazyitProperties;
   // 依赖注入CrazyitProperties属性处理Bean
   @Autowired
   public HelloController(CrazyitProperties crazyitProperties)
   {
      this.crazyitProperties = crazyitProperties;
   }
   @GetMapping
   public CrazyitProperties hello()
   {
      return crazyitProperties;
   }
}

运行结果：

属性处理类也支持使用构造器完成属性值注入，但是要额外使用@ConstructorBinding修饰用于执行构造注入的构造器。注意：使用构造器注入，必须使用@EnableConfigurationProperties或者@ConfigurationPropertiesScan注解来启用@ConfigurationProperties注解。

属性处理类示例：

@ConfigurationProperties(prefix = "org.crazyit", ignoreUnknownFields=false)
public class CrazyitProperties
{
   private boolean enabled;
   private String name;
   private InetAddress remoteAddress;
   private final Item item;
   @ConstructorBinding
   public CrazyitProperties(boolean enabled, String name, InetAddress remoteAddress, Item item)
   {
      this.enabled = enabled;
      this.name = name;
      this.remoteAddress = remoteAddress;
      this.item = item;
   }
       // 省略getter\setter 
   public static class Item
   {
      private String brand;
      private List<String> comments = new ArrayList<>(Collections.singleton("GREAT"));
       // 省略getter\setter 
   }
}

application.yml

org:
  crazyit:
    enabled: true
    name: 哈利波特
    remote-address: 192.168.1.188
    item:
      brand: Apple
      comments:
        - Good
        - Excellent

上面配置的属性为org.crazyit.remote-address与CrazyitProperties类中定义的remoteAddress属性不完全相同，SpringBoot能成功注入吗？

答案是肯定的，因为SpringBoot支持宽松绑定（Relaxed Binding）。它不要求配置的属性名和属性处理类中的属性名完全相同。

宽松绑定的四种情况（这4种情况都能完成注入）：

在*.properties和 *.yml文件中配置List类型的属性有较小的区别：

因此，*.properties和 *.yml文件中，都可以用英文逗号隔开多个值来构建List。

App.java示例

@SpringBootApplication
// 指定扫描org.crazyit.app.config包及其子包下的@ConfigurationProperties注解修饰的类
@ConfigurationPropertiesScan("org.crazyit.app.config")
public class App
{
   public static void main(String[] args)
   {
      // 创建Spring容器、运行Spring Boot应用
      SpringApplication.run(App.class, args);
   }
}

为容器中的bean注入配置属性

@ConfigurationProperties注解除了可修饰类，还可修饰@Bean注解修饰的方法。

代码示例：Book类

public class Book
{
   private String title;
   private double price;
   private String author;
   private List<String> keywords;
	// 省略getter、setter
}

代码示例：配置类

@Configuration
public class MyConfig
{
   @Bean
   // @ConfigurationProperties注解会驱动Spring自动调用该Bean的setter方法
   @ConfigurationProperties("fkjava.book")
   public Book book()
   {
      return new Book();
   }
}

代码示例：application.yml

fkjava:
  book:
    title: "美语音标"
    price: 128
    author: "赖世雄"
    keywords:
      - 英语
      - 音标

代码示例：控制器类

@RestController
public class HelloController
{
   private final Book book;
    // 通过构造器注入Book对象
   @Autowired
   public HelloController(Book book)
   {
      this.book = book;
   }
   @GetMapping
   public Book hello()
   {
      return book;
   }
}

运行结果：

@Value和 @ConfigurationProperties的对比

特征@ConfigurationProperties@Value
注入的属性个数批量单个
宽松绑定支持部分支持
SpEL不支持支持
元数据支持支持不支持

属性转换

SpringBoot内置了常用的类型转换机制，如果在转换失败，则应用启动会失败，并抛出异常。如果要忽略转换失败的属性，可将@ConfigurationProperties注解的ignoreInvaildFields属性设为true（默认是false）。

SpringBoot可自动转换如下类型：Duration、Period、DataSize，并支持为属性值指定单位。

代码示例：属性处理类

// 指定读取以org.crazyit.*开头的属性
@ConfigurationProperties(prefix = "org.crazyit")
@Component
public class CrazyitProperties
{
   private Duration timeout;
    //   @DurationUnit注解指定默认的时间单位
   @DurationUnit(ChronoUnit.SECONDS)
   private Duration lastTime;
   private Period runPeriod;
    // @DataSizeUnit注解指定默认的数据单位
   @DataSizeUnit(DataUnit.MEGABYTES)
   private DataSize maxSize;
	// 省略getter、setter
}

代码示例：application.properties

org.crazyit.timeout=30000
# 默认单位是秒
org.crazyit.last-time=45
org.crazyit.run-period=2m5d
org.crazyit.max-size=2

代码示例：控制器类

@RestController
public class HelloController
{
   private final CrazyitProperties crazyitProperties;
   // 依赖注入CrazyitProperties属性处理Bean
   @Autowired
   public HelloController(CrazyitProperties crazyitProperties)
   {
      this.crazyitProperties = crazyitProperties;
   }
   @GetMapping
   public Map<String, Object> hello()
   {
      System.out.println(crazyitProperties.getMaxSize().toKilobytes());
      return Map.of("props", crazyitProperties,
            "maxSize", crazyitProperties.getMaxSize().toKilobytes());
   }
}

运行结果：

校验@ConfigurationProperties

只要为属性处理类添加@Validated注解，并使用JSR303的校验注解修饰需要校验的示例变量，SpringBoot会自动校验配置文件中的属性值。如果某个属性校验不通过，应用会启动失败，并用FailureAnalyzer显式校验错误。

如果属性处理类包含复合类型的属性，且要对复合类型的子属性进行校验，则应为该复合类型的属性添加@Valid注解。

@ConfigurationProperties校验基于JSR303，因此必须添加JSR303依赖，spring-boot-starter-validation依赖库包含了JSR303的依赖，因此要在pom文件中添加以下依赖

<!-- 添加Spring Boot Validation依赖库 -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

属性处理类示例：

// 指定读取以org.crazyit.*开头的属性
@ConfigurationProperties(prefix = "org.crazyit", ignoreUnknownFields=false)
@Component
@Validated
public class CrazyitProperties
{
   @NotEmpty
   private String name;
   @Range(max = 150, min=90, message = "价格必须位于90～150之间")
   private double price;
   @Pattern(regexp = "[1][3-8][0-9]{9}", message = "必须输入有效的手机号")
   private String mobile;
   @Valid
   private final Item item = new Item();
	// 省略getter setter
   public static class Item
   {
      @Length(min=5, max=10, message = "品牌名长度必须在5到10个字符")
      private String brand;
      @Size(min = 1, message = "comments至少包含一个元素")
      private List<String> comments = new ArrayList<>(Collections.singleton("GREAT"));
	// 省略getter、setter
   }
}

代码示例：application.properties

org.crazyit.name=Crazy Java
org.crazyit.price=89
org.crazyit.mobile=13334444
org.crazyit.item.brand=Apple
org.crazyit.item.comments=Great, Excellent

运行结果：

对于使用@ConfigurationProperties修饰@Bean方法的情况，同样可对配置属性进行校验，主要为@Bean方法添加@Validated注解即可。

到此这篇关于SpringBoot整体读取多个配置属性及其相关操作的文章就介绍到这了,更多相关SpringBoot读取多个配置属性内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文