Java中的三种校验注解的使用(@Valid,@Validated和@PathVariable)

目录
  • @Valid和@Validated
    • @Valid和@Validated比较
    • @Valid高级使用
      • @Valid级联校验
    • @Validated高级使用
      • @Validated分组校验
      • @Validated分组校验顺序
      • @Validated非实体类校验
  • @PathVariable
    • 正则表达式校验
    • 继承BasicErrorController类
  • 自定义校验注解

@Valid和@Validated

@Valid和@Validated比较

  • 相同点:

    • @Valid注解和 @Validated注解都是开启校验功能的注解
  • 不同点:
    • @Validated注解是Spring基于 @Valid注解的进一步封装,并提供比如分组,分组顺序的高级功能
    • 使用位置不同:
      • @Valid注解 : 可以使用在方法,构造函数,方法参数和成员属性上
      • @Validated注解 : 可以用在类型,方法和方法参数上. 但是不能用在成员属性上

@Valid高级使用

@Valid级联校验

  • 级联校验: 也叫嵌套检测.嵌套就是一个实体类包含另一个实体类
  • @Valid和可以用在成员属性的字段上,因此 @Valid可以提供级联校验
  • 示例:

    @Data
    public class Hair {
    
    	@NotBlank(message = "头发长度必须提交!")
    	private Double length;
    
      	@NotBlank(message = "头发颜色必须提交!")
      	private String color;
    }
    
    @Data
    public class Person {
    
    	@NotBlank(message = "用户姓名必须提交!")
    	@Size(min=2, max=8)
    	private String userName;
    
      	// 添加@Valid注解实现嵌套检测
      	@Valid
        @NotEmpty(message = "用户要有头发!")
        private List<Hair> hairs;
    }
    
    @PostMapping("/person")
    public Result addPerson(@Valid @RequestBody Person person) {
    	return Result.buildSuccess(person);
    }
    • 只是在方法参数前面添加 @Valid@Validated注解,不会对嵌套的实体类进行校验.要想实现对嵌套的实体类进行校验,需要在嵌套的实体类属性上添加 @Valid注解

@Validated高级使用

@Validated分组校验

  • 分组校验:

    • 对指定的组开启校验,可以分别作用于不同的业务场景中
    • 分组校验是由 @Validated注解中的value提供的
  • groups:
    • JSR 303校验注解中的分组方法groups
    • 示例:
    @Data
    public class PersonGroup {
    
    	public interface AddGroup {}
    
      	public interface UpdateGroup {}
    
      	// @Validated注解value方法指定分组UpdateGroup.class时校验
      	@NotBlank(message = "用户ID必须提交!", groups = UpdateGroup.class)
      	private String id;
    
      	// @Validated注解value方法指定分组AddGroup.class或者分组UpdateGroup.class时校验
      	@NotBlank(message = "用户的姓名必须提交!", groups = {AddGroup.class, UpdateGroup.class})
      	private String name;
    
      	// @Validated注解value方法未指定分组时校验
      	@Range(min = 1, max = 200, message = "用户的年龄必须提交!")
      	private int age;
    }
  • 开启分组校验: 通过 @Validated注解的value方法对指定的分组开启校验
@RestController
@RequestMapping("/person")
public class PersonGroupController {

	// 不指定分组时校验
	@GetMapping("/person")
	public Result getPerson(@Validated @RequestBody PersonGroup person) {
		return Result.buildSuccess(person);
	}

	// 指定AddGroup分组校验
	@PostMapping("/person")
	public Result addPerson(@Validated(value = PersonGroup.AddGroup.class) @RequestBody PersonGroup person) {
		return Result.buildSuccess(person);
	}

	// 指定UpdateGroup分组校验
	@PutMapping("/person")
	public Result updatePerson(@Validated(value = PersonGroup.updateGroup.class) @RequestBody PersonGroup person) {
		return Result.buildSuccess(person);
	}
}
  • 校验方法添加groups的值来指定分组,只有使用 @Validated注解的value的值指定这个分组时,开会开启注解的校验数据的功能

@Validated分组校验顺序

  • 默认情况下,分组间的约束是无序的,但是在一些特殊的情况下可能对分组间的校验有一定的顺序

    • 比如第二组的分组的约束的校验需要依赖第一组的稳定状态来进行,此时,要求分组间的约束校验一定要有顺序
  • 分组校验顺序通过使用 @GroupSequence注解实现
  • 示例:
