关于后端:hibernate-validator二声明和验证Bean约束

首发博客地址

https://blog.zysicyj.top/

一、申明bean束缚

1. 字段级别束缚

不反对动态类型字段
验证引擎间接拜访实例变量，不会调用属性的拜访器
在验证字节码加强的对象时，应实用属性级别束缚，因为字节码增库无奈通过反射确定字段拜访

package org.hibernate.validator.referenceguide.chapter02.fieldlevel;
public class Car {
    @NotNull
    private String manufacturer;
    @AssertTrue
    private boolean isRegistered;
    public Car(String manufacturer, boolean isRegistered) {
        this.manufacturer = manufacturer;
        this.isRegistered = isRegistered;
    }
    //getters and setters...
}

2. 属性级别束缚

必须正文getter而不是setter，这样能够限度没有设置办法的只读属性
该级别将应用属性拜访策略来拜访验证的值，即验证引擎通过属性拜访器来拜访数据
不要字段和getter都加校验，这样会导致校验两次

package org.hibernate.validator.referenceguide.chapter02.propertylevel;
public class Car {
    private String manufacturer;
    private boolean isRegistered;
    public Car(String manufacturer, boolean isRegistered) {
        this.manufacturer = manufacturer;
        this.isRegistered = isRegistered;
    }
    @NotNull
    public String getManufacturer() {
        return manufacturer;
    }
    public void setManufacturer(String manufacturer) {
        this.manufacturer = manufacturer;
    }
    @AssertTrue
    public boolean isRegistered() {
        return isRegistered;
    }
    public void setRegistered(boolean isRegistered) {
        this.isRegistered = isRegistered;
    }
}

容器元素束缚

3.1 Iterable

在该类型上加束缚时，将会校验每个元素

package org.hibernate.validator.referenceguide.chapter02.containerelement.set;
import java.util.HashSet;
import java.util.Set;
public class Car {
    private Set<@ValidPart String> parts = new HashSet<>();
    public void addPart(String part) {
        parts.add( part );
    }
    //...
}

Car car = new Car();
car.addPart( "Wheel" );
car.addPart( null );
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
assertEquals( 1, constraintViolations.size() );
ConstraintViolation<Car> constraintViolation =
        constraintViolations.iterator().next();
assertEquals(
        "'null' is not a valid car part.",
        constraintViolation.getMessage()
);
assertEquals( "parts[].<iterable element>",
        constraintViolation.getPropertyPath().toString() );

3.2 List

也会校验每个元素

package org.hibernate.validator.referenceguide.chapter02.containerelement.list;
public class Car {
    private List<@ValidPart String> parts = new ArrayList<>();
    public void addPart(String part) {
        parts.add( part );
    }
    //...
}

Car car = new Car();
car.addPart( "Wheel" );
car.addPart( null );
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
assertEquals( 1, constraintViolations.size() );
ConstraintViolation<Car> constraintViolation =
        constraintViolations.iterator().next();
assertEquals(
        "'null' is not a valid car part.",
        constraintViolation.getMessage()
);
assertEquals( "parts[1].<list element>",
        constraintViolation.getPropertyPath().toString() );

3.3 Map

package org.hibernate.validator.referenceguide.chapter02.containerelement.map;
import java.util.HashMap;
import java.util.Map;
import javax.validation.constraints.NotNull;
public class Car {
    public enum FuelConsumption {
        CITY,
        HIGHWAY
    }
    private Map<@NotNull FuelConsumption, @MaxAllowedFuelConsumption Integer> fuelConsumption = new HashMap<>();
    public void setFuelConsumption(FuelConsumption consumption, int value) {
        fuelConsumption.put( consumption, value );
    }
    //...
}

Car car = new Car();
car.setFuelConsumption( Car.FuelConsumption.HIGHWAY, 20 );
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
assertEquals( 1, constraintViolations.size() );
ConstraintViolation<Car> constraintViolation =
        constraintViolations.iterator().next();
