通过varargs参数可能导致堆污染


433

我知道在Java 7中使用带有泛型类型的varargs时会发生这种情况。

但是我的问题是..

Eclipse说“使用它可能会污染堆”时,这是什么意思?

@SafeVarargs注释如何防止这种情况?




我在编辑器中看到了这个:Possible heap pollution from parameterized vararg type
Alexander Mills,

Answers:


252

堆污染是一个技术术语。它引用的引用类型不是其指向的对象的超类型。

List<A> listOfAs = new ArrayList<>();
List<B> listOfBs = (List<B>)(Object)listOfAs; // points to a list of As

这可能会导致“无法解释” ClassCastException

// if the heap never gets polluted, this should never throw a CCE
B b = listOfBs.get(0); 

@SafeVarargs完全不能阻止这一点。但是,有些方法证明不会污染堆,编译器无法证明这一点。以前,此类API的调用者会收到令人讨厌的警告,这些警告是完全没有意义的,但必须在每个调用站点中都加以抑制。现在,API作者可以在声明站点中将其取消一次。

但是,如果方法其实并不安全,用户将不再被警告。


2
那么我们是说堆被污染了吗,因为它包含的引用类型不是我们所期望的?(您的示例中的List <A>与List <B>)
hertzsprung 2012年


30
这个答案很好地解释了什么是堆污染,但是并没有真正解释为什么可变参数特别容易引起堆污染,以致需要提出具体警告。
Dolda2000 '17

4
我也是,我也缺少有关如何确保我的代码不包含此问题的信息(例如,我如何知道它已经足够坚固以添加@SafeVarargs)
Daniel Alder

237

当你声明

public static <T> void foo(List<T>... bar) 编译器将其转换为

public static <T> void foo(List<T>[] bar) 然后

public static void foo(List[] bar)

这样就有危险,您会错误地将错误的值分配给列表,并且编译器将不会触发任何错误。例如,如果T为a,String则以下代码将正确编译,但在运行时将失败:

// First, strip away the array type (arrays allow this kind of upcasting)
Object[] objectArray = bar;

// Next, insert an element with an incorrect type into the array
objectArray[0] = Arrays.asList(new Integer(42));

// Finally, try accessing the original array. A runtime error will occur
// (ClassCastException due to a casting from Integer to String)
T firstElement = bar[0].get(0);

如果您检查了该方法以确保它不包含此类漏洞,则可以对它进行注释@SafeVarargs以禁止显示警告。对于接口,请使用@SuppressWarnings("unchecked")

如果收到此错误消息:

Varargs方法可能会由于不可修正的varargs参数而导致堆污染

并且您确定自己的用法是安全的,那么应该@SuppressWarnings("varargs")改为使用。请参见@SafeVarargs是否适合此方法?https://stackoverflow.com/a/14252221/14731,以获得有关第二种错误的很好的解释。

参考文献:


2
我想我了解得更好。当您将varargs投向时,危险就来了Object[]。只要您不投稿Object[],听起来就应该没事。
djeikyb 2014年

3
例如,您可以做一个愚蠢的事情:static <T> void bar(T...args) { ((Object[])args)[0] = "a"; }。然后致电bar(Arrays.asList(1,2));
djeikyb 2014年

1
@djeikyb如果仅在我强制转换时才会出现危险,否则Object[]为什么编译器将触发警告?毕竟,应该很容易在编译时进行检查(以防我不将其传递给具有相似签名的另一个函数,在这种情况下,另一个函数应该触发警告)。我不认为这确实是警告的核心(“如果不进行广播,您会很安全”),而且我仍然不明白在那种情况下我还可以。
2016年

5
@djeikyb如果没有参数化的varargs(例如bar(Integer...args)),您可能会做完全相同的愚蠢的事情。那么,这个警告有什么意义呢?
Vasiliy Vlasov

3
@VasiliyVlasov此问题仅与参数化varargs有关。如果您尝试对非类型化数组执行相同的操作,则运行时将阻止您将错误类型插入数组。编译器警告您运行时将无法避免错误行为,因为参数类型在运行时未知(相反,数组在运行时确实知道其非泛型元素的类型)。
吉利2015年


6

当您使用varargs时,可能会导致创建一个Object[]来保存参数。

由于进行了转义分析,JIT可以优化此数组创建。(我发现过这样做的几次)不能保证对其进行优化,但是除非您在内存分析器中看到它的问题,否则我不会担心。

AFAIK @SafeVarargs禁止编译器发出警告,并且不会更改JIT的行为。


6
有趣的是,尽管它并不能真正回答他关于的问题@SafeVarargs
Paul Bellora 2012年

1
不。那不是堆污染。“当参数化类型的变量引用的对象不是该参数化类型的对象时,就会发生堆污染。” 参考:docs.oracle.com/javase/tutorial/java/generics/…–
Doradus

1

原因是因为varargs提供了使用非参数化对象数组调用的选项。因此,如果您的类型是List <A> ...,则也可以使用List [] non-varargs类型调用它。

这是一个例子:

public static void testCode(){
    List[] b = new List[1];
    test(b);
}

@SafeVarargs
public static void test(List<A>... a){
}

如您所见,List [] b可以包含任何类型的使用者,但是此代码可以编译。如果使用varargs,就可以了,但是如果在类型擦除之后使用方法定义-void test(List [])-则编译器将不会检查模板参数类型。@SafeVarargs将禁止显示此警告。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.