[英]custom jpa validation in spring boot
我有一个这样的实体:
@Entity
@Table(name = "transaction_receiver")
public class TransactionReceiver implements Serializable, Addressable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
@NotNull
@Column(name = "contact_id", nullable = false)
private String contactId;
@Column(name = "datev_number")
private String datevNumber;
@NotNull
@Column(name = "receiver", nullable = false)
private String receiver;
@NotNull
@Size(min = 22, max = 34)
@Column(name = "iban", length = 34, nullable = false)
private String iban;
@Size(min = 8, max = 11)
@Column(name = "bic", length = 11, nullable = false)
private String bic;
@NotNull
@Column(name = "institute")
private String institute;
@Column(name = "company")
private String company;
我需要编写一个自定义验证“您可以提供一个空的 iban、bic 和 Institute,没关系。但如果任何字段不为空,则必须保持上述约束”
我正在寻找最优雅的方式来实现这一目标。
我目前的解决方案是 - 我认为有点脏,但有效 - 使用@PrePersist
语句并从那里抛出异常
@PrePersist
public void checkBankData() {
boolean ibanEmpty = iban == null || iban.isEmpty();
boolean ibanValid = !ibanEmpty && iban.length() >= 22 && iban.length() <= 34;
boolean bicEmpty = bic == null || bic.isEmpty();
boolean bicValid = !bicEmpty && bic.length() >= 8 && bic.length() <= 11;
boolean instituteEmpty = institute == null || institute.isEmpty();
boolean validState = (ibanEmpty && bicEmpty && instituteEmpty) || ibanValid && bicValid;
if (!validState) {
throw new IllegalStateException(
String.format(
"bank data is not empty and %s%s%s%s%s",
!ibanValid ? "iban has to be from 22 to 34 chars long" : "",
!ibanValid && !bicValid ? "and" : "",
!bicValid ? "bic has to be from 8 to 11 chars long" : "",
!ibanValid && !bicValid && instituteEmpty ? "and" : "",
instituteEmpty ? "institue must not be empty" : ""
)
);
}
}
哪个不受@Valid
注释的约束。 一种不同的方法是定义一个像这里描述的自定义验证器: http : //docs.jboss.org/hibernate/validator/4.1/reference/en-US/html/validator-customconstraints.html
但这对我的约束来说确实看起来有点矫枉过正。
就没有其他优雅的方式吗?
使用 Hibernate Validation API 并不像看起来那么复杂,对于您的约束是一个不错的解决方案。 但是,您可以使用 Hibernate Validator 获得一种更简单的方法来定义约束,就像我们在一个项目中所做的那样,添加了几个类。 您的约束将如下所示:
@Validate(method = "checkBankData", message = "{BankData.invalid.message}")
@Entity
@Table(name = "transaction_receiver")
public class TransactionReceiver implements Serializable, Addressable {
为此,您需要定义 @Validate 注释和 CustomValidator 类。
@Target({ ElementType.TYPE, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = CustomValidator.class)
@Documented
/**
* Annotation to allow custom validation against model classes
*/
public @interface Validate {
/**
* Validation message
*/
String message();
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
/**
* Validation method name
*/
String method() default "";
}
public class CustomValidator implements ConstraintValidator<Validate, BusinessObject> {
private static Log log = LogFactory.getLog(CustomValidator.class);
private String validator;
@Override
public void initialize(Validate constraintAnnotation) {
validator = constraintAnnotation.method();
}
@Override
public boolean isValid(BusinessObject bo, ConstraintValidatorContext constraintContext) {
try {
return isValidForMethod(bo);
} catch (Exception e) {
/* Error durante la ejecución de la condición o del validador */
log.error("Error validating "+bo, e);
return false;
}
}
private boolean isValidForMethod(BusinessObject bo) throws Exception {
Method validatorMethod = ReflectionUtils.findMethod(bo.getClass(), validator, new Class[] {});
if (validatorMethod != null) {
/* Validator call */
Boolean valid = (Boolean) validatorMethod.invoke(bo);
return valid != null && valid;
} else {
/* Method not found */
log.error("Validator method not found.");
return false;
}
}
}
如果您计划定义更多约束,这种方法会很好。 您可以使用更多功能扩展它,例如验证条件或添加多个验证等。
题外话:
验证与 Spring Boot 无关,因此无需在您的问题中提及。
serialVersionUID = 1L; 是一个非常糟糕的主意。 使用您的 IDE serialVersionUID 生成器使用与 1L 不同的值填充此字段。
要绕过默认的 JPA 验证,该验证不具有与 Hibernate 验证器的 @NotEmpty 等效的功能,您可以尝试使用 @Size 注释来指定它必须大于或小于某个数字。
@NotNull
@Size(min=1)
private String description;
这是我能想到的最干净的方式来完成你想要做的事情。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.