Lombok @Builder 和 JPA 默认构造函数

Question

我正在将 Lombok 项目与 Spring Data JPA 一起使用。 有没有办法将 Lombok @Builder与 JPA 默认构造函数连接起来？

代码：

@Entity 
@Builder
class Person {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
}

据我所知，JPA 需要由@Builder注释覆盖的默认构造函数。 有什么解决方法吗？

这段代码给了我错误： org.hibernate.InstantiationException: No default constructor for entity: : app.domain.model.Person

Answer 1

更新

根据反馈和约翰的回答，我更新了不再使用@Tolerate或@Data的答案，而是通过@Getter和@Setter创建访问器和@Setter器，通过@Getter创建默认构造@NoArgsConstructor ，最后我们创建所有参数构建器通过@AllArgsConstructor需要的构造@AllArgsConstructor 。

由于您想使用构建器模式，我想您想限制构造函数和修改器方法的可见性。 为了实现这一目标，我们将能见度设为package private通过access该属性@NoArgsConstructor和@AllArgsConstructor注释和value的属性@Setter注解。

重要的

请记住正确覆盖toString 、 equals和hashCode 。 有关详细信息，请参阅 Vlad Mihalcea 的以下帖子：

• 最好的实现方式等于哈希码和字符串与 jpa 和休眠
• 如何使用 jpa-entity-identifier 实现等号和哈希码
• hibernate-facts-equals-and-hashcode

package com.stackoverflow.SO34299054;

import static org.junit.Assert.*;

import java.util.Random;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

import org.junit.Test;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@SuppressWarnings("javadoc")
public class Answer {

    @Entity
    @Builder(toBuilder = true)
    @AllArgsConstructor(access = AccessLevel.PACKAGE)
    @NoArgsConstructor(access = AccessLevel.PACKAGE)
    @Setter(value = AccessLevel.PACKAGE)
    @Getter
    public static class Person {

        @Id
        @GeneratedValue(strategy = GenerationType.AUTO)
        private Long id;

        /*
         * IMPORTANT:
         * Set toString, equals, and hashCode as described in these
         * documents:
         * - https://vladmihalcea.com/the-best-way-to-implement-equals-hashcode-and-tostring-with-jpa-and-hibernate/
         * - https://vladmihalcea.com/how-to-implement-equals-and-hashcode-using-the-jpa-entity-identifier/
         * - https://vladmihalcea.com/hibernate-facts-equals-and-hashcode/
         */
    }

    /**
     * Test person builder.
     */
    @Test
    public void testPersonBuilder() {

        final Long expectedId = new Random().nextLong();
        final Person fromBuilder = Person.builder()
            .id(expectedId)
            .build();
        assertEquals(expectedId, fromBuilder.getId());

    }

    /**
     * Test person constructor.
     */
    @Test
    public void testPersonConstructor() {

        final Long expectedId = new Random().nextLong();
        final Person fromNoArgConstructor = new Person();
        fromNoArgConstructor.setId(expectedId);
        assertEquals(expectedId, fromNoArgConstructor.getId());
    }
}

使用@Tolerate和@Data旧版本：

使用@Tolerate可以允许添加 noarg 构造函数。

由于您想使用构建器模式，我想您想控制 setter 方法的可见性。

@Data注释使生成的 setter public ，将@Setter(value = AccessLevel.PROTECTED)应用于字段使它们protected 。

请记住正确覆盖toString 、 equals和hashCode 。 有关详细信息，请参阅 Vlad Mihalcea 的以下帖子：

• 最好的实现方式等于哈希码和字符串与 jpa 和休眠
• 如何使用 jpa-entity-identifier 实现等号和哈希码
• hibernate-facts-equals-and-hashcode

package lombok.javac.handlers.stackoverflow;

import static org.junit.Assert.*;

import java.util.Random;

import javax.persistence.GenerationType;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

import lombok.AccessLevel;
import lombok.Builder;
import lombok.Data;
import lombok.Setter;
import lombok.experimental.Tolerate;

import org.junit.Test;

public class So34241718 {

    @Builder
    @Data
    public static class Person {

        @Id
        @GeneratedValue(strategy = GenerationType.AUTO)
        @Setter(value = AccessLevel.PROTECTED)
        Long id;

        @Tolerate
        Person() {}

       /* IMPORTANT:
          Override toString, equals, and hashCode as described in these 
          documents:
          - https://vladmihalcea.com/the-best-way-to-implement-equals-hashcode-and-tostring-with-jpa-and-hibernate/
          - https://vladmihalcea.com/how-to-implement-equals-and-hashcode-using-the-jpa-entity-identifier/
          - https://vladmihalcea.com/hibernate-facts-equals-and-hashcode/
          */
    }

