使用Hibernate-Validator優雅的驗證RESTful Web Services的參數

時間  2019-11-17
標籤 使用 hibernate validator 優雅 驗證 restful web services 參數 欄目 Hibernate 简体版
原文   原文鏈接

何爲Hibernate-Validator

在RESTful Web Services的接口服務中，會有各類各樣的入參，咱們不可能徹底不作任何校驗就直接進入到業務處理的環節，一般咱們會有一個基礎的數據驗證的機制，待這些驗證過程完畢，結果無誤後，參數纔會進入到正式的業務處理中。而數據驗證又分爲兩種，一種是無業務關聯的規則性驗證，一種是根據現有數據進行的聯動性數據驗證（簡單來講，參數的合理性，須要查數據庫）。而Hibernate-Validator則適合作無業務關聯的規則性驗證。html

Hibernate-Validator的相關依賴

若是項目的框架是spring boot的話，在spring-boot-starter-web 中已經包含了Hibernate-validator的依賴，咱們點開spring-boot-starter-web的pom.xml則能夠看到相關的依賴內容。java

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starters</artifactId>
		<version>1.5.10.RELEASE</version>
	</parent>
	<artifactId>spring-boot-starter-web</artifactId>
	<name>Spring Boot Web Starter</name>
	<description>Starter for building web, including RESTful, applications using Spring
		MVC. Uses Tomcat as the default embedded container</description>
	<url>http://projects.spring.io/spring-boot/</url>
	<organization>
		<name>Pivotal Software, Inc.</name>
		<url>http://www.spring.io</url>
	</organization>
	<properties>
		<main.basedir>${basedir}/../..</main.basedir>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
		</dependency>
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-validator</artifactId>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
		</dependency>
	</dependencies>
複製代碼

若是是其餘的框架風格的話，引入以下的依賴就能夠了。git

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.10.Final</version>
</dependency>
複製代碼

初步使用Hibernate-Validator

如下代碼環境均在Spring boot 1.5.10的版本下運行。web

Hibernate-Validator的主要使用的方式就是註解的形式，而且是「零配置」的，無需配置也可使用。下面用一個最簡單的案例。正則表達式

  • Hibernate-Validator 最基本的使用spring

    1.添加一個普通的接口信息，參數是@RequestParam類型的，傳入的參數是id，且id不能小於10。數據庫

@RestController
@RequestMapping("/example")
@Validated
public class ExampleController {

    /** * 用於測試 * @param id id數不能小於10 @RequestParam類型的參數須要在Controller上增長@Validated * @return */
    @RequestMapping(value = "/info",method = RequestMethod.GET)
    public String test(@Min(value = 10, message = "id最小隻能是10") @RequestParam("id") Integer id){
        return "恭喜你拿到參數了";
    }
}
複製代碼

2.在全局異常攔截中添加驗證異常的處理tomcat

@Slf4j
@ControllerAdvice
@Component
public class GlobalExceptionHandler {

    @ExceptionHandler
    @ResponseBody
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public String handle(ConstraintViolationException exception, HttpServletRequest request) {
        Set<ConstraintViolation<?>> violations = exception.getConstraintViolations();
        StringBuffer errorInfo = new StringBuffer();
        for (ConstraintViolation<?> item : violations) {
            /**打印驗證不經過的信息*/
            errorInfo.append(item.getMessage());
            errorInfo.append(",");
        }
        log.error("{}接口參數驗證失敗，內容以下：{}",request.getRequestURI(),errorInfo.toString());
        return "您的請求失敗，參數驗證失敗，失敗信息以下："+ errorInfo.toString();
    }
}
複製代碼

3.一個簡單的測試。springboot

驗證失敗的案例.png

  • 驗證複雜參數的案例mvc

    1.添加一個vo的實體信息。

/** * 用戶的vo類 * @author dengyun */
@Data
public class ExampleVo {

    @NotBlank(message = "用戶名不能爲空")
    private String userName;