assertEquals(
        "20 is outside the max fuel consumption.",
        constraintViolation.getMessage()
);
assertEquals(
        "fuelConsumption[HIGHWAY].<map value>",
        constraintViolation.getPropertyPath().toString()
);

Car car = new Car();
car.setFuelConsumption( null, 5 );
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
assertEquals( 1, constraintViolations.size() );
ConstraintViolation<Car> constraintViolation =
        constraintViolations.iterator().next();
assertEquals(
        "must not be null",
        constraintViolation.getMessage()
);
assertEquals(
        "fuelConsumption<K>[].<map key>",
        constraintViolation.getPropertyPath().toString()
);

3.4 Optional

package org.hibernate.validator.referenceguide.chapter02.containerelement.optional;
public class Car {
    private Optional<@MinTowingCapacity(1000) Integer> towingCapacity = Optional.empty();
    public void setTowingCapacity(Integer alias) {
        towingCapacity = Optional.of( alias );
    }
    //...
}

Car car = new Car();
car.setTowingCapacity( 100 );
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
assertEquals( 1, constraintViolations.size() );
ConstraintViolation<Car> constraintViolation = constraintViolations.iterator().next();
assertEquals(
        "Not enough towing capacity.",
        constraintViolation.getMessage()
);
assertEquals(
        "towingCapacity",
        constraintViolation.getPropertyPath().toString()
);

3.5 自定义容器

package org.hibernate.validator.referenceguide.chapter02.containerelement.custom;
public class Car {
    private GearBox<@MinTorque(100) Gear> gearBox;
    public void setGearBox(GearBox<Gear> gearBox) {
        this.gearBox = gearBox;
    }
    //...
}

package org.hibernate.validator.referenceguide.chapter02.containerelement.custom;
public class GearBox<T extends Gear> {
    private final T gear;
    public GearBox(T gear) {
        this.gear = gear;
    }
    public Gear getGear() {
        return this.gear;
    }
}

package org.hibernate.validator.referenceguide.chapter02.containerelement.custom;
public class Gear {
    private final Integer torque;
    public Gear(Integer torque) {
        this.torque = torque;
    }
    public Integer getTorque() {
        return torque;
    }
    public static class AcmeGear extends Gear {
        public AcmeGear() {
            super( 60 );
        }
    }
}

package org.hibernate.validator.referenceguide.chapter02.containerelement.custom;
public class GearBoxValueExtractor implements ValueExtractor<GearBox<@ExtractedValue ?>> {
    @Override
    public void extractValues(GearBox<@ExtractedValue ?> originalValue, ValueExtractor.ValueReceiver receiver) {
        receiver.value( null, originalValue.getGear() );
    }
}

Car car = new Car();
car.setGearBox( new GearBox<>( new Gear.AcmeGear() ) );
Set<ConstraintViolation<Car>> constraintViolations = validator.validate( car );
assertEquals( 1, constraintViolations.size() );
ConstraintViolation<Car> constraintViolation =
        constraintViolations.iterator().next();
assertEquals(
        "Gear is not providing enough torque.",
        constraintViolation.getMessage()
);
assertEquals(
        "gearBox",
        constraintViolation.getPropertyPath().toString()
);

3.6 嵌套容器元素

package org.hibernate.validator.referenceguide.chapter02.containerelement.nested;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.validation.constraints.NotNull;
public class Car {
    private Map<@NotNull Part, List<@NotNull Manufacturer>> partManufacturers =
            new HashMap<>();
    //...
}

4. 类级别束缚

在这种状况下，验证的对象不是单个属性而是残缺的对象
适宜依赖于对象的多个属性之间的相关性很高的场景

package org.hibernate.validator.referenceguide.chapter02.classlevel;
@ValidPassengerCount
public class Car {
    private int seatCount;
    private List<Person> passengers;
    //...
}

