Bean Validation：如何手动创建 ConstraintViolation？

Question

我有一个特定的场景，我只能在流程的稍后阶段手动检查违规条件。

我想要做的是抛出一个ConstraintViolationException，并为其提供一个“真实的”ConstraintViolation object（当我在堆栈中捕获异常时，我使用#{validatedValue} 和violation.getPropertyPath() 参数）。

如何在不让框架通过注释为我完成的情况下自己创建ConstraintViolation（我使用 Hibernate Validator）？

代码示例：

List<String> columnsListForSorting = new ArrayList<String>(service.getColumnsList(domain));
Collections.sort(columnsListForSorting);

String firstFieldToSortBy = this.getTranslatedFieldName(domain.getClass().getCanonicalName(), sortingInfo.getSortedColumn());
if (!columnsListForSorting.contains(firstFieldToSortBy)){
    throw new ConstraintViolationException(<what here?...>);
}

谢谢。

Answer 1

我已经多次遇到这个问题并想出了这个小解决方案。 它基于 Validator 的 validateValue 方法，并在测试类中使用了一个 helper-validator，用于在一行中生成一个 Set<ConstraintViolation<T>> 对象。

假设您正在测试一个内部使用验证器的类，在我们的测试中模拟，对象“数据数据”具有 Bean 验证注释，例如字段“sessionId”用@NotNull 注释。

您的测试类将至少有以下两个成员：

@Mock
private Validator validator;

private Validator violationCreatorValidator;

@Before
public void setup() {
     MockitoAnnotations.initMocks(this);
     violationsGenerator.Validation.buildDefaultValidatorFactory().getValidator();
}

然后在测试用例中：

when(validator.validate(data))
.thenReturn(violationsGenerator.validateValue(Data.class, "sessionId", null));

就是这样。无需实现 ConstraintViolation 接口或调用可怕的 ConstraintViolationImpl.forBeanValidation。让验证器为您完成这项工作。

Answer 2

为什么不在您的测试中注入Validator 并创建一个触发您想要的验证错误的对象？

Set<ConstraintViolation<T>> res = validator.validate(object);

Answer 3

我不喜欢 Hibernate Validator 的另一个原因。他们使得以编程方式创建一个简单的违规真的很困难，而实际上它应该很简单。我确实有测试代码，我需要在其中创建违规以提供给我的模拟子系统。

无论如何，没有滚动您自己的违规约束实现 - 这是我为字段创建违规的方法：

private static final String MESSAGE_TEMPLATE = "{messageTemplate}";
private static final String MESSAGE = "message";

public static <T, A extends Annotation> ConstraintViolation<T> forField(
  final T rootBean, 
  final Class<T> clazz,
  final Class<A> annotationClazz,
  final Object leafBean, 
  final String field, 
  final Object offendingValue) {

  ConstraintViolation<T> violation = null;
  try {
    Field member = clazz.getDeclaredField(field);
    A annotation = member.getAnnotation(annotationClazz);
    ConstraintDescriptor<A> descriptor = new ConstraintDescriptorImpl<>(
      new ConstraintHelper(), 
      member, 
      annotation, 
      ElementType.FIELD);
    Path p = PathImpl.createPathFromString(field);
    violation = ConstraintViolationImpl.forBeanValidation(
      MESSAGE_TEMPLATE, 
      MESSAGE, 
      clazz, 
      rootBean, 
      leafBean,
      offendingValue, 
      p, 
      descriptor, 
      ElementType.FIELD);
  } catch (NoSuchFieldException ignore) {}
  return violation;

}

HTH

Answer 4

这里有几件事：

1. ConstraintViolation 是一个接口，因此您可以实现自己的版本

2. Hibernate Validator 使用它自己的内部接口实现 - org.hibernate.validator.internal.engine.ConstraintViolationImpl。它是一个公共类，但由于它位于 internal 包中，因此不鼓励您直接使用它。但是，您可能会知道实现 ConstraintViolation 需要什么。

Answer 5

在我看来，最简单的方法是模拟你的服务在你的测试中抛出约束冲突。例如，您可以通过扩展类来手动完成，也可以使用模拟框架，例如mockito。我更喜欢模拟框架，因为它们大大简化了事情，因为您不必创建和维护额外的类，也不必处理将它们注入到您的测试对象中。

以 mockito 为起点，您可能会编写类似以下内容：

import org.hibernate.exception.ConstraintViolationException;
import org.mockito.InjectMocks;
import org.mockito.Mock;

import static org.mockito.Mockito.when;


public class MyTest {
    @Mock /* service mock */
    private MyService myService;

    @InjectMocks /* inject the mocks in the object under test */
    private ServiceCaller serviceCaller;

    @Test
    public void shouldHandleConstraintViolation() {
        // make the mock throw the exception when called
        when(myService.someMethod(...)).thenThrow(new ConstraintViolationException(...))

        // get the operation result
        MyResult result = serviceCaller.doSomeStuffWhichInvokesTheServiceMethodThrowingConstraintViolation();

        // verify all went according to plan
        assertWhatever(result);
    }
}