PathVariable 'name'が検証に合格しない場合、javax.validation.ConstraintViolationExceptionがスローされます。スローされたjavax.validation.ConstraintViolationExceptionでパラメータ名を取得する方法はありますか?
@RestController
@Validated
public class HelloController {
@RequestMapping("/hi/{name}")
public String sayHi(@Size(max = 10, min = 3, message = "name should have between 3 and 10 characters") @PathVariable("name") String name) {
return "Hi " + name;
}
次の例外ハンドラは、それがどのように機能するかを示しています。
@ExceptionHandler(ConstraintViolationException.class)
ResponseEntity<Set<String>> handleConstraintViolation(ConstraintViolationException e) {
Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
Set<String> messages = new HashSet<>(constraintViolations.size());
messages.addAll(constraintViolations.stream()
.map(constraintViolation -> String.format("%s value '%s' %s", constraintViolation.getPropertyPath(),
constraintViolation.getInvalidValue(), constraintViolation.getMessage()))
.collect(Collectors.toList()));
return new ResponseEntity<>(messages, HttpStatus.BAD_REQUEST);
}
無効な値(名前)にアクセスするには
constraintViolation.getInvalidValue()
プロパティ名 'name'にアクセスするには
constraintViolation.getPropertyPath()
このメソッドを使用します(例はConstraintViolationExceptionインスタンスです):
Set<ConstraintViolation<?>> set = ex.getConstraintViolations();
List<ErrorField> errorFields = new ArrayList<>(set.size());
ErrorField field = null;
for (Iterator<ConstraintViolation<?>> iterator = set.iterator();iterator.hasNext(); ) {
ConstraintViolation<?> next = iterator.next();
System.out.println(((PathImpl)next.getPropertyPath())
.getLeafNode().getName() + " " +next.getMessage());
}
getPropertyPath()
の戻り値を調べると、Iterable<Node>
そしてイテレータの最後の要素はフィールド名です。次のコードは私のために働きます:
// I only need the first violation
ConstraintViolation<?> violation = ex.getConstraintViolations().iterator().next();
// get the last node of the violation
String field = null;
for (Node node : violation.getPropertyPath()) {
field = node.getName();
}
同じ問題がありましたが、getPropertyPathから「sayHi.arg0」も取得しました。 NotNullアノテーションは、私たちのパブリックAPIの一部であるため、メッセージを追加することにしました。お気に入り:
@NotNull(message = "timezone param is mandatory")
呼び出してメッセージを取得できます
ConstraintViolation#getMessage()
Path
の最後の部分であるパラメーター名のみを取得します。
violations.stream()
.map(violation -> String.format("%s value '%s' %s", StreamSupport.stream(violation.getPropertyPath().spliterator(), false).reduce((first, second) -> second).orElse(null),
violation.getInvalidValue(), violation.getMessage())).collect(Collectors.toList());