SpringBoot整合JSR-303表单校验

最新推荐文章于 2024-10-03 07:15:00 发布
最新推荐文章于 2024-10-03 07:15:00 发布
阅读量1.3k 收藏 8
点赞数 1
分类专栏： SpringBoot整合 文章标签： spring boot java 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44981526/article/details/128057393
版权

JSR-303表单校验

思考一个问题，引出JSR-303

为什么前端做了参数校验，后端还要进行参数校验？

普通用户通过页面操作，前端可以校验住参数的正确性。但如果有人获取到接口，利用接口调用工具比如：postman对后端接口直接发起请求，这样就可以绕过前端校验，此时如果后端不做参数校验就不能保证数据规则。而JSR-303验证框架提供了丰富的参数校验注解来支持后端的表单校验。

image-20221126193348025

1.概述

● 概述

  1. 对输入的数据(比如表单数据)，进行必要的验证，并给出相应的提示信息。
  2. 对于验证表单数据，springMVC 提供了很多实用的注解, 这些注解由 JSR 303 验证框架提供

● JSR 303 验证框架

1.JSR 303 是 Java 为 Bean 数据合法性校验提供的标准框架，它已经包含在 JavaEE 中

  1. JSR 303 通过在 Bean 属性上标注类似于 @NotNull、@Max 等标准的注解指定校验规则， 并通过标准的验证接口对 Bean 进行验证

  2. JSR 303 提供的基本验证注解有:

    空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false

长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.

日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。

数值检查
建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内
@Range(min=10000,max=50000,message=”range.bean.wage”)
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
//验证URL是否正确
@URL(protocol=,host=, port=,regexp=, flags=)

● Hibernate Validator 扩展注解

  1. Hibernate Validator 和 Hibernate 没有关系，只是 JSR 303 实现的一个扩展.

  2. Hibernate Validator 是 JSR 303 的一个参考实现，除支持所有标准的校验注解外，它还支 持以下的扩展注解:

  3. 扩展注解有如下

image-20220618170242629

2.应用实例

1.基础校验

准备工作

1.创建SpringBoot项目

2.引入依赖，以SpringBoot为例，spring-boot-starter-web依赖中包含了校验框架。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

image-20221126185410911

代码实现

1.controller层代码，使用@Validated开启校验

@RestController
@RequestMapping("commodity/brand")
public class BrandController {
    @Autowired
    private BrandService brandService;

    /**
     * 信息
     */
    @RequestMapping("/info/{id}")
    public R info(@PathVariable("id") Long id) {
        BrandEntity brand = brandService.getById(id);
        return R.ok().put("brand", brand);
    }

    /**
     * 保存
     * @Validated({SaveGroup.class})
     * 指定分组校验之后，@Validated修饰的类，每个字段必须指定组否则校验不会生效
     */
    @RequestMapping("/save")
    public R save(@Validated @RequestBody BrandEntity brand) {
        brandService.save(brand);
        return R.ok();
    }

    /**
     * 修改
     */
    @RequestMapping("/update")
    public R update(@Validated @RequestBody BrandEntity brand) {
        brandService.updateById(brand);
        return R.ok();
    }

}

说明：开启校验需要在方法入参使用@Validated修饰

@Valid与@Validated区别：https://blog.csdn.net/qq_33274797/article/details/109060226

2.在@Validated修饰的类上，不同类型字段上添加对应的验证注解

@Data
@TableName("commodity_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    @TableId
    @Null(message = "添加不能指定id")
    private Long id;

    @NotBlank(message = "品牌名不能为空")
    private String name;
    /**
     * logo
     */
    @NotBlank(message = "logo不能为空")
    @URL(message = "logo不是一个合法的URL")
    private String logo;
    /**
     * 说明
     */
    private String description;
    /**
     * 显示
     */
    @NotNull(message = "显示状态不能为空")
    private Integer isshow;
    /**
     * 检索首字母
     */
    @NotBlank(message = "检索首字母不能为空")
    @Pattern(regexp = "^[a-zA-Z]$", message = "检索字母必须是一个字母")
    private String firstLetter;
    /**
     * 排序
     */
    @NotNull(message = "排序值不能为空")
    @Min(value = 0, message = "排序值要求大于等于 0")
    private Integer sort;

}

