使用jsr303規(guī)范驗(yàn)證數(shù)據(jù)

Pandaaa 發(fā)布于2019-08-16 18:29 / 1511人閱讀

摘要：我們有時(shí)需要對前端傳過來的數(shù)據(jù)做校驗(yàn)，就可以使用。他可以使我們不用在每個(gè)編寫校驗(yàn)代碼，可以達(dá)到解耦的功能。本文環(huán)境為，框架使用。

我們有時(shí)需要對前端傳過來的數(shù)據(jù)做校驗(yàn)，就可以使用spring validation。他可以使我們不用在每個(gè)Controller編寫校驗(yàn)代碼，可以達(dá)到解耦的功能。本文環(huán)境為jdk8，框架使用springboot 2.1.0.RELEASE。
1.添加依賴


    org.springframework.boot
    spring-boot-starter-validation

2.需要被校驗(yàn)的實(shí)體類

@Data
public class LoginVo {

    @Size(min=6,max = 12,message = "用戶名不符合規(guī)范")
    String username;
    @NotBlank(message = "密碼不能為空")
    String password;
}

3.Controller層,在參數(shù)Login前加上@Validated注解，表明需要spring對其進(jìn)行校驗(yàn)

public JSONResult registerOrLogin(@Validated LoginVo loginVo)

 

JSR提供的校驗(yàn)注解：
@Null   被注釋的元素必須為 null    
@NotNull    被注釋的元素必須不為 null    
@AssertTrue     被注釋的元素必須為 true    
@AssertFalse    被注釋的元素必須為 false    
@Min(value)     被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值    
@Max(value)     被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值    
@DecimalMin(value)  被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值    
@DecimalMax(value)  被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值    
@Size(max=, min=)   被注釋的元素的大小必須在指定的范圍內(nèi)    
@Digits (integer, fraction)     被注釋的元素必須是一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi)    
@Past   被注釋的元素必須是一個(gè)過去的日期    
@Future     被注釋的元素必須是一個(gè)將來的日期    
@Pattern(regex=,flag=)  被注釋的元素必須符合指定的正則表達(dá)式 
Hibernate Validator提供的校驗(yàn)注解：  
@NotBlank(message =)   驗(yàn)證字符串非null，且長度必須大于0    
@Email  被注釋的元素必須是電子郵箱地址    
@Length(min=,max=)  被注釋的字符串的大小必須在指定的范圍內(nèi)    
@NotEmpty   被注釋的字符串的必須非空    
@Range(min=,max=,message=)  被注釋的元素必須在合適的范圍內(nèi)

4.如果前端傳來的數(shù)值不符合標(biāo)準(zhǔn)，后端會(huì)報(bào)錯(cuò)，所以我們可以編寫一個(gè)全局異常類來捕獲這個(gè)參數(shù)綁定異常，從而給前端返回提示消息

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {

    @ExceptionHandler(value = Exception.class)//攔截所有異常
    public JSONResult exceptionHandler(HttpServletRequest request, Exception e){
        e.printStackTrace();
         if(e instanceof BindException) {
            BindException ex = (BindException)e;
            List errors = ex.getAllErrors();//綁定錯(cuò)誤返回很多錯(cuò)誤，是一個(gè)錯(cuò)誤列表，只需要第一個(gè)錯(cuò)誤
            ObjectError error = errors.get(0);
            String msg = error.getDefaultMessage();
            return JSONResult.errorMsg("用戶名或密碼格式錯(cuò)誤");
        }else {
            return JSONResult.errorMsg("未知錯(cuò)誤");
        }

    }
}

5.驗(yàn)證
前端：

后端:

如圖，后端捕獲了異常，并向前端返回了提示信息
6.我們還可以使用分組功能，是變量在某些場景需要被驗(yàn)證，而不是所有場景，增加靈活性。