快捷導(dǎo)航

lombok注解@Data使用在繼承類上時(shí)出現(xiàn)警告的問(wèn)題及解決

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

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

lombok為我們提供了@Data注解，幫助我們省略了@Setter，@Getter，@ToString等注解，一般對(duì)于普通的實(shí)體類使用該注解，不會(huì)出現(xiàn)什么問(wèn)題，但是當(dāng)我們把這個(gè)注解，使用在派生類上，就出現(xiàn)了一個(gè)警告

1 情景再現(xiàn)

父類：

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

子類：

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

此時(shí)，idea中顯示，在子類的@Data注解的地方會(huì)出現(xiàn)警告，如圖：

出現(xiàn)的警告信息：

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.

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

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

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) ，警告消失

這時(shí)候，我們?cè)賮?lái)看我們的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;
}

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

這么一來(lái)，好像就解決了在繼承情況下使用@Data注解的警告問(wèn)題。

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

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

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

下面，我們通過(guò)這種方式來(lái)解決這個(gè)警告的問(wèn)題。

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>

經(jīng)過(guò)上兩步步驟警告已經(jīng)消失，如圖：