测试

image-20221126194246610

2.分组校验

为了满足新增、修改不同的参数校验，JSR-303校验框架还支持分组校验。这里以新增、修改为例

1.创建新增、修改分组校验标识接口

/**
 * 没有什么具体代码，就在做一个分组的标识
 * 表示新增组的校验标识
 */
public interface SaveGroup {


}
//用于修改组的校验标识
public interface UpdateGroup {


}

2.在controller层代码中修改@Validated注解，使用@Validated({分组类名.class})来进行分组校验

/**
 * 保存
 * @Validated({SaveGroup.class})
 * 指定分组校验之后，@Validated修饰的类，每个字段必须指定组否则校验不会生效
 */
@RequestMapping("/save")
public R save(@Validated({SaveGroup.class}) @RequestBody BrandEntity brand) {
    brandService.save(brand);
    return R.ok();
}

/**
 * 修改
 */
@RequestMapping("/update")
public R update(@Validated({UpdateGroup.class}) @RequestBody BrandEntity brand) {
    brandService.updateById(brand);
    return R.ok();
}

注意：@Validated注解指定分组校验之后，@Validated修饰的类，每个字段必须指定组否则校验不会生效

3.在@Validated修饰的类上，不同类型字段上添加对应的验证注解并标识不同的分组

@Data
@TableName("commodity_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * id
     * 1. @NotNull(message = "修改要求指定id",groups = {UpdateGroup.class})
     * 表示@NotNull 在UpdateGroup校验组生效
     * <p>
     * 2. @Null(message = "添加不能指定id",groups = {SaveGroup.class})
     * 表示@Null 在SaveGroup校验组生效
     */
    @TableId
    @NotNull(message = "修改要求id不能为空",groups ={UpdateGroup.class})
    @Null(message = "添加不能指定id",groups = {SaveGroup.class})
    private Long id;

    /**
     * 品牌名
     * 说明
     * 1. @NotBlank 表示name必须包括一个非空字符
     * 2. message = "品牌名不能为空" 是老师指定的一个校验消息
     * 3. 如果没有指定 message = "品牌名不能为空" ,就会返回默认的校验消息  key = javax.validation.constraints.NotBlank.message
     * 4. 这个默认的消息是在  ValidationMessages_zh_CN.properties 文件配置 javax.validation.constraints.NotBlank.message        = \u4e0d\u80fd\u4e3a\u7a7a
     * 5. @NotBlank 可以用于  CharSequence
     * 6. groups = {SaveGroup.class, UpdateGroup.class}
     * 就是@NotBlank 在 SaveGroup 和 UpdateGroup都生效
     */
    @NotBlank(message = "品牌名不能为空", groups = {SaveGroup.class, UpdateGroup.class})
    private String name;
    /**
     * logo
     */
    @NotBlank(message = "logo不能为空",groups = {SaveGroup.class, UpdateGroup.class})
    @URL(message = "logo不是一个合法的URL",groups = {SaveGroup.class, UpdateGroup.class})
    private String logo;
    /**
     * 说明
     */
    private String description;
    /**
     * 显示
     */
    @NotNull(message = "显示状态不能为空",groups = {SaveGroup.class, UpdateGroup.class})
    private Integer isshow;
    /**
     * 检索首字母
     */
    @NotBlank(message = "检索首字母不能为空",groups = {SaveGroup.class, UpdateGroup.class})
    @Pattern(regexp = "^[a-zA-Z]$", message = "检索字母必须是一个字母",groups = {SaveGroup.class, UpdateGroup.class})
    private String firstLetter;
    /**
     * 排序
     */
    @NotNull(message = "排序值不能为空",groups = {SaveGroup.class, UpdateGroup.class})
    @Min(value = 0, message = "排序值要求大于等于 0",groups = {SaveGroup.class, UpdateGroup.class})
    private Integer sort;

}

