记录一下 JSR303的学习，主要包括简单校验，分组校验，自定义校验

最新推荐文章于 2022-08-14 11:33:40 发布
最新推荐文章于 2022-08-14 11:33:40 发布
阅读量188 收藏
点赞数
分类专栏： 服务端校验 springboot java 文章标签： jsr
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tanlongkui/article/details/107779404
版权

其实JSR303没啥介绍的，大家知道是做校验的就可以了。简书里面是这样说的：SR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation，Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。

一切尽在代码中：

快捷创建一个springboot项目

1，pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.dwsoft.test</groupId>
    <artifactId>test-jsr303</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>test-jsr303</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>11</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpcore</artifactId>
            <version>4.4.13</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

我用的springboot版本是:<version>2.1.8.RELEASE</version>,如果使用其他版本也可以，但是一定要确保引入了校验包：

 2，创建主类，实体类，控制器

   主类：

@SpringBootApplication
public class TestJsr303Application {

    public static void main(String[] args) {
        SpringApplication.run(TestJsr303Application.class, args);
    }

}

控制类：

/**
 * @author tlk
 * @date 2020/8/4-18:36
 */
@RestController
public class TestController {
    
}

实体类：

package com.dwsoft.test.testjsr303.entity;

import lombok.Data;
import java.io.Serializable;

/**
 * @author tlk
 * @date 2020/8/4
 */
@Data
public class Brand implements Serializable {
    private static final long serialVersionUID = 6249214818970952452L;
    /**
     * 品牌id
     */
    private Long brandId;
    /**
     * 品牌名
     */
    private String name;
    /**
     * 品牌logo地址
     */
    private String logo;
    /**
     * 介绍
     */
    private String descript;
    /**
     * 显示状态[0-不显示；1-显示]
     */
    private Integer showStatus;
    /**
     * 检索首字母
     */
    private String firstLetter;
    /**
     * 排序
     */
    private Integer sort;

}

 用的是注解@Data,需要安装插件lombok;你也可以不用这个注解，直接写get,set等方法。

统一格式响应封装类：

package com.dwsoft.test.testjsr303.utils;


import org.apache.http.HttpStatus;

import java.util.HashMap;
import java.util.Map;

/**
 * 返回数据
 *
 * @author tlk 
 */
public class R extends HashMap<String, Object> {
    private static final long serialVersionUID = 1L;

    public R() {
        put("code", 0);
        put("msg", "success");
    }

    public static R error() {
        return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "未知异常，请联系管理员");
    }

    public static R error(String msg) {
        return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
    }

    public static R error(int code, String msg) {
        R r = new R();
        r.put("code", code);
        r.put("msg", msg);
        return r;
    }

    public static R ok(String msg) {
        R r = new R();
        r.put("msg", msg);
        return r;
    }

    public static R ok(Map<String, Object> map) {
        R r = new R();
        r.putAll(map);
        return r;
    }

    public static R ok() {
        return new R();
    }

    public R put(String key, Object value) {
        super.put(key, value);
        return this;
    }
}

开始校验：

1》简简单单的校验

给bean添加校验注解：

开启校验功能@Valid

用postman测试（入参给的是一个空的json串）：

这是原始相应，我们可以封装统一格式，并且自定义message

改动如下：

 控制器中引入 BindingResult

package com.dwsoft.test.testjsr303.controller;

import com.dwsoft.test.testjsr303.entity.Brand;
import com.dwsoft.test.testjsr303.utils.R;
import org.apache.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author tlk
 * @date 2020/8/4
 */
@RestController
public class TestController {
    @RequestMapping("/test/jsr303")
    public R testJsr303(@Valid @RequestBody Brand brand, BindingResult bindingResult) {
        if(bindingResult.hasErrors()){
            Map<String,String>map=new HashMap<>();
            List<FieldError> fieldErrors = bindingResult.getFieldErrors();
            fieldErrors.forEach((item) ->{
                String field = item.getField();
                String defaultMessage = item.getDefaultMessage();
                map.put(field,defaultMessage);
            });
            return R.error(HttpStatus.SC_BAD_REQUEST,"入参不合法").put("data",map);
        }
        //业务处理
        return R.ok();
    }
}

 再次测试：

 完美！

