javax-validation 后台参数验证的使用详解_javax.validation maven-程序员宅基地

技术标签: java  

一、前言

在后台开发过程中,对参数的校验成为开发环境不可缺少的一个环节。比如参数不能为null,email那么必须符合email的格式,如果手动进行if判断或者写正则表达式判断无意开发效率太慢,在时间、成本、质量的博弈中必然会落后。所以把校验层抽象出来是必然的结果,下面说下几种解决方案。

二、几种解决方案

1、struts2的valid可以通过配置xml,xml中描述规则和返回的信息,这种方式比较麻烦、开发效率低,不推荐

2、validation bean 是基于JSR-303标准开发出来的,使用注解方式实现,及其方便,但是这只是一个接口,没有具体实现.Hibernate Validator是一个hibernate独立的包,可以直接引用,他实现了validation bean同时有做了扩展,比较强大 ,实现图如下:

点此查看中文官方手册

3、oval 是一个可扩展的Java对象数据验证框架,验证的规则可以通过配置文件、Annotation、POJOs 进行设定。可以使用纯 Java 语言、JavaScript 、Groovy 、BeanShell 等进行规则的编写,本次不过多讲解

三、bean validation 框架验证介绍

bean validation 包放在maven上维护,最新包的坐标如下:

1

2

3

4

5

6

7

8

9

<dependency>

 

  <groupId>javax.validation</groupId>

 

  <artifactId>validation-api</artifactId>

 

  <version>1.1.0.Final</version>

 

</dependency>

 点击这里查看最新的坐标地址

下载之后打开这个包,有个package叫constraints,里面放的就是验证的的注解:

  

下面开始用代码实践一下:

1、定义一个待验证的bean:Student.java

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

package com.shishang;

 

import javax.validation.constraints.*;

import java.io.Serializable;

import java.math.BigDecimal;

import java.util.Date;

 

public class Student implements Serializable {

 

 

  @NotNull(message = "名字不能为空")

  private String name;

 

  @Size(min = 6,max = 30,message = "地址应该在6-30字符之间")

  private String address;

 

  @DecimalMax(value = "100.00",message = "体重有些超标哦")

  @DecimalMin(value = "60.00",message = "多吃点饭吧")

  private BigDecimal weight;

 

  private String friendName;

  @AssertTrue

  private Boolean isHaveFriend(){

    return friendName != null?true:false;

  }

 

  @Future(message = "生日必须在当前实践之前")

  private Date birthday;

 

  @Pattern(regexp = "^(.+)@(.+)$",message = "邮箱的格式不合法")

  private String email;

 

 

  public String getName() {

    return name;

  }

 

  public void setName(String name) {

    this.name = name;

  }

 

  public String getAddress() {

    return address;

  }

 

  public void setAddress(String address) {

    this.address = address;

  }

 

  public BigDecimal getWeight() {

    return weight;

  }

 

  public void setWeight(BigDecimal weight) {

    this.weight = weight;

  }

 

  public String getFriendName() {

    return friendName;

  }

 

  public void setFriendName(String friendName) {

    this.friendName = friendName;

  }

 

  public Date getBirthday() {

    return birthday;

  }

 

  public void setBirthday(Date birthday) {

    this.birthday = birthday;

  }

 

  public String getEmail() {

    return email;

  }

 

  public void setEmail(String email) {

    this.email = email;

  }

}

2、测试类:StudentTest.java

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

package com.use;

 

import javax.validation.ConstraintViolation;

import javax.validation.Validation;

import javax.validation.Validator;

import javax.validation.ValidatorFactory;

import java.io.Serializable;

import java.math.BigDecimal;

import java.util.ArrayList;

import java.util.Date;

import java.util.List;

import java.util.Set;

 

public class StudentTest implements Serializable {

  public static void main(String[] args) {

    Student xiaoming = getBean();

    List<String> validate = validate(xiaoming);

    validate.forEach(row -> {

      System.out.println(row.toString());

    });

 

  }

 

  private static Student getBean() {

    Student bean = new Student();

    bean.setName(null);

    bean.setAddress("北京");

    bean.setBirthday(new Date());

    bean.setFriendName(null);

    bean.setWeight(new BigDecimal(30));

    bean.setEmail("xiaogangfan163.com");

    return bean;

  }

 

  private static ValidatorFactory factory = Validation.buildDefaultValidatorFactory();

 

  public static <T> List<String> validate(T t) {

    Validator validator = factory.getValidator();

    Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);

 

    List<String> messageList = new ArrayList<>();

    for (ConstraintViolation<T> constraintViolation : constraintViolations) {

      messageList.add(constraintViolation.getMessage());

    }

    return messageList;

  }

}

3、运行testValidation()方法,输处如下:

  1. 地址应该在6-30字符之间
  2. 邮箱的格式不合法
  3. 生日必须在当前时间之前
  4. 多吃点饭吧
  5. 名字不能为空

