如何使用JPA和Hibernate映射组合键？

在此代码中，如何为组合键生成Java类（如何在休眠状态下组合键）：

create table Time (
     levelStation int(15) not null,
     src varchar(100) not null,
     dst varchar(100) not null,
     distance int(15) not null,
     price int(15) not null,
     confPathID int(15) not null,
     constraint ConfPath_fk foreign key(confPathID) references ConfPath(confPathID),
     primary key (levelStation, confPathID)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

要映射组合键，你可以使用EmbeddedId 或在IdClass注解。我知道这个问题不仅仅涉及JPA，但规范定义的规则也适用。因此，它们是：

2.1.4主键和实体身份

...

组合主键必须对应于单个持久性字段或属性，或者对应于如下所述的一组此类字段或属性。必须定义一个主键类来表示一个复合主键。当数据库密钥由几列组成时，从主数据库进行映射时，通常会出现复合主键。的EmbeddedId和 IdClass注解用于表示复合主键。参见9.1.14和9.1.15节。

...

以下规则适用于组合主键：

• 主键类必须是公共的，并且必须具有公共的无参数构造函数。
• 如果使用基于属性的访问，则主键类的属性必须是公共的或受保护的。
• 主键类必须为serializable。
• 主键类必须定义equals和hashCode 方法。这些方法的值相等的语义必须与键映射到的数据库类型的数据库相等一致。
• 复合主键必须表示并映射为可嵌入类（请参见第9.1.14节“ EmbeddedId注释”），或者必须表示并映射至实体类的多个字段或属性（请参见第9.1.15节“ IdClass”）注解”）。
• 如果组合主键类映射到实体类的多个字段或属性，则主键类中的主键字段或属性的名称必须与实体类的名称相一致，并且它们的类型必须相同。

带着 IdClass

复合主键的类可能看起来像（可以是静态内部类）：

public class TimePK implements Serializable {
    protected Integer levelStation;
    protected Integer confPathID;

    public TimePK() {}

    public TimePK(Integer levelStation, Integer confPathID) {
        this.levelStation = levelStation;
        this.confPathID = confPathID;
    }
    // equals, hashCode
}

和实体：

@Entity
@IdClass(TimePK.class)
class Time implements Serializable {
    @Id
    private Integer levelStation;
    @Id
    private Integer confPathID;

    private String src;
    private String dst;
    private Integer distance;
    private Integer price;

    // getters, setters
}

该IdClass注释映射多个字段的表PK。

用 EmbeddedId

复合主键的类可能看起来像（可以是静态内部类）：

@Embeddable
public class TimePK implements Serializable {
    protected Integer levelStation;
    protected Integer confPathID;

    public TimePK() {}

    public TimePK(Integer levelStation, Integer confPathID) {
        this.levelStation = levelStation;
        this.confPathID = confPathID;
    }
    // equals, hashCode
}

和实体：

@Entity
class Time implements Serializable {
    @EmbeddedId
    private TimePK timePK;

    private String src;
    private String dst;
    private Integer distance;
    private Integer price;

    //...
}

该@EmbeddedId注解映射一个PK类表PK。

差异：

• 从物理模型的角度来看，没有区别
• @EmbeddedId通过某种方式可以更清楚地传达出该密钥是组合密钥，而当组合的pk本身是有意义的实体或在代码中重用时，IMO便有意义。
• @IdClass 指定某些字段组合是唯一的很有用，但是这些没有特殊的含义。

它们还会影响您编写查询的方式（使它们或多或少变得冗长）：

• 与 IdClass

  select t.levelStation from Time t

• 与 EmbeddedId

  select t.timePK.levelStation from Time t

参考资料

• JPA 1.0规范
  • 第2.1.4节“主键和实体标识”
  • 第9.1.14节“ EmbeddedId注释”
  • 第9.1.15节“ IdClass注释”

您需要使用@EmbeddedId：

@Entity
class Time {
    @EmbeddedId
    TimeId id;

    String src;
    String dst;
    Integer distance;
    Integer price;
}

@Embeddable
class TimeId implements Serializable {
    Integer levelStation;
    Integer confPathID;
}

正如我在本文中所解释的，假设您具有以下数据库表：

首先，您需要创建@Embeddable包含复合标识符的代码：

@Embeddable
public class EmployeeId implements Serializable {

    @Column(name = "company_id")
    private Long companyId;

    @Column(name = "employee_number")
    private Long employeeNumber;

    public EmployeeId() {
    }

    public EmployeeId(Long companyId, Long employeeId) {
        this.companyId = companyId;
        this.employeeNumber = employeeId;
    }

    public Long getCompanyId() {
        return companyId;
    }

    public Long getEmployeeNumber() {
        return employeeNumber;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof EmployeeId)) return false;
        EmployeeId that = (EmployeeId) o;
        return Objects.equals(getCompanyId(), that.getCompanyId()) &&
                Objects.equals(getEmployeeNumber(), that.getEmployeeNumber());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getCompanyId(), getEmployeeNumber());
    }
}

