JSR303校验

news/2025/3/26 1:22:06/

1、JSR-303数据校验简介 

JSR是Java Specification Requests的缩写，意思是Java 规范提案

JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation

即，JSR 303，Bean Validation规范 ，为Bean验证定义了元数据模型和API.。默认的元数据模型是通过Annotations来描述的，但是也可以使用XML来重载或者扩展。

2、SR303数据校验使用步骤

1.引入依赖

       <dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId></dependency>


2.实体类上加校验注解

@NotBlank
@NotEmpty
@NotNull
@Pattern
@Url

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;import java.io.Serializable;import lombok.Data;
import org.hibernate.validator.constraints.URL;import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Positive;/*** 品牌* * @author liucan* @email liucan@gmail.com* @date 2022-08-27 14:23:15*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {private static final long serialVersionUID = 1L;/*** 品牌id*/@TableIdprivate Long brandId;/*** 品牌名*/@NotEmpty(message = "品牌名不能为空")private String name;/*** 品牌logo地址*/@NotEmpty(message = "logo不能为空")@URL(message = "logo必须是一个合法的url")private String logo;/*** 介绍*/private String descript;/*** 显示状态[0-不显示；1-显示]*/private Integer showStatus;/*** 检索首字母*/@NotEmpty@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母")private String firstLetter;/*** 排序*/@NotNull@Positive(message = "排序必须为正整数")private Integer sort;}

3.在Controller中的方法形参前加上@Valid注解

    /*** 保存*/@RequestMapping("/save")public R save(@RequestBody @Valid BrandEntity brand, BindingResult result){HashMap<String, String> map = new HashMap<>();if(result.hasErrors()){result.getFieldErrors().forEach((item)->{String field = item.getField();String message = item.getDefaultMessage();map.put(field,message);});return R.error(400,"提交的数据不合法").put("data",map);}else{brandService.save(brand);}return R.ok();}

        在参数后接收BingingResult可获取到校验结果

4.测试

 3、统一异常处理

1.在common中新建一个枚举用于存放我们异常类型

public enum BizCodeEnume {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;}
}

2.在exception下新建GulimallExceptionControllerAdvice用于集中处理异常

import com.liucan.common.exception.BizCodeEnume;
import com.liucan.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;import java.util.HashMap;/*** 集中处理异常*/
// 统一处理basePackages中的异常
@Slf4j
//@ResponseBody
//@ControllerAdvice(basePackages = "com.liucan.gulimall.product.controller")@RestControllerAdvice(basePackages = "com.liucan.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {//标注方法可以处理的异常@ExceptionHandler(value = MethodArgumentNotValidException.class)public R handleVaildException(MethodArgumentNotValidException e){log.info("数据校验出现异常:{},异常类型:{}",e.getMessage(),e.getClass());BindingResult result = e.getBindingResult();HashMap<String, String> errMap = new HashMap<>();result.getFieldErrors().forEach((item)->{errMap.put(item.getField(),item.getDefaultMessage());});return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errMap);}@ExceptionHandler(value = Throwable.class)public R hanleException(Throwable throwable){return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());}
}

3.测试

 4.分组校验

1.在校验注解中有个groups属性，里面存放一个接口数组，例如：
@NotNull(message = “修改时品牌id不能为空”,groups = {UpdateGroup.class，AddGroup.class})

