详解如何在Spring Boot项目使用参数校验

 更新时间:2017年06月05日 14:58:21   作者:葬月魔帝  
本篇文章主要介绍了如何在Spring Boot项目使用参数校验,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验,比如非空,非null,整数值的范围,字符串的个数,日期,邮箱等等。最常见的就是我们直接写代码校验,这样以后比较繁琐,而且不够灵活。

Bean Validation 1.0(JSR-303)是一个校验规范,在spring Boot项目由于自带了hibernate validator 5(http://hibernate.org/validator/)实现,所以我们可以非常方便的使用这个特性 。

核心的pom依赖:

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

首先,需要我们声明一个Bean,注入校验器到Spring Boot的运行环境

@Configuration
@EnableAutoConfiguration
public class FactoryConfig {
  
  final static Logger logger= LoggerFactory.getLogger(FactoryConfig.class);
 
  @Bean
  public MethodValidationPostProcessor methodValidationPostProcessor(){
   return new MethodValidationPostProcessor();
  }
  
  }

校验常用的注解如下:

@AssertFalse 校验false
@AssertTrue 校验true
@DecimalMax(value=,inclusive=) 小于等于value,
inclusive=true,是小于等于
@DecimalMin(value=,inclusive=) 与上类似
@Max(value=) 小于等于value
@Min(value=) 大于等于value
@NotNull 检查Null
@Past 检查日期
@Pattern(regex=,flag=) 正则
@Size(min=, max=) 字符串,集合,map限制大小
@Valid 对po实体类进行校验

下面看一个使用例子:

package hello;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class PersonForm {

  //名字不能为空,而且长度必须在2和30之间
  @NotNull(message = "名称不能为空")
  @Size(min=2, max=30, message = "名字长度必须在2和30之间")
  private String name;
  
  //年龄不能为空,而且必须大于等于18岁
  @NotNull
  @Min(18)
  private Integer age;

  public String getName() {
    return this.name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public Integer getAge() {
    return age;
  }

  public void setAge(Integer age) {
    this.age = age;
  }

  public String toString() {
    return "Person(Name: " + this.name + ", Age: " + this.age + ")";
  }
}

接着看下如何在Controller层使用

//非实体类参数可以直接使用注解
 @GetMapping("/check")
@ResponseBody
public String check(@Min(0,message = "kpId必须大于等于0") @RequestParam int kpId,@RequestParam int level) {
    return "ok";
}
  //实体类注解校验使用@Valid
  @PostMapping("/")
  public String checkPersonInfo(@Valid PersonForm personForm, BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
      return "form";
    }
    return "redirect:/results";
  }

注意上面的Spring提供的BindingResult是错误结果的一个封装,我们可以在web页面中通过这个对象拿到详细的错误信息,

<td th:if="${#fields.hasErrors('age')}" th:errors="*{age}">Age Error</td>

总结:

通过使用注解来快速检验传入的web参数还是非常简洁强大的,这里仅仅列举了一小部分的校验的知识,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • spring中的DI步骤详解

    spring中的DI步骤详解

    本文主要介绍了bean的装配实现过程,通常对于简单数据类型数据初始主要在获得对象后,使用setter方法完成,所谓的装配主要是复杂数据类型的依赖注入,感兴趣的朋友一起看看吧
    2023-11-11
  • Java 利用枚举实现接口进行统一管理

    Java 利用枚举实现接口进行统一管理

    这篇文章主要介绍了Java 利用枚举实现接口进行统一管理,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • JRebel在线激活破解实现教程

    JRebel在线激活破解实现教程

    这篇文章主要介绍了JRebel在线激活破解实现教程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-12-12
  • Java Fluent Mybatis 项目工程化与常规操作详解流程篇 上

    Java Fluent Mybatis 项目工程化与常规操作详解流程篇 上

    Java中常用的ORM框架主要是mybatis, hibernate, JPA等框架。国内又以Mybatis用的多,基于mybatis上的增强框架,又有mybatis plus和TK mybatis等。今天我们介绍一个新的mybatis增强框架 fluent mybatis
    2021-10-10
  • 关于json序列化(javaBean转Json的细节处理)

    关于json序列化(javaBean转Json的细节处理)

    这篇文章主要介绍了关于json序列化(javaBean转Json的细节处理),具有很好的参考价值,希望对大家有所帮助。
    2022-03-03
  • 基于feign传参MultipartFile问题解决

    基于feign传参MultipartFile问题解决

    这篇文章主要介绍了基于feign传参MultipartFile问题解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Feign+mybatisplus搭建项目遇到的坑及解决

    Feign+mybatisplus搭建项目遇到的坑及解决

    这篇文章主要介绍了Feign+mybatisplus搭建项目遇到的坑及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • Java8中Stream使用的一个注意事项

    Java8中Stream使用的一个注意事项

    最近在工作中发现了对于集合操作转换的神器,java8新特性 stream,但在使用中遇到了一个非常重要的注意点,所以这篇文章主要给大家介绍了关于Java8中Stream使用过程中的一个注意事项,需要的朋友可以参考借鉴,下面随着小编来一起学习学习吧。
    2017-11-11
  • SpringBoot集成Swagger2的方法

    SpringBoot集成Swagger2的方法

    这篇文章主要介绍了SpringBoot集成Swagger2的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • 详解Java中的流程控制

    详解Java中的流程控制

    今天带大家复习Java基础知识,文中对Java流程控制作了非常详细的介绍及代码示例,对正在学习Java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05

最新评论