摘要：前言在建立的過程中，往往需要對當前的測試樣例和注解進行驗證，比如檢查測試類是否含有非靜態內部類，測試類是否是的。的驗證機制非常精致而優美，在本次博客中我們就主要來談一談機制的實現。首先在中定義三個默認的類，如下。
前言
在建立Runner的過程中，往往需要對當前的測試樣例和注解進行驗證，比如檢查測試類是否含有非靜態內部類，測試類是否是Public的。Junit的驗證機制非常精致而優美，在本次博客中我們就主要來談一談Validator機制的實現。
指定一個驗證器
首先我們可以使用注解來指定某一個用戶自定義Validator來進行驗證，下面給出AnnotationValidator的父類以及相應注解。
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ValidateWith {
Class value();
}
public abstract class AnnotationValidator {
private static final List NO_VALIDATION_ERRORS = emptyList();
public List validateAnnotatedClass(TestClass testClass) {
return NO_VALIDATION_ERRORS;
}
public List validateAnnotatedField(FrameworkField field) {
return NO_VALIDATION_ERRORS;
}
public List validateAnnotatedMethod(FrameworkMethod method) {
return NO_VALIDATION_ERRORS;
}
}
以上可以很清楚地看出ValidateWith注解會指定相關的用戶自定義Validator。AnnotationValidator是真正執行驗證操作的單元，至于這些Validator的Validate方法在何時調用，我們會在文章的最后一部分講解。
對一個類進行驗證
從上面的代碼可以看出一個Validator需要實現三方面的驗證——對類的驗證、對方法的驗證、對域的驗證，Junit使用職責鏈模式來提供了三方面的驗證。
首先在AnnotationsValidator中定義三個默認的Validator類，如下。
private static class ClassValidator extends AnnotatableValidator {
@Override
Iterable getAnnotatablesForTestClass(TestClass testClass) {
return singletonList(testClass);
}
@Override
List validateAnnotatable(
AnnotationValidator validator, TestClass testClass) {
return validator.validateAnnotatedClass(testClass);
}
}
private static class MethodValidator extends
AnnotatableValidator {
@Override
Iterable getAnnotatablesForTestClass(
TestClass testClass) {
return testClass.getAnnotatedMethods();
}
@Override
List validateAnnotatable(
AnnotationValidator validator, FrameworkMethod method) {
return validator.validateAnnotatedMethod(method);
}
}
private static class FieldValidator extends
AnnotatableValidator {
@Override
Iterable getAnnotatablesForTestClass(TestClass testClass) {
return testClass.getAnnotatedFields();
}
@Override
List validateAnnotatable(
AnnotationValidator validator, FrameworkField field) {
return validator.validateAnnotatedField(field);
}
}
然后依次調用這三種Validator
private static final List> VALIDATORS = Arrays.>asList(
new ClassValidator(), new MethodValidator(), new FieldValidator());
/**
* Validate all annotations of the specified test class that are be
* annotated with {@link ValidateWith}.
*
* @param testClass
* the {@link TestClass} that is validated.
* @return the errors found by the validator.
*/
public List validateTestClass(TestClass testClass) {
List validationErrors= new ArrayList();
for (AnnotatableValidator validator : VALIDATORS) {
List additionalErrors= validator
.validateTestClass(testClass);
validationErrors.addAll(additionalErrors);
}
return validationErrors;
}
我們可以看到ClassValidator等都繼承自AnnotatableValidator，而且在真正驗證的時候調用的是它們的validateTestClass方法。它們其實也并非驗證的真正執行單元，它們首先找到相應TestClass的所有對應層面的注解，然后看這些注解是否是ValidateWith類型，是的話則由類的內置工廠來提供具體的AnnotationValidator。詳細情況我們在下一小節中描述。
擴展與默認的結合——漂亮的工廠
首先我們給出AnnotationValidatorFactory的定義
public class AnnotationValidatorFactory {
private static final ConcurrentHashMap VALIDATORS_FOR_ANNOTATION_TYPES =
new ConcurrentHashMap();
public AnnotationValidator createAnnotationValidator(ValidateWith validateWithAnnotation) {
AnnotationValidator validator = VALIDATORS_FOR_ANNOTATION_TYPES.get(validateWithAnnotation);
if (validator != null) {
return validator;
}
Class clazz = validateWithAnnotation.value();
try {
AnnotationValidator annotationValidator = clazz.newInstance();
VALIDATORS_FOR_ANNOTATION_TYPES.putIfAbsent(validateWithAnnotation, annotationValidator);
return VALIDATORS_FOR_ANNOTATION_TYPES.get(validateWithAnnotation);
} catch (Exception e) {
throw new RuntimeException("Exception received when creating AnnotationValidator class " + clazz.getName(), e);
}
}
}
工廠通過一個線程安全的Map存儲注解和對應的實際AnnotationValidator實例，而AnnotableValidator內置通過內置一個工廠來存儲所有對應層級的驗證器實例，并調用這些驗證器對應層級的驗證方法來返回可能的異常，我們下面貼出該內部類的代碼：
private static abstract class AnnotatableValidator {
private static final AnnotationValidatorFactory ANNOTATION_VALIDATOR_FACTORY = new AnnotationValidatorFactory();
abstract Iterable getAnnotatablesForTestClass(TestClass testClass);
abstract List validateAnnotatable(
AnnotationValidator validator, T annotatable);
public List validateTestClass(TestClass testClass) {
List validationErrors= new ArrayList();
for (T annotatable : getAnnotatablesForTestClass(testClass)) {
List additionalErrors= validateAnnotatable(annotatable);
validationErrors.addAll(additionalErrors);
}
return validationErrors;
}
private List validateAnnotatable(T annotatable) {
List validationErrors= new ArrayList();
for (Annotation annotation : annotatable.getAnnotations()) {
Class annotationType = annotation
.annotationType();
ValidateWith validateWith = annotationType
.getAnnotation(ValidateWith.class);
if (validateWith != null) {
AnnotationValidator annotationValidator = ANNOTATION_VALIDATOR_FACTORY
.createAnnotationValidator(validateWith);
List errors= validateAnnotatable(
annotationValidator, annotatable);
validationErrors.addAll(errors);
}
}
return validationErrors;
}
}
可以說這個帶工廠的內部類是一處神來之筆，整個流程是AnnotationsValidator類的validateTestClass方法依次調用職責鏈中三個層級的AnnotatableValidator，它們先找出所有對應層次上的注解，再濾掉那些不是ValidateWith類型的注解，然后通過一個工廠來維護所有驗證器實例，調用這些實例來真正驗證。因為對于不同的TestClass，我們在一個層面上只用維護一個工廠。使用內部類，只暴露應該暴露的，擴展的用戶只應擴展自定義的Validator，不應該在層次邏輯上進行擴展，不應該在整體驗證的AnnotationsValidator之外再使用任何多帶帶層次的AnnotatableValidator。
文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。
轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/65451.html