@Data
public class UserGroupSequence {

	public interface FirstGroup {}

	public interface SecondGroup {}

	// 使用GroupSequence定义分组校验顺序:按照FirstGroup,SecondGroup分组顺序进行校验
	@GroupSequence({FirstGroup.class, SecondGroup.class})
	public interface Group {}

	@NotEmpty(message = "用户ID必须提交!", group = FirstGroup.class)
	private String userId;

	@NotEmpty(message = "用户姓名必须提交!", group = FirstGroup.class)
	@Size(min = 2, max = 8, message = "用户姓名的长度在2~8之间", goup = Second.class)
	private String userName;
} 
@RestController
@RequestMapping("/user")
public class UserGroupSequenceController {
	// 这里方法中@Validated注解value的值是Group.class
	@PostMapping("/user")
	public Result addGroup(@Validated(value = Group.class) @RequestBody UserGroupSequence user) {
		return Result.buildSuccess(user);
	}
}
  • 使用 @GroupSequence注解指定分组校验顺序后,第一组分组的约束的校验没有通过后,就不会进行第二组分组的约束的校验

@Validated非实体类校验

  • 在非实体类上添加 @Validated注解对非实体类进行校验
@Validated
public class AnnotationController {

	@GetMapping("/person")
	public Result getAge(@Range(min = 2, max = 8, message = "年龄在3~8岁!") @RequestParam int age) {
		return Result.buildSuccess(age);
	}
}
  • GlobalExceptionHandler中添加全局统一异常处理方法:
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public Result resolveConstraintViolationException(ConstraintVilationException exception) {
	Set<ConstraintVilation<?>> constraintVilations = exception.getConstraintVilations();
	// 处理异常信息
	if (!CollectionUtils.isEmpty(constraintVilations)) {
		StringBuilder messageBuilder = new StringBuilder();
		for (ConstraintVilation constraintViolation : constraintVilations) {
			messageBuilder.append(constraintVilation.getMessage()).append(",");
		}
		String errorMessage = messageBuilder.toString();
		if (errorMessage.length() > 1) {
			errorMessage.substring(0, errorMessage.length() - 1);
		}
		return Result.builderFailure(ErrorStatus.ILLEGAL_DATA.getCode(), errorMessage);
	}
	return Result.builderFailure(ErrorStatus.ILLEGAL_DATA.getCode(), exception.getMessage())
}

@PathVariable

  • @PathVariable的作用: 用来指定请求URL路径里面的变量
  • @PathVariable@RequestParam的区别:
    • @PathVariable用来指定请求URL中的变量
    • @RequestParam用来获取静态的URL请求入参

正则表达式校验

  • 使用正则表达式校验 @PathVariable指定的路径变量
// 请求路径中的id必须是数字,否则寻找不到这个路径404
@GetMapping("/user/{id:\\d+}")
public Result getId(@PathVariable(name="id") String userId) {
	return Result.buildSuccess(userId);
}

继承BasicErrorController类

  • @ControllerAdvice注解只能处理进入控制器方法抛出的异常
  • BasicErrorController接口可以处理全局异常
  • @PathVariable路径校验异常不是控制器方法抛出的,此时还没有进入控制器方法:
    • BasicErrorController处理异常,比如404异常时,会跳转到 /error路径,此时会返回错误的html页面
    • 为了保证返回结果统一,继承BasicErrorController类,重写BasicErrorController接口中的错误处理方法
@RestController
public class PathErrorController extends BasicErrorController {

	@Autowired
	public PathErrorController(ErrorAttributes errorAttributes, ServerProperties serverProperties, List<ErrorViewResolver> errorViewResolvers) {
		super(errorAttributes, serverProperties.getError(), errorViewResolvers);
	}

	/**
	 * 处理html请求
	 */
	@Override
	public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
		HttpStatus status = getStatus(request);
		Map<String, Object> model = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML));
		ModelAndView modelAndView = new ModelAndView("pathErrorPage", model, status);
		return modelAndView;
	}

	/**
	 * 处理json请求
	 */
	@Override
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));

		Map<String, Object> responseBody = new HashMap<>(8);
		responseBody.put("success", false);
		responseBody.put("code", body.get("status"));
		responseBody.put("message", body.get("error")); 

		return new ResponseEntity<>(responseBody, HttpStatus.OK);
	}
} 

