如何处理未经检查的投射警告?

时间:2009-02-03 21:57:48

标签: java generics warnings

Eclipse正在向我发出以下形式的警告:

  

类型安全:取消选中从对象转换为HashMap

这是来自对我无法控制的API的调用,返回Object:

HashMap<String, String> getItems(javax.servlet.http.HttpSession session) {
  HashMap<String, String> theHash = (HashMap<String, String>)session.getAttribute("attributeKey");
  return theHash;
}

如果可能的话,我想避免使用Eclipse警告,因为理论上它们至少表明存在潜在的代码问题。不过,我还没有找到消除这个的好方法。我可以将涉及的单行提取到方法中,并将@SuppressWarnings("unchecked")添加到该方法,从而限制了我忽略警告的代码块的影响。有更好的选择吗?我不想在Eclipse中关闭这些警告。

在我开始使用代码之前,它更简单,但仍然引发了警告:

HashMap getItems(javax.servlet.http.HttpSession session) {
  HashMap theHash = (HashMap)session.getAttribute("attributeKey");
  return theHash;
}

当你试图使用你会收到警告的哈希时,问题出在其他地方:

HashMap items = getItems(session);
items.put("this", "that");

Type safety: The method put(Object, Object) belongs to the raw type HashMap.  References to generic type HashMap<K,V> should be parameterized.

24 个答案:

答案 0 :(得分:509)

当然,显而易见的答案是不做未经检查的演员。

如果绝对必要,那么至少要尝试限制@SuppressWarnings注释的范围。根据它的Javadocs,它可以用于局部变量;这样,它甚至不会影响整个方法。

示例:

@SuppressWarnings("unchecked")
Map<String, String> myMap = (Map<String, String>) deserializeMap();

无法确定Map是否确实应具有通用参数<String, String>。您必须事先知道参数应该是什么(或者当您获得ClassCastException时,您会发现)。这就是代码生成警告的原因,因为编译器不可能知道是否安全。

答案 1 :(得分:138)

不幸的是,这里没有很好的选择。请记住,所有这一切的目标是保持类型安全。 “Java Generics”提供了处理非泛化遗留库的解决方案,在8.2节中有一个特别称为“空循环技术”。基本上,进行不安全的转换,并禁止警告。然后循环遍历地图:

@SuppressWarnings("unchecked")
Map<String, Number> map = getMap();
for (String s : map.keySet());
for (Number n : map.values());

如果遇到意外类型,您将获得运行时ClassCastException,但至少它会发生在问题源附近。

答案 2 :(得分:110)

哇;我想我找到了自己问题的答案。我只是不确定它是否值得! :)

问题是未检查演员表。所以,你必须自己检查一下。您不能只使用instanceof检查参数化类型,因为参数化类型信息在运行时不可用,已在编译时擦除。

但是,您可以使用instanceof对哈希中的每个项目执行检查,并且这样做,您可以构造一个类型安全的新哈希。而且你不会引发任何警告。

感谢mmyers和Esko Luontola,我已经参数化了我最初在这里编写的代码,因此它可以包含在某个实用程序类中并用于任何参数化的HashMap。如果你想更好地理解它并且不熟悉泛型,我鼓励查看这个答案的编辑历史。

public static <K, V> HashMap<K, V> castHash(HashMap input,
                                            Class<K> keyClass,
                                            Class<V> valueClass) {
  HashMap<K, V> output = new HashMap<K, V>();
  if (input == null)
      return output;
  for (Object key: input.keySet().toArray()) {
    if ((key == null) || (keyClass.isAssignableFrom(key.getClass()))) {
        Object value = input.get(key);
        if ((value == null) || (valueClass.isAssignableFrom(value.getClass()))) {
            K k = keyClass.cast(key);
            V v = valueClass.cast(value);
            output.put(k, v);
        } else {
            throw new AssertionError(
                "Cannot cast to HashMap<"+ keyClass.getSimpleName()
                +", "+ valueClass.getSimpleName() +">"
                +", value "+ value +" is not a "+ valueClass.getSimpleName()
            );
        }
    } else {
        throw new AssertionError(
            "Cannot cast to HashMap<"+ keyClass.getSimpleName()
            +", "+ valueClass.getSimpleName() +">"
            +", key "+ key +" is not a " + keyClass.getSimpleName()
        );
    }
  }
  return output;
}

