方式一:jee自带
加上@Valid注解开启valid校验
Validation的参数校验常用注解:
https://www.cnblogs.com/javafucker/p/9935095.html
https://www.jianshu.com/p/98700c1385c6
空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length(min=, max=)
验证字符串的长度是否在给定的范围之内,包含两端
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
数值检查:建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为"",Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;
@Valid递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)
方式二:自定义约束校验类
org.hibernate.validator.constraints
1.定义校验类
校验类需要实现ConstraintValidator接口,接口使用了泛型,需要指定两个参数,第一个自定义注解类,第二个为需要校验的数据类型。
实现接口后要override两个方法,分别为initialize方法和isValid方法。其中initialize为初始化方法,可以在里面做一些初始化操作,isValid方法就是我们最终需要的校验方法了。可以在该方法中实现具体的校验步骤。
https://blog.csdn.net/qq_38439885/article/details/81227063
import com.cashew.example.aop.annotation.validator.IsMobile;
import org.apache.commons.lang3.StringUtils;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
/**
* 作用在 javax.validation.Valid 修饰的参数前
* 不通过 org.springframework.validation.BindException get请求
* org.springframework.web.bind.MethodArgumentNotValidException post请求
*/
public class IsMobileValidator implements ConstraintValidator<IsMobile,String> {
@Override
public void initialize(IsMobile constraintAnnotation) {
System.out.println("校验器初始化中……");
}
@Override
public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
System.out.println("Validator 校验器校验中……");
if(StringUtils.isNotBlank(s) && regexTel(s)){
System.out.println("手机号正则tttt校验通过……》");
return true;
}
return false;
}
}
2.自定义注解,@Constraint指定校验类
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(
validatedBy = {IsMobileValidator.class}
)
/**
* 再写一个处理器 IsMobileValidator
*/
public @interface IsMobile {
//.ConstraintDefinitionException: HV000074: com.cashew.example.aop.annotation.validator.IsMobile contains Constraint annotation, but does not contain a message parameter
String message() default "手机格式不正确";
// but does not contain a groups parameter
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
3.作用在字段上
@Data
public class User {
private String id;
private String username;
private String password;
@IsMobile
private String tel;
private String email;
}
4.在控制层使用,如果不写切面,加上@Valid注解开启valid校验
@PostMapping("/co")
public Object helloCo(@Valid @RequestBody User model){
System.out.println(model.toString() );
return result.success(model.toString());
}
@GetMapping("/do")
public Object helloDo(@Valid User model){
System.out.println(model.toString() );
return result.success(model.toString());
}
方式三:自定义切面
1.自定义注解
该校验注解,既可以校验控制层方法里的自定义类型参数,也可以校验自定义类对象的字段
import java.lang.annotation.*;
/**
* 基本类型不为 null,String类型可以为""
*/
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NotNull {
String msg() default "字段不能为null";
}
2.自定义异常
public class ParamBlankException extends RuntimeException{
public ParamBlankException() {
}
public ParamBlankException(String message) {
super(message);
}
}
3.定义切面,校验带注解的参数
import com.cashew.example.aop.annotation.NotNull;
import com.cashew.example.aop.exception.ParamBlankException;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.lang.reflect.Field;
import java.lang.reflect.Parameter;
import java.util.Arrays;
@Aspect
@Component
@Slf4j
public class ParamCheckAspect2 {
//定义一个切点
@Pointcut("execution(public * com.cashew.*.*.controller.AopTest*.*(..))")
public void checkParam(){}
@Before("checkParam()")
public void paramCheck(JoinPoint joinPoint) throws Exception {
log.info("切麵参数验证中……");
Object[] args = joinPoint.getArgs();
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Parameter[] parameters = signature.getMethod().getParameters();
for (int i = 0; i < parameters.length; i++) {
Parameter parameter = parameters[i];
log.info("参数类型:"+ parameter.getType().getName());
log.info("参数名:"+ parameter.getName());
//判断参数前是否有注解
NotNull notNull1 = parameter.getAnnotation(NotNull.class);
if (notNull1 != null && args[i] == null) {
throw new ParamBlankException(parameter.toString() + notNull1.msg());
}
/*
* 没有标注@ValidParam注解,或者是HttpServletRequest、HttpServletResponse、HttpSession时,都不做处理
*/
if (parameter.getType().isAssignableFrom(HttpServletRequest.class) || parameter.getType().isAssignableFrom(HttpSession.class) ||
parameter.getType().isAssignableFrom(HttpServletResponse.class)) {
continue;
}
Class<?> paramClazz = parameter.getType();
//获取类型所对应的参数对象,实际项目中Controller中的接口不会传两个相同的自定义类型的参数,所以此处直接使用findFirst()
Object arg = Arrays.stream(args).filter(ar -> paramClazz.isAssignableFrom(ar.getClass())).findFirst().get();
//得到参数的所有成员变量
Field[] declaredFields = paramClazz.getDeclaredFields();
for (Field field : declaredFields) {
field.setAccessible(true);
//校验标有@NotNull注解的字段
NotNull notNull = field.getAnnotation(NotNull.class);
if (notNull != null) {
Object fieldValue = field.get(arg);
if (fieldValue == null) {
throw new ParamBlankException(field.getName() + notNull.msg());
}
}
}
}
}
}
4.使用在实体类上
@Entity
@Table(name = "team")
public class TeamModel1 implements Serializable{
@Id
@GeneratedValue(strategy= GenerationType.AUTO)
private long id;
@NotNull
private String name;
@Transient
private String myFavoritePlayer;
public String getMyFavoritePlayer() {
return myFavoritePlayer;
}
public void setMyFavoritePlayer(String myFavoritePlayer) {
this.myFavoritePlayer = myFavoritePlayer;
}
public TeamModel1() {
}
@Override
public String toString() {
return "TeamModel1{" +
"id=" + id +
", name='" + name + '\'' +
", myFavoritePlayer='" + myFavoritePlayer + '\'' +
'}';
}
public long getId() {
return id;
}
public void setId(long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
使用在参数中
@PostMapping("/hello")
public Object helloAop(TeamModel1 model, @NotNull Integer limit){
return result.success(model.toString() + "limit: " + limit);
}
@PostMapping("/bo")
public Object helloBo(@RequestBody TeamModel1 model, @NotNull Integer limit){
System.out.println(model.toString() + "limit: " + limit);
return result.success(model.toString() + "limit: " + limit);
}
异常捕获
@ControllerAdvice
public class GlobalDefaultExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public String exceptionMethod1(MethodArgumentNotValidException e) {
BindingResult bindingResult = e.getBindingResult();
FieldError fieldError = bindingResult.getFieldError();
return fieldError.getField() + " " + fieldError.getDefaultMessage() + "真不乖!";
}
@ExceptionHandler(BindException.class)
@ResponseBody
public String exceptionMethod2(BindException e) {
BindingResult bindingResult = e.getBindingResult();
FieldError fieldError = bindingResult.getFieldError();
return fieldError.getField() + " " + fieldError.getDefaultMessage() + "太烦了!";
}
}