自定义校验注解

  • 使用场景:

    • 对某一个只能输入指定值的字段进行校验. 此时需要使用自定义注解实现
  • 定义自定义的注解 @Show :
@Documented
@Constraint(validateBy = {Show.ShowConstraintValidator.class})
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Rentation(RUNTIME)
public @interface Show {
	String message() default "{com.oxford.annotation.Show.message}";

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

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

	int[] value();

	class ShowConstraintValidator implements ConstraintValidator<Show, Integer> {

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

		/**
		 * 初始化操作
		 * 获取value属性指定的数字,保存到Set集合中
		 */
		@Override
		public void initilize(Show constraintAnnotation) {
			int[] value = constraintAnnotation.value();
			for (int v : value) {
				set.add(i);
			}
		}	

		@Override
		public boolean isValid(Integer value, ConstraintValidatorContext context) {
			return set.contains(value);
		}
	}
}
  • 注意点:

    • @Constraint注解:

      • 将自定义的注解和实现的校验类联系起来
    • 自定义校验注解类需要实现ConstraintValidator<A extends Annotation, T> 接口
      • 接口中第一个泛型参数表示的是自定义注解类
      • 接口中第二个泛型参数表示的是校验的属性的值的类型
    • initialize() 方法:
      • 获取到自定义注解中的相关的数据
    • isValid() 方法:
      • 实现自定义的校验逻辑
      • 返回boolean类型的校验结果
  • 自定义注解的使用:
@Data
public class AnnotationQuery {

	@Show(value = {0, 1}, message = "数值只能是0或者1")
	private Integer isShow;
}
@PostMapping("/annotation")
public Result addAnnotation(@Validated @RequestBody AnnotationQuery annotation) {
	return Result.buildSuccess(annotation);
}