说明，上面的代码表示添加时不需要填写id,修改时需要填写id； 其他参数修改、新增都做相同校验

4.测试

新增时，指定id。提示添加时不能指定id

image-20221126195527698

而修改时，指定id时可以的

image-20221126195600517

3.自定义校验

引出自定义校验的必要性，为什么要使用自定义校验？

@NotNull(message = "显示状态不能为空",groups = {SaveGroup.class, UpdateGroup.class})
private Integer isshow;

image-20221126195916213

如上所示，针对是否显示做校验，比如我们想让1-表示显示，0-表示不显示。即isshow的值只能为0或者1。

当然前面提到的@Pattern注解可以实现这个功能，但@Pattern只能修饰字符串类型的字段。修饰其他字段则会抛出异常。因此如下代码是不成立的。

@NotNull(message = "显示状态不能为空",groups = {SaveGroup.class, UpdateGroup.class})
@Pattern(regexp = "^[0-1]$", message = "显示状态的值为0或1",groups = {SaveGroup.class, UpdateGroup.class})
private Integer isshow;
1.创建自定义校验注解
/**
 * 1. EnumConstraintValidator是真正的校验器,即校验的逻辑是写在这里的
 * 2. EnumConstraintValidator需要实现接口 ConstraintValidator
 * 3. <EnumValidate,Integer> 表示该校验器是针对 @EnumValidate 传入的Integer类型数据进行校验
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EnumConstraintValidator.class})
public @interface EnumValidate {

    /**
     * 指定错误信息描述所在类的所在字段
     * @return
     */
    String message() default "{com.llp.common.valid.EnumValidate.message}";

    /**
     * 指定分组
     * @return
     */
    Class<?>[] groups() default { };

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

    //增加values属性
    int[] values() default {};

    //增加regexp
    String regexp() default "";
}
2.自定义校验器

这里正则校验和数组元素校验存在重复，仅作为示例

/**
 * 自定义校验器
 */
public class EnumConstraintValidator implements ConstraintValidator<EnumValidate, Integer> {

    Set<Integer> set = new HashSet<>();
    private String regexp = "";

    /**
     * 初始化验证器，为isValid(Object, ConstraintValidatorContext)调用做准备。传递给定约束声明的约束注释。
     * 保证在使用此实例进行验证之前调用此方法。 默认的实现是无操作的
     *
     * @param constraintAnnotation 自定义注解
     */
    @Override
    public void initialize(EnumValidate constraintAnnotation) {
        int[] values = constraintAnnotation.values();
        for (int value : values) {
            set.add(value);
        }
        regexp = constraintAnnotation.regexp();
    }

    /**
     * 如果返回true表示验证成功-通过
     * 返回false，表示验证失败-没有通过
     *
     * @param value
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        boolean contains = set.contains(value);
        if (!contains) {
            return false;
        }
        if (!value.toString().matches(regexp)) {
            return false;
        }
        return true;
    }
}
3.自定义错误提示信息

在类路径resource目录下创建ValidationMessages.properties文件，“显示状态的值需要是0或者1”中文部分需转换为unicode码。

com.llp.common.valid.EnumValidate.message=显示状态的值需要是0或者1
4.在表单校验的类中添加自定义校验注解
@NotNull(message = "显示状态不能为空", groups = {SaveGroup.class, UpdateGroup.class})
@EnumValidate(values = {0, 1}, message = "显示只必须为1或者0", regexp = "^[0-1]$", groups = {SaveGroup.class, UpdateGroup.class})
private Integer isshow;
5.测试

可以看到针对isshow的校验信息，显示只必须为1或者0

image-20221126211241942

3.注意事项和使用细节

  1. 一个自定义校验注解，可以由多个校验器来组合校验 ，如下

    /**
 * 1. EnumConstraintValidator是真正的校验器,即校验的逻辑是写在这里的
 * 2. EnumConstraintValidator需要实现接口 ConstraintValidator
 * 3. <EnumValidate,Integer> 表示该校验器是针对 @EnumValidate 传入的Integer类型数据进行校验
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EnumConstraintValidator.class})
public @interface EnumValidate {

    /**
     * 指定错误信息描述所在类的所在字段
     * @return
     */
    String message() default "{com.llp.common.valid.EnumValidate.message}";

