使用 hamcrest contains() 方法比较两个集合

Question

我有两个集合，我试图在单元测试中比较它们是否相等，但我正在努力使用 contains 方法。这是我所拥有的：

@Test
public void getAllItems() {

    Collection<Item> actualItems = auction.getAllItems(joe);
    Collection<Item> expectedItems = Lists.newArrayList();
    expectedItems.add(iPhone);
    expectedItems.add(skateboard);
    assertThat(expectedItems, contains(actualItems));

}

items 包含与expectedItems 相同的对象，所以我希望断言是真的，但这是我得到的输出：

[Item{name=iPhone}, Item{name=Skateboard}]  --> Expected
[Item{name=iPhone}, Item{name=Skateboard}]  --> Actual

java.lang.AssertionError: 
Expected: iterable containing [<[Item{name=iPhone}, Item{name=Skateboard}]>]
     but: item 0: was <Item{name=iPhone}>
    at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:20)
    at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:8)

请您帮我解决使用contains 方法的问题所在？

public class Item {

    private String name;

    public Item(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String toString() {
        return Objects.toStringHelper(this).add("name", name).toString();
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        Item other = (Item) obj;
        if (name == null) {
            if (other.name != null)
                return false;
        } else if (!name.equals(other.name))
            return false;
        return true;
    }

}

Answer 1

集合的.contains(...) 使用对象的equals 和hashCode 方法。为了在您自己的对象上使用equals（或在本例中为contains），您需要覆盖您的类的equals 和hashCode 方法。这是因为 Java 在后台使用引用，所以即使字段可能相等，对象引用也不相同。

在 Eclipse 中，您可以使用 right-mouse click -> Source -> Generate hashCode() and equals()... 生成它们。但是，由于您从未声明您使用 Eclipse，因此这里是生成的方法的示例：

// Overriding this class' equals and hashCode methods for Object comparing purposes 
// using the Collection's contains
// contains does the following behind the scenes: Check if both inputs aren't null, 
// check if the HashCodes match, check if the Objects are equal.
// Therefore to use the Collection's contains for Objects with the same fields, we
// need to override the Object's equals and hashCode methods
// These methods below are generated by Eclipse itself using "Source -> Generate 
// hashCode() and equals()..."
@Override
public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((name == null) ? 0 : name.hashCode());
    return result;
}
@Override
public boolean equals(Object obj) {
    if(this == obj)
        return true;
    if(obj == null)
        return false;
    if(getClass() != obj.getClass())
        return false;
    Item other = (Item) obj;
    if(name == null){
        if(other.name != null)
            return false;
    }
    else if(!name.equals(other.name))
        return false;
    return true;
}

如果您将这两个都添加到您的 Item 类中，contains 将起作用。

---

编辑：

我不确定，但是当我查看您的代码时，我认为以下可能是错误的：

@Test
public void getAllItems() {

    Collection<Item> actualItems = auction.getAllItems(joe);
    Collection<Item> expectedItems = Lists.newArrayList();

    // You first print both lists
    System.out.println(expectedItems);
    System.out.println(items);

    // And then add the two items to the expectedItems
    expectedItems.add(iPhone);
    expectedItems.add(skateboard);
    assertThat(expectedItems, contains(actualItems));
}

如果您尝试以下方法：

@Test
public void getAllItems() {

    Collection<Item> actualItems = auction.getAllItems(joe);
    Collection<Item> expectedItems = Lists.newArrayList();

    // First add both items
    expectedItems.add(iPhone);
    expectedItems.add(skateboard);

    // Then print both lists
    System.out.println(expectedItems);
    System.out.println(items);

    assertThat(expectedItems, contains(actualItems));
}

expectedList 现在是否包含 4 个项目？

[Item{name=iPhone}, Item{name=Skateboard}, Item{name=iPhone}, Item{name=Skateboard}]  --> Expected
[Item{name=iPhone}, Item{name=Skateboard}]  --> Actual

在这种情况下，您不应该添加这两个项目，因为它们已经存在于列表中。

另外，您正在尝试在整个列表中使用contains。通常contains 用于查看列表中是否存在单个项目。所以你可以使用这样的东西：

for(Item i : expectedList){
    assertTrue(actualList.contains(i));
}

or perhaps something like this, in case you use these libraries:

assertThat(actualList, is(expectedList));

我不确定这是否是原因以及是否可以解决它，因为您使用不同的 JUnit 库，然后我通常会这样做，我不确定这些带有 Asserts 的语法是否可行。

Answer 2

我真的不认为你真的需要 hamcrest。通过以下方式之一进行断言会不会更容易：

列表在一天结束时仍然是一个对象：

org.junit.Assert.assertEquals(expected, actual)

使用containsAll(..) 的老式列表功能：

org.junit.Assert.assertTrue(expectedItems.containsAll(actualItems))

对数组的相等性使用断言：

org.junit.Assert.assertArrayEquals(expectedItems.toArray(), actualItems.toArray())

当然你也可以使用hamcrest：

org.hamcrest.MatcherAssert.assertThat(actual, Matchers.containsInAnyOrder(actual.toArray()));

或

org.hamcrest.MatcherAssert.assertThat(actual, Matchers.contains(actual.toArray()));

Answer 3

您基本上断言expectedItems 是一个包含一个元素的列表，而这个元素本身应该是一个包含iPhone 和skateboard 两项的列表。

要断言expectedItems 和actualItems 具有相同顺序的相同元素，请尝试以下操作：

@Test
public void getAllItems() {

    Collection<Item> actualItems = auction.getAllItems(joe);

    assertThat(actualItems, contains(iPhone, skateboard));
}

请注意assertThat 期望“实际”对象作为第一个参数，而不是“预期”。

您也可以这样做：

@Test
public void getAllItems() {

    Collection<Item> actualItems = auction.getAllItems(joe);
    Collection<Item> expectedItems = Lists.newArrayList();
    expectedItems.add(iPhone);
    expectedItems.add(skateboard);

    assertThat(actualItems, contains(expectedItems.toArray(new Item[expectedItems.size()])));
}