到此这篇关于Java中的三种校验注解的使用(@Valid,@Validated和@PathVariable)的文章就介绍到这了,更多相关Java 校验注解内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • javax.validation自定义日期范围校验注解操作

    实际项目中经常需要对传入的日期时间进行判断,如是否为一年内,几个月之内,几天前,几天之内等等的需求. 如要求前端传入的日期是要为当前日期一年内的某个日期,基于jdk8的LocalDateTime or LocalDate等常用的做法如下: // 前端传字符串如'2020-07-13 09:09:09' springmvc接收并转换为LocalDateTime类型 @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd

  • Java如何使用JSR303校验数据与自定义校验注解

    一.自带校验注解实现数据校验 1.web项目导入依赖 <!-- 该依赖默认导入了 hibernate-validator 所以不需要再单独导入 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> 下图可以看到spring-boot

  • Spring的@Validation和javax包下的@Valid区别以及自定义校验注解

    1.后台参数校验 Spring Validation验证框架对参数的验证机制提供了@Validated(Spring JSR-303规范,是标准JSR-303的一个变种),javax提供了@Valid(标准JSR-303规范),配合BindingResult可以直接提供参数验证结果 spring提供的验证:org.springframework.validation.annotation.Validated; javax提供的验证:javax.validation.Valid; 在检验Contr

  • java自定义注解实现前后台参数校验的实例

    其实是可以通过@Constraint来限定自定义注解的方法. @Constraint(validatedBy = xxxx.class) 下面是我做的 java自定义注解实现前后台参数校验 的代码示例 对这个感兴趣的,请好好看,好好学: package sonn.sonnannotation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.anno

  • Java中的三种校验注解的使用(@Valid,@Validated和@PathVariable)

    目录 @Valid和@Validated @Valid和@Validated比较 @Valid高级使用 @Valid级联校验 @Validated高级使用 @Validated分组校验 @Validated分组校验顺序 @Validated非实体类校验 @PathVariable 正则表达式校验 继承BasicErrorController类 自定义校验注解 @Valid和@Validated @Valid和@Validated比较 相同点: @Valid注解和 @Validated注解都是开启

  • Java中的三种标准注解和四种元注解说明

    目录 Java的三种标准注解和四种元注解 先来说说什么是注解 Java内置了三种注解,定义在java.lang中的注解 Java除了内置了三种标准注解,还有四种元注解 元注解和自己写一个注解 一.元注解 二.自己写注解 Java的三种标准注解和四种元注解 先来说说什么是注解 注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便地使用这些数据. 注解的语法比较简单,除了@符号的使用之外,它基本与Java固有的语法一致. Java内置了三种注解,定义在

  • java中的三种取整函数总结

    如下所示: 1. 舍掉小数取整:Math.floor(3.5)=3 2. 四舍五入取整:Math.rint(3.5)=4 3. 进位取整:Math.ceil(3.1)=4 以上这篇java中的三种取整函数总结就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我们.

  • 详解Java 中的三种代理模式

    代理模式 代理(Proxy)是一种设计模式,提供了对目标对象另外的访问方式;即通过代理对象访问目标对象.这样做的好处是:可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能. 这里使用到编程中的一个思想:不要随意去修改别人已经写好的代码或者方法,如果需改修改,可以通过代理的方式来扩展该方法. 举个例子来说明代理的作用:假设我们想邀请一位明星,那么并不是直接连接明星,而是联系明星的经纪人,来达到同样的目的.明星就是一个目标对象,他只要负责活动中的节目,而其他琐碎的事情就交给他的代理

  • 详解Java中的三种流程控制语句

    目录 顺序语句 选择语句 if else的嵌套 switch case default 循环语句 for for in while do while break continue 顺序语句 顺序顾名思义就是程序自上而下执行 public class User { public static void main(String[] args) { String name = "hacker"; int age = 18; String happy = "学习Java";

  • Java spring的三种注入方式详解流程

    目录 设置Spring的作用域 自动注入 @Primary Qualifier @ComponentScan不同的配置对性能的影响 懒加载 三种注入方式 字段注入(IDEA 会提示不推荐) 字段注入的bean类外部不可见 循环依赖问题 构造器注入(官方推荐) set方法注入 设置Spring的作用域 或者使用枚举值设置 单例和多里使用场景 自动注入 @Primary 一个接口有多个实现被spring管理吗,在依赖注入式,spring会不知道注入哪个实现类就会抛出NoUniqueBeanDefin

  • Java Spring Dubbo三种SPI机制的区别

    目录 前言 SPI 有什么用?​ JDK SPI​ Dubbo SPI Spring SPI​ 对比​ 前言 SPI 全称为 Service Provider Interface,是一种服务发现机制.SPI 的本质是将接口实现类的全限定名配置在文件中,并由服务加载器读取配置文件,加载实现类.这样可以在运行时,动态为接口替换实现类.正因此特性,我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能. 本文主要是特性 & 用法介绍,不涉及源码解析(源码都很简单,相信你一定一看就懂) SPI 有什

  • 使用maven运行Java Main的三种方法解析

    maven使用exec插件运行java main方法,以下是3种不同的操作方式. 一.从命令行运行 1.运行前先编译代码,exec:java不会自动编译代码,你需要手动执行mvn compile来完成编译. mvn compile 2.编译完成后,执行exec运行main方法. 不需要传递参数: mvn exec:java -Dexec.mainClass="com.vineetmanohar.module.Main" 需要传递参数: mvn exec:java -Dexec.main

  • 浅谈Java中的四种引用方式的区别

    强引用.软引用.弱引用.虚引用的概念 强引用(StrongReference) 强引用就是指在程序代码之中普遍存在的,比如下面这段代码中的object和str都是强引用: Object object = new Object(); String str = "hello"; 只要某个对象有强引用与之关联,JVM必定不会回收这个对象,即使在内存不足的情况下,JVM宁愿抛出OutOfMemory错误也不会回收这种对象. 比如下面这段代码: public class Main { publi

  • Struts2中Action三种接收参数形式与简单的表单验证功能

    有了前几篇的基础,相信大家对于Struts2已经有了一个很不错的认识,本篇我将为大家介绍一些关于Action接收参数的三种形式,以及简单的表单验证实现,下面进入正题,首先我们一起先来了解一下最基本的Action接收参数的形式,直接在我们的Action类中添加成员变量,这样就可以完成Action接收参数的操作,具体内容详见代码展示: 这里我们以登录验证为例,进行代码展示,首先是我们的Action类: /*** * 最基本的接收参数形式 * @author jho * http://localhos

随机推荐