2》分组校验主要用于表单的添加或者修改进行区分

添加两个接口：

package com.dwsoft.test.testjsr303.valid;

/**
 * @author tlk
 * @date 2020/8/4-11:08
 */
public interface UpdateGroup {
}

package com.dwsoft.test.testjsr303.valid;

/**
 * @author tlk
 * @date 2020/8/4-11:08
 */
public interface AddGroup {
}

如果想在添加的时候生效，如下：

测试：

 如果只是把bean改成：

 测试：

校验没有起作用。

也可这样配置：

正常逻辑添加修改分开写，控制器对应方法只会配置一个分组

只要满足校验规则，就起作用。

注意：如果采用分组校验的形式，对应bean中的属性必须标注采用哪个校验组，不然不起任何校验作用

比如：

 

正常逻辑添加修改分开写，控制器对应方法只会配置一个分组 

 测试：

加上分组：

测试：

 完美！分组主要看自己的分配逻辑，我这边只是做一个引导！

3》自定义校验：

如显示状态，我们要求在指定的数据中选择

该怎么操作？

a》编写一个自定义的校验注解(可以参照@NotBlank等注解格式）

package com.dwsoft.test.testjsr303.valid;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @author tlk
 * @date 2020/8/4-14:15
 */
@Documented
@Constraint(
        validatedBy = {}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Checkvalue.List.class)
public @interface Checkvalue {
    String message() default "{com.dwsoft.test.testjsr303.valid.Checkvalue.message}";

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

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

    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface List {
        Checkvalue[] value();
    }
}

 

这个地方可以创建自己的消息文件（位置：resources/），ValidationMessages.properties，文件名一定要是这个

com.dwsoft.test.testjsr303.valid.Checkvalue.message = "请使用指定值"

b》编写一个自定义的校验器

package com.dwsoft.test.testjsr303.valid;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

/**
 * @author tlk
 * @date 2020/8/4-14:29
 */
public class CheckValueConstraintValidator implements ConstraintValidator<Checkvalue,Integer> {

    private Set<Integer> set=new HashSet<>();
    @Override
    public void initialize(Checkvalue constraintAnnotation) {
        int[] value = constraintAnnotation.value();
        if(value!=null && value.length>1){
            for (Integer integer : set) {
                set.add(integer);
            }
        }
    }

    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        if(set.contains(integer)) return true;
        return false;
    }
}

c》关联自定义的校验器和自定义的校验注解

 测试：

先修改控制器：

修改bean:

postman:

 成功！

这个是配置文件的提示，咱们也可以在bean上再自定义

 测试：

 校验这一块结束！！！！！！

补充一下全局异常处理：

a》编写异常处理类，使用@ControllerAdvice，使用@ExceptionHandler标注方法可以处理的异常。

package com.dwsoft.test.testjsr303.expection;

import com.dwsoft.test.testjsr303.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.apache.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author tlk
 * @date 2020/8/4-15:31
 */
//@ResponseBody
//@ControllerAdvice    合二为一
@RestControllerAdvice
public class MyControllerAdvice {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidExpection(MethodArgumentNotValidException e){
        Map<String,String>map=new HashMap<>();
        BindingResult bindingResult = e.getBindingResult();
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        fieldErrors.forEach((one)->{
            String field = one.getField();
            String defaultMessage = one.getDefaultMessage();
            map.put(field,defaultMessage);
        });
        return R.error(HttpStatus.SC_BAD_REQUEST,"入参不合法").put("data",map);
    }

    //其他异常
    @ExceptionHandler(value = Throwable.class)
    public R handleOtherExpection(Throwable  throwable){
        return R.error();
    }

}

控制器注释掉之前的处理：

