当前位置：首页 > 科技 > 软件

非Controller控制层参数校验要怎么做

来源：责编：时间：2024-03-26 09:34:47 114观看

导读上篇文章中我们介绍了如何自定义Springboot参数约束注解和约束校验器，默认情况下，Springboot中的参数校验都是在Controller控制层完成的，那如果我们想要在非Controller控制层进行参数校验要怎么办呢？本文将介绍非Control

上篇文章中我们介绍了如何自定义Springboot参数约束注解和约束校验器，默认情况下，Springboot中的参数校验都是在Controller控制层完成的，那如果我们想要在非Controller控制层进行参数校验要怎么办呢？本文将介绍非Controller控制层参数校验的方法。

看源码

从上篇文章中我们知道Spring提供了JSR-303 的一个变种 @Validated ，下面我们看一下 @Validated 的部分源码。

图片

Validator

看注释官方是让我们去看看Validator#validate() 方法，官方让我看我们就去看呗，索性直接看Validator 源码：

public interface Validator { <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups); <T> Set<ConstraintViolation<T>> validateProperty(T object,              String propertyName,              Class<?>... groups); <T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType,              String propertyName,              Object value,              Class<?>... groups); BeanDescriptor getConstraintsForClass(Class<?> clazz); <T> T unwrap(Class<T> type); ExecutableValidator forExecutables();}

那Validator是做什么用的呢？

Validator 接口定义了用于执行验证的方法，用于验证对象的字段值是否符合指定的约束条件。它主要提供了以下几个核心方法：

<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups)：

该方法用于验证给定对象是否符合指定的约束条件。

参数 object是要验证的对象，参数 groups可选，表示验证组。

返回一个 Set 集合，其中包含违反约束条件的 ConstraintViolation 对象。

<T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, Class<?>... groups)：

该方法用于验证给定对象的特定属性是否符合指定的约束条件。
参数 object是要验证的对象，参数 propertyName是属性名，参数 groups可选，表示验证组。
返回一个 Set 集合，其中包含违反约束条件的 ConstraintViolation 对象。

<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups)：

该方法用于验证给定属性值是否符合指定的约束条件，而不需要实际创建对象实例。
参数 beanType是对象类型，参数 propertyName是属性名，参数 value是属性值，参数 groups可选，表示验证组。
返回一个 Set 集合，其中包含违反约束条件的 ConstraintViolation 对象。

这些方法能够对 Java 对象进行全面的验证，从整个对象级别到单个属性值的验证，都可以通过 Validator 接口提供的方法来实现。

实操

从上面的介绍我们可以看到，实际上参数校验是通过 Validator 接口的实现类来验证的。下面我们通过代码来看一下 Validator 接口怎么用？

先把我们的老演员拿出来，下面再校验就用它了。

@Datapublic class UserBean {    @NotBlank    private String username;    @Min(value = 18)    private Integer age;}

依赖Spring 容器

JSR 303 提供了 Validator 接口作为规范接口，用于实现数据校验功能。在实际应用中，我们并不需要自己从头开始实现这一接口，因为已经有官方参考实现——Hibernate Validator。Spring 框架作为广泛使用的Java开发框架，自然也遵循这一原则，它并没有重复造轮子，而是采用了 Hibernate Validator 的实现来支持校验功能。

因此，当我们使用 Spring 框架进行开发时，通常意味着我们可以直接利用 Spring 提供的集成，将 Validator 接口注入到我们的组件中，然后方便地使用它来进行数据校验。

下面来看下如何在Springboot中使用 Validator 接口。

@SpringBootTestclass SpringbootPracticeApplicationTests { @Resource    private Validator validator; @Test    public void testValidator(){        UserBean userBean = new UserBean();        userBean.setAge(17);        userBean.setUsername(null);        Set<ConstraintViolation<UserBean>> constraintViolations = validator.validate(userBean);        System.out.println("validate 校验对象属性：");        System.out.println(constraintViolations);        System.out.println();        constraintViolations = validator.validateProperty(userBean, "age");        System.out.println("validateProperty校验age属性是否合规：");        System.out.println(constraintViolations);        System.out.println();        constraintViolations = validator.validateValue(UserBean.class , "age", 14 );        System.out.println("validateValue校验age属性的值是否合规：");        System.out.println(constraintViolations);    }}

测试结果：

