第24条:消除非受检警告

用泛型编程时,会遇到许多编译器警告:非受检强制转化警告(unchecked cast warnings)、非受检方法调用警告、非受检普通数组创建警告,以及非受检转换警告(unchecked conversion warnings)。当你越来越熟悉泛型之后,遇到的警告也会越来越少,但是不要期待从一开始用泛型编写代码就可以正确地进行编译。

有许多非受检警告很容易消除。例如,假设意外地编写了这样一个声明:

Set<Lark> exaltation = new HashSet();

编译器会细致地提醒你哪里出错了:

Venery.java:4: warning: [unchecked] unchecked conversion
found   : HashSet, required: Set<Lark>
    Set<Lark> exaltation = new HashSet();
                         ^

你就可以纠正所显示的错误,消除警告:

Set<Lark> exaltation = new HashSet<Lark>();

有些警告比较难以消除。本章主要介绍这种警告的示例。当你遇到需要进行一番思考的警告时,要坚持住!要尽可能地消除每一个非受检警告。如果消除了所有警告,就可以确保代码是类型安全的,这是一件很好的事情。这意味着不会在运行时出现ClassCastException异常,你会更加自信自己的程序可以实现预期的功能。

如果无法消除警告,同时可以证明引起警告的代码是类型安全的,(只有在这种情况下才)可以用一个@SuppressWarnings("unchecked")注解来禁止这条警告。如果在禁止警告之前没有先证实代码是类型安全的,那就只是给你自己一种错误的安全感而已。代码在编译的时候可能没有出现任何警告,但它在运行时仍然会抛出ClassCastException异常了但是如果忽略(而不是禁止)明知道是安全的非受检警告,那么当新出现一条真正有问题的警告时,你也不会注意到。新出现的警告就会淹没在所有的错误警告当中。

SuppressWarnings注解可以用在任何粒度的级别中,从单独的局部变量声明到整个类都可以。应该始终在尽可能小的范围中使用SuppressWarnings注解。它通常是个变量声明,或是非常简短的方法或者 构造器。永远不要再整个类上使用SuppressWarnings注解,这么做可能会掩盖了重要的警告。

如果你发现自己在长度不止一行的方法或者构造器中使用SuppressWarnings注解,可以将它移到一个局部变量的声明中。虽然你必须声明一个新的局部变量,不过这么做还是值得的。例如,考虑ArrayList类当中的toArray方法:

public <T> toArray(T[] a) {
    if (a.length < size)
        return (T[]) Arrays.copyOf(elements, size, a.getClass());
    System.arrayCopy(elements, 0, a, 0, size);
    if (a.length > size)
        a[size] = null;
    return a;
}

如果编译ArrayList,该方法就会产生这条警告:

ArrayList.java:305: warning: [unchecked] unchecked cast
found   : Object[], required: T[]
    return (T[]) Arrays.copyOf(elements, size, a.getClass());
                              ^

SuppressWarnings注解放在return语句中是非法的,因为它不是一个生命[JLS,9.7]。你可以试着将注解放在整个方法上,但是在实践中千万不要这么做,而是应该声明一个局部变量来保存返回值,并注解其声明,像这样:

// Adding local variable to reduce scope of @SuppressWarnings
public <T> T[] toArray(T[] a) {
    if (a.length < size) {
        // This cast is correct because the array we're creating
        // is of the same type as the one passed in, which is T[].
        @SuppressWarnings("unchecked") T[] result =
            (T[]) Arrays.copyOf(elements, size, a.getClass());
        return result;
    }
    System.arrayCopy(elements, 0, a, 0, size);
    if (a.length > size)
        a[size] = null;
    return a;
}

这个方法可以正确地编译,禁止非受检警告的范围也减到了最小。

每当使用SuppressWarnings("unchecked")注解时,都要添加一条注释,说明为什么这么做是安全的。这样可以帮助其他人理解代码,更重要的是,可以尽量减少其他人修改代码后导致计算不安全的概率。如果你觉得这种注释很难编写,就要多加思考。最终你会发现非受检操作时非常不安全的。

总而言之,非受检警告很重要,不要忽略它们。每一条警告都表示可能在运行时抛出ClassCastException异常。要尽最大的努力消除这些警告。如果无法消除非受检警告,同时可以证明引起警告的代码是类型安全的,就可以在尽可能小的范围中,用@SuppressWarnings("unchecked")注解禁止该警告。要用注释把禁止该警告的原因记录下来。

results matching ""

    No results matching ""