这是很多工作,可能只是为了很少的奖励......我不确定我是否会使用它。我很感激有关人们是否认为值得的评论。另外,我很欣赏改进建议:除了抛出AssertionErrors之外,我还能做些什么吗?我能抛出更好的东西吗?我应该将其设为已检查的例外吗?

答案 3 :(得分:49)

在Eclipse Preferences中,转到Java-&gt; Compiler-&gt; Errors / Warnings-&gt; Generic类型并选中Ignore unavoidable generic type problems复选框。

这满足了问题的意图,即

  

我想避免Eclipse警告...

如果不是精神。

答案 4 :(得分:26)

您可以创建如下所示的实用程序类,并使用它来禁止未经检查的警告。

public class Objects {

    /**
     * Helps to avoid using {@code @SuppressWarnings({"unchecked"})} when casting to a generic type.
     */
    @SuppressWarnings({"unchecked"})
    public static <T> T uncheckedCast(Object obj) {
        return (T) obj;
    }
}

您可以按如下方式使用它:

import static Objects.uncheckedCast;
...

HashMap<String, String> getItems(javax.servlet.http.HttpSession session) {
      return uncheckedCast(session.getAttribute("attributeKey"));
}

有关此问题的更多讨论在此处: http://cleveralias.blogs.com/thought_spearmints/2006/01/suppresswarning.html

答案 5 :(得分:20)

这个东西很难,但这是我目前的想法:

如果您的API返回Object,那么您无能为力 - 无论如何,您将盲目地投射对象。您让Java抛出ClassCastExceptions,或者您可以自己检查每个元素并抛出Assertions或IllegalArgumentExceptions等等,但这些运行时检查都是等效的。无论你在运行时做什么,都必须禁止编译时未经检查的转换。

我只是喜欢盲目转换并让JVM为我执行运行时检查,因为我们“知道”API应该返回什么,并且通常愿意假设API有效。如果需要,可以在演员阵容上方的任何地方使用泛型。你不是真的在那里购买任何东西,因为你仍然有单盲,但至少你可以从那里使用泛型,所以JVM可以帮助你避免在代码的其他部分盲目投射。

在这种特殊情况下,大概你可以看到对SetAttribute的调用并看到类型正在进入,所以在出路时盲目地将类型转换为相同并不是不道德的。添加引用SetAttribute的注释并完成它。

答案 6 :(得分:12)

在HTTP会话世界中,您无法真正避免强制转换,因为API是以这种方式编写的(只接受并返回Object)。

通过一些工作,你可以很容易地避免未经检查的演员阵容,“但是。这意味着它将变成一个传统的演员,在发生错误的情况下在那里给出ClassCastException。未经检查的异常可能会在以后的任何时候转变为CCE而不是转换点(这就是为什么它是一个单独的警告)。

用专用类替换HashMap:

import java.util.AbstractMap;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

public class Attributes extends AbstractMap<String, String> {
    final Map<String, String> content = new HashMap<String, String>();

    @Override
    public Set<Map.Entry<String, String>> entrySet() {
        return content.entrySet();
    }

    @Override
    public Set<String> keySet() {
        return content.keySet();
    }

    @Override
    public Collection<String> values() {
        return content.values();
    }

    @Override
    public String put(final String key, final String value) {
        return content.put(key, value);
    }
}

然后转换为该类而不是Map<String,String>,并且将在您编写代码的确切位置检查所有内容。之后没有意外的ClassCastExceptions

答案 7 :(得分:11)

