在Java的JAX-RS框架中，Bean Validation是一个非常强大的功能，它可以用于验证输入数据是否符合预期的规则。然而，默认情况下，当验证失败时，Jersey会抛出ConstraintViolationException，并返回一个“Bad Request”（400）错误。虽然这已经足够用于基本的验证，但有时候我们可能需要更详细的错误信息来帮助用户理解问题所在。本文将通过一个完整的示例，展示如何实现自定义的ExceptionMapper来返回更友好的验证错误信息。
-
实现自定义ExceptionMapper
为了实现自定义的异常处理逻辑，我们需要创建一个实现了ExceptionMapper接口的类。以下是具体的实现代码：
java复制
@Provider
public class MyExceptionMapper implements ExceptionMapper {
@Override
public Response toResponse(final ConstraintViolationException exception) {
return Response.status(Response.Status.BAD_REQUEST)
.entity(prepareMessage(exception))
.type(“text/plain”)
.build();
}private String prepareMessage(ConstraintViolationException exception) {
StringBuilder msg = new StringBuilder();
for (ConstraintViolation<?> cv : exception.getConstraintViolations()) {
msg.append(cv.getPropertyPath()).append(" “).append(cv.getMessage()).append(”\n");
}
return msg.toString();
}
}
在这个实现中，toResponse方法会捕获ConstraintViolationException，并调用prepareMessage方法来生成详细的错误信息。prepareMessage方法会遍历所有的验证错误，并将它们格式化为一个字符串，最终返回给客户端。 -
创建带有验证注解的JAX-RS资源
接下来，我们需要创建一个JAX-RS资源类，并在其中使用Bean Validation注解来定义验证规则。以下是一个简单的示例：
java复制
@Path(“/customers”)
public class CustomerResource {
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public String createCustomer(@NotNull @FormParam(“name”) String name,
@NotNull @FormParam(“address”) String address,
@NotNull @Pattern(regexp = “\d{3}-\d{3}-\d{4}”)
@FormParam(“phone-number”) String phoneNumber) {
System.out.println(“-- in createCustomer() method --”);
return String.format(“created dummy customer name: %s, address: %s, phoneNumber:%s%n”,
name, address, phoneNumber);
}
}
在这个资源类中，我们定义了一个createCustomer方法，它接收三个表单参数：name、address和phone-number。我们使用了@NotNull注解来确保这些参数不能为空，并且使用了@Pattern注解来验证phone-number是否符合特定的格式。 -
测试自定义异常处理逻辑
为了测试我们的自定义异常处理逻辑，我们可以编写一个简单的JAX-RS客户端来发送请求并接收响应。以下是客户端的代码：
java复制
public class MyClient {
public static void main(String[] args) throws Exception {
Form form = new Form();
form.param(“name”, null)
.param(“address”, null)
.param(“phone-number”, “343-343-343”);
Client client = ClientBuilder.newBuilder().build();
WebTarget target = client.target(“http://localhost:8080/customers”);
Future future = target.request(MediaType.APPLICATION_FORM_URLENCODED)
.buildPost(Entity.form(form))
.submit(Response.class);
Response r = future.get();
if (r.getStatus() != Response.Status.OK.getStatusCode()) {
System.out.println(r.getStatus() + " - " + r.getStatusInfo());
}
System.out.println(r.readEntity(String.class));
}
}
在这个客户端中，我们故意发送了一个无效的请求，其中name和address参数为空，phone-number参数不符合格式。运行客户端后，我们得到了以下输出：
复制
400 - Bad Request
createCustomer.arg0 may not be null
createCustomer.arg1 may not be null
createCustomer.arg2 must match “\d{3}-\d{3}-\d{4}”
可以看到，我们的自定义ExceptionMapper成功地返回了详细的验证错误信息。 -
项目依赖与技术栈
为了运行上述示例，我们需要以下依赖和环境：
jersey-server 2.25.1：Jersey核心服务器实现。
jersey-container-servlet 2.25.1：Jersey核心Servlet 3.x实现。
jersey-bean-validation 2.25.1：Jersey扩展模块，提供对Bean Validation（JSR-349）API的支持。
JDK 1.8
Maven 3.5.4
通过上述依赖和环境，我们可以轻松地实现和测试自定义的Bean Validation异常处理逻辑。
总结
通过实现自定义的ExceptionMapper，我们可以更好地控制Bean Validation失败时的响应行为，从而为用户提供更友好的错误信息。这不仅可以提高用户体验，还可以帮助开发人员更快地定位问题。希望本文的示例能够帮助你更好地理解和应用这一技术。
