JavaでObjectクラスのequalsメソッドをオーバーライドするメリット
すべてのjavaクラスは、equalsメソッドを持っています。
そのequalsメソッドをオーバーライド(上書き)するメリットを自分なりに説明してみます。
説明に使うクラス
/** * 人間、一人を表すクラス */ class Person { /** 名前 */ private String name; /** 年齢 */ private int age; /** コンストラクタ */ public Person(String name, int age) { this.name = name; this.age = age; } // ...各フィールドのgetter/setter }
オーバーライドしなかった時のデフォルト実装
equalsメソッドをオーバーライドしなかった場合、Objectクラスのequalsメソッドが使われます。
/** * Objectクラスのequalsメソッド */ public boolean equals(Object obj) { return (this == obj); }
この実装は、単にオブジェクトの参照先(メモリのアドレス値)が同一かのみを判断していて、自分自身のみと等しくなります。
下記が小さなサンプルコードです。
フィールドの値が全て一致していても新しくインスタンスを作れば、equalsメソッドの結果はfalseになります。
オブジェクトの参照先が変わるからです。
Person person1 = new Person("ほげさん", 20); Person person2 = person1; Person person3 = new Person("ほげさん", 20); person1.equals(person2); //=> true person1.equals(person3); //=> false
イメージが分かりやすい参考サイト
equalsメソッドをオーバーライドするメリット
一つ前で、デフォルト(初期)のequalsメソッドを説明しました。
ではメリットを説明する前に Personクラスのequalsメソッドを名前が一致すれば 同じオブジェクトだ！ のように変更しましょう。
イメージとして、10人〜20人規模の名簿を管理しているとして、
その中に同姓同名が存在する可能性は低いので名前が同じであれば同じ人間であると設計しましょう という意味です。
ちなみに、hashCodeメソッドもオーバーライドしていますが、もう少し下の方で説明しています。
class Person { // ..... @Override public boolean equals(Object obj) { if (this == obj) return true; if (!(obj instanceof Person)) return false; Person otherPerson = (Person) obj; // nameの値として nullを許容しています。 return code == null ? otherPerson.getName() == null : code.equals(otherPerson.getName()); } @Override public int hashCode() { final int prime = 31; int result = 1; result = prime * result + ((name == null) ? 0 : name.hashCode()); return result; } }
メリットを説明しますね。
仮にList<Person> personListがあるとします。
その中から、名前 = "ほげさん"というPersonが存在するかチェックしたい時に、あなたならどうしますか？
単純に考えると、Listをループして一つずつチェックし一致したら trueを返すと書くかもしれません。
でも、このループ処理は equalsメソッドをオーバーライドしていれば実装する手間が省けます。
List<Person> personList = new ArrayList<>(); personList.add(new Person("テスト００１さん", 30)); personList.add(new Person("テスト００２さん", 30)); personList.add(new Person("テスト００３さん", 30)); personList.add(new Person("テスト００４さん", 30)); personList.add(new Person("ほげさん", 20)); // equalsメソッドをオーバーライドしなかった場合 boolean existFlg = false; for(Person person : personList) { if("ほげさん".equals(person.getName())) { existFlg = true; break; } } // equalsメソッドをオーバーライドした場合 Person hogePerson = new Person(); hogePerson.setName("ほげさん"); boolean existFlg = personList.contains(hogePerson); //=> true
equalsメソッドをオーバーライドして、ArrayListのcontainsメソッドを使うと、存在チェック処理を簡単に書ける。
containsメソッド内でも、同じようにループ処理を行っているんですが、オブジェクトの一致判定にequalsメソッドを使っています。
なので、euqlasメソッドを自分が想定する条件になるようオーバーライドすれば、containsメソッドが利用可能になる。
仮に、オーバーライドせずにcontainsメソッドを使用すると、自分自身のみと等しいことになるので、フィールドが一致していても無視されます。
// equalsメソッドをオーバーライドしなかった場合 Person hogePerson = new Person(); hogePerson.setName("ほげさん"); boolean existFlg = personList.contains(hogePerson); //=> false
同様に、ArrayListのメソッド内で、equalsメソッドに依存しているメソッドがいくつかあります。
indexOf(Object obj)
name値が"ほげさん"のインデックス番号(List内での順番,要素番号)を取得する。
remove(Object obj)
name値が"ほげさん"で一番最初にヒットするPersonをListから削除する。
参考サイト
Java SE 7 - ArrayListのメソッド一覧 - ArrayList (Java Platform SE 7)
説明した後に、一つ補足です。
List<String> strList = new ArrayList<>(); strList.add("aaa"); strList.add("bbb"); strList.add("ccc"); strList.add("hoge"); strList.contains("hoge"); //=> true
このように、ListにStringやInteger、Dateなど Javaから提供されているクラスを入れる場合は、すでにそのクラスでequalsメソッドをオーバーライドされているので、equalsメソッドのオーバーライドは不要です。
オーバーライドする必要があるのは、自作の値クラスをListに入れた時です(^-^)
equalsメソッドをオーバーライドする時に注意すること。
equalsメソッドをオーバーライドする際には、守らないといけないルールが５つある。
ざっと書くと
- 反射性 (reflexive): null 以外の参照値 x について、x.equals(x) は true を返します。
- 対称性 (symmetric): null 以外の参照値 x および y について、y.equals(x) が true を返す場合に限り、x.equals(y) は true を返します。
- 推移性 (transitive): null 以外の参照値 x、y、および z について、x.equals(y) が true を返し、y.equals(z) が true を返す場合、x.equals(z) は true を返します。
- 一貫性 (consistent): null 以外の参照値 x および y について、x.equals(y) の複数の呼び出しは、このオブジェクトに対する equals による比較で使われた情報が変更されていなければ、一貫して true を返すか、一貫して false を返します。
- null 以外の参照値 x について、x.equals(null) は false を返します。
一つずつ、説明すると新たに記事を作成しないといけない内容なので、このルールについて詳しく知りたい方は
EFFECTIVE JAVA 第2版 (The Java Series)
- 作者: Joshua Bloch,柴田芳樹
- 出版社/メーカー: 丸善出版
- 発売日: 2014/03/11
- メディア: 単行本（ソフトカバー）
- この商品を含むブログ (5件) を見る
さらに、equalsメソッドをオーバーライドする際は必ず、hashCodeメソッドもオーバーライドが必要です。
equalsメソッドがtrueなら、その比較した2つのオブジェクトが持つhashCodeメソッドの返り値が同じにならなければならない。
そうしないと HashMapなどを使った時に困るからです。
詳しくは、下記のサイトが分かりやすかったです＾ー＾b
http://education.yachinco.net/tips/java/01/4.html
でも、これは１から全て実装する時に意識する必要がありますが、自分が知っている限りだと自動生成したり、ライブラリに処理を任せたり出来ます。
Apache common langのEqualsBuilderを使う
import org.apache.commons.lang3.builder.EqualsBuilder; import org.apache.commons.lang3.builder.HashCodeBuilder; @Override public boolean equals(Object o) { return EqualsBuilder.reflectionEquals(this, o); } @Override public int hashCode() { return HashCodeBuilder.reflectionHashCode(this); }
au版 iPhoneの留守番電話サービスについて
今日、iPhoneを使ってる知人から留守番電話の機能使いたいんだけど、どうしたら使えるように設定出来るの？
と言われて調べた結果を書きますね。
まず結果から。
4G,LTE回線を使っているau版のiPhoneでは、
電話きほんパック(月額300円)の申し込みが必要
auのお留守番サービスは無料とは書いてあるものの、
公式サイトを見ると下記のような記述があります。
4G LTEスマートフォンで留守番電話をご利用いただくには「電話きほんパック」へのお申込みが必要です。
au公式サイト - お留守番サービス
4G、LTEスマートフォンについては、「電話きほんパック」に申し込みが必要とのこと。
一番最初、自分はiPhoneの設定で留守番電話の機能がOFFになってるんじゃ？
と思って下記のサイトを参考に設定。
au版iPhone、「留守番電話」機能の設定方法 - たのしいiPhone！ AppBank
設定後、電話して30秒後に留守番電話にならずに電話が切れる結果に。
それで色々調べると そもそも留守番電話機能のサービスに申し込む必要があると分かった感じです。
ちなみに、電話きほんパック申し込んでいる人を対象に書きますが
呼び出し時間の秒数設定っていうことも、出来るようなのでついでに書きます。
下記のような電話番号に掛けると留守番電話になるまでの時間(呼び出し時間)を設定出来ます。
TEL: 1418xx-☎
xx(設定したい秒数を 05~55で入力する)
デフォルトは、20秒。
留守番電話機能って利用しない人にとっては、
全く知らない情報だと思うので知らなかった人の参考になれば幸いだー。