package com.liucan.gulimall.product.entity;import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;import java.io.Serializable;import com.liucan.common.valid.AddGroup;
import com.liucan.common.valid.UpdateGroup;
import lombok.Data;
import org.apache.ibatis.annotations.Update;
import org.hibernate.validator.constraints.URL;import javax.validation.constraints.*;/*** 品牌* * @author liucan* @email liucan@gmail.com* @date 2022-08-27 14:23:15*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {private static final long serialVersionUID = 1L;/*** 品牌id*/@Null(message = "新增品牌时品牌id必须为空",groups = {AddGroup.class})@NotNull(message = "新增品牌时品牌id能为空",groups = {UpdateGroup.class})@TableIdprivate Long brandId;/*** 品牌名*/@NotNull(message = "品牌不能为空",groups = {UpdateGroup.class,AddGroup.class})@NotEmpty(message = "品牌名不能为空")private String name;/*** 品牌logo地址*/@NotEmpty(message = "logo不能为空",groups = {AddGroup.class})@URL(message = "logo必须是一个合法的url",groups = {UpdateGroup.class,AddGroup.class})private String logo;/*** 介绍*/private String descript;/*** 显示状态[0-不显示；1-显示]*/private Integer showStatus;/*** 检索首字母*/@NotEmpty(groups = {AddGroup.class})@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups = {UpdateGroup.class,AddGroup.class})private String firstLetter;/*** 排序*/@NotNull(groups = {AddGroup.class})@Positive(message = "排序必须为正整数",groups = {UpdateGroup.class,AddGroup.class})private Integer sort;}

 其中的AddGroup与UpdateGroup是我们自定义的接口，无需实现，只作为分组

public interface AddGroup {
}public interface UpdateGroup {
}

2.在控制器Bean前添加注解@Validated({UpdateGroup.class})，用于指定我们要使用的分组

 /*** 保存*/@RequestMapping("/save")public R save(@RequestBody @Validated({AddGroup.class}) BrandEntity brand/*, BindingResult result*/){brandService.save(brand);return R.ok();}/*** 修改*/@RequestMapping("/update")public R update(@RequestBody @Validated({UpdateGroup.class}) BrandEntity brand){brandService.updateById(brand);return R.ok();}

 3.效果:

五.自定义校验器

例如我们校验某个字段是不是我们指定的值：

	/*** 显示状态[0-不显示；1-显示]*/@ListValue(vals = {0,1})  // 只希望接收0或1private Integer showStatus;/**

1、编写自定义校验注解

  • 新建自定义校验注解ListVaue

