Apache Commons równa się / hashCode builder [zamknięty]

Ludzie, obudźcie się! od Java 7 istnieją metody pomocnicze dla równa sięi hashCode w bibliotece standardowej. Ich użycie jest w pełni równoważne z użyciem metod Guava.

Jeśli nie chcesz polegać na bibliotece innej firmy (być może używasz urządzenia a z ograniczonymi zasobami), a nawet nie chcesz wpisywać własnych metod, możesz również pozwolić IDE wykonać to zadanie, np. w eclipse użyj

Source -> Generate hashCode() and equals()...

Otrzymasz 'natywny' kod, który możesz skonfigurować tak, jak chcesz i który musisz wspierać przy zmianach.

Przykład (eclipse Juno):

import java.util.Arrays;
import java.util.List;

public class FooBar {

    public String string;
    public List<String> stringList;
    public String[] stringArray;

    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((string == null) ? 0 : string.hashCode());
        result = prime * result + Arrays.hashCode(stringArray);
        result = prime * result
                + ((stringList == null) ? 0 : stringList.hashCode());
        return result;
    }
    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        FooBar other = (FooBar) obj;
        if (string == null) {
            if (other.string != null)
                return false;
        } else if (!string.equals(other.string))
            return false;
        if (!Arrays.equals(stringArray, other.stringArray))
            return false;
        if (stringList == null) {
            if (other.stringList != null)
                return false;
        } else if (!stringList.equals(other.stringList))
            return false;
        return true;
    }

}

EqualsBuilder i HashCodeBuilder mają dwa główne aspekty, które różnią się od ręcznie pisanego kodu:

• null handling
• Tworzenie instancji

EqualsBuilder i HashCodeBuilder ułatwiają porównywanie pól, które mogą być null. Przy ręcznym pisaniu kodu tworzy to dużo kotła.

EqualsBuilder z drugiej strony utworzy instancję dla wywołania metody equals. Jeśli twoje metody są często wywoływane, stworzy to wiele przypadków.

Dla Hibernate implementacja equals i hashCode nie ma znaczenia. Są one tylko szczegółem realizacji. dla prawie wszystkich obiektów domeny załadowanych za pomocą hibernate, overhead runtime (nawet bez analizy escape) Buildera może być zignorowany. Baza danych i komunikacja będą znaczące.

Jak wspomniał skaffman, wersja reflection nie może być używana w kodzie produkcyjnym. Refleksja będzie powolna, a "realizacja" nie będzie poprawne dla wszystkich, oprócz najprostszych klas. Uwzględnienie wszystkich członków jest również niebezpieczne, ponieważ nowo wprowadzeni członkowie zmieniają zachowanie metody equals. Wersja reflection może być przydatna w kodzie testowym.

Jeśli nie piszesz własnego, istnieje również możliwość skorzystania z Google guava (dawniej Google collections)

Jeśli masz do czynienia tylko z encją, w której id jest kluczem podstawowym, możesz to uprościć.

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

      EntityBean castOther = (EntityBean) other;
      return new EqualsBuilder().append(this.getId(), castOther.getId()).isEquals();
   }

Moim zdaniem nie gra dobrze z Hibernate, szczególnie przykłady z odpowiedzi porównującej długość, imię i dzieci dla jakiegoś podmiotu. Hibernate radzi aby używać klucza biznesowego do użycia w equals() i hashCode () i mają swoje powody. Jeśli używasz auto equals() i hashCode () generator na klucz biznesowy, to jest w porządku, tylko problemy z wydajnością muszą być brane pod uwagę, jak wspomniano wcześniej. Ale ludzie zwykle używają wszystkich właściwości, co jest IMO bardzo złe. Na przykład obecnie pracuję nad projektem, w którym encje są pisane za pomocą Pojomatic z @AutoProperty, co uważam za naprawdę zły wzór.

Ich dwa główne scenariusze użycia hashCode () i equals() to:

• gdy umieścisz instancje klas trwałych w zbiorze (the zalecany sposób reprezentowania wielu cenionych stowarzyszeń) i
• kiedy używasz reattachment odłączonych instancji

