摘要：前言在建立的過(guò)程中，往往需要對(duì)當(dāng)前的測(cè)試樣例和注解進(jìn)行驗(yàn)證，比如檢查測(cè)試類是否含有非靜態(tài)內(nèi)部類，測(cè)試類是否是的。的驗(yàn)證機(jī)制非常精致而優(yōu)美，在本次博客中我們就主要來(lái)談一談機(jī)制的實(shí)現(xiàn)。首先在中定義三個(gè)默認(rèn)的類，如下。

在建立Runner的過(guò)程中，往往需要對(duì)當(dāng)前的測(cè)試樣例和注解進(jìn)行驗(yàn)證，比如檢查測(cè)試類是否含有非靜態(tài)內(nèi)部類，測(cè)試類是否是Public的。Junit的驗(yàn)證機(jī)制非常精致而優(yōu)美，在本次博客中我們就主要來(lái)談一談Validator機(jī)制的實(shí)現(xiàn)。

首先我們可以使用注解來(lái)指定某一個(gè)用戶自定義Validator來(lái)進(jìn)行驗(yàn)證，下面給出AnnotationValidator的父類以及相應(yīng)注解。

@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注解會(huì)指定相關(guān)的用戶自定義Validator。AnnotationValidator是真正執(zhí)行驗(yàn)證操作的單元，至于這些Validator的Validate方法在何時(shí)調(diào)用，我們會(huì)在文章的最后一部分講解。

從上面的代碼可以看出一個(gè)Validator需要實(shí)現(xiàn)三方面的驗(yàn)證——對(duì)類的驗(yàn)證、對(duì)方法的驗(yàn)證、對(duì)域的驗(yàn)證，Junit使用職責(zé)鏈模式來(lái)提供了三方面的驗(yàn)證。

首先在AnnotationsValidator中定義三個(gè)默認(rèn)的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);
        }
    }

然后依次調(diào)用這三種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，而且在真正驗(yàn)證的時(shí)候調(diào)用的是它們的validateTestClass方法。它們其實(shí)也并非驗(yàn)證的真正執(zhí)行單元，它們首先找到相應(yīng)TestClass的所有對(duì)應(yīng)層面的注解，然后看這些注解是否是ValidateWith類型，是的話則由類的內(nèi)置工廠來(lái)提供具體的AnnotationValidator。詳細(xì)情況我們?cè)谙乱恍」?jié)中描述。

首先我們給出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);
        }
    }

}

工廠通過(guò)一個(gè)線程安全的Map存儲(chǔ)注解和對(duì)應(yīng)的實(shí)際AnnotationValidator實(shí)例，而AnnotableValidator內(nèi)置通過(guò)內(nèi)置一個(gè)工廠來(lái)存儲(chǔ)所有對(duì)應(yīng)層級(jí)的驗(yàn)證器實(shí)例，并調(diào)用這些驗(yàn)證器對(duì)應(yīng)層級(jí)的驗(yàn)證方法來(lái)返回可能的異常，我們下面貼出該內(nèi)部類的代碼：

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;
        }
    }

可以說(shuō)這個(gè)帶工廠的內(nèi)部類是一處神來(lái)之筆，整個(gè)流程是AnnotationsValidator類的validateTestClass方法依次調(diào)用職責(zé)鏈中三個(gè)層級(jí)的AnnotatableValidator，它們先找出所有對(duì)應(yīng)層次上的注解，再濾掉那些不是ValidateWith類型的注解，然后通過(guò)一個(gè)工廠來(lái)維護(hù)所有驗(yàn)證器實(shí)例，調(diào)用這些實(shí)例來(lái)真正驗(yàn)證。因?yàn)閷?duì)于不同的TestClass，我們?cè)谝粋€(gè)層面上只用維護(hù)一個(gè)工廠。使用內(nèi)部類，只暴露應(yīng)該暴露的，擴(kuò)展的用戶只應(yīng)擴(kuò)展自定義的Validator，不應(yīng)該在層次邏輯上進(jìn)行擴(kuò)展，不應(yīng)該在整體驗(yàn)證的AnnotationsValidator之外再使用任何多帶帶層次的AnnotatableValidator。