@Documented
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {// 此类的全限定类名String message() default "{com.XXX.common.valid.ListValue.message}";Class<?>[] groups() default { };Class<? extends Payload>[] payload() default { };int[] vals() default { };}

2、编写自定义校验器

  • 新建自定义校验器ListValuaConstraintValidator，并实现ConstraintValidator

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;public class ListValuaConstraintValidator implements ConstraintValidator<ListValue,Integer>{private Set<Integer> set = new HashSet<>();//初始化方法@Overridepublic void initialize(ListValue constraintAnnotation) {int[] vals = constraintAnnotation.vals();if(vals.length != 0){for (int val : vals) {set.add(val);}}}/*** 判断是否校验成功* @param value 需要校验的值* @param constraintValidatorContext* @return*/@Overridepublic boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {return set.contains(value);}
}
  • 新建配置文件ValidationMessages.properties，定义我们自定义校验注解校验失败后的返回信息
com.xxx.common.valid.ListValue.message =  必须提交指定参数

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

  • 在刚刚编写好的自定义注解@ListVaue中关联我们自定义的检验器
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;@Documented
@Constraint(validatedBy = {ListValuaConstraintValidator.class /* 【可以指定多个不同的校验器，适配不同类型的校验】 */})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {// 此类的全限定类名String message() default "{com.xxx.common.valid.ListValue.message}";Class<?>[] groups() default { };Class<? extends Payload>[] payload() default { };int[] vals() default { };}

4.测试

文章来源:https://blog.csdn.net/weixin_53922163/article/details/126772298
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.ppmy.cn/news/271753.html

相关文章

Fast DDS和Cyclone DDS对比性能测试

Fast DDS和Cyclone DDS对比性能测试

Fast DDS vs Cyclone DDS Performance 不同软件供应商提供不同的DDS实现，有必要在它们之间进行性能的比较。在本文中，eProsima对Fast DDS和Eclipse Cyclone DDS进行了性能比较，包括延迟Latency和吞吐量Throughput性能。 经过测试发现，Fast DDS比Cyclone DDS具有更低的延迟和…
阅读更多...
戴尔服务器r330系统安装,Dell 服务器 PowerEdge R330

戴尔服务器r330系统安装,Dell 服务器 PowerEdge R330

处理器选项 英特尔至强处理器E5-2400产品系列 英特尔至强处理器E5-1410 英特尔奔腾处理器1400产品系列 处理器插槽数 1个 高速缓存 每核心2.5 MB&#xff1b;核心数量选项&#xff1a;2、4、6、8 内部互连 英特尔DMI 2.0 操作系统选项 Microsoft Windows Server 2012 Microsoft…
阅读更多...
RK3568 VS RK3399

RK3568 VS RK3399

从上图看以看出&#xff0c;RK3568做为瑞芯微2020年第二季度发布的产品&#xff0c;功能优势非常明显&#xff0c;采用四核64位ARMv8.2A架构&#xff0c;22nm制程&#xff0c;主频最高可以达到2.0Ghz。GPU部分采用ARM Mali-G52 2EE MC2芯片&#xff0c;主频800Mhz,性能大致相当…
阅读更多...
戴尔服务器r330系统安装,Dell PowerEdge R330

戴尔服务器r330系统安装,Dell PowerEdge R330

技术规格 处理器 以下产品系列中的1个处理器&#xff1a;英特尔至强处理器E3-1200 v6产品系列英特尔奔腾英特尔酷睿i3英特尔赛扬 操作系统选项 Microsoft Windows Server 2012Microsoft Windows Server 2012 R2 x64Microsoft Windows Server 2016Red Hat Enterprise LinuxVMwar…
阅读更多...
DELL 13代R230 R330 R430 R530 R630 R730 R830 R930服务器设置iDRAC8及打开虚拟控制台

DELL 13代R230 R330 R430 R530 R630 R730 R830 R930服务器设置iDRAC8及打开虚拟控制台

13代机架式服务器为iDRAC8&#xff0c;今天举例R230 来设置iDRAC 1 开机自检时选择F2 system setup 2 选择第二项iDRAC Settings 3 选择最后一项 Reset iDRAC configurations to defaults 4 选择YES&#xff0c;等待初始化完成 5 初始化完成&#xff0c;选择Network&#xff…
阅读更多...
DELL 13代服务器R230 R330 R430 R530 R630 R730 R830 R930升级BIOS

DELL 13代服务器R230 R330 R430 R530 R630 R730 R830 R930升级BIOS

13代机架式服务器升级BIOS&#xff0c;今天举例R730来升级BIOS&#xff0c;系统为windows环境 背景&#xff1a;R730原机为E5-2620V3&#xff0c;现在需要上E5-2683V4&#xff0c;则需要更新BIOS才支持V4 CPU 1 开机自检顶部显示BIOS版本&#xff0c;或进F2 System setup查看…
阅读更多...
华为机试HJ69

华为机试HJ69

HJ69 矩阵乘法 法一 import java.util.*;public class Main {public static void main(String[] args) {Scanner sc new Scanner(System.in);while (sc.hasNext()) {int x sc.nextInt();int y sc.nextInt();int z sc.nextInt();int[][] arr1 new int[x][y];int[][] arr2…
阅读更多...
【算法与数据结构】59、LeetCode螺旋矩阵2

【算法与数据结构】59、LeetCode螺旋矩阵2

文章目录 题目一、方向向量法完整代码 所有的LeetCode题解索引&#xff0c;可以看这篇文章——【算法和数据结构】LeetCode题解。 题目 一、方向向量法 思路分析&#xff1a;螺旋矩阵在旋转过程中&#xff0c;我们选择的区间是左闭右开区间[ , ]&#xff0c;例如方向为从左往右…
阅读更多...
最新文章

Copyright @ 2022~2023