转-JPA 批注参考(5)
在示例 1-52 中，Project 对作为 Map 的 Employee 实例拥有一对多关系。示例 1-52 显示了如何使用 @MapKey 批注指定此 Map 的键为 Employee 字段 empPK，它是一个类型为 EmployeePK（请参阅示例 1-52）的嵌入式复合主键（请参阅示例 1-51）。
示例 1-50 使用 @MapKey 的 Project 实体
@Entity
public class Project {
??? ...
??? @OneToMany(mappedBy="project")???
??? @MapKey(name="empPK")
??? public Map<EmployeePK, Employee> getEmployees() {
??? ...
??? }
??? ...
}
示例 1-51 Employee 实体
@Entity
public class Employee {
??? @EmbeddedId
??? public EmployeePK getEmpPK() {
???? ...
??? }
??? ...
??? @ManyToOne
??? @JoinColumn(name="proj_id")
??? public Project getProject() {
??? ...
??? }
...
}
示例 1-52 EmployeePK 复合主键类
@Embeddable
public class EmployeePK {
??? String name;
??? Date birthDate;
}
@MappedSuperclass
默认情况下，JPA 持续性提供程序假设实体的所有持久字段均在该实体中定义。
使用 @MappedSuperclass 批注指定一个实体类从中继承持久字段的超类。当多个实体类共享通用的持久字段或属性时，这将是一个方便的模式。
您可以像对实体那样使用任何直接和关系映射批注（如 @Basic 和 @ManyToMany）对该超类的字段和属性进行批注，但由于没有针对该超类本身的表存在，因此这些映射只适用于它的子类。继承的持久字段或属性属于子类的表。
可以在子类中使用 @AttributeOverride 或 @AssociationOverride 批注来覆盖超类的映射配置。
该批注没有属性。有关更多详细信息，请参阅 API。
示例 1-53 显示了如何使用此批注将 Employee 指定为映射超类。示例 1-54 显示了如何扩展实体中的此超类，以及如何在实体类中使用 @AttributeOverride 以覆盖超类中设置的配置。
示例 1-53 @MappedSuperclass
@MappedSuperclass
public class Employee {
@Id
protected Integer empId;
@Version
protected Integer version;
@ManyToOne
@JoinColumn(name="ADDR")
protected Address address;
public Integer getEmpId() {
??????? ...
??? }
public void setEmpId(Integer id) {
??????? ...
??? }
public Address getAddress() {
??????? ...
??? }
public void setAddress(Address addr) {
??????? ...
??? }
}
示例 1-54 扩展 @MappedSuperclass
@Entity
@AttributeOverride(name="address", column=@Column(name="ADDR_ID"))
public class PartTimeEmployee extends Employee {
@Column(name="WAGE")
protected Float hourlyWage;
public PartTimeEmployee() {
??????? ...
??? }
public Float getHourlyWage() {
??????? ...
??? }
public void setHourlyWage(Float wage) {
??????? ...
??? }
}
@NamedNativeQueries
如果需要指定多个 @NamedNativeQuery，则必须使用一个 @NamedNativeQueries 批注指定所有命名查询。
表 1-25 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-25 @NamedNativeQueries 属性
?
属性
必需
说明
value
示例 1-55 显示了如何使用此批注指定两个命名原生查询。
示例 1-55 @NamedNativeQueries
@Entity
@NamedNativeQueries({
@NamedNativeQuery(
name="findAllPartTimeEmployees",
query="SELECT * FROM EMPLOYEE WHERE PRT_TIME=1"
??? ),
@NamedNativeQuery(
name="findAllSeasonalEmployees",
query="SELECT * FROM EMPLOYEE WHERE SEASON=1"
??? )
})
public class PartTimeEmployee extends Employee {
??? ...
}
@NamedNativeQuery
在使用 JPA 持续性提供程序的应用程序中，可以使用实体管理器动态创建和执行查询，也可以预定义查询并在运行时按名称执行。
使用 @NamedNativeQuery 批注创建与 @Entity 或 @MappedSuperclass 关联的预定义查询，这些查询：
● 使用基础数据库的原生 SQL
● 经常被使用
● 比较复杂并且难于创建
● 可以在不同实体之间共享
● 返回实体、标量值或两者的组合（另请参阅 @ColumnResult、@EntityResult、@FieldResult 和@SqlResultSetMapping）
如果有多个要定义的 @NamedNativeQuery，则必须使用 @NamedNativeQueries。
要预定义适合于任何数据库的可移植查询，请参阅 @NamedQuery。
表 1-26 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-26 @NamedNativeQuery 属性
?
属性
必需
说明
query
示例 1-56 显示了如何使用 @NamedNativeQuery 批注定义一个使用基础数据库的原生 SQL 的查询。示例 1-57 显示了如何使用 EntityManager 获取此查询以及如何通过 Query 方法 getResultList 执行该查询。
示例 1-56 使用 @NamedNativeQuery 实现一个 Oracle 层次查询
@Entity
@NamedNativeQuery(
name="findAllEmployees",
query="SELECT * FROM EMPLOYEE"
)
public class Employee implements Serializable {
??? ...
}
示例 1-57 执行一个命名原生查询
Query queryEmployees = em.createNamedQuery("findAllEmployees");
Collection employees = queryEmployees.getResultList();
@NamedQueries
如果需要指定多个 @NamedQuery，则必须使用一个 @NamedQueries 批注指定所有命名查询。
表 1-27 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-27 @NamedQueries 属性
?
属性
必需
说明
value
示例 1-58 显示了如何使用此批注指定两个命名查询。
示例 1-58 @NamedQueries
@Entity
@NamedQueries({
@NamedQuery(
name="findAllEmployeesByFirstName",
query="SELECT OBJECT(emp) FROM Employee emp WHERE emp.firstName = :firstname"
??? ),
@NamedQuery(
name="findAllEmployeesByLasttName",
query="SELECT OBJECT(emp) FROM Employee emp WHERE emp.lasstName = :lastname"
??? )
})
public class PartTimeEmployee extends Employee {
??? ...
}
@NamedQuery
在使用 JPA 持续性提供程序的应用程序中，可以使用实体管理器动态创建和执行查询，也可以预定义查询并在运行时按名称执行。
使用 @NamedQuery 批注创建与 @Entity 或 @MappedSuperclass 关联的预定义查询，这些查询：
● 使用 JPA 查询语言（请参阅 JSR-000220 Enterprise JavaBeans v3.0 规范，第 4 章）进行基于任何基础数据库的可移植执行
● 经常被使用
● 比较复杂并且难于创建
● 可以在不同实体之间共享
● 只返回实体（从不返回标量值），并只返回一个类型的实体
如果有多个要定义的 @NamedQuery，则必须使用 @NamedQueries。
要在已知的基础数据库中预定义原生 SQL 查询，请参阅 @NamedNativeQuery。使用原生 SQL 查询，您可以返回实体（包括不同类型的实体）、标量值或同时返回两者。
表 1-28 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-28 @NamedQuery 属性
?
属性
必需
说明
query
示例 1-59 显示了如何使用 @NamedQuery 批注定义一个JPA 查询语言查询，该查询使用名为 firstname 的参数。示例 1-60 显示了如何使用 EntityManager 获取此查询并使用 Query 方法 setParameter 设置 firstname 参数。
示例 1-59 使用 @NamedQuery 实现一个带参数的查询
@Entity
@NamedQuery(
name="findAllEmployeesByFirstName",
query="SELECT OBJECT(emp) FROM Employee emp WHERE emp.firstName = :firstname"
)
public class Employee implements Serializable {
??? ...
}
示例 1-60 执行命名查询
Query queryEmployeesByFirstName = em.createNamedQuery("findAllEmployeesByFirstName");
queryEmployeeByFirstName.setParameter("firstName", "John");
Collection employees = queryEmployessByFirstName.getResultList();
@OneToMany
默认情况下，JPA 为具有一对多多重性的多值关联定义一个 OneToMany 映射。
使用 @OneToMany 批注：
● 将获取类型配置为 LAZY
● 由于所使用的 Collection 不是使用一般参数定义的，因此配置关联的目标实体
● 配置必须层叠到关联目标的操作：例如，如果删除了拥有实体，则确保还删除关联的目标
● 配置持续性提供程序对单向一对多关系使用的连接表（请参阅 @JoinTable）的详细信息
表 1-29 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-29 @OneToMany 属性
?
属性
必需
说明
cascade
示例 1-61 和示例 1-62 显示了如何使用此批注在使用一般参数的 Customer（被拥有方）和 Order（拥有方）之间配置一个一对多映射。
示例 1-61 @OneToMany - 使用一般参数的 Customer 类
@Entity
public class Customer implements Serializable {
??? ...
@OneToMany(cascade=ALL, mappedBy="customer")
public Set<Order> getOrders() {
return orders;
??? }
??? ...
}
示例 1-62 @ManyToOne - 使用一般参数的 Order 类
@Entity
public class Customer implements Serializable {
??? ...
@ManyToOne
@JoinColumn(name="CUST_ID", nullable=false)
public Customer getCustomer() {
return customer;
??? }
??? ...
}
@OneToOne
默认情况下，JPA 为指向另一个具有一对一多重性的实体的单值关联定义一个 OneToOne 映射，并从被引用的对象类型推断出关联的目标实体。
使用 @OneToOne 批注：
● 将获取类型配置为 LAZY
● 如果空值不适合于应用程序，则将映射配置为禁止空值（针对非基元类型）
● 配置关联的目标实体（如果无法从被引用的对象类型推断出它）
● 配置必须层叠到关联目标的操作：例如，如果删除了拥有实体，则确保还删除关联的目标
表 1-30 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-30 @OneToOne 属性
?
属性
必需
说明
cascade
optional
示例 1-63 和示例 1-64 显示了如何使用此批注在 Customer（拥有方）和 CustomerRecord（被拥有方）之间配置一个一对一映射。
示例 1-63 @OneToOne - Customer 类
@Entity
public class Customer implements Serializable {
??? ...
@OneToOne(optional=false)
@JoinColumn(name="CUSTREC_ID", unique=true, nullable=false, updatable=false)
public CustomerRecord getCustomerRecord() {
return customerRecord;
??? }
??? ...
}
示例 1-64 @OneToOne - CustomerRecord 类
@Entity
public class CustomerRecord implements Serializable {
??? ...
@OneToOne(optional=false, mappedBy="customerRecord")
public Customer getCustomer() {
return customer;
??? }
??? ...
}
@OrderBy
默认情况下，JPA 持续性提供程序按关联实体的主键以升序顺序检索 Collection 关联的成员。
将 @OrderBy 批注与 @OneToMany 和 @ManyToMany 一起使用以便：
● 指定一个或多个作为排序依据的其他字段或属性
● 为每个这样的字段或属性名指定不同的排序（升序或降序）
表 1-31 列出了此批注的属性。有关更多详细信息，请参阅 API。
表 1-31 @OrderBy 属性
?
属性
必需
说明
value
示例 1-65 显示了如何使用 @OrderBy 批注指定 Project 方法 getEmployees 应按 Employee 字段 lastname 以升序顺序并按 Employee 字段 seniority 以降序顺序返回 Employee 的 List。示例 1-66 显示了默认情况下，Employee 方法 getProjects 按 Employee 主键 empId 以升序顺序返回 List。
示例 1-65 Project 实体
@Entity public class Project {
??? ...
@ManyToMany
@OrderBy("lastname ASC", "seniority DESC")
public List<Employee> getEmployees() {
??? ...
??? };
??? ...
}
示例 1-66 Employee 实体
@Entity public class Employee {
@Id
private int empId;
??? ...
private String lastname;
??? ...
private int seniority;
??? ...
@ManyToMany(mappedBy="employees")
// By default, returns a List in ascending order by empId
public List<Project> getProjects() {
??? ...
??? };
??? ...
}
