Spring + Thymeleaf 自定义验证显示
Spring + Thymeleaf custom validation display
我一直在尝试让自定义 javax 验证工作(Spring Boot & Thymeleaf),但我不知道如何显示错误消息。问题似乎是,"normal" 错误(例如@Size、@NotNull 等)似乎在绑定结果中添加了一个 FieldError。我的自定义验证器虽然提供了一个 ObjectError。我不知道如何让 Thymeleaf 显示我的自定义错误(显然已通过,因为 th:errors="*{*}"
显示了它)。
非常感谢任何帮助。
更新:
我现在可以通过
显示错误消息
<p th:if="${#fields.hasErrors('${user}')}" th:errors="${user}"></p>
但是,如果我需要一个以上的验证器(例如确认密码和确认电子邮件),此解决方案将不起作用(如果一个不合适,则显示两条错误消息。如果您有建议,请不要犹豫。
下面是我为此使用的代码:
模板:
<p th:if="${#fields.hasErrors('username')}"th:errors="*{username}"></p>
<!-- works just fine -->
<p th:if="${#fields.hasErrors('*')}" th:errors="*{*}"></p>
<!-- works and displays all errors (for every field with an error,
including my custom validator) -->
<p th:if="${#fields.hasErrors('confirmPassword')}" th:errors="*{*}"></p>
<!-- does not work -->
<p th:if="${#fields.hasErrors('*')}" th:errors="*{confirmPassword}"></p>
<!-- does not work -->
验证器实现:
public class PasswordsEqualConstraintValidator implements
ConstraintValidator<PasswordsEqualConstraint, Object> {
@Override
public void initialize(PasswordsEqualConstraint arg0) {
}
@Override
public boolean isValid(Object candidate, ConstraintValidatorContext arg1) {
User user = (User) candidate;
return user.getPassword().equals(user.getConfirmPassword());
}
}
验证器接口:
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = PasswordsEqualConstraintValidator.class)
public @interface PasswordsEqualConstraint {
String message();
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
User.java:
@PasswordsEqualConstraint(message = "passwords are not equal")
public class User implements java.io.Serializable {
...
@Size(min=2, max=40)
private String username;
...
private String confirmPassword;
...
控制器:
@RequestMapping(value = "/signup", method = RequestMethod.POST)
public String signup(@Valid User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return "signup";
}
... do db stuff .. return "success";
}
这可能是因为您的@PasswordsEqualConstraint 分配给了整个 bean(类型)而不是字段 "confirmPassword"。要向具体字段添加可能的约束违规,您可以像下面的示例一样。
FieldMatch 比较两个字段,如果它们不相等,则将验证错误分配给第二个字段。
顺便说一句。这是您正在做的事情的更通用的解决方案。例如,对于密码,您可以像
这样使用它
@FieldMatch(first = "password", second = "confirmPassword", message = "Passowords are not equal.")
验证者:
public class FieldMatchValidator implements ConstraintValidator<FieldMatch, Object> {
private String firstFieldName;
private String secondFieldName;
@Override
public void initialize(final FieldMatch constraintAnnotation) {
firstFieldName = constraintAnnotation.first();
secondFieldName = constraintAnnotation.second();
}
@Override
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
try {
final Object firstObj = BeanUtils.getProperty(value, firstFieldName);
final Object secondObj = BeanUtils.getProperty(value, secondFieldName);
boolean isValid = firstObj == null && secondObj == null || firstObj != null && firstObj.equals(secondObj);
if (!isValid) {
context.disableDefaultConstraintViolation();
context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate()).addNode(secondFieldName).addConstraintViolation();
}
return isValid;
}
catch (final Exception ignore) {
// ignore
}
return true;
}
}
我终于得到了工作的批准答案,但只有在从第一个问题部分获得详细信息之后。一开始并不清楚如何定义 @FieldMatch 接口。主要是
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FieldMatchValidator.class)
在 FieldMatch 界面中是必需的。
这是 spring 文档。 http://dolszewski.com/spring/custom-validation-annotation-in-spring/
spring 文档显示
@Target({ElementType.METHOD, ElementType.FIELD})
这让我很困惑,因为当 isValid 被调用时目标是方法和字段对象只是我放置 @FieldMatch 注释的 1 属性的值。但是有
@Target({ElementType.TYPE})
然后,当调用 Valid 时,我得到了正在验证的整个 bean,我可以转换为它或使用反射来获取值。
我一直在尝试让自定义 javax 验证工作(Spring Boot & Thymeleaf),但我不知道如何显示错误消息。问题似乎是,"normal" 错误(例如@Size、@NotNull 等)似乎在绑定结果中添加了一个 FieldError。我的自定义验证器虽然提供了一个 ObjectError。我不知道如何让 Thymeleaf 显示我的自定义错误(显然已通过,因为 th:errors="*{*}"
显示了它)。
非常感谢任何帮助。
更新: 我现在可以通过
显示错误消息<p th:if="${#fields.hasErrors('${user}')}" th:errors="${user}"></p>
但是,如果我需要一个以上的验证器(例如确认密码和确认电子邮件),此解决方案将不起作用(如果一个不合适,则显示两条错误消息。如果您有建议,请不要犹豫。
下面是我为此使用的代码:
模板:
<p th:if="${#fields.hasErrors('username')}"th:errors="*{username}"></p>
<!-- works just fine -->
<p th:if="${#fields.hasErrors('*')}" th:errors="*{*}"></p>
<!-- works and displays all errors (for every field with an error,
including my custom validator) -->
<p th:if="${#fields.hasErrors('confirmPassword')}" th:errors="*{*}"></p>
<!-- does not work -->
<p th:if="${#fields.hasErrors('*')}" th:errors="*{confirmPassword}"></p>
<!-- does not work -->
验证器实现:
public class PasswordsEqualConstraintValidator implements
ConstraintValidator<PasswordsEqualConstraint, Object> {
@Override
public void initialize(PasswordsEqualConstraint arg0) {
}
@Override
public boolean isValid(Object candidate, ConstraintValidatorContext arg1) {
User user = (User) candidate;
return user.getPassword().equals(user.getConfirmPassword());
}
}
验证器接口:
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = PasswordsEqualConstraintValidator.class)
public @interface PasswordsEqualConstraint {
String message();
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
User.java:
@PasswordsEqualConstraint(message = "passwords are not equal")
public class User implements java.io.Serializable {
...
@Size(min=2, max=40)
private String username;
...
private String confirmPassword;
...
控制器:
@RequestMapping(value = "/signup", method = RequestMethod.POST)
public String signup(@Valid User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
return "signup";
}
... do db stuff .. return "success";
}
这可能是因为您的@PasswordsEqualConstraint 分配给了整个 bean(类型)而不是字段 "confirmPassword"。要向具体字段添加可能的约束违规,您可以像下面的示例一样。
FieldMatch 比较两个字段,如果它们不相等,则将验证错误分配给第二个字段。
顺便说一句。这是您正在做的事情的更通用的解决方案。例如,对于密码,您可以像
这样使用它@FieldMatch(first = "password", second = "confirmPassword", message = "Passowords are not equal.")
验证者:
public class FieldMatchValidator implements ConstraintValidator<FieldMatch, Object> {
private String firstFieldName;
private String secondFieldName;
@Override
public void initialize(final FieldMatch constraintAnnotation) {
firstFieldName = constraintAnnotation.first();
secondFieldName = constraintAnnotation.second();
}
@Override
public boolean isValid(final Object value, final ConstraintValidatorContext context) {
try {
final Object firstObj = BeanUtils.getProperty(value, firstFieldName);
final Object secondObj = BeanUtils.getProperty(value, secondFieldName);
boolean isValid = firstObj == null && secondObj == null || firstObj != null && firstObj.equals(secondObj);
if (!isValid) {
context.disableDefaultConstraintViolation();
context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate()).addNode(secondFieldName).addConstraintViolation();
}
return isValid;
}
catch (final Exception ignore) {
// ignore
}
return true;
}
}
我终于得到了工作的批准答案,但只有在从第一个问题部分获得详细信息之后。一开始并不清楚如何定义 @FieldMatch 接口。主要是
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FieldMatchValidator.class)
在 FieldMatch 界面中是必需的。
这是 spring 文档。 http://dolszewski.com/spring/custom-validation-annotation-in-spring/
spring 文档显示 @Target({ElementType.METHOD, ElementType.FIELD})
这让我很困惑,因为当 isValid 被调用时目标是方法和字段对象只是我放置 @FieldMatch 注释的 1 属性的值。但是有 @Target({ElementType.TYPE}) 然后,当调用 Valid 时,我得到了正在验证的整个 bean,我可以转换为它或使用反射来获取值。