SpringBoot开发技巧启动时配置校验实现示例
概述
在项目开发过程中，某个功能需要依赖在配置文件中配置的参数。这时候就可能出现下面这种现象问题：
有时候经常出现项目启动了，等到使用某个功能组件的时候出现异常，提示参数未配置或者bean注入失败。
有没有一种方法在项目启动时就对参数进行校验而不是在实际使用的时候再抛出提示呢？
答案就是使用Spring提供的Java Validation功能，简单实用。
增加启动校验
只需要在我们创建的配置Properties类增加Validation相关配置即可
@Validated
@Data
@ConfigurationProperties(prefix = "app")
@Component
public class AppConfigProperties {
@NotEmpty(message = "配置文件配置必须要配置[app.id]属性")
private String id;
}
上面的配置就会校验我们在 application.yml中有没有配置 app.id参数。如果在配置文件中没有该配置，项目启动就会失败，并抛出校验异常。
在使用配置文件校验时，必须使用@configurationproperties注解，@value不支持该注解。
在需要使用app.id的时候注入配置类即可：
@Autowired private AppConfigProperties appConfigProperties;
这样就可以实现我们想要的效果，如下图：
效果
校验类型
| 校验规则 | 规则说明 |
|---|---|
| @Null | 限制只能为null |
| @NotNull | 限制必须不为null |
| @AssertFalse | 限制必须为false |
| @AssertTrue | 限制必须为true |
| @DecimalMax(value) | 限制必须为一个不大于指定值的数字 |
| @DecimalMin(value) | 限制必须为一个不小于指定值的数字 |
| @Digits(integer,fraction) | 限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction |
| @Future | 限制必须是一个将来的日期 |
| @Max(value) | 限制必须为一个不大于指定值的数字 |
| @Min(value) | 限制必须为一个不小于指定值的数字 |
| @Past | 验证注解的元素值（日期类型）比当前时间早 |
| @Pattern(value) | 限制必须符合指定的正则表达式 |
| @Size(max,min) | 限制字符长度必须在min到max之间 |
| @NotEmpty | 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0） |
| @NotBlank | 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格 |
| 验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式 |
Validation 支持如下几种校验，可以满足基本的业务逻辑，当然如果还是满足不了你的业务逻辑，可以选择定制校验规则。
定制校验逻辑
定义校验逻辑规则，实现 org.springframework.validation.Validator
public class ConfigPropertiesValidator implements Validator {
@Override
public boolean supports(Class<?> aClass) {
return AppConfigProperties.class.isAssignableFrom(aClass);
}
@Override
public void validate(Object o, Errors errors) {
AppConfigProperties config = (AppConfigProperties) o;
if(StringUtils.isEmpty(config.getId())){
errors.rejectValue("id", "app.id.empty", "[app.id] 属性必须要在配置文件配置");
}else if (config.getId().length() < 5) {
errors.rejectValue("id", "app.id.short", "[app.id] 属性的长度必须不能小于5");
}
}
}
使用自定义校验规则就不需要在使用原生的@NotEmpty了，将其删除
@Validated
@Data
@ConfigurationProperties(prefix = "app")
@Component
public class AppConfigProperties {
// @NotEmpty(message = "配置文件配置必须要配置[app.id]属性")
private String id;
}
注入自定义校验规则
@Bean
public ConfigPropertiesValidator configurationPropertiesValidator(){
return new ConfigPropertiesValidator();
}
注意：这里bean的方法名必须要 configurationPropertiesValidator，否则启动的时候不会执行该校验
修改app.id配置，观察启动情况
错误信息即为我们自定义校验的结果。
小结
通过配置Spring Boot启动校验功能，可以快速的识别参数配置的错误，避免在使用组件的时候才发现问题，可以减少排查问题的工作量，并且在我们封装自定义的starter时可以有更好的体验。
以上就是SpringBoot开发技巧启动时配置校验实现示例的详细内容，更多关于SpringBoot启动时配置校验的资料请关注脚本之家其它相关文章！
相关文章
模式匹配语法中，采用match关键字声明，每个分支采用case关键字进行声明，当需要匹配时，会从第一个case分支开始，如果匹配成功，那么执行对应的逻辑代码，如果匹配不成功，继续执行下一个分支进行判断2023-02-02
这篇文章主要介绍了Java e.printStackTrace()案例讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下2021-08-08
本文详细介绍了SpringCloudGateway的路由匹配规则,包括基本概念、常用属性、实际应用以及注意事项,路由匹配规则决定了请求如何被转发到目标服务,是Gateway的核心功能之一,在配置路由时需要注意顺序、性能和安全性2025-02-02
这篇文章主要介绍了Java变量与常量，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-04-04
这篇文章主要介绍了教你怎么用Java实现给图片打上水印,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下2021-04-04
这篇文章主要介绍了SpringBoot--Banner的定制和关闭操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2018-05-05
解决springboot3:mybatis-plus依赖错误:org.springframework.beans.fac
这篇文章主要介绍了解决springboot3:mybatis-plus依赖错误:org.springframework.beans.factory.UnsatisfiedDependencyException问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-07-07
在本篇文章里小编给大家整理的是一篇关于Java用POI导入导出Excel实例分析内容，有需要的朋友们可以跟着学习下。2021-11-11
这篇文章主要为大家详细介绍了java常用工具类中的数字工具类，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-05-05
这篇文章主要介绍了Spring boot应用启动后首次访问很慢的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-06-06
最新评论