4、总结

  1. 像@NotNull、@Size等比较简单也易于理解,不多说
  2. 因为bean validation只提供了接口并未实现,使用时需要加上一个provider的包,例如hibernate-validator
  3. @Pattern 因为这个是正则,所以能做的事情比较多,比如中文还是数字、邮箱、长度等等都可以做
  4. @AssertTRue 这个与其他的校验注解有着本质的区别,这个注解适用于多个字段。例子中isHaveFriend方法依赖friendName字段校验
  5. 验证的api是经过我加工了一下,这样可以批量返回校验的信息
  6. 有时我们需要的注解可能没有提供,这时候就需要自定义注解,写实现类,下面说一下自定义注解的使用

四、自定义bean validation 注解验证

有时框架自带的没法满足我们的需求,这时就需要自己动手丰衣足食了,恩恩 ,这个不难,下面说下。

这个例子验证字符串是大写还是小写约束标注,代码如下:

1、枚举类型CaseMode, 来表示大写或小写模式

1

2

3

4

5

6

7

8

9

10

package com.defineconstrain;

 

/**

 * created by xiaogangfan

 * on 16/10/25.

 */

public enum CaseMode {

  UPPER,

  LOWER;

}

2、定义一个CheckCase的约束标注

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

package com.defineconstrain;

 

/**

 * created by xiaogangfan

 * on 16/10/25.

 */

import static java.lang.annotation.ElementType.*;

import static java.lang.annotation.RetentionPolicy.*;

 

import java.lang.annotation.Documented;

import java.lang.annotation.Retention;

import java.lang.annotation.Target;

 

import javax.validation.Constraint;

import javax.validation.Payload;

 

@Target( { METHOD, FIELD, ANNOTATION_TYPE })

@Retention(RUNTIME)

@Constraint(validatedBy = CheckCaseValidator.class)

@Documented

public @interface CheckCase {

 

  String message() default "{com.mycompany.constraints.checkcase}";

 

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

 

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

 

  CaseMode value();

 

}

3、约束条件CheckCase的验证器

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

package com.defineconstrain;

 

/**

 * created by xiaogangfan

 * on 16/10/25.

 */

import javax.validation.ConstraintValidator;

import javax.validation.ConstraintValidatorContext;

 

public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {

 

  private CaseMode caseMode;

 

  public void initialize(CheckCase constraintAnnotation) {

    this.caseMode = constraintAnnotation.value();

  }

 

  public boolean isValid(String object, ConstraintValidatorContext constraintContext) {

 

    if (object == null)

      return true;

 

    if (caseMode == CaseMode.UPPER)

      return object.equals(object.toUpperCase());

    else

      return object.equals(object.toLowerCase());

  }

 

}

4、在Student.java中增加一个属性

1

2

@CheckCase(value = CaseMode.LOWER,message = "名字的拼音需要小写")

private String spellName;

5、在StudentTest.java的getBean()方法中增加一行

1

bean.setSpellName("XIAOGANGFAN");

6、运行testValidation()方法,输处如下:

  1. 地址应该在6-30字符之间
  2. 邮箱的格式不合法
  3. 生日必须在当前时间之前
  4. 多吃点饭吧
  5. 名字的拼音需要小写
  6. 名字不能为空

7、说明新增的约束生效了,大功告成

代码下载地址:[email protected]:xiaogangfan/vaidation.git

命令: git clone [email protected]:xiaogangfan/vaidation.git

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

 

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/zcywell/article/details/115401081

智能推荐

攻防世界_难度8_happy_puzzle_攻防世界困难模式攻略图文-程序员宅基地

文章浏览阅读645次。这个肯定是末尾的IDAT了,因为IDAT必须要满了才会开始一下个IDAT,这个明显就是末尾的IDAT了。,对应下面的create_head()代码。,对应下面的create_tail()代码。不要考虑爆破,我已经试了一下,太多情况了。题目来源:UNCTF。_攻防世界困难模式攻略图文

达梦数据库的导出(备份)、导入_达梦数据库导入导出-程序员宅基地

文章浏览阅读2.9k次,点赞3次,收藏10次。偶尔会用到,记录、分享。1. 数据库导出1.1 切换到dmdba用户su - dmdba1.2 进入达梦数据库安装路径的bin目录,执行导库操作  导出语句:./dexp cwy_init/[email protected]:5236 file=cwy_init.dmp log=cwy_init_exp.log 注释:   cwy_init/init_123..._达梦数据库导入导出

js引入kindeditor富文本编辑器的使用_kindeditor.js-程序员宅基地

文章浏览阅读1.9k次。1. 在官网上下载KindEditor文件,可以删掉不需要要到的jsp,asp,asp.net和php文件夹。接着把文件夹放到项目文件目录下。2. 修改html文件,在页面引入js文件:<script type="text/javascript" src="./kindeditor/kindeditor-all.js"></script><script type="text/javascript" src="./kindeditor/lang/zh-CN.js"_kindeditor.js

STM32学习过程记录11——基于STM32G431CBU6硬件SPI+DMA的高效WS2812B控制方法-程序员宅基地

