后端校驗技術
JSR303技術办龄，JSR-303 是JAVA EE 6 中的一項子規(guī)范箕般，叫做Bean Validation撇贺，Hibernate Validator 是 Bean Validation 的參考實現(xiàn) . Hibernate Validator 提供了 JSR 303 規(guī)范中所有內置 constraint 的實現(xiàn)谦疾，除此之外還有一些附加的 constraint纷闺，在springboot中使用也比較簡便。
1.給需要校驗的字段添加校驗注解
在javax.validation.constraints包下有許多的注解：
常用的校驗注解補充：
@NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大于0,只對字符串,且會去掉前后空格. @NotEmpty 檢查約束元素是否為NULL或者是EMPTY. @Length 被檢查的字符串長度是否在指定的范圍內 @CreditCardNumber信用卡驗證 @Email 驗證是否是郵件地址凳谦，如果為null,不進行驗證忆畅，算通過驗證。 @URL 驗證是否是一個url地址
注意：一個字段可以標注多個校驗注解尸执。
2.給需要檢驗的方法標準@Valid
如果只標注了注解字段家凯，不啟用@valid的是不生效的。
3.捕捉校驗異常如失，返回提示信息
對于程序可能有很多的校驗注解绊诲，可能會出現(xiàn)多個校驗錯誤，我們可以定義一個統(tǒng)一的異常處理類褪贵，幫我們捕捉校驗錯誤并返回提示信息掂之，這里可以利用Spring的ControllerAdvice技術。
（1）.編寫統(tǒng)一異常處理類
package io.renren.app.exception;
?
import io.renren.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
?
import java.util.HashMap;
import java.util.Map;
?
/**
* @Author zunhui
* @Email Qiangzunhui@126.com
* @Date 2020/8/5 13:45
* @Description 統(tǒng)一異常處理
*/
@RestControllerAdvice(basePackages = "io.renren.app.controller")
@Slf4j
public class AppManageControllerAdvices {
?
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public R handleVaildException(MethodArgumentNotValidException e) {
log.error("數(shù)據(jù)校驗出現(xiàn)問題{}，異常類型：{}", e.getMessage(), e.getClass());
BindingResult bindingResult = e.getBindingResult();
?
Map<String, String> errorMap = new HashMap<>();
bindingResult.getFieldErrors().forEach((fieldError) -> {
errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
});
return R.error(400, "數(shù)據(jù)校驗失敗").put("data", errorMap);
}
?
@ExceptionHandler(value = Throwable.class)
public R handleException(Throwable throwable) {
?
log.error("錯誤：", throwable);
return R.error(500, "系統(tǒng)未知異常");
}
}
(2)出現(xiàn)異常將異常拋出
對于校驗可能會出現(xiàn)的異常板惑，我們將其拋出橄镜，不予捕捉感知偎快，都交給我們的統(tǒng)一異常處理類處理冯乘，返回提示信息。
4.分組校驗（多場景的復雜校驗）
對于不同的操作晒夹，字段校驗的規(guī)則和數(shù)量可能是不同的裆馒，所以我們將校驗規(guī)則分組，對于不同的操作進行不同的校驗組丐怯，使用groups屬性喷好。
1.想要使用分組校驗功能，根據(jù)文檔我們首先編寫不同的校驗組接口读跷，只編寫空接口梗搅，用來表示就可以了：
//新增分組
public interface AddGroup{
?
}
//修改分組
public interface UpdateGroup{
?
}
2.編寫好分組接口，對于不同的檢驗規(guī)則效览，標注不同的分組標識：
@NotNull ( message ="修改必須指定id",groups = {UpdateGroup.class})
@Null(message = "新增不能指定id",groups = {AddGroup.class})
@TableId
private Long Id;
?
@NotBlank(message="名稱必須提交",groups={AddGroup.class,UpdateGroup.class})
private String name;
3.在controller方法上標注不同的分組校驗无切，使用@Validated注解：
//保存
@RequestMapping("/save")
//@RequiresPermissions("product:brand:save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
brandService.save(brand);
return R.ok();
}
@Validated({AddGroup.class}):啟用不同的分組校驗規(guī)則。
注意：在使用分組校驗的情況下丐枉，對于沒有標注分組的校驗規(guī)則哆键，默認是不生效的，只有標注了分組的校驗規(guī)則才會生效瘦锹。
5.自定義校驗
1.編寫一個自定義的校驗注解
導入依賴：
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
編寫自定義校驗注解
package com.zunhui.common.valid;
?
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
?
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
?
@Documented
//指定校驗器
@Constraint(validatedBy = {com.zunhui.common.valid.ListValueConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
//配置默認的提示消息籍嘹，新建配置文件ValidationMessages.properties在其中配置：
//com.zunhui.common.valid.ListValue.message = 必須提交指定的值
String message() default="{com.zunhui.common.valid.ListValue.message}";
Class<?>[] groups() default { };
?
Class<? extends Payload>[] payload() default { };
?
int[] vals() default { };
}
用來驗證自定義的字段值，非0即1弯院。
2.編寫一個自定義的校驗器
package com.zunhui.common.valid;
?
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
?
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
?
private Set<Integer> set = new HashSet<Integer>();
//初始化方法
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
for (int val : vals) {
set.add(val);
}
}
//判斷是否校驗成功
/**
* @param value 需要校驗的值
* @param context
* @return
*/
public boolean isValid(Integer value, ConstraintValidatorContext context) {
return set.contains(value);
}
}
3.關聯(lián)自定義的校驗器和自定義的校驗注解
@Constraint(validatedBy = {com.zunhui.common.valid.ListValueConstraintValidator.class })
在自定義的校驗注解中添加自己的校驗器辱士，就關聯(lián)好了，一個校驗注解可以指定多個不同類型的校驗器听绳，適配不同類型的校驗颂碘。關聯(lián)完成就可以使用了。
4.使用
//校驗指定字段非0即1
@ListValue(valus = {0,1},message="提示消息辫红，不指定則默認讀取配置文件中的")
private Integer showStatus;
測試：
save方法傳參: showStatus: 3 返回：
自定義校驗注解生效凭涂。
