首頁 > Java > java教程 > SpringBoot如何利用validation實現優雅的校驗參數

SpringBoot如何利用validation實現優雅的校驗參數

WBOY
發布: 2023-05-17 09:31:10
轉載
1285 人瀏覽過

1、前言

資料的校驗是互動網站一個不可或缺的功能,前端的js校驗可以涵蓋大部分的校驗職責,如使用者名稱唯一性,生日格式,郵箱格式校驗等等常用的校驗。但是為了避免用戶繞過瀏覽器,使用http工具直接向後端請求一些違法數據,服務端的數據校驗也是必要的,可以防止髒數據落到數據庫中,如果數據庫中出現一個非法的郵箱格式,也會讓維運人員頭痛不已。可以使用本文將要介紹的validation來對資料進行校驗。

2、常用校驗

1.JSR303/JSR-349: JSR303是一項標準,只提供規範不提供實現,規定一些校驗規範即校驗註解,如@ Null,@NotNull,@Pattern,位於javax.validation.constraints套件下。 JSR-349是其的升級版本,增加了一些新功能。

  • @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(value) 被註解的元素必須符合指定的正規表示式

2.hibernate validation:hibernate validation是對這個規範的實現,並增加了一些其他校驗註解,如@Email,@Length,@Range等等

@Email 被註解的元素必須是電子郵件位址

@Length 被註解的字串的大小必須在指定的範圍內

@NotEmpty 被註解的字串的必須非空

  • @Range 被註解的元素必須在適當的範圍內

  • 3.spring validation:spring validation對hibernate validation進行了二次封裝,在springmvc模組中新增了自動校驗,並將校驗資訊封裝進了特定的類別中

    3、spring boot的資料自動校驗功能
3.1 引入依賴

spring-web模組使用了hibernate -validation,並且databind模組也提供了相應的資料綁定功能。

<dependencies>
    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
登入後複製

我們只需要引入spring-boot-starter-web依賴即可,如果查看其子依賴,可以發現如下的依賴:
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>
登入後複製

3.2 建置啟動類別

@SpringBootApplication
public class App {
   public static void main(String[] args) {
       SpringApplication.run(App.class, args);
       System.out.println("Start app success.");
   }
}
登入後複製
3.3 建立需要被校驗的實體類別

public class Person {
    @NotEmpty(message = "name不能为空")
    private String name;
    @Range(min = 0, max = 100, message = "age不能大于100小于0")
    private int age;
    
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}
登入後複製

3.4 在Controller中校驗資料

springmvc為我們提供了自動封裝表單參數的功能,一個新增了參數校驗的典型controller如下圖所示。

@RequestMapping("/test")
public String valid(@Validated Person person, BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            System.out.println(fieldError);
        }
        return "fail";
    }
    return "success";
}
登入後複製

值得注意的地方:

參數Persison前需要加上@Validated註解,表明需要spring對其進行校驗,而校驗的資訊會存放到其後的BindingResult。請注意,必須相鄰,如果有多個參數需要校驗,形式可以如下。 valid(@Validated Person person, BindingResult personBindingResult ,@Validated Person2 person2, BindingResult person2BindingResult);即一個校驗類別對應一個校驗結果。

SpringBoot如何利用validation實現優雅的校驗參數

###校驗結果會自動填充,在controller中可以根據業務邏輯來決定具體的操作,例如跳到錯誤頁面。 ############一個最基本的校驗就完成了.######啟動容器測試結果如下:#########Field error in object 'person' on field 'age': rejected value [105]; codes [Range.person.age,Range.age,Range.int,Range]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codesage ]; arguments []; default message [age],100,0]; default message [age不能大於100小於0]#########3.5 統一例外處理######前面那種方式處理校驗錯誤,略顯複雜,而且一般網站都會對請求錯誤做統一的404頁面封裝,如果資料校驗不通過,則Spring boot會拋出BindException異常,我們可以捕獲這個異常並使用Result封裝返回結果。定義異常捕獲類別可使用@RestControllerAdvice。 ######Controller類別:###
@RequestMapping(value = "valid", method = RequestMethod.GET)
public String valid(@Validated Person person) {
    System.out.println(person);
    return "success";
}
登入後複製
###統一例外處理類別:###
@RestControllerAdvice
public class BindExceptionHanlder {
    @ExceptionHandler(BindException.class)
    public String handleBindException(HttpServletRequest request, BindException exception) {
        List<FieldError> allErrors = exception.getFieldErrors();
        StringBuilder sb = new StringBuilder();
        for (FieldError errorMessage : allErrors) {
            sb.append(errorMessage.getField()).append(": ").append(errorMessage.getDefaultMessage()).append(", ");
        }
        System.out.println(sb.toString());
        return sb.toString();
    }
}
登入後複製
###測試: http://localhost:8080/valid?age=105&name=steven##### #######

输出:age: age不能大于100小于0,

SpringBoot如何利用validation實現優雅的校驗參數

4、自定义校验注解

4.1 @NameValidation

@Documented
@Constraint(validatedBy = NameValidationValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RUNTIME)
public @interface NameValidation {
    String message() default "不是合法的名字";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    @Target({PARAMETER, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        NameValidation[] value();
    }
}
登入後複製

4.2 校验类NameValidationValidator

public class NameValidationValidator implements ConstraintValidator<NameValidation, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if ("steven".equalsIgnoreCase(value)) {
            return true;
        }
        String defaultConstraintMessageTemplate = context.getDefaultConstraintMessageTemplate();
        System.out.println("default message :" + defaultConstraintMessageTemplate);
        //禁用默认提示信息
		//context.disableDefaultConstraintViolation();
        //设置提示语
		//context.buildConstraintViolationWithTemplate("can not contains blank").addConstraintViolation();
        return false;
    }
}
登入後複製

4.3 在Person类增加新注解

@NotEmpty(message = "name不能为空")
@NameValidation
private String name;
登入後複製

测试: http://localhost:8080/valid?age=105&name=lxy

输出:age: age不能大于100小于0, name: 不是合法的名字,

SpringBoot如何利用validation實現優雅的校驗參數

以上是SpringBoot如何利用validation實現優雅的校驗參數的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:yisu.com
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板