用yml配置文件给bean绑定属性-创新互联
- 配置文件给bean绑定属性介绍
- 1.快速实现绑定
- 1.1 给自定bean绑定
- 1.2 给第三方bean绑定
- 1.3 使用@EnableConfigurationProperties统一管理绑定属性的类
- 2.松散绑定
- 3.常用计量单位绑定
- 4.校验
- 5.yaml文件的变量规则
配置文件功能强大,不仅可以设置各种依赖的属性,还可以给bean绑定属性,bean就是IOC容器管理的所有的类。
1.快速实现绑定 1.1 给自定bean绑定yml配置如下
servers:
IpAddress: 192.168.0.1
port: 8083
timeout: -1
实体类如下,@Component将该实体类作为IOC容器管理的bean,@Data是lombok快速给一个实体类实现getter,setter和构造方法。@ConfigurationProperties可以给bean指定配置文件中的“对象名”。
@Component
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {private String IpAddress;
private String port;
private String timeout;
}
小提示:使用 @ConfigurationProperties 时出现如下提示,只需要在pom.xml文件中引入以下坐标:
org.springframework.boot spring-boot-configuration-processor
1.2 给第三方bean绑定第三方bean的类函数是在包里的,无法直接在上面用注释导入。具体方法是构造一个返回值为该类的方法,如下:
datasource:
driverClassName: com.mysql.jdbc.driver
@Bean
// 注意datasource必须全小写
@ConfigurationProperties(prefix = "datasource")
public DruidDataSource datasource(){DruidDataSource ds = new DruidDataSource();
return ds;
}
1.3 使用@EnableConfigurationProperties统一管理绑定属性的类上述的方法已经能够实现给自定义的bean和第三方bean绑定属性,但是有一个问题是,当这些bean太多的时候,怎么知道哪些bean通过**@ConfigurationProperties绑定了属性?这时候就需要使用@EnableConfigurationProperties**统一声明和管理这些bean
@SpringBootApplication
// 这些类用逗号隔开,将@ConfigurationProperties注释的类注入到IOC容器中
@EnableConfigurationProperties(ServerConfig.class)
public class Springboot13ConfigurationApplication {}
这里注意@EnableConfigurationProperties注释会自动将找到的类注入到IOC容器中,也就是该类自动成为了IOC容器管理的Bean,所以就不要再用@Component声明了,如下即可:
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {private String IpAddress;
private String port;
private String timeout;
}
2.松散绑定松散绑定就是yaml配置文件中的命名和Bean的属性和 @ConfigurationProperties 中引用的“对象名”都不需要非常精确。以下形式都可以绑定到:
servers:
ipAddress: 192.168.0.2 # 驼峰模式
ip_address: 192.168.0.2 # 下划线模式
ip-address: 192.168.0.2 # 烤肉串模式
IP_ADDRESS: 192.168.0.2 # 常量模式
springboot官方推荐的是烤肉串模式,即使用-分隔,使用小写字母数字作为标准字符,且必须以字母开头。
有一点要注意的是 @ConfigurationProperties 中引用的“对象名”必须是烤肉串模式。
给出几个案例:
- 配置文件中驼峰命名,引用的对象名全小写
dataSource:
driverClassName: com.mysql.jdbc.driver
@Bean
@ConfigurationProperties(prefix = "datasource")
public DruidDataSource datasource(){DruidDataSource ds = new DruidDataSource();
return ds;
}
控制台打印的该bean,成功绑定:
- 配置文件中驼峰命名,引用的对象名烤肉串模式
dataSource:
driverClassName: com.mysql.jdbc.driver
@Bean
@ConfigurationProperties(prefix = "data-source")
public DruidDataSource datasource(){DruidDataSource ds = new DruidDataSource();
return ds;
}
控制台打印的该bean,成功绑定:
- 配置文件中全小写命名,引用的对象名烤肉串模式
datasource:
driverClassName: com.mysql.jdbc.driver
@Bean
@ConfigurationProperties(prefix = "data-source")
public DruidDataSource datasource(){DruidDataSource ds = new DruidDataSource();
return ds;
}
控制台打印的该bean,成功绑定:
- 配置文件中全小写命名,引用的对象名驼峰法模式
datasource:
driverClassName: com.mysql.jdbc.driver
@Bean
@ConfigurationProperties(prefix = "dataSource")
public DruidDataSource datasource(){DruidDataSource ds = new DruidDataSource();
return ds;
}
控制台打印的该bean,成功失败,提示要使用烤肉串模式:
总结:
松散绑定就是yaml配置文件中的名字可以有多种方式,bean的属性也可以有多种方式,springboot都能给我们绑定上,这就是 @ConfigurationProperties 注解的强大和方便之处。但是springboot官方推荐给我们的是在配置文件和注解中最好使用烤肉串模式,其中注解中必须使用烤肉串模式,实际上,全小写只是烤肉串模式的一个特例。
springboot利用JDK8提供的两个类,Duration和DataSize解决的绑定的单位问题
servers:
ip-address: 192.168.0.1
port: 8083
timeout: 4
data-size: 20
@Data
@ConfigurationProperties(prefix = "servers")
public class ServerConfig {private String IpaAddress;
private String port;
// 小时
@DurationUnit(ChronoUnit.HOURS)
private Duration timeout;
// MB
@DataSizeUnit(DataUnit.MEGABYTES)
private DataSize dataSize;
}
控制台打印结果如下:
Springboot给出了强大的数据校验功能,JAVAEE的JSR303规范中给出了具体的数据校验标准,但这是一些接口,开发者需要根据自己的需要选择对应的校验框架,这里以Hibernate提供的框架为例。
1. 开启校验框架
javax.validation validation-api org.hibernate.validator hibernate-validator
2. 在需要开启校验功能的类上使用注解@Validated开启校验功能
@Component
@Data
@ConfigurationProperties(prefix = "servers")
//开启对当前bean的属性注入校验
@Validated
public class ServerConfig {}
3. 对具体的字段设置校验规则
@Component
@Data
@ConfigurationProperties(prefix = "servers")
//开启对当前bean的属性注入校验
@Validated
public class ServerConfig {//设置具体的规则
@Max(value = 8080,message = "大值不能超过8080")
private int port;
}
当端口号设置为8083时,会报错
进入包中可以看到更多的方法,这里不再赘述,根据需要查阅即可
虽然字符串直接写数字一般会自动转化,但是万一是 0245 这种符合八进制写法的数字,则会自动转成十进制后再转成字符串,就会造成错误。所以如果是字符串最好直接加引号吧。
你是否还在寻找稳定的海外服务器提供商?创新互联www.cdcxhl.cn海外机房具备T级流量清洗系统配攻击溯源,准确流量调度确保服务器高可用性,企业级服务器适合批量采购,新人活动首月15元起,快前往官网查看详情吧
本文名称:用yml配置文件给bean绑定属性-创新互联
分享路径:http://ybzwz.com/article/ddisjg.html