百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程字典 > 正文

Hibernate Validator 第12篇缺省的内插约束错误信息

toyiye 2024-06-21 12:17 7 浏览 0 评论

消息插值是为违反Jakarta Bean验证约束创建错误消息的过程。在本篇文章中,你将了解如何定义和解析这些消息,以及在默认的方法不能满足您的需求时,如何自定义消息内插器。

一、缺省的消息内插器

约束违反消息来源于所谓的消息描述器。每个约束使用这个message属性,定义它自己的消息描述器。

在声明的时候,这个缺省的描述器可以通过一个指定的值,被重写。看下面例子:

public class Car {
 @NotNull(message = "The manufacturer name must not be null") 
 	private String manufacturer;
}

如果一个约束被违反,它的描述器会被验证引擎使用的当前配置的MessageInterpolator插入。这个插入的错误消息可以通过调用ConstraintViolation#getMessage()方法,从产生的约束违例中检索。

消息描述器可以包含容器参数,也可以包含消息表达式,它们可以在插入期间被解析。消息参数是字符串常量,存放在{}中,而消息表达式是字符串常量,并被包含在${}中使用。

下面的算法在方法插入期间被应用。

  1. 使用任何消息参数作为资源包ValidationMessages的键来解析它们。如果这个包包含一个给定的消息参数的实体,那么这个参数可以应用在相关的资源包中的值中。这一步可以被递归的执行以代替约束中的消息参数。这个资源包是开发者提供,因此,通过增加一个名为ValidationMessage.properties在类路径中。你也可以创建一个本地的错误消息,通过提供一个这个包的特定地区变体,例如ValidationMessages_en_US.properties. 如果不设置的话,这个JVM的默认的局部的(Locale#getDefault)将会被使用,在包中寻找消息。
  2. 使用任何消息参数作为资源包ValidationMessages的键来解析它们,资源包包含标准的错误信息,在内建约束中被定义在附录B中,在Jakarta Bean Validation 规范中。在Hibernate Valdiator,这个资源包叫做org.hibernate.validator.ValidationMessages. 如果这一步触发了一个替换,步骤一会被再次执行,否则步骤三会被应用。
  3. 解析任何消息参数,使用约束注解中相同名字的值替换他们的值。这允许推断约束中属性的值(例如,Size#mis())在错误消息中(例如必须至少大于${min})。
  4. 解析任何消息表达式,解析他们使用统一表达式语言。

1.1 特殊字符

既然这个“{”,"}"和"$"有一个特殊的含义,在消息表达器中。如果你想按字面意思使用它们,那么它们需要被转义。下面的规则可以使用:

  • “\{”可以认为是"{"
  • “\}”可以认为是"}"
  • \$可以认为是$
  • \\可以认为是\

1.2 内插消息表达式

由于Hibernate Validator5(Bean Validation 1.1),它可以使用Jakarta 表达式语言,在约束消息中。这允许基于条件逻辑和使用高级的形式定义错误消息。这个验证引擎使下面的选项有效在EL(表达式语言)环境中。

  • 属性值和属性的名字映射对应起来。
  • 当前的校验的值(属性,bean,方法参数等等)在名为validatedValue下面。
  • 一个bean映射了一个名字格式器,通过解析一个参数方法format(String format, Object... args),它表现的就像java.util.Format.format(String format, Object...args).

下面的部分,提供了一些使用EL表达式的例子,在错误信息中。

1.3 例子

package org.hibernate.validator.referenceguide.chapter04.complete;
public class Car { 
 @NotNull 
 private String manufacturer; 
 
 @Size( 
 min = 2, 
 max = 14, 
 message = "The license plate '${validatedValue}' must be between {min} and {max} characters long" ) 
 private String licensePlate; 
 
 @Min( 
 value = 2, 
 message = "There must be at least {value} seat${value > 1 ? 's' : ''}" ) 
 private int seatCount; 
 
 @DecimalMax( 
 value = "350", 
 message = "The top speed ${formatter.format('%1$.2f', validatedValue)} is higher than {value}" ) 
 private double topSpeed; 
 
 @DecimalMax(value = "100000", 
 message = "Price must not be higher than ${value}") 
 		private BigDecimal price; 
 
 public Car( 
 String manufacturer, 
 String licensePlate, 
 int seatCount, 
 double topSpeed, 
 BigDecimal price) { 
 this.manufacturer = manufacturer; 
 this.licensePlate = licensePlate; 
 this.seatCount = seatCount; 
 this.topSpeed = topSpeed; 
 this.price = price; 
 } 
 //getters and setters ...
} 

验证无效的Car实例会导致对消息的约束违反:

  • 这个@NotNull约束在manufacturer成员变量上,引起了错误消息是“must not be null”,因为这个默认的消息定义在Jakarta Bean Validation规范中,并且没有指定描述器在这个消息属性上。
  • 这个@Size约束应用在licensePlate成员变量上,展示了内插的消息参数({min},{max})和如何增加校验的值在错误信息中,通过使用EL表达式${validatedValue}.
  • 这个@Min约束应用在seatCount上,如何使用带有三元表达式的EL表达式来动态地选择单复数形式,这取决于约束的一个属性(“There must be at 1 seat ” vs "There must be at least 2 seats")。
  • 在应用在topSpeed上的@DecimalMax约束的消息展示了如何格式化校验了的值,使用格式化实例。
  • 最终,这个@DecimalMax注解应用在price上展示了内插参数表达式优于表达式求值,导致$标识显示在maximum price的前面。

看下面的例子:期待的错误信息。

Car car = new Car( null, "A", 1, 400.123456, BigDecimal.valueOf( 200000 ) );
String message = validator.validateProperty( car, "manufacturer" ) 
 .iterator() 
 .next() 
 .getMessage();

assertEquals( "must not be null", message );
message = validator.validateProperty( car, "licensePlate" ) 
 .iterator() 
 .next() 
 .getMessage();

assertEquals( "The license plate 'A' must be between 2 and 14 characters long", message);
message = validator.validateProperty( car, "seatCount" )
 .iterator()
 .next()
 .getMessage();

assertEquals( "There must be at least 2 seats", message );
message = validator.validateProperty( car, "topSpeed" )
 .iterator()
 .next()
 .getMessage();

assertEquals( "The top speed 400.12 is higher than 350", message );
message = validator.validateProperty( car, "price" )
 .iterator()
 .next(.getMessage();

assertEquals( "Price must not be higher than $100000", message );

相关推荐

为何越来越多的编程语言使用JSON(为什么编程)

JSON是JavascriptObjectNotation的缩写,意思是Javascript对象表示法,是一种易于人类阅读和对编程友好的文本数据传递方法,是JavaScript语言规范定义的一个子...

何时在数据库中使用 JSON(数据库用json格式存储)

在本文中,您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?,Devops,敏捷?,测试?以及?项目?管理?最新?,最热门?的?文章?,每天?花?...

MySQL 从零开始:05 数据类型(mysql数据类型有哪些,并举例)

前面的讲解中已经接触到了表的创建,表的创建是对字段的声明,比如:上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...

JSON对象花样进阶(json格式对象)

一、引言在现代Web开发中,JSON(JavaScriptObjectNotation)已经成为数据交换的标准格式。无论是从前端向后端发送数据,还是从后端接收数据,JSON都是不可或缺的一部分。...

深入理解 JSON 和 Form-data(json和formdata提交区别)

在讨论现代网络开发与API设计的语境下,理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里,特别值得关注的是两种主流数据格式:...

JSON 语法(json 语法 priority)

JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...

JSON语法详解(json的语法规则)

JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意:json的key是字符串,且必须是双引号,不能是单引号...

MySQL JSON数据类型操作(mysql的json)

概述mysql自5.7.8版本开始,就支持了json结构的数据存储和查询,这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库,在处理json这种非结构化的数据...

JSON的数据模式(json数据格式示例)

像XML模式一样,JSON数据格式也有Schema,这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...

前端学习——JSON格式详解(后端json格式)

JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...

什么是 JSON:详解 JSON 及其优势(什么叫json)

现在程序员还有谁不知道JSON吗?无论对于前端还是后端,JSON都是一种常见的数据格式。那么JSON到底是什么呢?JSON的定义...

PostgreSQL JSON 类型:处理结构化数据

PostgreSQL提供JSON类型,以存储结构化数据。JSON是一种开放的数据格式,可用于存储各种类型的值。什么是JSON类型?JSON类型表示JSON(JavaScriptO...

JavaScript:JSON、三种包装类(javascript 包)

JOSN:我们希望可以将一个对象在不同的语言中进行传递,以达到通信的目的,最佳方式就是将一个对象转换为字符串的形式JSON(JavaScriptObjectNotation)-JS的对象表示法...

Python数据分析 只要1分钟 教你玩转JSON 全程干货

Json简介:Json,全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...

比较一下JSON与XML两种数据格式?(json和xml哪个好)

JSON(JavaScriptObjectNotation)和XML(eXtensibleMarkupLanguage)是在日常开发中比较常用的两种数据格式,它们主要的作用就是用来进行数据的传...

取消回复欢迎 发表评论:

请填写验证码