5. 束缚继承

在一个类实现接口或扩大另一个类时，在超类上申明的所有束缚正文都以与该类自身上指定的束缚雷同的形式束缚

package org.hibernate.validator.referenceguide.chapter02.inheritance;
public class Car {
    private String manufacturer;
    @NotNull
    public String getManufacturer() {
        return manufacturer;
    }
    //...
}

package org.hibernate.validator.referenceguide.chapter02.inheritance;
public class RentalCar extends Car {
    private String rentalStation;
    @NotNull
    public String getRentalStation() {
        return rentalStation;
    }
    //...
}

RentalCar 不仅会校验getRentalStation，而且会校验父类的getManufacturer
若继承换成接口，也是会校验超类的

6. 对象图

不仅反对单个对象校验，还反对级联验证

对象的级联校验

package org.hibernate.validator.referenceguide.chapter02.objectgraph;
public class Car {
    @NotNull
    @Valid
    private Person driver;
    //...
}

package org.hibernate.validator.referenceguide.chapter02.objectgraph;
public class Person {
    @NotNull
    private String name;
    //...
}

在校验Car的时候，会校验Person，因而若Car援用的Person的name为空，则会校验失败

容器的级联校验

package org.hibernate.validator.referenceguide.chapter02.objectgraph.containerelement;
public class Car {
    private List<@NotNull @Valid Person> passengers = new ArrayList<Person>();
    private Map<@Valid Part, List<@Valid Manufacturer>> partManufacturers = new HashMap<>();
    //...
}

package org.hibernate.validator.referenceguide.chapter02.objectgraph.containerelement;
public class Part {
    @NotNull
    private String name;
    //...
}

package org.hibernate.validator.referenceguide.chapter02.objectgraph.containerelement;
public class Manufacturer {
    @NotNull
    private String name;
    //...
}

校验Person的名字是否存在为null的
校验Part的名字是否存在为null的
校验所有的Manufacturer是否存在名字为null的

二、验证Bean束缚

1. 获取验证器

2. 验证的三种形式

先来个车

class Car {
    @NotNull
    @Size(min = 5,max = 20)
    private String manufacturer;
    @AssertTrue
    private boolean isRegistered;
    public Car(String manufacturer, boolean isRegistered) {
        this.manufacturer = manufacturer;
        this.isRegistered = isRegistered;
    }
}

bean全副验证

验证单个属性

对属性的值进行验证

3. 束缚违规

内插的谬误音讯

09:35:00.446 [main] INFO com.bm.validate.TestValidatorBean - 内插的谬误音讯：只能为true

非插补的谬误音讯

09:35:00.446 [main] INFO com.bm.validate.TestValidatorBean - 非插补的谬误音讯：{javax.validation.constraints.AssertTrue.message}

正在验证的根Bean

09:35:00.446 [main] INFO com.bm.validate.TestValidatorBean - 正在验证的根Bean：com.bm.validate.Car@7c83dc97

如果是bean束缚，则将束缚利用到bean实例；如果是属性束缚，则是托管该束缚的属性的bean实例

09:35:00.446 [main] INFO com.bm.validate.TestValidatorBean - 如果是bean束缚，则将束缚利用到bean实例；如果是属性束缚，则是托管该束缚的属性的bean实例：com.bm.validate.Car@7c83dc97

bean验证器值的属性门路

09:35:00.447 [main] INFO com.bm.validate.TestValidatorBean - 根bean验证器值的属性门路：isRegistered

**报告束缚失败的原数据

09:35:00.447 [main] INFO com.bm.validate.TestValidatorBean - 报告束缚失败的原数据：false

告束缚失败的元数据