    @Range(min = 18,max = 60,message = "只能填報年齡在18~60歲的")
    private String age;
}

複製代碼

2.添加一個POST請求的接口。

/** * 用於測試 * @param vo 按照vo的驗證 * @return */
    @RequestMapping(value = "/info1",method = RequestMethod.POST)
    public String test1(@Valid @RequestBody ExampleVo vo){
        return "恭喜你拿到參數了";
    }
複製代碼

3.在全局異常攔截中添加驗證處理的結果

@ResponseBody
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public String handle(MethodArgumentNotValidException exception,HttpServletRequest request) {
        StringBuffer errorInfo=new StringBuffer();
        List<ObjectError> errors = exception.getBindingResult().getAllErrors();
        for(int i=0;i<errors.size();i++){
            errorInfo.append(errors.get(i).getDefaultMessage()+",");
        }
        log.error("{},接口參數驗證失敗：{}",request,errorInfo.toString());
        return "您的請求失敗，參數驗證失敗，失敗信息以下:"+errorInfo.toString();
    }
複製代碼

4.一個簡單的測試

複雜參數校驗失敗.png

我我的比較推薦使用全局異常攔截處理的方式去處理Hibernate-Validator的驗證失敗後的處理流程，這樣能能減小Controller層或Services層的代碼邏輯處理。雖然它也能在Controller中增長BindingResult的實例來獲取數據，可是並不推薦。

更加靈活的運用

首先列舉一下Hibernate-Validator全部的內置驗證註解。

@Null 被註釋的元素必須爲 null
@NotNull 被註釋的元素必須不爲 null
@AssertTrue 被註釋的元素必須爲 true
@AssertFalse 被註釋的元素必須爲 false
@Min(value) 被註釋的元素必須是一個數字，其值必須大於等於指定的最小值 @Max(value) 被註釋的元素必須是一個數字，其值必須小於等於指定的最大值 @DecimalMin(value) 被註釋的元素必須是一個數字，其值必須大於等於指定的最小值
@DecimalMax(value) 被註釋的元素必須是一個數字，其值必須小於等於指定的最大值
@Size(max=, min=) 被註釋的元素的大小必須在指定的範圍內
@Digits (integer, fraction) 被註釋的元素必須是一個數字，其值必須在可接受的範圍內
@Past 被註釋的元素必須是一個過去的日期
@Future 被註釋的元素必須是一個未來的日期
@Pattern(regex=,flag=) 被註釋的元素必須符合指定的正則表達式
Hibernate Validator 附加的 constraint
@NotBlank(message =) 驗證字符串非null，且長度必須大於0
@Email 被註釋的元素必須是電子郵箱地址
@Length(min=,max=) 被註釋的字符串的大小必須在指定的範圍內
@NotEmpty 被註釋的字符串的必須非空
@Range(min=,max=,message=) 被註釋的元素必須在合適的範圍內

這些註解能適應咱們絕大多數的驗證場景，可是爲了應對更多的可能性，咱們須要增長註解功能配合Hibernate-Validator的其餘的特性，來知足驗證的需求。

1. 自定義註解

  • 添加自定義註解

咱們必定會用到這麼一個業務場景，vo中的屬性必須符合枚舉類中的枚舉。Hibernate-Validator中尚未關於枚舉的驗證規則，那麼，咱們則須要自定義一個枚舉的驗證註解。

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumCheckValidator.class)
public @interface EnumCheck {
    /** * 是否必填 默認是必填的 * @return */
    boolean required() default true;
    /** * 驗證失敗的消息 * @return */
    String message() default "枚舉的驗證失敗";
    /** * 分組的內容 * @return */
    Class<?>[] groups() default {};

    /** * 錯誤驗證的級別 * @return */
    Class<? extends Payload>[] payload() default {};

    /** * 枚舉的Class * @return */
    Class<? extends Enum<?>> enumClass();

