lombok注解@Data使用在繼承類上時出現警告的問題及解決

更新時間：2024年10月23日 10:40:36 作者：吳名氏.

Lombok的@Data注解簡化了實體類代碼,但在子類中使用時會出現警告,指出equals和hashCode方法不會考慮父類屬性,解決方法有兩種：一是在父類上使用@EqualsAndHashCode(callSuper=true)注解；二是通過配置lombok.config文件,均能有效解決警告問題

1 情景再現

父類：

@Data
public class BaseEntity {
 
    /**
     * 公共字段主鍵id
     */
    private Integer id;
 
    /**
     * 公共字段創(chuàng)建時間
     */
    private Date createTime;
 
    /**
     * 公共字段更新時間
     */
    private Date updateTime;
 
}

子類：

@Data
public class User extends BaseEntity {
 
    /**
     * 用戶名
     */
    private String username;
 
    /**
     * 密碼
     */
    private String password;
 
}

此時，idea中顯示，在子類的@Data注解的地方會出現警告，如圖：

出現的警告信息：

Generating equals/hashCode implementation but without a call to superclass, even though this class does not extend java.lang.Object. If this is intentional, add '@EqualsAndHashCode(callSuper=false)' to your type.

大致意思是默認子類的equals和hashCode方法，不會包含或者考慮基類的屬性。

我們可以通過反編譯工具查看項目target/classes目錄下的User.class的hashCode方法，默認情況下屬性都是使用的他自身的屬性。

public int hashCode()
{
    int PRIME = 59;
    int result = 1;
    Object $username = getUsername();
    result = result * 59 + ($username == null ? 43 : $username.hashCode());
    Object $password = getPassword();
    result = result * 59 + ($password == null ? 43 : $password.hashCode());
    Object $mobile = getMobile();
    result = result * 59 + ($mobile == null ? 43 :     $mobile.hashCode());
    return result;
}

2 解決方案一(添加注解)

在警告的父類加上注解@EqualsAndHashCode(callSuper=true) ，警告消失

這時候，我們再來看我們的User.class中的hashCode方法：

public int hashCode()
{
    int PRIME = 59;
    int result = super.hashCode();
    Object $username = getUsername();
    result = result * 59 + ($username == null ? 43 : $username.hashCode());
    Object $password = getPassword();
    result = result * 59 + ($password == null ? 43 : $password.hashCode());
    Object $mobile = getMobile();
    result = result * 59 + ($mobile == null ? 43 : $mobile.hashCode());
    return result;
}

可以看出代碼中不一樣的地方,默認情況下是int result=1，當添加注解@EqualsAndHashCode(callSuper=true)時，變成了int result=super.hashCode()。

這么一來，好像就解決了在繼承情況下使用@Data注解的警告問題。

但是問題是，每一個繼承的類，都需要這么來解決，也不是很方便。所以，lombok作者Roel也給出了解決辦法，就是通過自定義lombok.config文件來解決。

3 解決方案二(配置lombok.config)

lombok.config文件需要放在src/main/java文件夾下的目錄中（也可以放在實體同級目錄下），放在src/main/resources目錄下，不會生效。

下面，我們通過這種方式來解決這個警告的問題。

3.1 新建lombok.config文件，然后配置：

config.stopBubbling=true
lombok.equalsAndHashCode.callSuper=call

3.2 pom.xml文件中需要加入如下插件：

<plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
      <configuration>
          <source>1.8</source>
          <target>1.8</target>
      </configuration>
</plugin>

經過上兩步步驟警告已經消失，如圖：