Spring boot进行参数校验的方法实例详解

 更新时间:2018年05月05日 15:06:10   作者:大神带我来搬砖  
这篇文章主要介绍了Spring boot进行参数校验的方法实例详解,非 常不错,具有参考借鉴价值,需要的朋友参考下吧

Spring boot开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验,比如非空、整数值的范围、字符串的长度、日期、邮箱等等。Spring支持JSR-303 Bean Validation API,可以方便的进行校验。

使用注解进行校验

先定义一个form的封装对象

class RequestForm {
  @Size(min = 1, max = 5)
  private String name;
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
}

其中name这个字段用Size注解限制长度1到5。Size是javax.validation包中的constraint注解。

 在使用时用@Valid注解表示要校验这个bean。

  @ResponseBody
  @GetMapping(value = "bean")
  public String validate(@Valid RequestForm request) {
    System.out.println(request.getName());
    return "OK";
  }

自定义注解

如果内置的注解不够用,可以自定义注解。

 比如先定义一个注解NameConstraint,限制name字段只能从特定数据中选取。

@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = NameConstraintValidator.class)
@interface NameConstraint {
  String[] allowedValues();
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
  String message();
}

其中allowedValues表示合法的取值范围,message是校验失败的显示信息。

message、groups、payload是hibernate validator要求的字段,想了解的请看官方文档

 再定义一个validator做真正的校验

class NameConstraintValidator implements ConstraintValidator<NameConstraint, String> {
  private String[] validValues;
  @Override
  public void initialize(NameConstraint constraintAnnotation) {
    validValues = constraintAnnotation.allowedValues();
  }
  @Override
  public boolean isValid(String value, ConstraintValidatorContext context) {
    for (String s : this.validValues) {
      if (s.equals(value)) {
        return true;
      }
    }
    return false;
  }
}

在form bean中按如下方式使用

class RequestFormWithCustomConstraint {
  @NameConstraint(allowedValues = { "bar", "foo" }, message = "只允许bar,foo")
  private String name;
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
}

直接校验参数

只有一个name字段,不想封装一个对象怎么办?可以直接校验该参数

@Controller
@Validated
@RequestMapping(value = "validator")
public class ParameterValidatorDemoController {
  @ResponseBody
  @GetMapping(value = "simple")
  public String validateParameter(@Size(min = 1, max = 5) String name) {
    System.out.println(name);
    return "OK";
  }
}

controller上面的@Validated注解则告诉spring需要扫描这个类,来检查其中的constraint注解。

详细信息可以参考官方文档有关章节

https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-validation
https://docs.spring.io/spring/docs/4.3.16.RELEASE/spring-framework-reference/htmlsingle/#validation-beanvalidation

代码在github

https://github.com/kabike/spring-boot-demo

总结

以上所述是小编给大家介绍的Spring boot进行参数校验的方法实例详解,希望对大家有所帮助,如果大家有任何疑问欢迎给我留言,小编会及时回复大家的!

相关文章

  • 深入理解Java new String()方法

    深入理解Java new String()方法

    今天给大家带来的是关于Java的相关知识,文章围绕着Java new String()展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • Java流形式返回前端的实现示例

    Java流形式返回前端的实现示例

    ​ Java后端开发项目时,需要给前端传一些数据,本文主要介绍了Java流形式返回前端的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • 使用IntelliJ IDEA2020.2.2 x64 新建java项目并且输出Hello World

    使用IntelliJ IDEA2020.2.2 x64 新建java项目并且输出Hello World

    这篇文章主要介绍了使用IntelliJ IDEA2020.2.2 x64 新建java项目并且输出Hello World,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • 一步步教你JAVA如何优化Elastic Search

    一步步教你JAVA如何优化Elastic Search

    想要榨干Java操作Elasticsearch的所有性能潜力?本指南将一步步教你如何优化Java与Elasticsearch的交互!从此,提升ES查询速度、降低资源消耗不再是难题,赶快一起来探索Java Elasticsearch优化的秘诀吧!
    2024-01-01
  • Java8新特性之默认方法和静态方法

    Java8新特性之默认方法和静态方法

    这篇文章主要给大家介绍了关于Java8新特性之默认方法和静态方法的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Spring中实现的三种异步流式接口方法

    Spring中实现的三种异步流式接口方法

    在现代Web开发中,接口超时是一个常见的问题,尤其是在处理耗时操作时,传统的同步接口在处理长时间任务时会阻塞请求线程,从而影响系统的响应能力,本文将详细讲解Spring中实现的三种异步流式接口方法,需要的朋友可以参考下
    2024-10-10
  • idea中database不显示问题的解决

    idea中database不显示问题的解决

    这篇文章主要介绍了idea中database不显示问题的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • SpringBoot将Bean放入容器的五种方式

    SpringBoot将Bean放入容器的五种方式

    这篇文章给大家介绍了SpringBoot将Bean放入容器的五种方式,文中通过代码示例给大家介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-02-02
  • Java实现动态创建类操作示例

    Java实现动态创建类操作示例

    这篇文章主要介绍了Java实现动态创建类操作,结合完整示例形式分析了Java动态创建类的具体步骤与相关操作技巧,需要的朋友可以参考下
    2020-02-02
  • Java TreeSet实现学生按年龄大小和姓名排序的方法示例

    Java TreeSet实现学生按年龄大小和姓名排序的方法示例

    这篇文章主要介绍了Java TreeSet实现学生按年龄大小和姓名排序的方法,涉及java类型转换、遍历、比较等相关操作技巧,需要的朋友可以参考下
    2017-09-09

最新评论