方式一: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() + "太煩了!";
}
}