怎么在JAVA中通过自定义注解进行数据验证

怎么在JAVA中通过自定义注解进行数据验证？很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。

自定义验证注解

考虑有一个API，接收一个Student对象，并希望对象里的age域的值是奇数，这时候就可以创建以下注解：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = AgeValidator.class)
public @interface Odd {
String message() default "Age Must Be Odd";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}

其中：

@Target指明这个注解要作用在什么地方，可以是对象、域、构造器等，因为要作用在age域上，因此这里选择FIELD
@Retention指明了注解的生命周期，可以有SOURCE（仅保存在源码中，会被编译器丢弃），CLASS（在class文件中可用，会被VM丢弃）以及RUNTIME（在运行期也被保留），这里选择了生命周期最长的RUNTIME
@Constraint是最关键的，它表示这个注解是一个验证注解，并且指定了一个实现验证逻辑的验证器
message()指明了验证失败后返回的消息，此方法为@Constraint要求
groups()和payload()也为@Constraint要求，可默认为空，详细用途可以查看@Constraint文档

创建验证器

有了注解之后，就需要一个验证器来实现验证逻辑：

public class AgeValidator implements ConstraintValidator<Odd,Integer> {
@Override
public void initialize(Odd constraintAnnotation) {
}

@Override
public boolean isValid(Integer age, ConstraintValidatorContext constraintValidatorContext) {
return age % 2 != 0;
}
}

其中：

验证器有两个类型参数，第一个是所属的注解，第二个是注解作用地方的类型，这里因为作用在age上，因此这里用了Integer
initialize()可以在验证开始前调用注解里的方法，从而获取到一些注解里的参数，这里用不到
isValid()就是判断是否合法的地方

应用注解

注解和验证器创建好之后，就可以使用注解了：

public class Student {
@Odd
private int age;
private String name;

public String getName() {
return name;
}

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

public int getAge() {
return age;
}

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

@RestController
public class StudentResource {
@PostMapping("/student")
public String addStudent(@Valid @RequestBody Student student) {
return "Student Created";
}
}

在需要启用验证的地方加上@Valid注解，这时候如果请求里的Student年龄不是奇数，就会得到一个400响应：

{
"timestamp": "2018-08-15T17:01:44.598+0000",
"status": 400,
"error": "Bad Request",
"errors": [
{
"codes": [
"Odd.student.age",
"Odd.age",
"Odd.int",
"Odd"
],
"arguments": [
{
"codes": [
"student.age",
"age"
],
"arguments": null,
"defaultMessage": "age",
"code": "age"
}
],
"defaultMessage": "Age Must Be Odd",
"objectName": "student",
"field": "age",
"rejectedValue": 12,
"bindingFailure": false,
"code": "Odd"
}
],
"message": "Validation failed for object='student'. Error count: 1",
"path": "/student"
}

也可以手动来处理错误，加上一个BindingResult来接收验证结果即可：

@RestController
public class StudentResource {
@PostMapping("/student")
public String addStudent(@Valid @RequestBody Student student, BindingResult validateResult) {
if (validateResult.hasErrors()) {
return validateResult.getAllErrors().get(0).getDefaultMessage();
}
return "Student Created";
}
}

Java的优点是什么

1. 简单，只需理解基本的概念，就可以编写适合于各种情况的应用程序；2. 面向对象；3. 分布性，Java是面向网络的语言；4. 鲁棒性，java提供自动垃圾收集来进行内存管理，防止程序员在管理内存时容易产生的错误。；5. 安全性，用于网络、分布环境下的Java必须防止病毒的入侵。6. 体系结构中立，只要安装了Java运行时系统，就可在任意处理器上运行。7. 可移植性，Java可以方便地移植到网络上的不同机器。8.解释执行，Java解释器直接对Java字节码进行解释执行。

看完上述内容是否对您有帮助呢？如果还想对相关知识有进一步的了解或阅读更多相关文章，请关注行业资讯频道，感谢您对亿速云的支持。

怎么在JAVA中通过自定义注解进行数据验证

Java的优点是什么

相关推荐