Załóżmy więc, że nasz byt wygląda tak:

class Entity {
  protected Long id;
  protected String someProp;
  public Entity(Long id, String someProp);
}

Entity entity1 = new Entity(1, "a");
Entity entity2 = new Entity(1, "b");

Oba są ta sama encja dla Hibernate, która została pobrana z jakiejś sesji w pewnym momencie(ich id i Klasa / Tabela są równe). Ale kiedy zaimplementujemy auto equals () a hashCode() na wszystkich rekwizytach, co mamy?

1. gdy umieścisz entity2 na trwałym zestawie, w którym entity1 już istnieje, zostanie to wprowadzone dwa razy i spowoduje wyjątek podczas commit.
2. Jeśli chcesz załączyć oddzielny entity2 do sesji, gdzie entity1 już istnieje (prawdopodobnie, nie testowane to szczególnie) nie zostaną prawidłowo połączone.

Tak więc, dla 99% projektu, który wykonuję, używamy następującej implementacji equals() i hashCode () napisanej raz w podstawowej klasie encji, co jest zgodne z pojęciami Hibernate:

@Override
public boolean equals(Object obj) {
    if (StringUtils.isEmpty(id))
        return super.equals(obj);

    return getClass().isInstance(obj) && id.equals(((IDomain) obj).getId());
}

@Override
public int hashCode() {
    return StringUtils.isEmpty(id)
        ? super.hashCode()
        : String.format("%s/%s", getClass().getSimpleName(), getId()).hashCode();
}

Dla istoty przejściowej robię to samo, co Hibernate zrobi na kroku persistence, tj. Używam dopasowania instancji. Dla trwałych obiektów porównuję unikalny klucz, którym jest table/id (nigdy nie używam kluczy kompozytowych).

Na wszelki wypadek, dla innych będzie to przydatne, wymyśliłem tę klasę pomocniczą do obliczeń kodu hashowego, która pozwala uniknąć dodatkowych kosztów tworzenia obiektów wymienionych powyżej (w rzeczywistości, kosztów obiektów.metoda hash () jest jeszcze większa, gdy masz dziedziczenie, ponieważ utworzy nową tablicę na każdym poziomie!).

Przykład użycia:

public int hashCode() {
    return HashCode.hash(HashCode.hash(timestampMillis), name, dateOfBirth); // timestampMillis is long
}

public int hashCode() {
    return HashCode.hash(super.hashCode(), occupation, children);
}

Pomocnik HashCode:

public class HashCode {

    public static int hash(Object o1, Object o2) {
        return add(Objects.hashCode(o1), o2);
    }

    public static int hash(Object o1, Object o2, Object o3) {
        return hash(Objects.hashCode(o1), o2, o3);
    }

    ...

    public static int hash(Object o1, Object o2, ..., Object o10) {
        return hash(Objects.hashCode(o1), o2, o3, ..., o10);
    }

    public static int hash(int initial, Object o1, Object o2) {
        return add(add(initial, o1), o2);
    }

    ...

    public static int hash(int initial, Object o1, Object o2, ... Object o10) {
        return add(... add(add(add(initial, o1), o2), o3) ..., o10);
    }

    public static int hash(long value) {
        return (int) (value ^ (value >>> 32));
    }

    public static int hash(int initial, long value) {
        return add(initial, hash(value));
    }

    private static int add(int accumulator, Object o) {
        return 31 * accumulator + Objects.hashCode(o);
    }
}

Doszedłem do wniosku, że 10 to maksymalna rozsądna liczba właściwości w modelu domeny, jeśli masz więcej powinieneś pomyśleć o refaktoryzacji i wprowadzeniu większej klasy zamiast utrzymywania sterty ciągów i prymitywów.

Wady są następujące: nie jest to przydatne, jeśli masz głównie prymitywy i / lub tablice, które musisz głęboko hashować. (Zwykle ma to miejsce, gdy masz do czynienia z płaskimi (transferowymi) obiektami, które są poza Twoją kontrolą).