Springboot JSR303 校验

最新推荐文章于 2024-09-28 10:18:43 发布
最新推荐文章于 2024-09-28 10:18:43 发布
阅读量277 收藏
点赞数
分类专栏： JSR303校验 统一返回异常 enum枚举
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yuzheh521/article/details/108169254
版权

引入依赖

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

定义枚举类存放常亮

/***
 * 错误码和错误信息定义类
 * 1. 错误码定义规则为5为数字
 * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常
 * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
 * 错误码列表：
 *  10: 通用
 *      001：参数格式校验
 *  11: 商品
 *  12: 订单
 *  13: 购物车
 *  14: 物流
 *
 *
 */
public enum BizCodeEnume {
    //1.提供枚举类的对象,多个对象之间用逗号,最后一个用分号结尾
    //相当于 private static finale  BizCodeEnume UNKNOW_EXCEPTION = new BizCodeEnume(10000,"系统未知异常")
    //就是简化的创建对象
    UNKNOW_EXCEPTION(10000,"系统未知异常"),
    VAILD_EXCEPTION(10001,"参数格式校验失败");

    private int code;
    private String msg;
    BizCodeEnume(int code,String msg){
        this.code = code;
        this.msg = msg;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

1.给Bean添加校验注解

都在:javax.validation.constraints.NotBlank;包下
@NotBlank(message = “品牌名不能为空”)

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

	/**
	 * 品牌id
	 */
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名不能为空")
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotEmpty
	@URL(message = "logo必须是合法的url地址")
	private String logo;
	
	
	/**
	 * 检索首字母
	 * 自定义校验,可以传正则表达式regexp
	 */
	@NotEmpty
	@Pattern(regexp ="/^[a-zA-Z]/$",message = "首字母必须是a-z或大写")
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull
	@Min(value = 0,message = "排序必须大于0")
	private Integer sort;

}

2.controller @Valid 开启校验

给校验的Bean后面紧跟一个BindingResult,就可以获得校验结果

2.1返回给前台自定义数据格式

1）.方法一Controller直接处理

 /**
     * 保存
     */
    //@Valid 开启校验
    @RequestMapping("/save")
    //@RequiresPermissions("product:brand:save")
    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) {
        if (result.hasErrors()) {
        //封装返回的错误信息
            Map<String, String> map = new HashMap<>();
            //获取校验错误结果
            result.getFieldErrors().forEach(item -> {
                //getDefaultMessage() 获取错误提示
                String message = item.getDefaultMessage();
                //item.getField()获取错误属性名
                String fieldName = item.getField();
                map.put(fieldName, message);

            });
            return R.error(400, "数据不合法").put("data", map);
        } else {
            brandService.save(brand);
            return R.ok();
        }


    }

2）. 方法二定义统一异常处理

  /**
     * 保存
     */
    //@Valid 开启校验
    @RequestMapping("/save")
    //@RequiresPermissions("product:brand:save")
    public R save(@Valid @RequestBody BrandEntity brand) {
        brandService.save(brand);
        return R.ok();

    }

如果出现异常会,统一到自定义的异常处理器,处理对应的异常

/**
 * @author
 * @create 2020-08-22 16:31
 * 集中处理所有异常
 */
//处理com.yzh.shop.product.controller包下的所有异常
@Slf4j
//@ResponseBody
//@ControllerAdvice(basePackages = "com.yzh.shop.product.controller")
@RestControllerAdvice(basePackages = "com.yzh.shop.product.controller")
public class ShopExceptionAdvice {
//精确匹配异常
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handlerValidationException(MethodArgumentNotValidException e) {
        log.error("数据校验出现问题{},异常类型:{}",e.getMessage(),e.getClass());
        BindingResult result = e.getBindingResult();
        Map<String, String> map = new HashMap<>();
        result.getFieldErrors().forEach(item->{
            map.put(item.getField(), item.getDefaultMessage());

        });
  return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(), BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data", map);

    }
 //如果没有精确到异常,就匹配其他任意异常
    @ExceptionHandler(value = Throwable.class)
    public R handlerException(Throwable throwable) {
        return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
    }



}

