java使用Validation進(jìn)行數(shù)據(jù)校驗(yàn)的方式總結(jié)

更新時(shí)間：2023年06月10日 11:44:15 作者：你小子在看什么……

在Java中提供了一系列的校驗(yàn)方式,下面這篇文章主要給大家介紹了關(guān)于java使用Validation進(jìn)行數(shù)據(jù)校驗(yàn)的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

在開(kāi)發(fā)中，我們經(jīng)常遇到參數(shù)校驗(yàn)的需求，比如用戶(hù)注冊(cè)的時(shí)候，要校驗(yàn)用戶(hù)名不能為空、用戶(hù)名長(zhǎng)度不超過(guò)20個(gè)字符、手機(jī)號(hào)是合法的手機(jī)號(hào)格式等等。如果使用普通方式，我們會(huì)把校驗(yàn)的代碼和真正的業(yè)務(wù)處理邏輯耦合在一起，而且如果未來(lái)要新增一種校驗(yàn)邏輯也需要在修改多個(gè)地方。而spring validation允許通過(guò)注解的方式來(lái)定義對(duì)象校驗(yàn)規(guī)則，把校驗(yàn)和業(yè)務(wù)邏輯分離開(kāi)，讓代碼編寫(xiě)更加方便。Spring Validation其實(shí)就是對(duì)Hibernate Validator進(jìn)一步的封裝，方便在Spring中使用。

在Spring中有多種校驗(yàn)的方式

第一種是通過(guò)實(shí)現(xiàn)org.springframework.validation.Validator接口，然后在代碼中調(diào)用這個(gè)類(lèi)

第二種是按照Bean Validation方式來(lái)進(jìn)行校驗(yàn)，即通過(guò)注解的方式。

第三種是基于方法實(shí)現(xiàn)校驗(yàn)

除此之外，還可以實(shí)現(xiàn)自定義校驗(yàn)

場(chǎng)景一：通過(guò)Validator接口實(shí)現(xiàn)

引入相關(guān)依賴(lài)

<dependencies>
    <dependency>
        <groupId>org.hibernate.validator</groupId>
        <artifactId>hibernate-validator</artifactId>
        <version>7.0.5.Final</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish</groupId>
        <artifactId>jakarta.el</artifactId>
        <version>4.0.1</version>
    </dependency>
</dependencies>

創(chuàng)建實(shí)體類(lèi)，定義屬性和方法

public class Person {
    private String name;
    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;
    }
}

創(chuàng)建類(lèi)實(shí)現(xiàn)Validator接口，實(shí)現(xiàn)接口方法指定校驗(yàn)規(guī)則

 
public class PersonValidator implements Validator {
    @Override
    public boolean supports(Class<?> clazz) {
        return Person.class.equals(clazz);
    }
    @Override
    public void validate(Object object, Errors errors) {
        ValidationUtils.rejectIfEmpty(errors, "name", "name.empty");
        Person p = (Person) object;
        if (p.getAge() < 0) {
            errors.rejectValue("age", "error value < 0");
        } else if (p.getAge() > 110) {
            errors.rejectValue("age", "error value too old");
        }
    }
}

上面定義的類(lèi)，其實(shí)就是實(shí)現(xiàn)接口中對(duì)應(yīng)的方法，

supports方法用來(lái)表示此校驗(yàn)用在哪個(gè)類(lèi)型上，

validate是設(shè)置校驗(yàn)邏輯的地點(diǎn)，其中ValidationUtils，是Spring封裝的校驗(yàn)工具類(lèi)，幫助快速實(shí)現(xiàn)校驗(yàn)。

使用上述Validator進(jìn)行測(cè)試

 public static void main(String[] args) {
        //創(chuàng)建person對(duì)象
        Person person = new Person();
        person.setName("lucy");
        person.setAge(-1);
        // 創(chuàng)建Person對(duì)應(yīng)的DataBinder
        DataBinder binder = new DataBinder(person);
        // 設(shè)置校驗(yàn)
        binder.setValidator(new PersonValidator());
        // 由于Person對(duì)象中的屬性為空，所以校驗(yàn)不通過(guò)
        binder.validate();
        //輸出結(jié)果
        BindingResult results = binder.getBindingResult();
        System.out.println(results.getAllErrors());
    }

場(chǎng)景二：Bean Validation注解實(shí)現(xiàn)

使用Bean Validation校驗(yàn)方式，就是如何將Bean Validation需要使用的javax.validation.ValidatorFactory 和javax.validation.Validator注入到容器中。spring默認(rèn)有一個(gè)實(shí)現(xiàn)類(lèi)LocalValidatorFactoryBean，它實(shí)現(xiàn)了上面Bean Validation中的接口，并且也實(shí)現(xiàn)了org.springframework.validation.Validator接口。