文章浏览阅读2.3k次,点赞6次,收藏14次。SPI的详情简介不必赘述。假设我们通过SPI发送0xAA,我们的数据线就会变为10101010,通过修改不同的内容,即可修改SPI中0和1的持续时间。比如0xF0即为前半周期为高电平,后半周期为低电平的状态。在SPI的通信模式中,CPHA配置会影响该实验,下图展示了不同采样位置的SPI时序图[1]。CPOL = 0,CPHA = 1:CLK空闲状态 = 低电平,数据在下降沿采样,并在上升沿移出CPOL = 0,CPHA = 0:CLK空闲状态 = 低电平,数据在上升沿采样,并在下降沿移出。_stm32g431cbu6

计算机网络-数据链路层_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输-程序员宅基地

文章浏览阅读1.2k次,点赞2次,收藏8次。数据链路层习题自测问题1.数据链路(即逻辑链路)与链路(即物理链路)有何区别?“电路接通了”与”数据链路接通了”的区别何在?2.数据链路层中的链路控制包括哪些功能?试讨论数据链路层做成可靠的链路层有哪些优点和缺点。3.网络适配器的作用是什么?网络适配器工作在哪一层?4.数据链路层的三个基本问题(帧定界、透明传输和差错检测)为什么都必须加以解决?5.如果在数据链路层不进行帧定界,会发生什么问题?6.PPP协议的主要特点是什么?为什么PPP不使用帧的编号?PPP适用于什么情况?为什么PPP协议不_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输

软件测试工程师移民加拿大_无证移民,未受过软件工程师的教育(第1部分)-程序员宅基地

文章浏览阅读587次。软件测试工程师移民加拿大 无证移民,未受过软件工程师的教育(第1部分) (Undocumented Immigrant With No Education to Software Engineer(Part 1))Before I start, I want you to please bear with me on the way I write, I have very little gen...

随便推点

Thinkpad X250 secure boot failed 启动失败问题解决_安装完系统提示secureboot failure-程序员宅基地

文章浏览阅读304次。Thinkpad X250笔记本电脑,装的是FreeBSD,进入BIOS修改虚拟化配置(其后可能是误设置了安全开机),保存退出后系统无法启动,显示:secure boot failed ,把自己惊出一身冷汗,因为这台笔记本刚好还没开始做备份.....根据错误提示,到bios里面去找相关配置,在Security里面找到了Secure Boot选项,发现果然被设置为Enabled,将其修改为Disabled ,再开机,终于正常启动了。_安装完系统提示secureboot failure

C++如何做字符串分割(5种方法)_c++ 字符串分割-程序员宅基地

文章浏览阅读10w+次,点赞93次,收藏352次。1、用strtok函数进行字符串分割原型: char *strtok(char *str, const char *delim);功能:分解字符串为一组字符串。参数说明:str为要分解的字符串,delim为分隔符字符串。返回值:从str开头开始的一个个被分割的串。当没有被分割的串时则返回NULL。其它:strtok函数线程不安全,可以使用strtok_r替代。示例://借助strtok实现split#include <string.h>#include <stdio.h&_c++ 字符串分割

2013第四届蓝桥杯 C/C++本科A组 真题答案解析_2013年第四届c a组蓝桥杯省赛真题解答-程序员宅基地

文章浏览阅读2.3k次。1 .高斯日记 大数学家高斯有个好习惯:无论如何都要记日记。他的日记有个与众不同的地方,他从不注明年月日,而是用一个整数代替,比如:4210后来人们知道,那个整数就是日期,它表示那一天是高斯出生后的第几天。这或许也是个好习惯,它时时刻刻提醒着主人:日子又过去一天,还有多少时光可以用于浪费呢?高斯出生于:1777年4月30日。在高斯发现的一个重要定理的日记_2013年第四届c a组蓝桥杯省赛真题解答

基于供需算法优化的核极限学习机(KELM)分类算法-程序员宅基地

文章浏览阅读851次,点赞17次,收藏22次。摘要:本文利用供需算法对核极限学习机(KELM)进行优化,并用于分类。

metasploitable2渗透测试_metasploitable2怎么进入-程序员宅基地

文章浏览阅读1.1k次。一、系统弱密码登录1、在kali上执行命令行telnet 192.168.26.1292、Login和password都输入msfadmin3、登录成功,进入系统4、测试如下:二、MySQL弱密码登录:1、在kali上执行mysql –h 192.168.26.129 –u root2、登录成功,进入MySQL系统3、测试效果:三、PostgreSQL弱密码登录1、在Kali上执行psql -h 192.168.26.129 –U post..._metasploitable2怎么进入

Python学习之路:从入门到精通的指南_python人工智能开发从入门到精通pdf-程序员宅基地

文章浏览阅读257次。本文将为初学者提供Python学习的详细指南,从Python的历史、基础语法和数据类型到面向对象编程、模块和库的使用。通过本文,您将能够掌握Python编程的核心概念,为今后的编程学习和实践打下坚实基础。_python人工智能开发从入门到精通pdf