其实JSR303没啥介绍的,大家知道是做校验的就可以了。简书里面是这样说的:SR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation,Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现,除此之外还有一些附加的 constraint。
一切尽在代码中:
快捷创建一个springboot项目
1,pom文件如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.8.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.dwsoft.test</groupId>
<artifactId>test-jsr303</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>test-jsr303</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcore</artifactId>
<version>4.4.13</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.8</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
我用的springboot版本是:<version>2.1.8.RELEASE</version>,如果使用其他版本也可以,但是一定要确保引入了校验包:
2,创建主类,实体类,控制器
主类:
@SpringBootApplication
public class TestJsr303Application {
public static void main(String[] args) {
SpringApplication.run(TestJsr303Application.class, args);
}
}
控制类:
/**
* @author tlk
* @date 2020/8/4-18:36
*/
@RestController
public class TestController {
}
实体类:
package com.dwsoft.test.testjsr303.entity;
import lombok.Data;
import java.io.Serializable;
/**
* @author tlk
* @date 2020/8/4
*/
@Data
public class Brand implements Serializable {
private static final long serialVersionUID = 6249214818970952452L;
/**
* 品牌id
*/
private Long brandId;
/**
* 品牌名
*/
private String name;
/**
* 品牌logo地址
*/
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示;1-显示]
*/
private Integer showStatus;
/**
* 检索首字母
*/
private String firstLetter;
/**
* 排序
*/
private Integer sort;
}
用的是注解@Data,需要安装插件lombok;你也可以不用这个注解,直接写get,set等方法。
统一格式响应封装类:
package com.dwsoft.test.testjsr303.utils;
import org.apache.http.HttpStatus;
import java.util.HashMap;
import java.util.Map;
/**
* 返回数据
*
* @author tlk
*/
public class R extends HashMap<String, Object> {
private static final long serialVersionUID = 1L;
public R() {
put("code", 0);
put("msg", "success");
}
public static R error() {
return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "未知异常,请联系管理员");
}
public static R error(String msg) {
return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
}
public static R error(int code, String msg) {
R r = new R();
r.put("code", code);
r.put("msg", msg);
return r;
}
public static R ok(String msg) {
R r = new R();
r.put("msg", msg);
return r;
}
public static R ok(Map<String, Object> map) {
R r = new R();
r.putAll(map);
return r;
}
public static R ok() {
return new R();
}
public R put(String key, Object value) {
super.put(key, value);
return this;
}
}
开始校验:
1》简简单单的校验
给bean添加校验注解:
开启校验功能@Valid
用postman测试(入参给的是一个空的json串):
这是原始相应,我们可以封装统一格式,并且自定义message
改动如下:
控制器中引入 BindingResult
package com.dwsoft.test.testjsr303.controller;
import com.dwsoft.test.testjsr303.entity.Brand;
import com.dwsoft.test.testjsr303.utils.R;
import org.apache.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author tlk
* @date 2020/8/4
*/
@RestController
public class TestController {
@RequestMapping("/test/jsr303")
public R testJsr303(@Valid @RequestBody Brand brand, BindingResult bindingResult) {
if(bindingResult.hasErrors()){
Map<String,String>map=new HashMap<>();
List<FieldError> fieldErrors = bindingResult.getFieldErrors();
fieldErrors.forEach((item) ->{
String field = item.getField();
String defaultMessage = item.getDefaultMessage();
map.put(field,defaultMessage);
});
return R.error(HttpStatus.SC_BAD_REQUEST,"入参不合法").put("data",map);
}
//业务处理
return R.ok();
}
}
再次测试:
完美!
2》分组校验主要用于表单的添加或者修改进行区分
添加两个接口:
package com.dwsoft.test.testjsr303.valid;
/**
* @author tlk
* @date 2020/8/4-11:08
*/
public interface UpdateGroup {
}
package com.dwsoft.test.testjsr303.valid;
/**
* @author tlk
* @date 2020/8/4-11:08
*/
public interface AddGroup {
}
如果想在添加的时候生效,如下:
测试:
如果只是把bean改成:
测试:
校验没有起作用。
也可这样配置:
正常逻辑添加修改分开写,控制器对应方法只会配置一个分组
只要满足校验规则,就起作用。
注意:如果采用分组校验的形式,对应bean中的属性必须标注采用哪个校验组,不然不起任何校验作用
比如:
正常逻辑添加修改分开写,控制器对应方法只会配置一个分组
测试:
加上分组:
测试:
完美!分组主要看自己的分配逻辑,我这边只是做一个引导!
3》自定义校验:
如显示状态,我们要求在指定的数据中选择
该怎么操作?
a》编写一个自定义的校验注解(可以参照@NotBlank等注解格式)
package com.dwsoft.test.testjsr303.valid;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
/**
* @author tlk
* @date 2020/8/4-14:15
*/
@Documented
@Constraint(
validatedBy = {}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Checkvalue.List.class)
public @interface Checkvalue {
String message() default "{com.dwsoft.test.testjsr303.valid.Checkvalue.message}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
int[] value() default {};
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface List {
Checkvalue[] value();
}
}
这个地方可以创建自己的消息文件(位置:resources/),ValidationMessages.properties,文件名一定要是这个
com.dwsoft.test.testjsr303.valid.Checkvalue.message = "请使用指定值"
b》编写一个自定义的校验器
package com.dwsoft.test.testjsr303.valid;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
/**
* @author tlk
* @date 2020/8/4-14:29
*/
public class CheckValueConstraintValidator implements ConstraintValidator<Checkvalue,Integer> {
private Set<Integer> set=new HashSet<>();
@Override
public void initialize(Checkvalue constraintAnnotation) {
int[] value = constraintAnnotation.value();
if(value!=null && value.length>1){
for (Integer integer : set) {
set.add(integer);
}
}
}
@Override
public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
if(set.contains(integer)) return true;
return false;
}
}
c》关联自定义的校验器和自定义的校验注解
测试:
先修改控制器:
修改bean:
postman:
成功!
这个是配置文件的提示,咱们也可以在bean上再自定义
测试:
校验这一块结束!!!!!!
补充一下全局异常处理:
a》编写异常处理类,使用@ControllerAdvice,使用@ExceptionHandler标注方法可以处理的异常。
package com.dwsoft.test.testjsr303.expection;
import com.dwsoft.test.testjsr303.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.apache.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author tlk
* @date 2020/8/4-15:31
*/
//@ResponseBody
//@ControllerAdvice 合二为一
@RestControllerAdvice
public class MyControllerAdvice {
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public R handleValidExpection(MethodArgumentNotValidException e){
Map<String,String>map=new HashMap<>();
BindingResult bindingResult = e.getBindingResult();
List<FieldError> fieldErrors = bindingResult.getFieldErrors();
fieldErrors.forEach((one)->{
String field = one.getField();
String defaultMessage = one.getDefaultMessage();
map.put(field,defaultMessage);
});
return R.error(HttpStatus.SC_BAD_REQUEST,"入参不合法").put("data",map);
}
//其他异常
@ExceptionHandler(value = Throwable.class)
public R handleOtherExpection(Throwable throwable){
return R.error();
}
}
控制器注释掉之前的处理:
package com.dwsoft.test.testjsr303.controller;
import com.dwsoft.test.testjsr303.entity.Brand;
import com.dwsoft.test.testjsr303.utils.R;
import com.dwsoft.test.testjsr303.valid.AddGroup;
import com.dwsoft.test.testjsr303.valid.UpdateGroup;
import org.apache.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.security.acl.Group;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author tlk
* @date 2020/8/4
*/
@RestController
public class TestController {
@RequestMapping("/test/jsr303")
public R testJsr303(@Validated(value = {AddGroup.class}) @RequestBody Brand brand
// , BindingResult bindingResult
)
{
// if(bindingResult.hasErrors()){
// Map<String,String>map=new HashMap<>();
// List<FieldError> fieldErrors = bindingResult.getFieldErrors();
// fieldErrors.forEach((item) ->{
// String field = item.getField();
// String defaultMessage = item.getDefaultMessage();
// map.put(field,defaultMessage);
// });
// return R.error(HttpStatus.SC_BAD_REQUEST,"入参不合法").put("data",map);
// }
//业务处理
return R.ok();
}
}
测试:
大功告成!!!!!!!!!!!