这是一个缩短的示例,它通过采用其他答案中提到的两种策略来避免“未经检查的强制转换”警告

  1. 在运行时(Class<T> inputElementClazz)传递感兴趣类型的类作为参数。然后您可以使用:inputElementClazz.cast(anyObject);

  2. 对于Collection的类型转换,请使用通配符?而不是通用类型T,以确认您确实不知道遗留代码(Collection<?> unknownTypeCollection)期望的对象类型。毕竟,这是“未经检查的演员”警告要告诉我们的内容:我们无法确定我们是否获得Collection<T>,所以诚实的做法是使用Collection<?>。如果绝对需要,仍然可以构建已知类型的集合(Collection<T> knownTypeCollection)。

  3. 以下示例中的遗留代码接口在StructuredViewer中具有属性“input”(StructuredViewer是树或表小部件,“input”是其背后的数据模型)。这个“输入”可以是任何类型的Java Collection。

    public void dragFinished(StructuredViewer structuredViewer, Class<T> inputElementClazz) {
        IStructuredSelection selection = (IStructuredSelection) structuredViewer.getSelection();
        // legacy code returns an Object from getFirstElement,
        // the developer knows/hopes it is of type inputElementClazz, but the compiler cannot know
        T firstElement = inputElementClazz.cast(selection.getFirstElement());
    
        // legacy code returns an object from getInput, so we deal with it as a Collection<?>
        Collection<?> unknownTypeCollection = (Collection<?>) structuredViewer.getInput();
    
        // for some operations we do not even need a collection with known types
        unknownTypeCollection.remove(firstElement);
    
        // nothing prevents us from building a Collection of a known type, should we really need one
        Collection<T> knownTypeCollection = new ArrayList<T>();
        for (Object object : unknownTypeCollection) {
            T aT = inputElementClazz.cast(object);
            knownTypeCollection.add(aT);
            System.out.println(aT.getClass());
        }
    
        structuredViewer.refresh();
    }
    

    当然,如果我们将遗留代码与错误的数据类型一起使用(例如,如果我们将数组设置为StructuredViewer的“输入”而不是Java Collection),则上面的代码可能会产生运行时错误。

    调用方法的示例:

    dragFinishedStrategy.dragFinished(viewer, Product.class);
    

答案 8 :(得分:8)

在这种特殊情况下,我不会直接将Maps存储到HttpSession中,而是将我自己的类的实例存储,而后者又包含一个Map(类的实现细节)。然后,您可以确保地图中的元素属于正确的类型。

但是如果你想要检查Map的内容是否是正确的类型,你可以使用这样的代码:

public static void main(String[] args) {
    Map<String, Integer> map = new HashMap<String, Integer>();
    map.put("a", 1);
    map.put("b", 2);
    Object obj = map;

    Map<String, Integer> ok = safeCastMap(obj, String.class, Integer.class);
    Map<String, String> error = safeCastMap(obj, String.class, String.class);
}

@SuppressWarnings({"unchecked"})
public static <K, V> Map<K, V> safeCastMap(Object map, Class<K> keyType, Class<V> valueType) {
    checkMap(map);
    checkMapContents(keyType, valueType, (Map<?, ?>) map);
    return (Map<K, V>) map;
}

private static void checkMap(Object map) {
    checkType(Map.class, map);
}

private static <K, V> void checkMapContents(Class<K> keyType, Class<V> valueType, Map<?, ?> map) {
    for (Map.Entry<?, ?> entry : map.entrySet()) {
        checkType(keyType, entry.getKey());
        checkType(valueType, entry.getValue());
    }
}

private static <K> void checkType(Class<K> expectedType, Object obj) {
    if (!expectedType.isInstance(obj)) {
        throw new IllegalArgumentException("Expected " + expectedType + " but was " + obj.getClass() + ": " + obj);
    }
}

答案 9 :(得分:7)

在Android Studio中,如果要禁用检查,可以使用:

//noinspection unchecked
Map<String, String> myMap = (Map<String, String>) deserializeMap();

答案 10 :(得分:7)

Esko Luontola上面的答案中的Objects.Unchecked实用程序功能是避免程序混乱的好方法。

如果您不想在整个方法上使用SuppressWarnings,Java会强制您将其放在本地方法上。如果您需要对成员进行强制转换,则可以使用以下代码:

@SuppressWarnings("unchecked")
Vector<String> watchedSymbolsClone = (Vector<String>) watchedSymbols.clone();
this.watchedSymbols = watchedSymbolsClone;

使用该实用程序要清晰得多,而且您正在做的事情仍然很明显:

this.watchedSymbols = Objects.uncheckedCast(watchedSymbols.clone());

<强> 注: 我觉得重要的是要补充说,有时警告确实意味着你做错了,如:

ArrayList<Integer> intList = new ArrayList<Integer>();
intList.add(1);
Object intListObject = intList; 

 // this line gives an unchecked warning - but no runtime error
ArrayList<String> stringList  = (ArrayList<String>) intListObject;
System.out.println(stringList.get(0)); // cast exception will be given here

编译器告诉你的是,在运行时不会检查此强制转换,因此在尝试访问通用容器中的数据之前不会引发运行时错误。

答案 11 :(得分:4)

