SpringBoot常用注解@ConfigurationProperties、松散绑定、数据校验

@ConfigurationProperties
源码分析

@ConfigurationProperties主要作用就是将prefix属性指定的前缀配置项的值绑定到这个JavaBean上 ，通过指定的前缀，来绑定配置文件中的配置，通过如下源码可以看出， 如果你想绑定和验证一些外部属性，可以将它添加到类定义或@Configuration类中的@Bean方法上。

标注在类上@Data //使用该注解需要导入Lombok依赖
@Component
@ConfigurationProperties(prefix = "userinfo")
public class UserInfo {

private String userId;
private String name;
}


application.yml文件配置内容

userInfo:
userId: 1001
name: lucy


接下来通过控制器方法来返回这个对象，查看数据是否绑定

@RestController
public class HelloController {

@Autowired
private UserInfo userInfo;

@GetMapping("/user")
public UserInfo getUserInfo(){
return userInfo;
}
}


标注在方法上

上面源码中说到可以将它添加到@Configuration类中的@Bean方法上，所以下面来看看标注在方法上是如何使用的！

比如我们用到druid数据源的操作，这个数据源是属于第三方的，所以我们不能操作源码，不能再源码里面找到它的对象来给他添加注解，但我们可以在yml文件中给他配置，来拿到它的属性。

首先添加所需的依赖


com.alibabagroupId>
druid-spring-boot-starterartifactId>
1.2.11version>
dependency>
mysqlgroupId>
mysql-connector-javaartifactId>
dependency>


接着在yml文件中配置数据源

spring:
datasource:
druid:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/test?serverTimezone=UTC
username: root
password: root


创建一个配置类，然后在类方法上添加注解，并通过prefix绑定数据

@SpringBootConfiguration
public class DatasourceConfig {

@Bean
@ConfigurationProperties(prefix = "spring.database.druid")
public DataSource database(){
return new DruidDataSource();
}
}


通过控制器方法来检验绑定效果

@RestController
public class HelloController {

@Autowired
private DataSource dataSource;

@GetMapping("/datasource")
public void getDataSource(){
System.out.println(dataSource);
}

}


访问http://localhost/datasource，查看控制台输出！！！

松散绑定

我们在使用@ConfigurationProperties注解的时候，@ConfigurationProperties(prefix = “userinfo”)，这里给prefix的属性值与yml文件中的属性名称不一致，但是依旧绑定成功了！原因是什么呢？

这就需要提到Spring的松散绑定属性规则。因此使用以下方式书写都能与类的属性名称匹配。

userInfo:
userId: 1001 # 驼峰命名方式
#user_id: 1002 #下划线方式
#user-id: 1003 #烤肉串方式
#USER_ID: 1004 # 常量方式
name: lucycd


需要注意的是，prefix的属性值必须全部为小写，就像下图所示，就会报错：前缀必须是规范形式。

运行程序，也会在控制台提示你：配置属性名称“userInfo”无效；无效字符：“I”

数据校验

Spring Boot中有很多配置文件，配置文件中我们可以自定义一些对应的属性值。那么这些属性值是否合法呢？我们如何来校验？在Java中有一种JSR303规范，我们可以针对一些对应的数值来进行校验。按照规范来进行书写，如果不符合要求就说明校验失败，反之，则成功！

SpringBoot也给出了强大的数据校验功能，可以有效的避免此类问题的发生。在JAVA EE的JSR303规范中给出了具体的数据校验标准，开发者可以根据自己的需要选择对应的校验框架，此处使用Hibernate提供的校验框架来作为实现进行数据校验。

导入验证包和校验实现包。另外推荐公众号Java精选，回复java面试，获取面试资料，支持在线随时随地手提。


javax.validationgroupId>
validation-apiartifactId>
dependency>
org.hibernate.validatorgroupId>
hibernate-validatorartifactId>
dependency>


添加注解@Validated

给属性添加验证规则

@Data
@Component
@ConfigurationProperties(prefix = "userinfo")
@Validated
public class UserInfo {

@Max(value = 1000,message = "userid超出范围了！")
@Min(value = 0,message = "userid不能小于0！")
private String userId;

@Size(min = 2,max = 5,message = "name长度应该在2-5之间")
private String name;
}


这里我们先输入不符合规范的数据，来验证数据是否能够校验成功

userInfo:
userId: 1001
name: lucycd


编写一个控制器方法来检验

@RestController
public class HelloController {

@Autowired
private UserInfo userInfo;

@GetMapping("/user")
public UserInfo getUserInfo(){
return userInfo;
}

}


运行程序，查看控制台，校验成功！！！

同样，将数据修改为符合规则的数据，程序就可以成功运行了！！！

当然，这里的校验规则还有许多，@NotNull、@NotEmpty、@Email等等，可以根据实际情况选择合适的注解。Java进阶路线：https://www.yoodb.com/

作者：Binaire-沐辰 https://blog.csdn.net/weixin_52986315

公众号“Java精选”所发表内容注明来源的，版权归原出处所有（无法查证版权的或者未注明出处的均来自网络，系转载，转载的目的在于传递更多信息，版权属于原作者。如有侵权，请联系，笔者会第一时间删除处理！

最近有很多人问，有没有读者交流群！加入方式很简单，公众号Java精选，回复“加群”，即可入群！

（微信小程序）：3000+道面试题，包含Java基础、并发、JVM、线程、MQ系列、Redis、Spring系列、Elasticsearch、Docker、K8s、Flink、Spark、架构设计等，在线随时刷题！

特别推荐：专注分享最前沿的技术与资讯，为弯道超车做好准备及各种开源项目与高效率软件的公众号，「大咖笔记」，专注挖掘好东西，非常值得大家关注。点击下方公众号卡片关注。

文章有帮助的话，点在看，转发吧！