Recommend ways to overwrite hashCode() in java

Perface

　　In the former chapter, I talk about topics about hashCode, And I will continue to finish the introduction to hashCode(). In this chapter, I will recommend several ways to overrwrite hashCode()  to facilitate our work

Recommended by the author of "Effective Java"

　　Ideally, a hash function should distribute any reasonable collection of unequal instances uniformly across all possible hash values. Here is a simple recipe:
    1.  Store some constant nonzero value, say, 17, in an int variable called result.
    2.  For each significant field f in your object (each field taken into account by the equals method, that is), do the following:
        a.  Compute an int hash code c for the field:
            i.   If the field is a boolean, compute (f ? 1 : 0).
            ii.  If the field is a byte, char, short, or int, compute (int) f.
            iii. If the field is a long, compute (int) (f ^ (f >>> 32)).
            iv. If the field is a float, compute Float.floatToIntBits(f).
            v.  If the field is a double, compute Double.doubleToLongBits(f), and then hash the resulting long as in step 2.a.iii.
            vi. If the field is an object reference and this class’s equals method compares the field by recursively invoking equals, recursively invoke hashCode on the field. If a more complex comparison is required, compute a “canonical representation” for this field and invoke hashCode on the canonical representation. If the value of the field is null, return 0.
            vii. If the field is an array, treat it as if each element were a separate field. If every element in an array field is significant, you can use one of theArrays.hashCode methods.
        b.  Combine the hash code c computed in step 1) into result as follows:
                result = 31 * result + c;
    3.      Return result.

Overriding hashCode() and equals() using Apache Commons Lang

　　Apache commons provide two excellent utility classes for generating hash code and equals methods. Below is its usage:

 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 public class Employee
 {
  private Integer id;
  private String firstname;
  private String lastName;
  private String department;
 public Integer getId() {
     return id;
  }
  public void setId(Integer id) {
     this.id = id;
  }
  public String getFirstname() {
     return firstname;
  }
  public void setFirstname(String firstname) {
     this.firstname = firstname;
  }
  public String getLastName() {
     return lastName;
  }
  public void setLastName(String lastName) {
     this.lastName = lastName;
  }
  public String getDepartment() {
     return department;
  }
  public void setDepartment(String department) {
     this.department = department;
  }
 @Override
  public int hashCode()
  {
     final int PRIME = 31;
     return new HashCodeBuilder(getId()%2==0?getId()+1:getId(), PRIME).
            toHashCode();
  }
 @Override
  public boolean equals(Object o) {
     if (o == null)
        return false;
     if (o == this)
        return true;
     if (o.getClass() != getClass())
        return false;
     Employee e = (Employee) o;
        return new EqualsBuilder().
               append(getId(), e.getId()).
               isEquals();
     }
  }

　　In the official doucment of HashCodeBuilder, it describes as follow:

　　This class enables a good hashCode method to be built for any class. It follows the rules laid out in the book Effective Java by Joshua Bloch. Writing a good hashCode method is actually quite difficult. This class aims to simplify the process.

　　The following is the approach taken. When appending a data field, the current total is multiplied by the multiplier then a relevant value for that data type is added. For example, if the current hashCode is 17, and the multiplier is 37, then appending the integer 45 will create a hashcode of 674, namely 17 * 37 + 45.

　　All relevant fields from the object should be included in the hashCode method. Derived fields may be excluded. In general, any field used in the equals method must be used in the hashCode method.

　　To use this class write code as follows:

 public class Person {
   String name;
   int age;
   boolean smoker;
   ...

   public int hashCode() {
     // you pick a hard-coded, randomly chosen, non-zero, odd number
     // ideally different for each class
     return new HashCodeBuilder(17, 37).
       append(name).
       append(age).
       append(smoker).
       toHashCode();
   }
 }

Automatically generated by eclipse IDE

　　if you are using any code editor, they also must be capable of generating some good structure for you. For example, Eclipse IDE has option under right click on class >> source > Generate hashCode() and equals() … will generate a very good implementation for you.

　　

Summary

　　In general, it is not common to override the hashCode() method, but if we need to do it in practical work, it will be a troublesome experience. To make our work easier and more efficiently, it is a good idea to follow the recommendations in the chapter. But if you want to achieve a higher performance, you'd better to override the method yourself carefully.

References

　　Working with hashCode and equals methods in java

　  Apache Commons Lang