    @Test
    public void testPersonBuilder() {

        Long expectedId = new Random().nextLong();
        final Person fromBuilder = Person.builder()
            .id(expectedId)
            .build();
        assertEquals(expectedId, fromBuilder.getId());

    }

    @Test
    public void testPersonConstructor() {

        Long expectedId = new Random().nextLong();
        final Person fromNoArgConstructor = new Person();
        fromNoArgConstructor .setId(expectedId);
        assertEquals(expectedId, fromNoArgConstructor.getId());
    }
}

Answer 2

您还可以使用@Data @Builder @NoArgsConstructor @AllArgsConstructor在类定义上组合来显式解决它。

Answer 3

似乎注释顺序在这里很重要，使用相同的注释，但顺序不同，您可以让代码工作，也可以不工作。

这是一个非工作示例：

@AllArgsConstructor
@Builder
@Data
@Entity
@EqualsAndHashCode
@NoArgsConstructor
@RequiredArgsConstructor
@Table
@ToString
public class Person implements Serializable {
  private String name;
}

这是一个工作示例：

@Builder
@Data
@Entity
@EqualsAndHashCode
@AllArgsConstructor
@NoArgsConstructor
@RequiredArgsConstructor
@Table
@ToString
public class Person implements Serializable {
  private String name;
}

所以一定要把@Builder 注释放在最上面的位置，在我的例子中我遇到了这个错误，因为我想按字母顺序对注释进行排序。

Answer 4

如果同时使用构造函数上的lombok.Tolerate和某些属性上的javax.validation.constraints.NotNull注释，sonarqube 会将其标记为严重错误： PROPERTY 标记为“javax.validation.constraints.NotNull”但不是在此构造函数中初始化。

如果项目使用带有JPA的SpringData，可以使用org.springframework.data.annotation.PersistenceConstructor解决（Spring注解，不是JPA！）

然后，结合 Lombok，注解会是这样的：

@RequiredArgsConstructor(onConstructor = @__(@PersistenceConstructor))

对于 Lombok builder，您还需要添加：

@Builder
@AllArgsConstructor

Answer 5

要使用以下组合

• 龙目岛
• 日本特许经营协会
  • CRUD
  • 正确的@EqualsAndHashCode
• 不变性 - 公共最终字段
• 没有吸气剂
• 没有二传手
• 通过@Builder和@With更改

我用了：

//Lombok & JPA
//https://stackoverflow.com/questions/34241718/lombok-builder-and-jpa-default-constructor

//Mandatory in conjunction with JPA: an equal based on fields is not desired
@lombok.EqualsAndHashCode(onlyExplicitlyIncluded = true)
//Mandatory in conjunction with JPA: force is needed to generate default values for final fields, that will be overriden by JPA
@lombok.NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
//Hides the constructor to force usage of the Builder.
@lombok.AllArgsConstructor(access = AccessLevel.PRIVATE)
@lombok.ToString
//Good to just modify some values
@lombok.With
//Mandatory in conjunction with JPA: Some suggest that the Builder should be above Entity - https://stackoverflow.com/a/52048267/99248
//Good to be used to modify all values
@lombok.Builder(toBuilder = true)
//final fields needed for imutability, the default access to public - since are final is safe 
@lombok.experimental.FieldDefaults(makeFinal = true, level = AccessLevel.PUBLIC)
//no getters and setters
@lombok.Getter(value = AccessLevel.NONE)
@lombok.Setter(value = AccessLevel.NONE)

//JPA
@javax.persistence.Entity
@javax.persistence.Table(name = "PERSON_WITH_MOTTO")
//jpa should use field access 
@javax.persistence.Access(AccessType.FIELD)
public class Person {
  @javax.persistence.Id
  @javax.persistence.GeneratedValue
  //Used also automatically as JPA
  @lombok.EqualsAndHashCode.Include
  Long id;
  String name;
  String motto;
}

Answer 6

使用@NoArgsConstructor和@AllArgsContructor将有助于解决带有@Builder的默认构造函数的问题。

例如

@Entity 
@Builder
@NoArgsConstructor
@AllArgsContructor
class Person {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
}

这是因为@Builder需要所有参数构造函数，并且仅指定默认构造函数会导致问题。

这里没有解释： https : //github.com/rzwitserloot/lombok/issues/1389#issuecomment-369404719

Answer 7

我使用所有这些注释解决了这个问题：

@Data
@Builder
@AllArgsConstructor(access = AccessLevel.PACKAGE)
@NoArgsConstructor(access = AccessLevel.PACKAGE)

Answer 8

Jeff 的回答很好，但是，@Builder 还不支持自引用关系。

检查此问题以获取更多详细信息：

JPA @OnetoOne 自引用关系与两列非空