二.分组校验

例如 : 添加的时候id是自增 可以为空,修改的时候id 不能是空

1.定义校验接口分组

在这里插入图片描述

2.实体类

给校验注解标注什么情况情况需要校验,如果字段不加 不会生效
默认没有指定分组校验的的@NotBlank()在分组情况下不会生效,只会在@Validated生效

 @NotBlank(message = "品牌名不能为空",groups = {AddGroup.class,UpdateGroup.class})

package com.yzh.shop.product.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

import java.io.Serializable;

import com.yzh.common.valid.AddGroup;
import com.yzh.common.valid.ListValue;
import com.yzh.common.valid.UpdateGroup;
import com.yzh.common.valid.UpdateStatusGroup;
import lombok.Data;
import org.hibernate.validator.constraints.URL;

import javax.validation.constraints.*;

/**
 * 品牌
 * 
 * @author yzh
 * @email yzh@gmail.com
 * @date 2020-08-02 12:37:27
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定Id" ,groups = UpdateGroup.class)
	@Null(message = "新增不能指定id",groups = AddGroup.class)
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名不能为空",groups = {AddGroup.class,UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 * 添加组,添加的时候不能为空
	 */

	@NotBlank(groups = AddGroup.class)
	@URL(message = "logo必须是合法的url地址",groups = {AddGroup.class,UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
	@ListValue(vals = {0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
	private Integer showStatus;
	/**
	 * 检索首字母
	 * 自定义校验,可以传正则表达式regexp
	 */
	@NotEmpty(groups = AddGroup.class)
	@Pattern(regexp ="^[a-zA-Z]$",message = "首字母必须是a-z或大写",groups = {AddGroup.class,UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(groups = AddGroup.class)
	@Min(value = 0,message = "排序必须大于0",groups = {AddGroup.class,UpdateGroup.class})
	private Integer sort;

}

}

3.Controller用@Validated(UpdateGroup.class)指定校验那一组

 /**
     * 保存
     */
    //@Valid 开启校验
    @RequestMapping("/save")
    //@RequiresPermissions("product:brand:save")
    public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand) {

        brandService.save(brand);
        return R.ok();

    }

    /**
     * 修改
     */
    @RequestMapping("/update")
    //@RequiresPermissions("product:brand:update")
    public R update(@Validated(UpdateGroup.class)@RequestBody BrandEntity brand) {
        brandService.updateById(brand);

        return R.ok();
    }

三.自定义校验

引入最上面的依赖可以不应再次引用下面的依赖
依赖maven

 <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>

1. 编写一个自定义校验的注解

package com.yzh.common.valid;

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

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @author
 */
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})//关联自定义校验器
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface ListValue {
    //默认错误信息,从哪里读取
    String message() default "{com.yzh.common.valid.ListValue.message}";

    //支持分组校验功能
    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
    //默认没有值
    int[] vals() default {};
}

2. 编写一个自定义的校验器,ConstraintValidator

package com.yzh.common.valid;

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

/**
 * @author
 * ListValue:校验注解
 * Integer:标记在哪个字段
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

    private Set<Integer> set = new HashSet<Integer>();
    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
          //我们传的值value是否满足vals的范围
        int[] vals = constraintAnnotation.vals();
        //判断传来的参数值是否满足vals
        for (int val : vals) {
            set.add(val);
        }

    }

    //判断是否校验成功

    /**
     *
     * @param value 从页面提交上来,需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
       //set集合中是否包含传入的参数值
        return set.contains(value);
    }
}

3. 关联自定义校验注解和自定义校验器,

@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})//关联自定义校验器,可以指定多个不同的,校验器,适配不同类型的校验
@Target({METHOD, FIELD,ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)

4.实体类

/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
	@ListValue(vals = {0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
	private Integer showStatus;

5.使用读取默认文件内的错误信息,也可以直接在注解用message

5.1在自定义注解中配置

 //默认错误信息,从哪里读取
    String message() default "{com.yzh.common.valid.ListValue.message}";

5.2在resources下新建
ValidationMessages.properties,文件

com.atguigu.common.valid.ListValue.message=必须提交指定的值

在这里插入图片描述

6.controller

  /**
     * 修改状态
     */
    @RequestMapping("/update/status")
    //@RequiresPermissions("product:brand:update")
    public R updateStatus(@Validated(UpdateStatusGroup.class)@RequestBody BrandEntity brand) {
        brandService.updateById(brand);

        return R.ok();
    }
yzhSWJ
关注
专栏目录
Spring Boot开发（四）统一异常、JSR303数据校验处理
m0_53698336的博客
11-12 645
Spring Boot异常处理 实际项目开发中，程序往往会发生各式各样的异常情况，特别是身为服务端开发人员的我们，总是不停的编写接口提供给前端调用，分工协作的情况下，避免不了异常的发生，如果直接将错误的信息直接暴露给用户，这样的体验可想而知，且对黑客而言，详细异常信息往往会提供非常大的帮助… Spring Boot 默认异常处理机制 Spring Boot 提供了一套默认的异常处理机制，一旦程序中出现了异常，Spring Boot 会自动识别客户端的类型（浏览器客户端或机器客户端），并根据客户端的不同，以不
SpringBoot JSR303数据校验
select_zxl的博客
07-20 250
SpringBoot JSR303数据校验
springboot-jsr303校验
m0_46522108的博客
11-14 139
jsr-303校验 导入maven依赖。 <!--jsr303 校验--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> @Validated：开启数据校验功能 @AllArgsConstructo
微服务JSR303解析部署使用全流程
最新发布
m0_71240584的博客
09-28 1401
JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。JSR303是提案中的一个，用来做JavaBean校验的。JSR是一个组织，用来收集整理java规范提案。任何人都可以提交提案，组织觉得有必要就会添加到新版本的jdk里。
springboot学习笔记（六）--整合JSR303数据校验
qq_46112274的博客
04-26 220
1、引入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 2、编写代码 Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的em
SpringBoot集成JSR303
Young_Naive的博客
01-26 857
文章目录集成JSR3031.引入依赖2.在需要进行校验的类的对象上加上注解`@Valid`3.在类的各个字段上加上指定注解4.自定义JSR303注解 集成JSR303 1.引入依赖 <!-- JSR303依赖 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifac
Spring boot JSR303 Bean的校验--基础篇
weixin_35675281的博客
06-12 178
对于参数的校验，一般使用Springboot、SpringMVC的同学，都会使用JSR303来进行参数的校验；这样会使得代码简介、规范，代码量减少、错误率减少的功效。 JSR303的官方文档：https://pan.baidu.com/s/1ju11mOKTimXhTRNF_zxGGA 提取码：qkbu 1、引入依赖，可以直接使用Springboot自带的starter，也可以是maven仓库是找依赖 Springboot自带的starter <dependency> &.
springboot JSR303参数校验 全局异常处理
01-07
Springboot全局异常处理、JSR303参数校验，具体详见: https://blog.csdn.net/herojuice/article/details/85788681
SpringBoot结合JSR303对前端数据进行校验的示例代码
10-14
本文将详细介绍如何在SpringBoot项目中结合JSR303（Java Bean Validation）进行前端数据校验，并通过示例代码来阐述其实现过程。 首先，让我们了解数据校验的基本分类。数据校验通常分为前端校验和后端校验。 前端...
Springboot集成JSR303参数校验的方法实现
10-16
Spring Boot集成JSR303参数校验的方法实现涉及了Java中参数校验的标准规范，即JSR303（Bean Validation）规范，该规范通过在Java对象属性上添加注解来实现数据校验的约束定义。这种方式能够将校验逻辑与业务逻辑分离...
SpringBoot业务开发 05、SpringBoot集成JSR303实现参数校验+全局异常捕捉_使用参数校验jsr303如何捕获
2401_84167046的博客
04-17 819
Min(value = 0, message = “排序必须要大于等于0”, groups = {AddGroup.class, UpdateGroup.class})@NotBlank(message = “品牌logo地址不能为空”, groups = {AddGroup.class, UpdateGroup.class})@NotBlank(message = “品牌名称不能为空”, groups = {AddGroup.class, UpdateGroup.class})
Spring Boot 快速入门4 ——JSR-303 数据校验
Z99263的博客
06-24 1378
我们在日常开发中，避不开的就是参数验证，有人说前端不是回在表单证进行校验吗，在后端中，我们可以直接不管前端怎么做判断过滤，在后端中为了安全，还是需要进行判断的。在前端做校验是很容易绕过的，举个例子，当测试使用PpostMan时，如果后端没有校验，肯定回出现很多异常。今天就和大家来一起学习JSR303专门用于参数校验。JSR-303是 JAVA EE 6 中的一项子规范，叫做，官方参考实现是。提供了JSR 303规范中所有内置constraint的实现，除此之外还有一些附加的traint。
Springboot 校验
Pancras_gc
09-18 262
@Email注解报红 是因为新版本需要validation启动器 解决方法：在pom.xml 加入下面依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> Springboot中可以用@validated来校验数据，如果数据异常
Springboot中的JSR303校验
我能在河边钓一整天的鱼
05-24 396
JSR303是Java为Bean数据合法性校验所提供的一个标准规范 我们知道前端传过来的数据后端也要做校验，但你在controller里边判断啊，返回提示信息啊着实很麻烦。此时你可以在类上使用@Validated注解开启JSD303校验，然后在具体的属性上添加@注解，如图，@Email会验证name自动是否符合邮箱格式，你还可以在注解的括号里修改提示信息...解放你的controller JSR303常用格式注解 ...
SpringBoot04 JSR303数据校验
ZHOUJIAN_TANK的博客
05-09 150
数据校验 官网链接>>> Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的name只能支持Email格式； The method validation feature supported by Bean Validation 1.1 is automatically enabled as long as a JSR-303 implementation (such as Hibernate val
SpringBoot(9) —— JSR303校验
Jzandth的博客
09-28 209
目录1.什么是JSR303校验2.怎么使用JSR303校验3.测试 1.什么是JSR303校验 JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator 此实现与 Hibernate ORM 没有任何关系。JSR 303 用于对 Java Bean 中的字段的值进行验证 Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证 可以使用注解的方式进行验证 2.怎么使
JSR303-Bean Validation介绍与基于SpringBoot项目使用
Java猿人一枚的博客
06-24 697
JSR303-Bean Validation介绍与基于SpringBoot项目使用JSR303-Bean Validation介绍与基于SpringBoot项目使用1.关于Bean Validation2.Constraint介绍Bean Validation 中内置的 constraintHibernate Validator 附加的 constraint3.Springboot项目中应用4.自...
SpringBoot使用JSR303参数校验并进行全局异常处理
你好啊佩奇
06-04 551
SpringBoot使用JSR303参数校验 开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验，比如非空，非null，整数值的范围，字符串的个数，日期，邮箱等等。最常见的就是我们直接写代码校验，这样以后比较繁琐，而且不够灵活。 不能总是写繁琐的代码来实现吧。 使用JSR303来做参数校验就方便并且整洁很多了。 pop引入依赖 1 2 3 4 5 ...
JSR303数据校验异常处理
suiyishiguang的博客
04-09 1233
【大型电商项目开发】品牌管理之统一数据校验异常处理-19
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

yzhSWJ

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值