警告抑制不是解决方案。你不应该在一个陈述中进行两级演员。

HashMap<String, String> getItems(javax.servlet.http.HttpSession session) {

    // first, cast the returned Object to generic HashMap<?,?>
    HashMap<?, ?> theHash = (HashMap<?, ?>)session.getAttribute("attributeKey");

    // next, cast every entry of the HashMap to the required type <String, String>
    HashMap<String, String> returingHash = new HashMap<>();
    for (Entry<?, ?> entry : theHash.entrySet()) {
        returingHash.put((String) entry.getKey(), (String) entry.getValue());
    }
    return returingHash;
}

答案 12 :(得分:2)

我可能误解了这个问题(一个例子和几条周围的线路会很好),但为什么不总是使用合适的接口(和Java5 +)呢?我认为你没有理由想要转换为HashMap而不是Map<KeyType,ValueType>。事实上,我无法想象任何理由将变量的类型设置为HashMap而不是Map

为什么来源是Object?它是旧版集合的参数类型吗?如果是这样,请使用泛型并指定所需的类型。

答案 13 :(得分:2)

拿这个,它比创建一个新的HashMap要快得多,如果它已经是一个,但仍然是安全的,因为每个元素都是根据它的类型进行检查...

@SuppressWarnings("unchecked")
public static <K, V> HashMap<K, V> toHashMap(Object input, Class<K> key, Class<V> value) {
       assert input instanceof Map : input;

       for (Map.Entry<?, ?> e : ((HashMap<?, ?>) input).entrySet()) {
           assert key.isAssignableFrom(e.getKey().getClass()) : "Map contains invalid keys";
           assert value.isAssignableFrom(e.getValue().getClass()) : "Map contains invalid values";
       }

       if (input instanceof HashMap)
           return (HashMap<K, V>) input;
       return new HashMap<K, V>((Map<K, V>) input);
    }

答案 14 :(得分:2)

如果我必须使用不支持Generics的API ..我尝试用尽可能少的行隔离包装程序中的那些调用。然后我使用SuppressWarnings注释并同时添加类型安全转换。

这只是个人偏好,尽可能保持整洁。

答案 15 :(得分:2)

如果你发布你的代码,你可以快速猜测,但你可能已经做了一些事情

HashMap<String, Object> test = new HashMap();

将在您需要时生成警告

HashMap<String, Object> test = new HashMap<String, Object>();

可能值得一看

Generics in the Java Programming Language

如果您不熟悉需要做的事情。

答案 16 :(得分:1)

几乎计算机科学中的每个问题都可以通过添加一个间接*或其他东西来解决。

因此,引入一个比Map更高级别的非泛型对象。没有背景,它看起来不会很有说服力,但无论如何:

public final class Items implements java.io.Serializable {
    private static final long serialVersionUID = 1L;
    private Map<String,String> map;
    public Items(Map<String,String> map) {
        this.map = New.immutableMap(map);
    }
    public Map<String,String> getMap() {
        return map;
    }
    @Override public String toString() {
        return map.toString();
    }
}

public final class New {
    public static <K,V> Map<K,V> immutableMap(
        Map<? extends K, ? extends V> original
    ) {
        // ... optimise as you wish...
        return Collections.unmodifiableMap(
            new HashMap<String,String>(original)
        );
    }
}

static Map<String, String> getItems(HttpSession session) {
    Items items = (Items)
        session.getAttribute("attributeKey");
    return items.getMap();
}

*除了太多的间接层外。

答案 17 :(得分:1)

当我覆盖equals()操作时,这是我处理此问题的一种方法。

public abstract class Section<T extends Section> extends Element<Section<T>> {
    Object attr1;

    /**
    * Compare one section object to another.
    *
    * @param obj the object being compared with this section object
    * @return true if this section and the other section are of the same
    * sub-class of section and their component fields are the same, false
    * otherwise
    */       
    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            // this exists, but obj doesn't, so they can't be equal!
            return false;
        }

        // prepare to cast...
        Section<?> other;

        if (getClass() != obj.getClass()) {
            // looks like we're comparing apples to oranges
            return false;
        } else {
            // it must be safe to make that cast!
            other = (Section<?>) obj;
        }

        // and then I compare attributes between this and other
        return this.attr1.equals(other.attr1);
    }
}

这似乎适用于Java 8(甚至使用-Xlint:unchecked编译)