    /**
     * 指定分组
     * @return
     */
    Class<?>[] groups() default { };

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

    //增加values属性
    int[] values() default {};

    //增加regexp
    String regexp() default "";
}

  2. 注意, validatedBy = {EnumConstraintValidator.class} 是可以带校验器类型数组的.

llp1110
关注
专栏目录
springboot整合JSR303参数校验与全局异常处理
jcc4261的博客
02-03 381
我们在日常开发中，避不开的就是参数校验，有人说前端不是会在表单中进行校验的吗？在后端中，我们可以直接不管前端怎么样判断过滤，我们后端都需要进行再次判断，为了安全。因为前端很容易拜托，当测试使用PostMan来测试，如果后端没有校验，不就乱了吗？肯定会有很多异常的。今天小编和大家一起学习一下JSR303专门用于参数校验的，算是一个工具吧！JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。
SpringBoot的参数校验器-Validator
mutf7的博客
07-22 2077
SpringBoot的参数校验器-Validator 1、分析 在日常的开发中，服务端对象的校验是非常重要的一个环节， 比如注册的时候：校验用户名，密码，身份证，邮箱等信息是否为空，以及格式是否正确， 但是这种在日常的开发中进行校验太繁琐了，代码繁琐而且很多。 Validator框架应运而生，它的出现就是为了减少开发人员在开发时的代码，提升开发效率。它有专门用来做接口的参数校验，比如：密码长度、是否为空等。 Spring的validator校验框架遵守的是JSR-303的验证规范（参数校验规范），JSP全称
springboot JSR303参数校验 全局异常处理
01-07
Springboot全局异常处理、JSR303参数校验，具体详见: https://blog.csdn.net/herojuice/article/details/85788681
Spring Boot 中使用 JSR-303 数据校验
Java徐师兄的博客
06-21 1063
JSR-303 是 Java 中的一个数据校验规范。它定义了一组注解，可以用于对 Java 对象中的属性进行校验。在 Spring Boot 中，我们可以使用 JSR-303 数据校验规范来校验表单数据的合法性。在本文中，我们介绍了在 Spring Boot 中使用 JSR-303 数据校验的方法，并提供了示例代码来演示它的用法。使用数据校验可以帮助我们提高 Web 应用程序的安全性和可靠性，减少不必要的错误和漏洞。
【SpringBoot】基础+JSR303数据校验
最新发布
weixin_71491685的博客
10-03 981
它的设计是为了使您能够尽可能快地启动和运行。它使用 “
springboot学习笔记（六）--整合JSR303数据校验
qq_46112274的博客
04-26 218
1、引入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 2、编写代码 Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的em
Spring Boot使用JSR303校验
qq_33594592的博客
10-11 1127
Hibernate Validator JSR-303 JSR-349
springboot整合JSR303校验
weixin_60257072的博客
01-14 804
此时就用到了分组校验，同一个属性定义多个校验规则属于不同的分组，比如：添加订单定义@NULL规则属于insert分组，更新订单定义@NotEmpty规则属于update分组，insert和update是分组的名称，是可以修改的。我们用class类型来表示不同的分组，所以我们定义不同的接口类型（空接口）表示不同的分组，由于校验分组是公用的，所以定义在 base工程中。Contoller中校验请求参数的合法性，包括：必填项校验，数据格式校验，比如：是否是符合一定的日期格式，等。
SpringBoot集成SpringSecurity5和OAuth2 — 3、基于数据库的OAuth2认证服务器_springboot oauth 客户端模式使用数据库
2401_84263208的博客
04-18 359
/允许客户端使用表单方式发送请求token的认证（因为表单一般是POST请求，所以使用POST方式发送获取token，但必须携带clientId，clientSecret，否则随便一请求过来验token是不验的）//默认允许获取token，但是需要授权后才能获取到 ，所以可以去掉 tokenKeyAccess()//如果保存在中间件（数据库、Redis），那么资源服务器与认证服务器可以不在同一个工程中。//“oauth/check_token"是校验token的地址。alibaba 数据连接池。
springboot整合springsecurity实现登入登出(附源码)
华夏天骄
09-13 2676
综合概述 Spring Security 是 Spring 社区的一个顶级项目，也是 Spring Boot 官方推荐使用的安全框架。除了常规的认证（Authentication）和授权（Authorization）之外，Spring Security还提供了诸如ACLs，LDAP，JAAS，CAS等高级特性以满足复杂场景下的安全需求。另外，就目前而言，Spring Security和Shiro也是当前广大应用使用比较广泛的两个安全框架。 Spring Security 应用级别的安全主要包含两个主要部分，
SpringBoot:快速使用Spring
lm12032015的博客
08-03 3054
SpringBoot,Shiro,Swagger,Dubbo等微服务技术讲解
springboot：JSR303数据校验
adsdaas的博客
03-22 459
如何使用     Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的name只能支持Email格式； @Component //注册bean @ConfigurationProperties(prefix = "person") @Validated //数据校验 pu...
Springboot——JSR303校验
weixin_61974247的博客
03-10 585
JSR 303校验是Java平台上的一种校验规范，用于在应用程序中执行数据验证。它定义了一组注解，开发人员可以将这些注解应用到Java Bean的属性上，从而指定这些属性的验证规则。这些规则包括数据格式、范围、必填性等。在运行时，可以使用校验引擎来执行这些校验规则。这有助于确保应用程序接收到有效的数据
SpringBoot-JSR303数据校验
yooppa的博客
07-04 177
springBoot 配置文件
Spring Boot整合JSR303校验
fly狮子座的博客
04-16 512
JSR303校验 一、背景 二、常用注解 注解 说明 @Null 被注释的元素必须为null @NotNull 被注释的元素不能为null @AssertTrue 被注释的元素必须为true @AssertFalse 被注释的元素必须为false @Min(value) 被注释的元素必须是一个数字，其值必须>=指定的最小值 @Max(value) 被注释的元素必须是一个数字，其值必须<=指定的最大值 @DecimalMin(value) 被注释的元素必须是
JSR 303 校验
weixin_43717148的博客
05-13 174
JSR 303 校验 Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。 @NotNull(message="名字不能为空") private String userName; @Max(value=120,message="年龄最大不能查过120") private int age; @Email(message="邮箱格式错误") private String email; 空检查 @Null 验证对象是否为null @NotN
springboot使用JSR303校验
qq_41399941的博客
07-29 334
springboot 结合JSR303校验
Spring Boot 使用 JSR303（@Validated） 实现参数校验
Mazhen5255的博客
08-23 1026
ListValueConstraintValidator定义了两个泛型参数, 第一个是这个校验器所服务到标注类型(在我们的例子中即ListValue), 第二个这个校验器所支持到被校验元素的类型 (即Integer)。这个验证器的实现就很平常了, initialize() 方法传进来一个所要验证的标注类型的实例, 在本例中, 我们通过此实例来获取其vals属性的值,并将其保存为Set集合中供下一步使用。新增和修改对于实体的校验规则是不同的，例如id是自增的时，新增时id要为空，修改则必须不为空；
springboot整合jsr303数据校验
weixin_48895167的博客
04-29 1115
学习目标： jsr303数据校验，为什么要学习这个技术呢，个人看法，唯一确保某些数据的合法性，比如在添加一个用户的时候用户的名称和密码肯定不能为空吧，即使在前端做了非空验证也不能保证用户会不会通过其他手段绕开前端的验证往数据库添加非法数据，所以在后台也需要做数据校验，双重保障。 开始实现： 第一步：导入依赖 <!--jsr303数据校验--> <dependency> <groupId>org.springframework.boot</g
SpringBoot配置与JSR-303数据校验解析
"关于Springboot的学习笔记，涵盖了基础概念、YAML与.properties配置文件的用法、松散绑定以及JSR-303数据校验等内容。" Spring Boot 是一个用于简化Spring应用程序初始搭建以及开发过程的框架。它集成了大量常用的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值