    /** * 枚舉中的驗證方法 * @return */
    String enumMethod() default "validation";
}
複製代碼
  • 註解的業務邏輯實現類
public class EnumCheckValidator implements ConstraintValidator<EnumCheck,Object> {
    private EnumCheck enumCheck;

    @Override
    public void initialize(EnumCheck enumCheck) {
        this.enumCheck =enumCheck;
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        // 註解代表爲必選項 則不容許爲空，不然能夠爲空
        if (value == null) {
            return this.enumCheck.required()?false:true;
        }
        //最終的返回結果
        Boolean result=Boolean.FALSE;
        // 獲取 參數的數據類型
        Class<?> valueClass = value.getClass();
        try {
            Method method = this.enumCheck.enumClass().getMethod(this.enumCheck.enumMethod(), valueClass);
            result = (Boolean)method.invoke(null, value);
            result= result == null ? false : result;
            //全部異常須要在開發測試階段發現完畢
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }finally {
            return result;
        }
    }
}

複製代碼
  • 編寫枚舉類
public enum  Sex{
    MAN("男",1),WOMAN("女",2);

    private String label;
    private Integer value;

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }

    public Integer getValue() {
        return value;
    }

    public void setValue(Integer value) {
        this.value = value;
    }

    Sex(String label, int value) {
        this.label = label;
        this.value = value;
    }

    /** * 判斷值是否知足枚舉中的value * @param value * @return */
    public static boolean validation(Integer value){
        for(Sex s:Sex.values()){
            if(Objects.equals(s.getValue(),value)){
                return true;
            }
        }
        return false;
    }
}
複製代碼
  • 使用方式
@EnumCheck(message = "只能選男：1或女:2",enumClass = Sex.class)
    private Integer sex;
複製代碼
  • 一個簡單的測試

自定義註解的驗證.png

咱們甚至能夠在自定義註解中作更加靈活的處理，甚至把與數據庫的數據校驗的也寫成自定義註解，來進行數據驗證的調用。

2. Hibernate-Validator的分組驗證

同一個校驗規則，不可能適用於全部的業務場景，對此，對每個業務場景去編寫一個校驗規則，又顯得特別冗餘。這裏咱們恰好能夠用到Hibernate-Validator的分組功能。

  • 添加一個名爲ValidGroupA的接口（接口內容能夠是空的，因此就不列舉代碼）
  • 添加一個須要分組校驗的字段
@Data
public class ExampleVo {

    @NotNull(message = "主鍵不容許爲空",groups = ValidGroupA.class)
    private Integer id;

    @NotBlank(message = "用戶名不能爲空",groups = Default.class)
    private String userName;
    
    @Range(min = 18,max = 60,message = "只能填報年齡在18~60歲的",groups = Default.class)
    private String age;

    @EnumCheck(message = "只能選男：1或女:2",enumClass = Sex.class,groups = Default.class)
    private Integer sex;
}
複製代碼
  • 改動接口的內容
@RequestMapping(value = "/info1",method = RequestMethod.POST)
    public String test1(@Validated({ValidGroupA.class,Default.class}) @RequestBody ExampleVo vo){
        return "恭喜你拿到參數了";
    }
複製代碼

這裏咱們能夠注意一下，校驗的註解由 @Valid 改爲了 @Validated。

  • 進行測試，保留ValidGroupA.class和去掉ValidGroupA.class的測試。

    • 保留ValidGroupA.class

      保留分組的測試.png

    • 去掉ValidGroupA.class

      去掉分組後的測試.png

使用分組能極大的複用須要驗證的類信息。而不是按業務重複編寫冗餘的類。然而Hibernate-Validator還提供組序列的形式進行順序式校驗，此處就不重複列舉了。我認爲順序化的校驗，場景更多的是在業務處理類，例如聯動的屬性驗證，值的有效性很大程度上不能從代碼的枚舉或常量類中來校驗。

部分引用及參考的文章

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程