有了这个，我们可以Employee通过使用注释来映射使用复合标识符的实体@EmbeddedId：

@Entity(name = "Employee")
@Table(name = "employee")
public class Employee {

    @EmbeddedId
    private EmployeeId id;

    private String name;

    public EmployeeId getId() {
        return id;
    }

    public void setId(EmployeeId id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

与关联的Phone实体需要通过两个映射引用父类的复合标识符：@ManyToOneEmployee@JoinColumn

@Entity(name = "Phone")
@Table(name = "phone")
public class Phone {

    @Id
    @Column(name = "`number`")
    private String number;

    @ManyToOne
    @JoinColumns({
        @JoinColumn(
            name = "company_id",
            referencedColumnName = "company_id"),
        @JoinColumn(
            name = "employee_number",
            referencedColumnName = "employee_number")
    })
    private Employee employee;

    public Employee getEmployee() {
        return employee;
    }

    public void setEmployee(Employee employee) {
        this.employee = employee;
    }

    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }
}

有关更多详细信息，请参阅本文。

主键类必须定义equals和hashCode方法

1. 实现equals时，应使用instanceof允许与子类进行比较。如果Hibernate lazy加载一对一或多对一关系，您将拥有该类的代理而不是普通类。代理是子类。比较类名将失败。
   从技术上讲：您应该遵循Liskows替代原理，而忽略对称性。
2. 下一个陷阱是使用诸如name.equals（that.name）之类的东西代替name.equals（that.getName（））。如果是代理，则第一个将失败。

http://www.laliluna.de/jpa-hibernate-guide/ch06s06.html

看起来您是从头开始的。尝试使用可用的逆向工程工具（例如来自数据库的Netbeans实体）至少使基础知识自动化（例如嵌入式ID）。如果您有很多桌子，这可能会变得很头疼。我建议避免重新发明轮子，并使用尽可能多的可用工具，以将编码减少到您打算做的最小和最重要的部分。

让我们举一个简单的例子。假设有两个名为的表test，customer其中描述如下：

create table test(
  test_id int(11) not null auto_increment,
  primary key(test_id));

create table customer(
  customer_id int(11) not null auto_increment,
  name varchar(50) not null,
  primary key(customer_id));

那里还有一张表，它记录tests和customer：

create table tests_purchased(
  customer_id int(11) not null,
  test_id int(11) not null,
  created_date datetime not null,
  primary key(customer_id, test_id));

我们可以看到在表tests_purchased中主键是组合键，因此我们将<composite-id ...>...</composite-id>在hbm.xml映射文件中使用标记。因此，PurchasedTest.hbm.xml将如下所示：

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
  "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
  "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

<hibernate-mapping>
  <class name="entities.PurchasedTest" table="tests_purchased">

    <composite-id name="purchasedTestId">
      <key-property name="testId" column="TEST_ID" />
      <key-property name="customerId" column="CUSTOMER_ID" />
    </composite-id>

    <property name="purchaseDate" type="timestamp">
      <column name="created_date" />
    </property>

  </class>
</hibernate-mapping>

但这并没有到此结束。在Hibernate中，我们使用session.load（entityClass，id_type_object）通过主键查找和加载实体。对于复合键，ID对象应该是一个单独的ID类（在上面的情况下是一个PurchasedTestId类），它仅声明主键属性，如下所示：

import java.io.Serializable;

public class PurchasedTestId implements Serializable {
  private Long testId;
  private Long customerId;

  // an easy initializing constructor
  public PurchasedTestId(Long testId, Long customerId) {
    this.testId = testId;
    this.customerId = customerId;
  }

  public Long getTestId() {
    return testId;
  }

  public void setTestId(Long testId) {
    this.testId = testId;
  }

  public Long getCustomerId() {
    return customerId;
  }

  public void setCustomerId(Long customerId) {
    this.customerId = customerId;
  }

  @Override
  public boolean equals(Object arg0) {
    if(arg0 == null) return false;
    if(!(arg0 instanceof PurchasedTestId)) return false;
    PurchasedTestId arg1 = (PurchasedTestId) arg0;
    return (this.testId.longValue() == arg1.getTestId().longValue()) &&
           (this.customerId.longValue() == arg1.getCustomerId().longValue());
  }

