Spring + Thymeleaf custom validation display

Question

I've been trying to get custom javax validation working (Spring Boot & Thymeleaf), but I cannot figure out how to display the error message. The problem seems to be, that "normal" errors (e.g. @Size, @NotNull, etc.) seem to add a a FieldError to the binding result. My custom validator delivers an ObjectError though. I can't figure out how to get Thymeleaf to display my custom error (which obviously gets passed, since th:errors="*{*}" shows it).

Any help is greatly appreciated.

UPDATE: I can now display the error message via

<p th:if="${#fields.hasErrors('${user}')}" th:errors="${user}"></p>

However, if I need more than one validator (e.g. confirm password and confirm email) this solution will not work (or display both error messages if one doesn't fit. Don't hesitate if you have a suggestion.

Below is the code I've used for this:

Template:

<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 -->

Validator implementation:

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());
    }
}

Validator interface:

@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;
...

Controller:

@RequestMapping(value = "/signup", method = RequestMethod.POST)
public String signup(@Valid User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            return "signup";
        }
        ... do db stuff .. return "success";
}

Marek Raki · Accepted Answer · 2015-09-18T14:19:37.197

This is probably because your @PasswordsEqualConstraint is assigned to the whole bean (type) not field "confirmPassword". To add possible constraint violation to a concrete field you may do like on example below.

FieldMatch compares two fields if they are not equal then the validation error is assigned to the second field.

BTW. this is more generic solution for the thing you are doing. Fo example for passwords you may use it like

@FieldMatch(first = "password", second = "confirmPassword", message = "Passowords are not equal.")

validator:

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;
  }
}

Works like a charm, thanks a lot! One little change to your answer is to use addPropertyNode() instead of the deprecated addNode() method. — Lukehey, Sep 20 '15 at 13:05

emmmdeee · Answer 2 · 2017-08-08T19:23:55.750

I finally got the approved answer to work but only after getting details from the first question section. It was unclear at first exactly how to define the @FieldMatch interface. Mainly that

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FieldMatchValidator.class)

are required in the FieldMatch interface.

Here is the spring documentation. http://dolszewski.com/spring/custom-validation-annotation-in-spring/

The spring documentation shows @Target({ElementType.METHOD, ElementType.FIELD})

which was messing me up because with target being Method and Field when isValid got called Object was only ever the value of the 1 attribute I put the @FieldMatch annotation on. But having @Target({ElementType.TYPE}) Then when is Valid is called I get the whole bean that's being validated and I can either cast to it or use reflection to get the values.

Spring + Thymeleaf custom validation display

2 Answers2

Linked