09:35:00.447 [main] INFO com.bm.validate.TestValidatorBean - 报告束缚失败的元数据：ConstraintDescriptorImpl{annotation=j.v.c.AssertTrue, payloads=[], hasComposingConstraints=true, isReportAsSingleInvalidConstraint=false, elementType=FIELD, definedOn=DEFINED_LOCALLY, groups=[interface javax.validation.groups.Default], attributes={groups=[Ljava.lang.Class;@60015ef5, message={javax.validation.constraints.AssertTrue.message}, payload=[Ljava.lang.Class;@2f54a33d}, constraintType=GENERIC, valueUnwrapping=DEFAULT}

三、内置束缚

@AssertFalse

查看带正文元素的属性为false

Boolean, boolean

@AssertTrue

查看带正文元素的属性为True

Boolean,boolean

@DecimalMax(value=, inclusive=)

inclusive为false，查看带正文的值是否小于指定的最大值。否则，该值是否小于等于指定的最大值
BigDecimal,BigInteger,CharSequence,byte,short,int,long，原始数据包装类,Number,javax.money.MonetaryAmount任意子类

@DecimalMin(value=, inclusive=)

inclusive为false，查看带正文的值是否大于指定的最小值。否则，该值是否大于等于指定的最小值
BigDecimal,BigInteger,CharSequence,byte,short,int,long，原始数据包装类,Number,javax.money.MonetaryAmount任意子类

@Digits(integer=, fraction=)

integer 指定整数位数限度，fraction指定小数位数限度
BigDecimal,BigInteger,CharSequence,byte,short,int,long，原始数据包装类,Number,javax.money.MonetaryAmount任意子类

@Email

是否为无效的电子邮箱地址
regexp和flags参数指定正则规定，必须匹配的其它表达式
CharSequence

@Future

查看是否是未来的日期
java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate; 如果类门路上有Joda Time日期/工夫API ，则由HV额定反对：ReadablePartial和的任何实现ReadableInstant

@FutureOnPresent

查看日期是先在还是未来
java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate; 如果类门路上有Joda Time日期/工夫API ，则由HV额定反对：ReadablePartial和的任何实现ReadableInstant

@Max(value=)

是否小于或等于该值
BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装; HV额定反对：的任何子类型CharSequence（评估字符序列示意的数值），Number和的任何子类型javax.money.MonetaryAmount

@Min(value=)

是否大于或等于该值
BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装; HV额定反对：的任何子类型CharSequence（评估字符序列示意的数值），Number和的任何子类型javax.money.MonetaryAmount

@NotBlank

指定字符不为null并且长度大于0
CharSequence

@NotEmpty

指定字符不为null或为空（去除尾随空格）
CharSequence，Collection，Map和数组

@NotNull

查看正文的值不为null
所有类型均反对

@Negative

查看元素是否严格为负，零被视为有效
BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装; HV额定反对：的任何子类型CharSequence（评估字符序列示意的数值），Number和的任何子类型javax.money.MonetaryAmount

@NegativeOrZero

查看元素是正数或0
BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装; HV额定反对：的任何子类型CharSequence（评估字符序列示意的数值），Number和的任何子类型javax.money.MonetaryAmount

@Null

查看正文的值是null
所有类型均反对

@Past

查看带正文的日期是否是过来的日期
java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate; 如果类门路上有Joda Time日期/工夫API ，则由HV附加反对：ReadablePartial和的任何实现ReadableInstant

@PastOrPresent

查看带正文的日期是过来还是当初
java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate; 如果类门路上有Joda Time日期/工夫API ，则由HV附加反对：ReadablePartial和的任何实现ReadableInstant

@Pattern(regex=, flags=)

regex思考给定标记，查看带正文的字符串是否与正则表达式匹配match
CharSequence

@Positive

查看元素是否严格为正。零值被视为有效
BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装; HV额定反对：的任何子类型CharSequence（评估字符序列示意的数值），Number和的任何子类型javax.money.MonetaryAmount

@PositiveOrZero

查看元素是否严格为正或零
BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装; HV额定反对：的任何子类型CharSequence（评估字符序列示意的数值），Number和的任何子类型javax.money.MonetaryAmount

@Size(min=, max=)

查看带正文的元素的大小是否介于min和之间max（包含）
CharSequence，Collection，Map和数组

@CreditCardNumber(ignoreNonDigitCharacters=)

查看带正文的字符序列是否通过了Luhn校验和测试
ignoreNonDigitCharacters容许疏忽非数字字符。默认值为false。
CharSequence

@Currency(value=)

查看带正文的货币单位javax.money.MonetaryAmount是否为指定货币单位的一部分。
javax.money.MonetaryAmount

@DurationMax(days=, hours=, minutes=, seconds=, millis=, nanos=, inclusive=)

查看带正文的java.time.Duration元素不大于由正文参数结构的元素。如果将inclusiveflag设置为，则容许平等true
java.time.Duration

@DurationMin(days=, hours=, minutes=, seconds=, millis=, nanos=, inclusive=)

查看带正文的java.time.Duration元素不少于由正文参数结构的元素。如果将inclusiveflag设置为，则容许平等true。
java.time.Duration

@EAN

查看带正文的字符序列是无效的EAN条形码。类型决定条形码的类型
CharSequence

@ISBN

查看带正文的字符序列是无效的ISBN
CharSequence

@Length(min=, max=)

验证该正文字符序列是间min和max蕴含
CharSequence

@Range(min=, max=)

查看带正文的值是否介于（包含）指定的最小值和最大值之间
BigDecimal，BigInteger，CharSequence，byte，short，int，long和原始类型的相应的包装

@UniqueElements

查看带正文的汇合仅蕴含惟一元素。应用该equals()办法确定相等性。默认音讯不包含反复元素的列表，然而您能够通过笼罩音讯并应用{duplicates}message参数来包含它。反复元素的列表也蕴含在束缚违反的动静无效负载中。
Collection��负载中。
Collection

本文由mdnice多平台公布

关于后端:hibernate-validator二声明和验证Bean约束

首发博客地址

一、申明bean束缚

1. 字段级别束缚

2. 属性级别束缚

3.1 Iterable

3.2 List

3.3 Map

3.4 Optional

3.5 自定义容器

3.6 嵌套容器元素

4. 类级别束缚

5. 束缚继承

6. 对象图

对象的级联校验

容器的级联校验

二、验证Bean束缚

1. 获取验证器

2. 验证的三种形式

先来个车

bean全副验证

验证单个属性

对属性的值进行验证

3. 束缚违规

内插的谬误音讯

非插补的谬误音讯

正在验证的根Bean

如果是bean束缚，则将束缚利用到bean实例；如果是属性束缚，则是托管该束缚的属性的bean实例

bean验证器值的属性门路

**报告束缚失败的原数据

告束缚失败的元数据

三、内置束缚

@AssertFalse

@AssertTrue

@DecimalMax(value=, inclusive=)

@DecimalMin(value=, inclusive=)

@Digits(integer=, fraction=)

@Email

@Future

@FutureOnPresent

@Max(value=)

@Min(value=)

@NotBlank

@NotEmpty

@NotNull

@Negative

@NegativeOrZero

@Null

@Past

@PastOrPresent

@Pattern(regex=, flags=)

@Positive

@PositiveOrZero

@Size(min=, max=)

@CreditCardNumber(ignoreNonDigitCharacters=)

@Currency(value=)

@DurationMax(days=, hours=, minutes=, seconds=, millis=, nanos=, inclusive=)

@DurationMin(days=, hours=, minutes=, seconds=, millis=, nanos=, inclusive=)

@EAN

@ISBN

@Length(min=, max=)

@Range(min=, max=)

@UniqueElements

评论

发表回复 取消回复

更多文章

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

深入解析：基于Delta的线性数据结构模型，打造高效富文本编辑器

轻松管理社交媒体：使用Automa插件实现一键拉黑功能

发表回复取消回复