springboot数据校验——Hibernate Validator

已于 2023-09-25 18:02:00 修改
阅读量1.3k 收藏
点赞数 1
文章标签： java
于 2022-10-28 17:05:18 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_46110252/article/details/127574396
版权

1、导包

<dependency>
	<groupId>org.hibernate</groupId>
	<artifactId>hibernate-validator</artifactId>
	<version>6.0.1.Final</version>
</dependency>

2、注解说明

在这里插入图片描述
在这里插入图片描述

3、需要数据校验的地方

两种请求：

  • get、delete等请求，参数形式为RequestParam/PathVariable
  • post、put等请求，参数形式为RequestBoty

RequestParam/PathVariable形式的参数校验

Get、Delete请求一般会使用RequestParam/PathVariable形式参数参数，这种形式的参数校验一般需要以下两个步骤，如果校验失败，会抛出ConstraintViolationException异常。

必须在Controller类上标注@Validated注解；
在接口参数前声明约束注解(如@NotBlank等)

@RestController
@Validated
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;
    
	@GetMapping("/{id}")
	@MyLog("获取用户")
	public R user(@Max(value = 12,message = "用户id不能为空") @PathVariable("id")Integer id,
	              @NotBlank(message = "用户名不能为空") @RequestParam("username") String username){
	    User user = userService.getById(id);
	    return R.ok().put("data",user);
	}

	@PostMapping("/add")
    public R add( @RequestBody Teacher teacher){
        ValidatorUtils.validateObject(teacher, AddGroup.class);
        System.out.println(JSONUtil.toJsonStr(teacher));
        return R.ok();
    }

}

RequestBoty形式的参数校验

POST、PUT请求一般会使用requestBody传递参数，这种情况下，在入参对象上添加@Validated注解就能实现自动参数校验。

比如，有一个保存用户信息的接口，要求username长度是2-20位，password字段长度是8-20位，还要加上邮箱校验。如果校验失败，会抛出MethodArgumentNotValidException异常，Spring默认会将其转为400（Bad Request）请求.

分组校验

背景：在执行保存和更新操作的时候，校验的参数可能存在差异，比如保存的时候不需要校验Id，而更新的时候就需要校验id(主键)，写两个实体类复用率会很低。所以这个时候分组校验就很有必要

/**
 * 新增数据 Group
 */
public interface AddGroup {
}

/**
 * 更新数据 Group
 */
public interface UpdateGroup {
}

实体类

@Data
public class Teacher {
    
    @NotNull(message = "id不能为空",groups = UpdateGroup.class)
    private Integer id;
	
	//这里注意要使用 org.hibernate.validator.constraints.NotBlank，不要导错类
    @NotBlank(message = "教师账号不能为空",groups = {UpdateGroup.class, AddGroup.class})
    private String tid;

    @NotBlank(message = "密码不能为空",groups = {UpdateGroup.class, AddGroup.class})
    private String pwd;

    @NotBlank(message = "教师姓名不能为空",groups = {UpdateGroup.class, AddGroup.class})
    private String tname;

    @Email(message = "教师邮箱不合法",groups = {UpdateGroup.class, AddGroup.class})
    private String email;

    @NotNull(message = "学生信息不能为空",groups = {UpdateGroup.class, AddGroup.class})
    @Valid //数据嵌套要加上，要不然嵌套的不会校验
    private List<Student> students;
    
}

@Data
public class Student {

    @NotNull(message = "id不能为空",groups = UpdateGroup.class)
    private Integer id;

    @NotBlank(message = "学生账号不能为空",groups = {UpdateGroup.class, AddGroup.class})
    private String sid;

    @NotBlank(message = "密码不能为空",groups = {UpdateGroup.class, AddGroup.class})
    private String pwd;

    @NotBlank(message = "学生姓名不能为空",groups = {UpdateGroup.class, AddGroup.class})
    private String sname;

    @Email(message = "学生邮箱不合法",groups = {UpdateGroup.class, AddGroup.class})
    private String email;

}

分组校验工具类

public class ValidatorUtils {
    private static final ValidatorFactory VALIDATOR_FACTORY = Validation.buildDefaultValidatorFactory();
    /**
     * 参数校验
     *
     * @param paramObject 需要校验的参数
     */
    public static void validateObject(Object paramObject) {
        Validator validator = VALIDATOR_FACTORY.getValidator();
        Set<ConstraintViolation<Object>> validateResult = validator.validate(paramObject);
        if (CollectionUtils.isEmpty(validateResult)) {
            return;
        }

        StringBuilder errorMessageSb = new StringBuilder();
        for (ConstraintViolation<Object> violation : validateResult) {
            errorMessageSb.append(violation.getMessage()).append(";");
        }
        throw new RRException(errorMessageSb.toString());
    }

    /**
     * 参数校验【支持分组校验】
     *
     * @param paramObject 需要校验的参数
     * @param classes     具体的分组
     */
    public static void validateObject(Object paramObject, Class<?> classes) {
        Validator validator = VALIDATOR_FACTORY.getValidator();
        Set<ConstraintViolation<Object>> validateResult = validator.validate(paramObject, classes);
        if (CollectionUtils.isEmpty(validateResult)) {
            return;
        }

        Set<String> errorMsgSet = new HashSet<>();
        for (ConstraintViolation<Object> violation : validateResult) {
            errorMsgSet.add(violation.getMessage());
        }
        throw new RRException(String.join("<br>", errorMsgSet));
    }

    private ValidatorUtils() {
    }
}

自定义异常处理类

/**
 * 自定义异常
 *
 * 
 */
public class RRException extends RuntimeException {
	private static final long serialVersionUID = 1L;
	
    private String msg;
    private int code = 500;
    
    public RRException(String msg) {
		super(msg);
		this.msg = msg;
	}
	
	public RRException(String msg, Throwable e) {
		super(msg, e);
		this.msg = msg;
	}
	
	public RRException(String msg, int code) {
		super(msg);
		this.msg = msg;
		this.code = code;
	}
	
	public RRException(String msg, int code, Throwable e) {
		super(msg, e);
		this.msg = msg;
		this.code = code;
	}

	public String getMsg() {
		return msg;
	}

	public void setMsg(String msg) {
		this.msg = msg;
	}

	public int getCode() {
		return code;
	}

	public void setCode(int code) {
		this.code = code;
	}
	
}

全局异常处理类

/**
 * 异常处理器
 *
 *
 */
@RestControllerAdvice
@Log4j
public class RRExceptionHandler {
	private Logger logger = LoggerFactory.getLogger(getClass());

	/**
	 * 处理自定义异常
	 */
	@ExceptionHandler(RRException.class)
	public R handleRRException(RRException e){
		R r = new R();
		r.put("code", e.getCode());
		r.put("msg", e.getMessage());
		return r;
	}

	/**
	 * 方法参数校验异常
	 */
	@ExceptionHandler(MethodArgumentNotValidException.class)
	public R handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
		logger.error("[全局异常处理] [参数校验不通过]{}", e.getMessage(), e);
		return R.error(e.getMessage());
	}


	/**
	 * 方法参数校验异常[类型不配备]
	 */
	@ExceptionHandler(UnexpectedTypeException.class)
	public R handleUnexpectedTypeException(UnexpectedTypeException e) {
		logger.error("[全局异常处理] [参数校验类型不匹配]{}", e.getMessage(), e);
		return R.error(e.getMessage());
	}

	/**
	 * 方法RequestParam/PathVariable形式参数校验异常
	 */
	@ExceptionHandler(ConstraintViolationException.class)
	public R handleConstraintViolationException(ConstraintViolationException e) {
		Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
		List<String> msgList = new ArrayList<>();
		for (ConstraintViolation<?> constraintViolation : constraintViolations) {
			msgList.add(constraintViolation.getMessageTemplate());
		}
		return R.error(String.join("<br>",msgList));
	}


	@ExceptionHandler(Exception.class)
	public R handleException(Exception e){
		logger.error(e.getMessage(), e);
		return R.error();
	}
}

返回类

public class R extends HashMap<String, Object> {
    private static final long serialVersionUID = 1L;

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

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