  @Override
  public int hashCode() {
    int hsCode;
    hsCode = testId.hashCode();
    hsCode = 19 * hsCode+ customerId.hashCode();
    return hsCode;
  }
}

重要的一点是，我们还实现了这两个功能hashCode()，equals()并且Hibernate依赖于这两个功能。

映射的另一个选择是作为ConfPath表中复合元素的映射。

但是，此映射将受益于（ConfPathID，levelStation）上的索引。

public class ConfPath {
    private Map<Long,Time> timeForLevelStation = new HashMap<Long,Time>();

    public Time getTime(long levelStation) {
        return timeForLevelStation.get(levelStation);
    }

    public void putTime(long levelStation, Time newValue) {
        timeForLevelStation.put(levelStation, newValue);
    }
}

public class Time {
    String src;
    String dst;
    long distance;
    long price;

    public long getDistance() {
        return distance;
    }

    public void setDistance(long distance) {
        this.distance = distance;
    }

    public String getDst() {
        return dst;
    }

    public void setDst(String dst) {
        this.dst = dst;
    }

    public long getPrice() {
        return price;
    }

    public void setPrice(long price) {
        this.price = price;
    }

    public String getSrc() {
        return src;
    }

    public void setSrc(String src) {
        this.src = src;
    }
}

对应：

<class name="ConfPath" table="ConfPath">
    <id column="ID" name="id">
        <generator class="native"/>
    </id>
    <map cascade="all-delete-orphan" name="values" table="example"
            lazy="extra">
        <key column="ConfPathID"/>
        <map-key type="long" column="levelStation"/>
        <composite-element class="Time">
            <property name="src" column="src" type="string" length="100"/>
            <property name="dst" column="dst" type="string" length="100"/>
            <property name="distance" column="distance"/>
            <property name="price" column="price"/>
        </composite-element>
    </map>
</class>

使用hbm.xml

    <composite-id>

        <!--<key-many-to-one name="productId" class="databaselayer.users.UserDB" column="user_name"/>-->
        <key-property name="productId" column="PRODUCT_Product_ID" type="int"/>
        <key-property name="categoryId" column="categories_id" type="int" />
    </composite-id>  

使用注释

复合键类

public  class PK implements Serializable{
    private int PRODUCT_Product_ID ;    
    private int categories_id ;

    public PK(int productId, int categoryId) {
        this.PRODUCT_Product_ID = productId;
        this.categories_id = categoryId;
    }

    public int getPRODUCT_Product_ID() {
        return PRODUCT_Product_ID;
    }

    public void setPRODUCT_Product_ID(int PRODUCT_Product_ID) {
        this.PRODUCT_Product_ID = PRODUCT_Product_ID;
    }

    public int getCategories_id() {
        return categories_id;
    }

    public void setCategories_id(int categories_id) {
        this.categories_id = categories_id;
    }

    private PK() { }

    @Override
    public boolean equals(Object o) {
        if ( this == o ) {
            return true;
        }

        if ( o == null || getClass() != o.getClass() ) {
            return false;
        }

        PK pk = (PK) o;
        return Objects.equals(PRODUCT_Product_ID, pk.PRODUCT_Product_ID ) &&
                Objects.equals(categories_id, pk.categories_id );
    }

    @Override
    public int hashCode() {
        return Objects.hash(PRODUCT_Product_ID, categories_id );
    }
}

实体类别

@Entity(name = "product_category")
@IdClass( PK.class )
public  class ProductCategory implements Serializable {
    @Id    
    private int PRODUCT_Product_ID ;   

    @Id 
    private int categories_id ;

    public ProductCategory(int productId, int categoryId) {
        this.PRODUCT_Product_ID = productId ;
        this.categories_id = categoryId;
    }

    public ProductCategory() { }

    public int getPRODUCT_Product_ID() {
        return PRODUCT_Product_ID;
    }

    public void setPRODUCT_Product_ID(int PRODUCT_Product_ID) {
        this.PRODUCT_Product_ID = PRODUCT_Product_ID;
    }

    public int getCategories_id() {
        return categories_id;
    }

    public void setCategories_id(int categories_id) {
        this.categories_id = categories_id;
    }

    public void setId(PK id) {
        this.PRODUCT_Product_ID = id.getPRODUCT_Product_ID();
        this.categories_id = id.getCategories_id();
    }

    public PK getId() {
        return new PK(
            PRODUCT_Product_ID,
            categories_id
        );
    }    
}