文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringBoot开发启动时配置校验的方法是什么

2023-06-25 11:14

关注

这篇文章主要介绍“SpringBoot开发启动时配置校验的方法是什么”,在日常操作中,相信很多人在SpringBoot开发启动时配置校验的方法是什么问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”SpringBoot开发启动时配置校验的方法是什么”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

概述

在项目开发过程中,某个功能需要依赖在配置文件中配置的参数。这时候就可能出现下面这种现象问题:

有时候经常出现项目启动了,等到使用某个功能组件的时候出现异常,提示参数未配置或者bean注入失败。

有没有一种方法在项目启动时就对参数进行校验而不是在实际使用的时候再抛出提示呢?

答案就是使用Spring提供的Java Validation功能,简单实用。

增加启动校验

只需要在我们创建的配置Properties类增加Validation相关配置即可

@Validated@Data@ConfigurationProperties(prefix = "app")@Componentpublic class AppConfigProperties {    @NotEmpty(message = "配置文件配置必须要配置[app.id]属性")    private String id;}

上面的配置就会校验我们在 application.yml中有没有配置 app.id参数。如果在配置文件中没有该配置,项目启动就会失败,并抛出校验异常。

在使用配置文件校验时,必须使用@configurationproperties注解,@value不支持该注解。

在需要使用app.id的时候注入配置类即可:

@Autowiredprivate AppConfigProperties appConfigProperties;

这样就可以实现我们想要的效果,如下图:

SpringBoot开发启动时配置校验的方法是什么 

效果

 校验类型

校验规则规则说明
@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验证注解的元素值是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")@Componentpublic class AppConfigProperties {//    @NotEmpty(message = "配置文件配置必须要配置[app.id]属性")    private String id;}

注入自定义校验规则

@Beanpublic  ConfigPropertiesValidator configurationPropertiesValidator(){  return new ConfigPropertiesValidator();}

注意:这里bean的方法名必须要 configurationPropertiesValidator,否则启动的时候不会执行该校验

修改app.id配置,观察启动情况

SpringBoot开发启动时配置校验的方法是什么

测试验证结果

错误信息即为我们自定义校验的结果。

到此,关于“SpringBoot开发启动时配置校验的方法是什么”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注编程网网站,小编会继续努力为大家带来更多实用的文章!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