創(chuàng)建配置類(lèi)，配置LocalValidatorFactoryBean

@Configuration
@ComponentScan("com.cj.spring6.validator.three")
public class ValidationConfig {
    @Bean
    public MethodValidationPostProcessor validationPostProcessor() {
        return new MethodValidationPostProcessor();
    }
}

創(chuàng)建實(shí)體類(lèi)，使用注解定義校驗(yàn)規(guī)則

public class User {
    @NotNull
    private String name;
    @Min(0)
    @Max(120)
    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;
    }
}

常用注解說(shuō)明

@NotNull 限制必須不為null

@NotEmpty 只作用于字符串類(lèi)型，字符串不為空，并且長(zhǎng)度不為0

@NotBlank 只作用于字符串類(lèi)型，字符串不為空，并且trim()后不為空串

@DecimalMax(value) 限制必須為一個(gè)不大于指定值的數(shù)字

@DecimalMin(value) 限制必須為一個(gè)不小于指定值的數(shù)字

@Max(value) 限制必須為一個(gè)不大于指定值的數(shù)字

@Min(value) 限制必須為一個(gè)不小于指定值的數(shù)字

@Pattern(value) 限制必須符合指定的正則表達(dá)式

@Size(max,min) 限制字符長(zhǎng)度必須在min到max之間

@Email 驗(yàn)證注解的元素值是Email，也可以通過(guò)正則表達(dá)式和flag指定自定義的email格式

使用兩種不同的校驗(yàn)器實(shí)現(xiàn)

使用jakarta.validation.Validator校驗(yàn)

@Service
public class MyService1 {
    @Autowired
    private Validator validator;
    public  boolean validator(User user){
        Set<ConstraintViolation<User>> sets =  validator.validate(user);
        return sets.isEmpty();
    }
}

使用org.springframework.validation.Validator校驗(yàn)

@Service
public class MyService2 {
    @Autowired
    private Validator validator;
    public boolean validaPersonByValidator(User user) {
        BindException bindException = new BindException(user, user.getName());
        validator.validate(user, bindException);
        return bindException.hasErrors();
    }
}

最后進(jìn)行測(cè)試

  @Test
    public void testMyService1() {
        ApplicationContext context = new AnnotationConfigApplicationContext(ValidationConfig.class);
        MyService1 myService = context.getBean(MyService1.class);
        User user = new User();
        user.setAge(-1);
        boolean validator = myService.validator(user);
        System.out.println(validator);
    }
    @Test
    public void testMyService2() {
        ApplicationContext context = new AnnotationConfigApplicationContext(ValidationConfig.class);
        MyService2 myService = context.getBean(MyService2.class);
        User user = new User();
        user.setName("lucy");
        user.setAge(130);
        user.setAge(-1);
        boolean validator = myService.validaPersonByValidator(user);
        System.out.println(validator);
    }

場(chǎng)景三：基于方法實(shí)現(xiàn)校驗(yàn)

創(chuàng)建配置類(lèi)，配置MethodValidationPostProcessor

@Configuration
@ComponentScan("com.cj.spring6.validator.two")
public class ValidationConfig {
    @Bean
    public LocalValidatorFactoryBean validatorFactoryBean() {
        return new LocalValidatorFactoryBean();
    }
}

創(chuàng)建實(shí)體類(lèi)，使用注解設(shè)置校驗(yàn)規(guī)則

import jakarta.validation.constraints.*;
public class User {
    @NotNull
    private String name;
    @Min(0)
    @Max(120)
    private int age;
    @Pattern(regexp = "^1(3|4|5|7|8)\\d{9}$",message = "手機(jī)號(hào)碼格式錯(cuò)誤")
    @NotBlank(message = "手機(jī)號(hào)碼不能為空")
    private String phone;
    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;
    }
    public String getPhone() {
        return phone;
    }
    public void setPhone(String phone) {
        this.phone = phone;
    }
}

定義Service類(lèi)，通過(guò)注解操作對(duì)象

@Service
@Validated
public class MyService {
    public String testParams(@NotNull @Valid User user) {
        return user.toString();
    }
}

最后測(cè)試

 @Test
    public void testMyService1() {
        ApplicationContext context = new AnnotationConfigApplicationContext(ValidationConfig.class);
        MyService myService = context.getBean(MyService.class);
        User user = new User();
        user.setAge(-1);
        myService.testParams(user);
    }

總結(jié)

到此這篇關(guān)于java使用Validation進(jìn)行數(shù)據(jù)校驗(yàn)的文章就介紹到這了,更多相關(guān)java用Validation數(shù)據(jù)校驗(yàn)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: