开发者

Java: Automatic equals() and hashCode()

Implementing equals() and hashCode() for simple data POJOs is cluttering my code and maintaining is tedious.

What are the libraries handling this automatically?

I prefer bytecode instrumentation over AOP approach due to performance reasons.

Update: The topic of the necessity of implementing equals() and hashCode() has been discussed, here's my point:

Isn't it better to have it done right upfront with minimal effort rather than digging in the code, adding hC/eq when it comes开发者_JAVA百科 to it?

Edit 2022: I have switched to Kotlin. Kotlin takes care of most of Java's boilerplate, see this page for the case of equals(): https://tedblob.com/kotlin-data-class/


Project Lombok provides the annotation @EqualsAndHashCode which will generate equals() and hashCode() for your Java classes. Of course there are some drawbacks in comparison to manually implementing these methods, so make sure you read the "small print" on the linked page.


Objects.hashCode & Objects.hash

While not the panacea you requested, writing the hashCode override is a bit easier now as of Java 7 and later.

As of Java 7, the Objects class offers a couple of utility methods for generating hash code values.

See my Answer on a related Question for more discussion.

  • If your hashCode (and equals) override is based on a single member of your class, use Objects.hashCode( member ).
  • If your hashCode (and equals) override is based on multiple attribute of your class, use Objects.hash( memberA , memberB , memberC ).

Single member, not tolerating a NULL

@Override
public int hashCode() {
    return this.member.hashCode() ;  // Throws NullPointerException if member variable is null.
}

Single member, tolerating a NULL

@Override
public int hashCode() {
    return Objects.hashCode( this.member ) ;  // Returns zero (0) if `this.member` is NULL, rather than throwing exception.
}

Multi-member

@Override
public int hashCode() {
    return Objects.hash( this.memberA , this.memberB , this.memberC  ) ;  // Hashes the result of all the passed objects’ individual hash codes.  
}

For an automatically generated hashCode & equals use a record, as discussed in my other Answer.


You can use Google's AutoValue library to automatically generate immutable value classes with equals and hashCode. These value classes are somewhat similar to Scala's case classes or those generated by Lombok.

There's also a post on how to use it in an IDE.


What about Guava's Objects.hashCode and Objects.equal?


The Apache commons-lang library has a HashCodeBuilder and EqualsBuilder that will do some of the work for you and shorten those methods. There are even reflection versions that will do it all for you based on the fields in the POJOs. However, I wouldn't recommend that. Reflection can be slow (though not as bad as many think), and you should implement them to be sure that only the correct fields are considered for equality.

My question is, do you really need to do this? Often hashcode and equals on POJOs only need to be implemented for use with Maps or Sets. In the case of Maps, usually you would use an ID for a key, which isn't the Pojo itself. So, .... are you making work for yourself?


Records

Java 16 gained a new feature, records.

If the main purpose of your class is to communicate data transparently and immutably, write the class as a record.

By default, you need do nothing more than declare the member fields. The compiler implicitly creates the constructor, getters, equals & hashCode, and toString.

record Person ( String givenName , String surname ) {}

record Point ( int x , int y ) {}

record User ( UUID id, String name ) {}

The default behavior of a record’s equals & hashCode is to consider each and every member field. You can override to provide your own logic.

I highly recommend reading the Java JEP linked above. You’ll learn that the purpose of the record feature is not a reduction in boilerplate. Less code is a nice extra benefit. But if you choose record only for less typing, you’ll likely be abusing the feature. Such abuse may confuse people reading your code, and may lead to other problems.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