package com.dwsoft.test.testjsr303.controller;

import com.dwsoft.test.testjsr303.entity.Brand;
import com.dwsoft.test.testjsr303.utils.R;
import com.dwsoft.test.testjsr303.valid.AddGroup;
import com.dwsoft.test.testjsr303.valid.UpdateGroup;
import org.apache.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;
import java.security.acl.Group;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author tlk
 * @date 2020/8/4
 */
@RestController
public class TestController {
    @RequestMapping("/test/jsr303")
    public R testJsr303(@Validated(value = {AddGroup.class}) @RequestBody Brand brand
//            , BindingResult bindingResult
      )
    {
//        if(bindingResult.hasErrors()){
//            Map<String,String>map=new HashMap<>();
//            List<FieldError> fieldErrors = bindingResult.getFieldErrors();
//            fieldErrors.forEach((item) ->{
//                String field = item.getField();
//                String defaultMessage = item.getDefaultMessage();
//                map.put(field,defaultMessage);
//            });
//            return R.error(HttpStatus.SC_BAD_REQUEST,"入参不合法").put("data",map);
//        }
        //业务处理
        return R.ok();
    }
}

测试：

大功告成！！！！！！！！！！！

tanlongkui
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Mybatis实体类中的annotation
裙下之陈
08-30 753
Bean Validation 中内置的 constraint   @Null 被注释的元素必须为 null @NotNull 被注释的元素必须不为 null @AssertTrue 被注释的元素必须为 true @AssertFalse 被注释的元素必须为 false @Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值 @Max(value) 被注释的元素必须是一个
JSR303分组校验
daniu_weilai的博客
08-29 1099
JSR303分组校验属于后端校验的一种很方便的方式 步骤： 1.新建两个接口,用来代表哪两个组，比如，AddGroup,UpdateGroup代表添加分组和修改分组 //添加分组 package com.jc.common.valid; public interface AddGroup { } //修改分组 package com.jc.common.valid; public interface UpdateGroup { } 2.给需要验证的实体类的字段上添加对应的校验注解，并且指定
JSR303校验,分组校验,自定义注解校验,全局异常处理
在路上
08-14 547
从简单的使用步骤到自定义注解校验, 一文搞定
JSR303验证
weixin_43477950的博客
11-26 227
JSR303常用的验证注解 hibernate扩展的验证注解 导入依赖 <!--hibernate的校验注解--> <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0.19.Final</version> &l
JSR303数据校验之分组校验
suqinyi的博客
04-09 2456
分组校验 使用场景： 一个实体类用到修改和添加 添加和修改校验的字段不同，便可以使用分组校验 文章目录分组校验快速入口一、新建空的接口二、使用gruops字段指定组三、在controller使用@Validated指定组四、完成总结 快速入口 springboot后端数据校验JSR303规范详解 以下是本篇文章正文内容，下面案例可供参考 一、新建空的接口 如图： 说明：这些接口是空的，校验是用来区分场景而已 package com.atguigu.common.valid; /** * @au
JSR303校验注解和自定义校验注解的使用
10-14
总结起来，JSR303校验注解提供了一种声明式的方式来验证对象属性，而自定义校验注解则允许你扩展验证功能，以适应更复杂的业务场景。通过合理利用这些工具，可以有效提升应用的数据质量，减少因数据错误导致的问题。
JSR303自定义参数校验-校验类型罗列
12-21
一、自定义参数校验 1、为什么要自定义？ 通过学习，了解到很多常用注解了，但是呢，总是有那么些需求… 2、案例分析(手机号格式) 2.1、需要验证的实体 Bean public class LoginVo { @NotNull @IsMobile //自定义...
Java如何使用JSR303校验数据与自定义校验注解
10-14
JSR303的一个具体实现是Hibernate Validator，它包含了丰富的内置校验注解以及自定义校验注解的能力。在Spring Boot项目中，我们通常通过集成Hibernate Validator来实现数据校验。 首先，为了在Spring Boot项目中...
SpringBoot结合JSR303对前端数据进行校验的示例代码
10-14
以下是一个简单的SpringBoot结合JSR303进行后端数据校验的例子： 1. 首先，我们需要创建一个实体类，例如`Person`，并在其中使用JSR303的注解进行校验： ```java import javax.persistence.Entity; import javax....
SpringBoot的JSR-303数据校验
诚
02-14 2206
一、 JSR-303 介绍   JSR 是Java Specification Requests 的缩写，是指向 JCP(Java Community Process) 提出新增一个标准化技术规范的正式请求。   任何人都可以提交 JSR，以向 Java 平台增添新的 API 和服务，已审核通过的规范涉及 Java 各个领域，有兴趣可以了解一下。   Bean Validation 是一个运行时...
JSR-303接口标准和参考实现
05-24
整合jsf2 bean验证需要的jar包，j2ee6规范jsr303 hibernate-validator-4.2.0.Final validation-api-1.0.0.GA
SR 303 - Bean Validation 介绍及最佳实践
weixin_34390996的博客
03-13 380
简介： JSR 303 – Bean Validation 是一个数据验证的规范，2009 年 11 月确定最终方案。2009 年 12 月 Java EE 6 发布，Bean Validation 作为一个重要特性被包含其中。本文将对 Bean Validation 的主要功能进行介绍，并通过一些示例来演示如何在 Java 开发过程正确的使用 Bean Validation。 关于 Bean V...
JSR303 校验扩展（分组、按顺序校验）
weixin_30802171的博客
03-14 329
1.在spring MVC 项目中使用JSR303 校验数据合法性，一般情况下使用方法为 （1）在接受数据的实体使用注解标添加校验规则 1 package com.hzsj.wechatdto; 2 3 import org.hibernate.validator.constraints.Length; 4 import org.hibernate.validato...
JSR303数据校验的分组校验
大魚的个人博客，如有不足，欢迎指正。
03-25 195
JSR303数据校验的分组校验 一个例子： public class Manager{ private static final long serialVersionUID = 48L; private Integer id; @NotBlank(message = "用户名不允许为空",groups = {AddEmployee.class,Login.class}) @Length(min = 4, max = 25, message = "用户名长度必须在4~25个字符之间"
SpringMVCJSR-303规范进行校验简单示例
陈三的博客
05-26 2387
JSR-303规范,No message found under code 'userName.not.exist.formModel.userName' for locale 'zh_CN'
JSR303参数校验
qq_33002953的博客
05-19 178
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> @RequestMapping("/do_lo...
【java后端校验JSR303】
嘉健的博客
04-14 343
【java后端校验JSR303】
springboot系列学习（七）JSR303数据校验 ， 注解不能使用爆红的解决方法，后端自动的校验实体类的值是不是合法的，
一天不写代码难受的博客
09-28 776
我们之前在前端，会校验我们输入的值是不是合法的，比如email，如果不是email格式那么就报错。这个是前段 的验证规则，其实后端也是可以的。这个就是JSR303数据校验 高版本需要导入JSR303数据校验依赖 <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <versi
【SpringBoot学习笔记 六】JSR303数据校验、日志配置及输出、静态资源映射
MaoLin Tian's Blog
10-08 678
前面5篇Blog详细介绍了SpringBoot的实现原理，本篇Blog从实战的角度来看下SpringBoot开发时我们还需要做哪些工作，这里我选择了三个比较重要的模块来进行介绍，包括我们的数据验证，日志配置以及静态资源的映射，这篇博客结束后我们即将进入到SpringBoot的各种整合和集成的学习中，可以理解为SpringBoot基础学习的最后一篇吧。
jsr303数据校验是什么
最新发布
07-28
JSR303数据校验是一种用于对Java Bean中的字段的值进行验证的规范。它可以通过注解的方式对表单提交的数据进行方便地验证。在Spring MVC 3.x中也大力支持JSR-303，可以在控制器中进行数据校验。\[1\]数据校验的基本...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值