    public static R error(String msg) {
        return error(HttpStatus.INTERNAL_SERVER_ERROR.value(), 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;
    }

    public Integer getCode() {
        return (Integer) get("code");
    }
}

使用注解方式：

/**
     * 走参数校验注解的 groups 组合校验
     *
     * @param userDTO
     * @return
     */
    @PostMapping("/update/groups")
    public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) {
        userService.updateById(userDTO);
        return RspDTO.success();
    }

全局异常捕获MethodArgumentNotValidException。将其返回

@ExceptionHandler(MethodArgumentNotValidException.class)
    public R handleMethodArgumentNotValidException(MethodArgumentNotValidException e){
        List<ObjectError> allErrors = e.getAllErrors();
        R r = new R();
        r.put("code", -1);
        for (ObjectError allError : allErrors) {
            r.put("msg", allError.getDefaultMessage());
            //只返回第一个错误提示
            break;
        }
        return r;
    }

参考
https://blog.csdn.net/WEDUEST/article/details/121594610

五更钟动
关注
SpringBoot中Hibernate-validator的使用
虎口脱险
10-06 877
前言 Hibernate-validator可以让我们通过注解的方式在实体类中指定一些校验规则和默认的校验失败的错误信息。在SpringBoot中有两种方式可以实现Hibernate-validator校验实体类，一种是结合使用Srping的默认实现自动校验，一种是手动封装工具栏进行校验。 下面的例子都是基于SpringBoot2.0.5版本。 首先引入hibernate-validator的依...
SpringBoot开发——整合Hibernate Validator实现数据校验
最新发布
bjzhang75的博客
09-07 841
SpringBoot整合Hibernate Validator实现数据校验
Hibernate Validator 数据校验框架
从基础到源码解析的学习记录
08-05 2254
JSR：Java Specification Requests的缩写，意思是Java规范提案是指向JCP(Java Community Process) 提出新增一个标准化技术规范的正式请求任何人都可以提交JSR，以向Java平台增添新的API和服务JSR已成为Java界的一个重要标准就是这个JSR规范之一Bean Validation是一个运行时的数据验证框架的标准JSR303是专家组成员向JCP提交的第1版Bean Validation，即针对bean数据校验提出的一个规范，
开发服务端校验组件——validator
m0_52322439的博客
07-28 529
hibernate-validator介绍 早期的网站，用户输入一个邮箱地址，需要将邮箱地址发送到服务端，服务端进行校验，校验成功后，给前端一个响应。 有了JavaScript后，校验工作可以放在前端去执行。那么为什么还需要服务端校验呢？ 因为前端传来的数据不可信。前端很容易获取到后端的接口，如果有人直接调用接口，就可能会出现非法数据，所以服务端也要数据校验。 总的来说： 前端校验：主要是提高用户体验 后端校验：主要是保证数据安全可靠 校验参数基本上是一个体力活，而且冗余代码繁多，
SpringBoot中处理校验逻辑的两种方式：Hibernate Validator+全局异常处理
qq_64948664的博客
03-27 925
实际开发中把两者结合在一起用，就可以弥补彼此的短板了，简单校验用 Hibernate Validator，复杂一点的逻辑校验，比如说需要数据库。
springboot使用hibernate validator校验
02-07 72
一、参数校验 在开发中经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等，写这些与业务逻辑关系不大的代码个人感觉有两个麻烦： 验证代码繁琐，重复劳动 方法内代码显得冗长 每次要看哪些参数验证是否完整，需要去翻阅验证逻辑代码 hibernate validator（官方文档）提供了一套比较完善、便捷的验证实现方式。 spring-boot-st...
【Spring Boot】整合 Hibernate-Validator 校验器
pcdd's blog
05-15 7164
ConstraintValidator是一个泛型接口，A表示之前我们自定义的注解，T表示被这个注解注释的字段的类型，这里指String（学历用String类型表示）创建一个类，实现ConstraintValidator接口，重写两个方法：initialize和isValid，分别表示初始化验证消息的方法和执行验证的方法。创建一个全局异常处理类，用于捕获抛出的异常，这里主要是通过Stream的API获取到注解中message属性的值。输入一个非法的值，比如硕士，观察结果。
SpringBoot后端进行数据校验——JSR303的使用
江小举的博客
03-05 3773
原创不易，未经允许，请勿转载。 博客主页：https://blog.csdn.net/qq_43058685?spm=1001.2014.3001.5343 如果只想查看注解，请跳到文章末尾部分 文章目录简介项目创建传统的检验方式使用JSR303自定义错误信息错误信息的获取与响应错误异常类型补充分组校验自定义校验常用注解汇总 简介 在前后端进行数据交互中，在前端把数据传送到后端前，一般会先进行校验一次,校验成功之后，才把数据发送到后端。但是我们在服务端还得在对数据进行一次校验。因为请求数据发送的链接很容.
【java框架】SpringBoot(9) -- Springboot中如何优雅的进行字段校验（csdn）————.pdf
12-04
【SpringBoot字段校验】在SpringBoot应用中，优雅地执行字段校验是确保系统数据安全性和用户体验的关键步骤。本文将介绍如何利用SpringBoot集成的Hibernate Validate库进行字段校验，以及SpringBoot中的一些最佳实践...
全局异常处理及参数校验-SpringBoot 2.7.2 实战基础（建议收藏）
youyacoder的博客
08-17 665
前后端分离开发非常普遍，后端处理业务，为前端提供接口。服务中总会出现很多运行时异常和业务异常，本文主要讲解在 SpringBoot 实战中如何进行异常统一处理和请求参数的校验。
springboot之hibernate-validator校验
lss0555的博客
01-05 1163
一、前言 hibernate-validator是Hibernate项目中的一个数据校验框架，它能够将数据校验从业务代码中脱离出来，增加代码可读性，同时也让数据校验变得更加方便、简单。 官方文档地址：http://hibernate.org/validator/documentation 二、准备工作 1、引入依赖 hibernate-validator依赖 implementation("org.hibernate.validator:hibernate-validator:6.0.19.Final")
SpringBoot使用Hibernate Validator表单验证
冲出仁川，走出马德里，故事还会再继续
03-29 333
文章目录一、要求二、实现步骤2.1 新建实体类2.2、创建控制器类UserController2.3、在templates目录下加入input.html和success.html2.4、修改application.properties文件2.5 启动Practice51Application主类，然后访问[http://localhost:8080/practice5_1/add](http://localhost:8080/practice5_1/)2.6输入如下数据，点击添加 一、要求 用户名必须输入
Hibernate Validator 整合 Spring Boot：全面使用方式与原理分析
weixin_49025285的博客
07-11 979
首先，你需要定义一个新的注解，这个注解将标记在需要自定义验证的字段或方法上。message()：用于定义验证失败时的错误信息。groups()：用于定义验证组。payload()：用于定义验证的上下文信息。// 定义自定义注解Class
Spring Boot 后台验证 Hibernate Validation
weixin_45743799的博客
02-17 223
后台验证详解 开发项目过程中，后台在很多地方需要进行校验操作，比如：前台表单提交，调用系统接口，数据传输等。而现在多数项目都采用MVC分层式设计，每层都需要进行相应地校验。 针对这个问题， JCP 出台一个 JSR 303-Bean Validation规范 ，而Hibernate Validator 作为Bean Validation的参考实现，提供了JSR 303规范中所有内置constrai...
使用Hibernate Validator进行Spring Boot后端数据校验
竹林幽深
01-02 339
什么是Hibernate Validator？Hibernate Validator是一个用于Java Bean验证的框架，它实现了Java Bean Validation API（JSR 380）规范。该框架提供了一组注解和API，用于在应用程序中声明性地定义验证规则，并在运行时执行这些规则。Hibernate Validator广泛用于Spring框架和Java EE应用中，用于对数据进行验证和约束。
Spring Boot整合hibernate-validator实现数据校验
weixin_45972546的博客
06-13 960
本文主要讲述了如果使用hibernate框架实现数据校验
20-SpringBoot之验证——Hibernate Validator
HJ的技术博客
11-28 242
SpringBoot之验证——Hibernate Validator1. Hibernate Validator的主要校验注解2. 添加pom依赖3. BeanValidator工具类4. 新建测试VO5. 测试Controller6. 源码下载 1. Hibernate Validator的主要校验注解 Hibernate Validator 是 Bean Validation 的参考实现 。H...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值