EffectiveJava(35) -- 注解优先于命名模式(从零构建JUnit测试类)

在 java1.5 版本之前的代码中 , 一般使用命名模式表明哪些程序元素需要通过某种工具或框架进行特殊处理 . 但是它有严重的缺点 – 以 Junit 为例

1.由于 JUnit 要求测试方法的开头必须为test , 所以类名的文字拼写会导致运行失败 , 但是编译器不会报错或提示

2.无法确保它们只用于相应的程序元素上

3.命名模式没有提供将参数值与程序元素关联起来的方法 例如想要支持只在抛出异常时才会运行成功的测试类

而注解则很好地解决了这些问题

例如我们自定义一个 JUnit 的 Test 注解

//元注解:注解注解的注解
@Retention(RetentionPolicy.RUNTIME) //它注明的注解应该在运行时保留
@Target(ElementType.METHOD) //他注明的注解表明Test注解只在方法声明中才是合法的
public @interface Test {
}

由于Test注解没有参数 , 只是”标注”被注解的元素 , 所以它被称作标记注解 接下来我们测试我们自定义的Test注解 , 在没写测试方法之前 , 我们可以通过上面的解释猜到一下测试方法的运行结果

public class Sample {
@Test
public static void t1() {
//  运行成功或失败
}
@Test
public static void t2() {
//抛出异常
throw new RuntimeException("BOOM");
}
@Test
public  void t3() {
//运行成功或失败
}
@Test
public static void t4() {
//抛出异常
throw new RuntimeException("Crash");
}
}

这是由于Test注解只能被用作无参的静态方法标注

接下来我们完成测试方法 , 检验我们的猜测

public class RunTests {
public static void main(String[] args) {
int tests = 0;
int passed = 0;
try {
Class testClass = Class.forName(args[0]);
for (Method m : testClass.getDeclaredMethods()) {
//isAnnotationPresent告知该工具要运行哪些方法
if (m.isAnnotationPresent(Test.class)) {
tests++;
try {
//反射式的运行所有标注了Test的方法
m.invoke(null);
passed++;
//如果测试方法抛出异常,反射机制就会将他封装在InvocationTargetException并打印报告  如t2 t4
} catch (InvocationTargetException e) {
Throwable exc = e.getCause();
System.out.println(m + "failed: " + exc);
} catch (Exception e) {
System.out.println("Invalid @Test: " + m);
}
}
}
System.out.printf("Passed: %d,Failed: %d%n", passed, tests - passed);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}

控制台输出

Invalid @Test:public static void Sample.t1()
public static void Sample.t2() failed:RuntimeException:BOOM
public static void Sample.t4() failed:RuntimeException:Crash
passed:1,Failed:3

结果正如我们所料

那么可以不可利用注解忽略异常组 , 使程序在抛出指定异常时依旧执行成功呢 ?让我们来测试一下

注解方法 –

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ExceptionTest {
//Class<? extends Exception>某个扩展Exception的类的Class对象 ; value:注解中的方法
Class<? extends Exception>[] value();
}

Sample --

public class Sample2 {
@ExceptionTest({ArithmeticException.class,NullPointExcepition.class})
public static void t1() {
int i = 0;
i = i / 0;
}
}

main方法 --

public class RunTests {
public static void main(String[] args) {
int tests = 0;
int passed = 0;
try {
Class testClass = Class.forName(args[0]);
for (Method m : testClass.getDeclaredMethods()) {
//isAnnotationPresent告知该工具要运行哪些方法
if (m.isAnnotationPresent(Test.class)) {
tests++;
try {
//反射式的运行所有标注了Test的方法
m.invoke(null);
System.out.printf("测试 %s 失败:没有注解这个异常%n",m);
//如果测试方法抛出异常,反射机制就会将他封装在InvocationTargetException并打印报告
} catch (InvocationTargetException e) {
//提取注解参数的值 , 并用它检验该测试抛出的异常是否为正确的类型
Throwable exc = e.getCause();
Class<? extends Exception>[] excTypes = m.getAnnotation(ExceptionTest.class).value();
int oldPassed = passed;
for(Class<? extends Exception> excType :excTypes){
if(excType.isInstance(exc)){
passed++;
break;
}
}
if(passed == oldPassed){
System.out.printf("测试%s失败:%s %n",m,exc);
}
} catch (Exception e) {
System.out.println("Invalid @Test: " + m);
}
}
}
System.out.printf("Passed: %d,Failed: %d%n", passed, tests - passed);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}

以上的例子不揭露了注解的冰山一角 , 但它鲜明了表达了一个观点 , 既然有了注解 , 就不必再用命名模式了

总结:除了特定的程序员之外 , 大多数程序员都不必定义注解类型 . 但是所有的程序员都应该使用Java平台所提供的预定义的注解类型 . 还要考虑 IDE 或者静态分析工具所提供的任何注解 . 这种注解可以提升由这些工具所提供的诊断信息的质量 . 但是要注意这些注解还没有表转化 , 因此如果变换工具或者形成标准 , 就需要做更多地工作 .