答案 18 :(得分:0)

如果您确定session.getAttribute()返回的类型是HashMap,那么您不能将该类型转换为该类型,而只依赖于检查泛型HashMap

HashMap<?,?> getItems(javax.servlet.http.HttpSession session) {  
    HashMap<?,?> theHash = (HashMap<?,?>)session.getAttribute("attributeKey");
    return theHash;
} 
然后,Eclipse将会出现警告,但当然这会导致运行时错误,而这些错误很难调试。我只在非操作关键的上下文中使用这种方法。

答案 19 :(得分:0)

两种方式,一种是完全避免标签,另一种是使用顽皮但很好的实用方法 问题是预先通用的集合......
我相信经验法则是:“一次一件事地投射物体” - 这意味着当试图在泛化世界中使用原始类时,这是因为你不知道这个地图中的内容&lt;?,?&gt; (事实上​​,JVM甚至可能发现它甚至不是Map!),当你​​想到它时,你就无法投射它。如果你有一个Map&lt; String,?&gt; map2然后是HashSet&lt; String&gt; keys =(HashSet&lt; String&gt;)map2.keySet()没有给你一个警告,尽管这是编译器的“信仰行为”(因为它可能会变成一个TreeSet)......但它只是 信仰行为。

PS反对以我的第一种方式迭代“无聊”和“需要时间”,答案是“没有痛苦没有收获”:一般化的集合保证包含Map.Entry&lt; String,String&gt; s,什么也没有其他。您必须支付此保证金。系统地使用泛型时,这种付款很漂亮,采用编码合规的形式,而不是机器时间! 有一种想法可能会说你应该设置Eclipse的设置来进行这种未经检查的强制转换错误,而不是警告。在这种情况下,你必须使用我的第一种方式。

package scratchpad;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Vector;

public class YellowMouse {

    // First way

    Map<String, String> getHashMapStudiouslyAvoidingSuppressTag(HttpSession session) {
      Map<?, ?> theHash = (Map<?, ?>)session.getAttribute("attributeKey");

      Map<String, String> yellowMouse = new HashMap<String, String>();
      for( Map.Entry<?, ?> entry : theHash.entrySet() ){
        yellowMouse.put( (String)entry.getKey(), (String)entry.getValue() );
      }

      return yellowMouse;
    }


    // Second way

    Map<String, String> getHashMapUsingNaughtyButNiceUtilityMethod(HttpSession session) {
      return uncheckedCast( session.getAttribute("attributeKey") );
    }


    // NB this is a utility method which should be kept in your utility library. If you do that it will
    // be the *only* time in your entire life that you will have to use this particular tag!!

    @SuppressWarnings({ "unchecked" })
    public static synchronized <T> T uncheckedCast(Object obj) {
        return (T) obj;
    }


}

答案 20 :(得分:0)

在施放它之前,请先检查它。

Object someObject = session.getAttribute("attributeKey");
if(someObject instanceof HashMap)
HashMap<String, String> theHash = (HashMap<String, String>)someObject;  

对于任何人来说,收到你不确定类型的对象是很常见的。大量遗留的“SOA”实现传递了您不应该信任的各种对象。 (恐怖!)

编辑更改了示例代码一次以匹配海报的更新,并且在发表一些评论之后,我发现instanceof与generics的效果不佳。但是,更改检查以验证外部对象似乎与命令行编译器一起使用。修订后的例子现已发布。

答案 21 :(得分:-1)

这使警告消失......

 static Map<String, String> getItems(HttpSession session) {
        HashMap<?, ?> theHash1 = (HashMap<String,String>)session.getAttribute("attributeKey");
        HashMap<String,String> theHash = (HashMap<String,String>)theHash1;
    return theHash;
}

答案 22 :(得分:-1)

问题出在这里:

... = (HashMap<String, String>)session.getAttribute("attributeKey");

session.getAttribute(...)的结果是object可能是任何内容,但由于您“知道”它是HashMap<String, String>,您只是在不先检查它的情况下进行投射。因此,警告。为了迂腐,Java希望你在这种情况下,你应该检索结果并验证它与instanceof的兼容性。

答案 23 :(得分:-3)

解决方案:在Eclipse中禁用此警告。不要@SuppressWarnings,只需完全禁用它。

上面提到的几个“解决方案”都是不合时宜的,因为为了抑制愚蠢的警告,代码难以理解。