javaのList<Class T>の比較方法

Index

Listの比較で困った

以下のようにフルーツの名前と値段を保持しているクラスがあります。

class Fruits {
    private final String m_name;
    private final Integer m_price;
    
    Fruits (final String name, final Integer price) {
        m_name = name;
        m_price = price;
    }
}

class Fruits {

private final String m_name;

private final Integer m_price;

Fruits (final String name, final Integer price) {

m_name = name;

m_price = price;

}

そのクラスのListが2つあります。

List<Fruits> fruitsList = new ArrayList<>();
fruitsList .add(new Fruits("orange",100));
fruitsList .add(new Fruits("peach",200));
fruitsList .add(new Fruits("dragonFruits",300));

List<Fruits> fruitsList2 = new ArrayList<>();
fruitsList .add(new Fruits("orange",100));
fruitsList .add(new Fruits("peach",200));
fruitsList .add(new Fruits("dragonFruits",300));

List<Fruits> fruitsList = new ArrayList<>();

fruitsList .add(new Fruits("orange",100));

fruitsList .add(new Fruits("peach",200));

fruitsList .add(new Fruits("dragonFruits",300));

List<Fruits> fruitsList2 = new ArrayList<>();

fruitsList .add(new Fruits("orange",100));

fruitsList .add(new Fruits("peach",200));

fruitsList .add(new Fruits("dragonFruits",300));

以下のように2つのリストの比較をしようとするとfalseが返ってきます。

Objects.equals(fruitsList,fruitsList2)//false

1	Objects.equals(fruitsList,fruitsList2)//false

リストの中身は同じはずなのにおかしい….

ちなみに

以下のようにプリミティブ型のリストの場合はちゃんとtrueが返ってくる

List<Integer> intList  = new ArrayList<>();
intList.add(1);
intList.add(2);
intList.add(3);
    
List<Integer> intList2  = new ArrayList<>();
intList2.add(1);
intList2.add(2);
intList2.add(3);
Objects.equals(intList,intList2);//true

List<Integer> intList = new ArrayList<>();

intList.add(1);

intList.add(2);

intList.add(3);

List<Integer> intList2 = new ArrayList<>();

intList2.add(1);

intList2.add(2);

intList2.add(3);

Objects.equals(intList,intList2);//true

解決策

結論から言うとequals,hashcodeをオーバーライドする必要があります。

実装は以下のようになります。

class Fruits {
    private final String m_name;
    private final Integer m_price;
    
    Fruits (final String name, final Integer price) {
        m_name = name;
        m_price = price;
    }
    @Override
    public boolean equals(Object object) {
        if(object == this) return true;
        
        if(!(object instanceof Fruits)) return false;
        
        final Fruits obj = (Fruits)object;
        return (this.m_name == obj.m_name) && (this.m_price == obj.m_price);
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = Integer.hashCode(m_price);
        result = prime * result + Objects.hashCode(m_name);
        result = prime * result + Integer.hashCode(m_price);
        return result;
    }
}

class Fruits {

private final String m_name;

private final Integer m_price;

Fruits (final String name, final Integer price) {

m_name = name;

m_price = price;

}

@Override

public boolean equals(Object object) {

if(object == this) return true;

if(!(object instanceof Fruits)) return false;

final Fruits obj = (Fruits)object;

return (this.m_name == obj.m_name) && (this.m_price == obj.m_price);

}

@Override

public int hashCode() {

final int prime = 31;

int result = Integer.hashCode(m_price);

result = prime * result + Objects.hashCode(m_name);

result = prime * result + Integer.hashCode(m_price);

return result;

}

これで以下のコードでtrueが返ってくるようになります。

Objects.equals(fruitsList,fruitsList2)//true

1	Objects.equals(fruitsList,fruitsList2)//true

解説

equalsメソッド

公式のリファレンスはこちら↓

https://docs.oracle.com/javase/jp/8/docs/api/java/lang/Object.html#equals-java.lang.Object-

コードについては特に記述することがないので、equalsをオーバライドする時の注意点についてまとめておきます。

①equalsをオーバライドするときは、常にhashCodeをオーバライドする
②あまりにも賢くなろうとしないこと
③equals宣言中のObjectを他の型で置き換えてはいけない
effective java

③については以下のように書いてはいけないということです。

  public boolean equals(Fruits object)

1	public boolean equals(Fruits object)

hashCodeメソッド

公式のリファレンスはこちら↓

https://docs.oracle.com/javase/jp/8/docs/api/java/lang/Object.html#hashCode–

hashCodeの実装方法は以下の通りです。

resultという名のint変数を宣言し、クラス内の意味のあるフィールドに対するハッシュコードで初期化する
クラス内の全ての意味のあるフィールドfに対して[result = 31 * result + Type.hashCode()]を行う

サンプルコードでみるとこんな感じ

    public int hashCode() {
        final int prime = 31;
        int result = Integer.hashCode(m_price);//①
        result = prime * result + Objects.hashCode(m_name);//②
        result = prime * result + Integer.hashCode(m_price);//②
        return result;
    }