validate 校验对象属性：[ConstraintViolationImpl{interpolatedMessage='不能为空', propertyPath=username, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.NotBlank.message}'}, ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]validateProperty校验age属性是否合规：[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]validateValue校验age属性的值是否合规：[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

从打印结果中可以发现具体是哪些字段约束不通过、具体的提示信息都有。

不依赖Spring 容器

JSR 303 是一种规范，意味着它不依赖Spring 容器，能用Java的地方都可以用它，那如果我们在非Spring框架的项目中怎么使用它呢？

其实，最主要的是能获取到 Validator 接口的实现，然后就可以进行验证了。Validator 接口的实现可以通过如下代码获取，前提是要引入 Hibernate Validator 的依赖或者自己重新造轮子实现Validator 接口。

public class ValidationUtils {    public static Validator getValidator(){        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();        return factory.getValidator();    }}

/** * @author 公众号-索码理(suncodernote) */public class ValidatorTest {    public static void main(String[] args) {        Validator validator = ValidationUtils.getValidator();        UserBean userBean = new UserBean();        userBean.setAge(17);        userBean.setUsername(null);        Set<ConstraintViolation<UserBean>> constraintViolations = validator.validate(userBean);        System.out.println("validate 校验对象属性：");        System.out.println(constraintViolations);        System.out.println();        constraintViolations = validator.validateProperty(userBean, "age");        System.out.println("validateProperty校验age属性是否合规：");        System.out.println(constraintViolations);        System.out.println();        constraintViolations = validator.validateValue(UserBean.class , "age", 14 );        System.out.println("validateValue校验age属性的值是否合规：");        System.out.println(constraintViolations);    }}

打印结果：

23:57:10.700 [main] INFO org.hibernate.validator.internal.util.Version -- HV000001: Hibernate Validator 8.0.1.Finalvalidate 校验对象属性：[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}, ConstraintViolationImpl{interpolatedMessage='不能为空', propertyPath=username, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.NotBlank.message}'}]validateProperty校验age属性是否合规：[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]validateValue校验age属性的值是否合规：[ConstraintViolationImpl{interpolatedMessage='最小不能小于18', propertyPath=age, rootBeanClass=class site.suncodernote.validation.UserBean, messageTemplate='{jakarta.validation.constraints.Min.message}'}]

可以看到依赖Spring 容器和不依赖Spring 容器，两者的调用结果都是相同的，不同之处就在于 Validator 的获取，前者直接从 Spring 容器获取，后者需要通过工厂类获取，适用范围更广一点，在Spring框架中也能使用。

总结

本文介绍了在非Controller控制层参数校验的两种方法，不管是哪种获取方法只要能达到结果就行，不过建议使用后者，可以把后者封装成工具类，统一管理校验方法。

本文链接：//www.dmpip.com//www.dmpip.com/showinfo-26-79295-0.html非Controller控制层参数校验要怎么做

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。邮件：2376512515@qq.com

上一篇：现代WPF界面轻松实现：探秘轻量级WPFUI库，MVVM与依赖注入一体化

下一篇： Spring Boot整合Camunda打造高效工作流程

标签：

热门焦点

鸿蒙OS 4.0公测机型公布：甚至连nova6都支持

华为全新的HarmonyOS 4.0操作系统将于今天下午正式登场，官方在发布会之前也已经正式给出了可升级的机型产品，这意味着这些机型会率先支持升级享用。这次的HarmonyOS 4.0支持
Mate60手机壳曝光致敬自己的经典设计

8月3日消息，今天下午博主数码闲聊站带来了华为Mate60的第三方手机壳图，可以让我们在真机发布之前看看这款华为全新旗舰的大致轮廓。从曝光的图片看，Mate 60背后摄像头面积依然
小米降噪蓝牙耳机Necklace分享：听一首歌读懂一个故事

在今天下午的小米Civi 2新品发布会上，小米还带来了一款新的降噪蓝牙耳机Necklace，我们也在发布结束的第一时间给大家带来这款耳机的简单分享。现在大家能见到最多的蓝牙耳机
六大权益！华为8月服务日开启：手机免费贴膜、维修免人工费

8月5日消息，一年一度的华为开发者大会2023（Together）日前在松山湖拉开帷幕，与此同时，华为8月服务日也式开启，到店可享六大专属权益。华为用户可在华为商城Ap
自动化在DevOps中的力量：简化软件开发和交付

自动化在DevOps中扮演着重要角色，它提升了DevOps的效能。通过自动化工具和方法，DevOps团队可以实现以下目标：消除手动和重复性任务。简化流程。在整个软件开发生命周期中实现更
电视息屏休眠仍有网络上传爱奇艺被质疑“薅消费者羊毛”

记者丨宁晓敏见习生丨汗青出品丨鳌头财经（theSankei）前不久，爱奇艺发布了一份亮眼的一季报，不仅营收和会员营收创造历史最佳表现，其运营利润也连续6个月实现增长。自去年年初
自研Exynos回归！三星Galaxy S24系列将提供Exynos和骁龙双版本

年初，全新的三星Galaxy S23系列发布，包含Galaxy S23、Galaxy S23+和Galaxy S23 Ultra三个版本，全系搭载超频版骁龙8 Gen 2，虽同样采用台积电4nm工艺制
iQOO 11S屏幕细节公布：首发三星2K E6全感屏安卓最好的直屏手机

日前iQOO手机官方宣布，新一代电竞旗舰iQOO 11S将会在7月4日19:00正式与大家见面。随着发布时间的日益临近，官方关于该机的预热也更加密集，截至目前已
2021中国国际消费电子博览会与青岛国际软件融合创新博览会新闻发布会隆重举行

9月18日，2021中国国际消费电子博览会与青岛国际软件融合创新博览会新闻发布会在青岛国际新闻中心隆重举行。发布会上青岛市政府领导联袂出席，对本次双展会情