Spring validation参数校验之自定义校验规则及编程式校验等进阶篇(1)

于 2024-04-08 12:55:23 发布
阅读量435 收藏 1
点赞数 7
分类专栏： 程序员 文章标签： spring java 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/2401_84010165/article/details/137504595
版权
本文介绍了Spring中如何实现自定义的参数校验规则，包括定义性别枚举、创建自定义校验注解、在Controller中启用数据校验，以及针对集合校验的自定义List实现和编程式校验的改进，以提供更清晰的错误提示。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1、定义性别枚举

1.1 BaseEnum.java

package com.jingai.validation.custom;

public interface BaseEnum {
    String getCode();
    String getDisplay();
}

1.2 GenderEnum.java

package com.jingai.validation.custom;

public enum GenderEnum implements BaseEnum {

    male("1", "男"),
    female("0", "女");

    private String code;
    private String display;

    private GenderEnum(String code, String display) {
        this.code = code;
        this.display = display;
    }

    @Override
    public String getCode() {
        return this.code;
    }

    @Override
    public String getDisplay() {
        return this.display;
    }
}

2 、自定义枚举类型的校验规则

package com.jingai.validation.custom;

import org.springframework.util.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * 验证给定的String值是否满足InEnum注解中的约束
 */
public class InEnumValidator implements ConstraintValidator<InEnum, String> {

    private Class<? extends BaseEnum> enumType;

    /**
     * 初始化方法可以获得该校验器对应的注解，从而获取注解中的信息。在校验方法调用前会调用
     */
    @Override
    public void initialize(InEnum constraintAnnotation) {
        enumType = constraintAnnotation.enumType();
    }

    /**
     * 校验。成功返回true，失败返回false
     */
    @Override
    public boolean isValid(String str, ConstraintValidatorContext constraintValidatorContext) {
        if(!StringUtils.hasText(str)) {
            return true;
        }
        if(enumType == null || !enumType.isEnum()) {
            return false;
        }
        for (BaseEnum e :enumType.getEnumConstants()){
            if(e.getCode().equals(str)) {
                return true;
            }
        }
        return false;
    }
}

3、自定义校验规则注解

package com.jingai.validation.custom;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解，判断是否值在指定的枚举中
 */
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
// 标记由哪个类来执行校验逻辑，该类需要实现ConstraintValidator接口
@Constraint(validatedBy = InEnumValidator.class)
public @interface InEnum {
    /**
     * 枚举类型
     */
    Class<? extends BaseEnum> enumType();

    String message() default "值不在枚举类型中";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

4、在参数中添加自定义的@InEnum注解。

package com.jingai.validation.vo;

import com.jingai.validation.custom.GenderEnum;
import com.jingai.validation.custom.InEnum;
import com.jingai.validation.groups.UserValidatedGroup;
import lombok.Data;

import javax.validation.constraints.*;

@Data
public class UserVo {

    @NotNull(message = "用户id不能为null", groups = {UserValidatedGroup.Query.class, UserValidatedGroup.Update.class})
    @Min(value = 1, message = "用户id无效")
    private Integer id;

    @NotBlank(message = "用户名称不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private String name;

    @NotBlank(message = "性别不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @InEnum(enumType = GenderEnum.class, message = "性别不在枚举范围中", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private String gender;

    @NotNull(message = "年龄不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Min(value = 18, message = "年龄必须大于18岁", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Max(value = 200, message = "年龄必须小于200岁", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private Integer age;

    @NotBlank(message = "手机号码不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Pattern(regexp = "^(13[0-9]|14[579]|15[012356789]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手机号码格式错误")
    private String phone;
}

5、在Controller的方法中，开启数据校验功能。

package com.jingai.validation.controller;

import com.jingai.validation.custom.RequestListValidated;
import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.service.UserService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.UserVo;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @Resource
    private UserService userService;

    @RequestMapping("adduser")
    public Map<String, Object> add(@RequestBody @Validated(value = UserValidatedGroup.Create.class) UserVo user) {
        // 省略其他代码
        return ResponseUtil.success();
    }

}

访问adduser，效果如下：

集合校验

在某些场景下，需要使用集合接收前端传递的参数，并对集合中的每个对象都进行参数校验。但如果只是用List接收并不会进行校验。针对这种场景，可以自定义一个List，代码如下：

1、自定义一个List

package com.jingai.validation.custom;

import lombok.experimental.Delegate;

import javax.validation.Valid;
import java.util.ArrayList;
import java.util.List;

public class ValidList<T> implements List<T> {

    @Delegate
    @Valid
    public List<T> list = new ArrayList<>();

}

@Delegate为Lombok的注解，简单理解就是该类拥有该属性的所有方法，这样类实现了List接口，便无需重写接口的方法。当调用该类的方法时，实际执行的是该属性的对应方法。

2、在Controller中使用自定义的集合接收数据

    @RequestMapping("addusers")
    public Map<String, Object> addUsers(@RequestBody @Validated(value = UserValidatedGroup.Create.class) ValidList<UserVo> list) {
        int rs = userService.saveBatch(list);
        return ResponseUtil.success(rs);
    }

访问接口后，效果如下：

校验失败时，抛NotReadablePropertyException异常，而在该异常中，没有明细信息，无法有效的进行提示。为了更清晰的提示，可以通过编程式校验进行改进。

编程式校验

Spring-validation除了支持注解方式校验以外，还支持编程式注解。以上面集合校验为例：

package com.jingai.validation.controller;

import com.jingai.validation.custom.RequestListValidated;
import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.service.UserService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.UserVo;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

@RestController
public class UserController {

    @Resource
    private Validator validator;

    @RequestMapping("addusers2")
    public Map<String, Object> addUsers2(@RequestBody List<UserVo> list) {
**自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。**

**深知大多数Python工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！**

**因此收集整理了一份《2024年Python开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**

![img](https://img-blog.csdnimg.cn/img_convert/4a6e10054349ef539137174d3acad153.png)

 

![img](https://img-blog.csdnimg.cn/img_convert/d65d91e1a7c78fcd2dc29c4ab41910e3.png)

![img](https://img-blog.csdnimg.cn/img_convert/46506ae54be168b93cf63939786134ca.png)

![img](https://img-blog.csdnimg.cn/img_convert/252731a671c1fb70aad5355a2c5eeff0.png)

![img](https://img-blog.csdnimg.cn/img_convert/6c361282296f86381401c05e862fe4e9.png)

![img](https://img-blog.csdnimg.cn/img_convert/9f49b566129f47b8a67243c1008edf79.png)

 

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！**

**由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新**

**如果你觉得这些内容对你有帮助，可以扫码获取！！！（备注Python）**

img.cn/img_convert/6c361282296f86381401c05e862fe4e9.png)

![img](https://img-blog.csdnimg.cn/img_convert/9f49b566129f47b8a67243c1008edf79.png)

 

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！**

**由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新**

**如果你觉得这些内容对你有帮助，可以扫码获取！！！（备注Python）**

<img src="https://img-community.csdnimg.cn/images/fd6ebf0d450a4dbea7428752dc7ffd34.jpg" alt="img" style="zoom:50%;" />
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值