`
hwpok
  • 浏览: 250657 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

jpa 详解(转)

阅读更多
Table
Table用来定义entity主表的name,catalog,schema等属性。
元数据属性说明:
name: 表名
catalog: 对应关系数据库中的catalog
schema:对应关系数据库中的schema
UniqueConstraints:定义一个UniqueConstraint数组,指定需要建唯一约束的列

@Entity 
@Table(name
="CUST"
public class Customer ...{ ... } 
  SecondaryTable 

一个entity class可以映射到多表,SecondaryTable用来定义单个从表的名字,主键名字等属性。
元数据属性说明:
name: 表名
catalog: 对应关系数据库中的catalog
schema:对应关系数据库中的schema
pkJoin: 定义一个PrimaryKeyJoinColumn数组,指定从表的主键列
UniqueConstraints:定义一个UniqueConstraint数组,指定需要建唯一约束的列
下面的代码说明Customer类映射到两个表,主表名是CUSTOMER,从表名是CUST_DETAIL,从表的主键列和主表的主键列类型相同,列名为CUST_ID。

@Entity 
@Table(name
="CUSTOMER"
@SecondaryTable(name
="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID")) 
public class Customer ...{ ... } 


SecondaryTables
当一个entity class映射到一个主表和多个从表时,用SecondaryTables来定义各个从表的属性。
元数据属性说明:
value: 定义一个SecondaryTable数组,指定每个从表的属性。

@Table(name = "CUSTOMER"
@SecondaryTables( value 
= ...
@SecondaryTable(name 
= "CUST_NAME", pkJoin = ...{ @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }), 
@SecondaryTable(name 
= "CUST_ADDRESS", pkJoin = ...{ @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }) }

public class Customer ...{} 


UniqueConstraint
UniqueConstraint定义在Table或SecondaryTable元数据里,用来指定建表时需要建唯一约束的列。
元数据属性说明:
columnNames:定义一个字符串数组,指定要建唯一约束的列名。

@Entity 
@Table(name
="EMPLOYEE"
uniqueConstraints
=...{@UniqueConstraint(columnNames=...{"EMP_ID""EMP_NAME"})} 

public class Employee ...{ ... } 


Column
Column元数据定义了映射到数据库的列的所有属性:列名,是否唯一,是否允许为空,是否允许更新等。
元数据属性说明:
name:列名。
unique: 是否唯一
nullable: 是否允许为空
insertable: 是否允许插入
updatable: 是否允许更新
columnDefinition: 定义建表时创建此列的DDL
secondaryTable: 从表名。如果此列不建在主表上(默认建在主表),该属性定义该列所在从表的名字。

public class Person ...
@Column(name 
= "PERSONNAME", unique = true, nullable = false, updatable = true
private String name; 
@Column(name 
= "PHOTO", columnDefinition = "BLOB NOT NULL", secondaryTable="PER_PHOTO"
private byte[] picture; 


JoinColumn
如果在entity class的field上定义了关系(one2one或one2many等),我们通过JoinColumn来定义关系的属性。JoinColumn的大部分属性和Column类似。
元数据属性说明:
name:列名。
referencedColumnName:该列指向列的列名(建表时该列作为外键列指向关系另一端的指定列)
unique: 是否唯一
nullable: 是否允许为空
insertable: 是否允许插入
updatable: 是否允许更新
columnDefinition: 定义建表时创建此列的DDL
secondaryTable: 从表名。如果此列不建在主表上(默认建在主表),该属性定义该列所在从表的名字。
下面的代码说明Custom和Order是一对一关系。在Order对应的映射表建一个名为CUST_ID的列,该列作为外键指向Custom对应表中名为ID的列。

public class Custom ...

@OneToOne 
@JoinColumn( 
name
="CUST_ID", referencedColumnName="ID", unique=true, nullable=true, updatable=true
public Order getOrder() ...
return order; 
}
 


JoinColumns
如果在entity class的field上定义了关系(one2one或one2many等),并且关系存在多个JoinColumn,用JoinColumns定义多个JoinColumn的属性。
元数据属性说明:
value: 定义JoinColumn数组,指定每个JoinColumn的属性。
下面的代码说明Custom和Order是一对一关系。在Order对应的映射表建两列,一列名为CUST_ID,该列作为外键指向Custom对应表中名为ID的列,另一列名为CUST_NAME,该列作为外键指向Custom对应表中名为NAME的列。

public class Custom ...
@OneToOne 
@JoinColumns(
...
@JoinColumn(name
="CUST_ID", referencedColumnName="ID"), 
@JoinColumn(name
="CUST_NAME", referencedColumnName="NAME"
}

public Order getOrder() ...
return order; 
}
 


Id
声明当前field为映射表中的主键列。id值的获取方式有五种:TABLE, SEQUENCE, IDENTITY, AUTO, NONE。Oracle和DB2支持SEQUENCE,SQL Server和Sybase支持IDENTITY,mysql支持AUTO。所有的数据库都可以指定为AUTO,我们会根据不同数据库做转换。NONE(默认)需要用户自己指定Id的值。元数据属性说明:
generate():主键值的获取类型
generator():TableGenerator的名字(当generate=GeneratorType.TABLE才需要指定该属性)
下面的代码声明Task的主键列id是自动增长的。(Oracle和DB2从默认的SEQUENCE取值,SQL Server和Sybase该列建成IDENTITY,mysql该列建成auto increment。)

@Entity 
@Table(name 
= "OTASK"
public class Task ...
@Id(generate 
= GeneratorType.AUTO) 
public Integer getId() ...
return id; 
}
 
}
 


IdClass
当entity class使用复合主键时,需要定义一个类作为id class。id class必须符合以下要求:类必须声明为public,并提供一个声明为public的空构造函数。必须实现Serializable接,覆写equals()和hashCode()方法。entity class的所有id field在id class都要定义,且类型一样。
元数据属性说明:
value: id class的类名

public class EmployeePK implements java.io.Serializable...
String empName; 
Integer empAge; 
public EmployeePK()...{} 
public boolean equals(Object obj)...{ ......} 
public int hashCode()...{......} 
}
 
@IdClass(value
=com.acme.EmployeePK.class
@Entity(access
=FIELD) 
public class Employee ...
@Id String empName; 
@Id Integer empAge; 
}
 



MapKey
在一对多,多对多关系中,我们可以用Map来保存集合对象。默认用主键值做key,如果使用复合主键,则用id class的实例做key,如果指定了name属性,就用指定的field的值做key。
元数据属性说明:
name: 用来做key的field名字
下面的代码说明Person和Book之间是一对多关系。Person的books字段是Map类型,用Book的isbn字段的值作为Map的key。

@Table(name = "PERSON"
public class Person ...
@OneToMany(targetEntity 
= Book.class, cascade = CascadeType.ALL, mappedBy = "person"
@MapKey(name 
= "isbn"
private Map books = new HashMap(); 
}
 


OrderBy
在一对多,多对多关系中,有时我们希望从数据库加载出来的集合对象是按一定方式排序的,这可以通过OrderBy来实现,默认是按对象的主键升序排列。
元数据属性说明:
value: 字符串类型,指定排序方式。格式为"fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],......",排序类型可以不指定,默认是ASC。
下面的代码说明Person和Book之间是一对多关系。集合books按照Book的isbn升序,name降序排列。

@Table(name = "MAPKEY_PERSON"
public class Person ...
@OneToMany(targetEntity 
= Book.class, cascade = CascadeType.ALL, mappedBy = "person"
@OrderBy(name 
= "isbn ASC, name DESC"
private List books = new ArrayList(); 
}
 


PrimaryKeyJoinColumn
在三种情况下会用到PrimaryKeyJoinColumn。
继承。
entity class映射到一个或多个从表。从表根据主表的主键列(列名为referencedColumnName值的列),建立一个类型一样的主键列,列名由name属性定义。
one2one关系,关系维护端的主键作为外键指向关系被维护端的主键,不再新建一个外键列。

元数据属性说明:
name:列名。
referencedColumnName:该列引用列的列名
columnDefinition: 定义建表时创建此列的DDL
下面的代码说明Customer映射到两个表,主表CUSTOMER,从表CUST_DETAIL,从表需要建立主键列CUST_ID,该列和主表的主键列id除了列名不同,其他定义一样。

@Entity 
@Table(name
="CUSTOMER"
@SecondaryTable(name
="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID",referencedColumnName="id")) 
public class Customer ...
@Id(generate 
= GeneratorType.AUTO) 
public Integer getId() ...
return id; 
}
 
}
 


下面的代码说明Employee和EmployeeInfo是一对一关系,Employee的主键列id作为外键指向EmployeeInfo的主键列INFO_ID。

@Table(name = "Employee"
public class Employee ...
@OneToOne 
@PrimaryKeyJoinColumn(name 
= "id", referencedColumnName="INFO_ID"
EmployeeInfo info; 
}
 


PrimaryKeyJoinColumns
如果entity class使用了复合主键,指定单个PrimaryKeyJoinColumn不能满足要求时,可以用PrimaryKeyJoinColumns来定义多个PrimaryKeyJoinColumn。
元数据属性说明:
value: 一个PrimaryKeyJoinColumn数组,包含所有PrimaryKeyJoinColumn。
下面的代码说明了Employee和EmployeeInfo是一对一关系。他们都使用复合主键,建表时需要在Employee表建立一个外键,从Employee的主键列id,name指向EmployeeInfo的主键列INFO_ID和INFO_NAME.

@Entity 
@IdClass(EmpPK.
class
@Table(name 
= "EMPLOYEE"
public class Employee ...
private int id; 
private String name; 
private String address; 
@OneToOne(cascade 
= CascadeType.ALL) 
@PrimaryKeyJoinColumns(
...
@PrimaryKeyJoinColumn(name
="id", referencedColumnName="INFO_ID"), 
@PrimaryKeyJoinColumn(name
="name" , referencedColumnName="INFO_NAME")}

EmployeeInfo info; 
}
 
@Entity 
@IdClass(EmpPK.
class
@Table(name 
= "EMPLOYEE_INFO"
public class EmployeeInfo ...
@Id 
@Column(name 
= "INFO_ID"
private int id; 
@Id 
@Column(name 
= "INFO_NAME"
private String name; 
}
 

Transient
Transient用来注释entity的属性,指定的这些属性不会被持久化,也不会为这些属性建表。

@Transient 
private String name; 

  
Version
Version指定实体类在乐观事务中的version属性。在实体类重新由EntityManager管理并且加入到乐观事务中时,保证完整性。每一个类只能有一个属性被指定为version,version属性应该映射到实体类的主表上。
下面的代码说明versionNum属性作为这个类的version,映射到数据库中主表的列名是OPTLOCK。

@Version 
@Column(
"OPTLOCK"
protected int getVersionNum() ...return versionNum; } 


Lob
Lob指定一个属性作为数据库支持的大对象类型在数据库中存储。使用LobType这个枚举来定义Lob是二进制类型还是字符类型。
LobType枚举类型说明:
BLOB 二进制大对象,Byte[]或者Serializable的类型可以指定为BLOB。
CLOB 字符型大对象,char[]、Character[]或String类型可以指定为CLOB。
元数据属性说明:
fetch: 定义这个字段是lazy loaded还是eagerly fetched。数据类型是FetchType枚举,默认为LAZY,即lazy loaded.
type: 定义这个字段在数据库中的JDBC数据类型。数据类型是LobType枚举,默认为BLOB。
下面的代码定义了一个BLOB类型的属性和一个CLOB类型的属性。

@Lob 
@Column(name
="PHOTO" columnDefinition="BLOB NOT NULL"
protected JPEGImage picture; 

@Lob(fetch
=EAGER, type=CLOB) 
@Column(name
="REPORT"
protected String report; 


JoinTable
JoinTable在many-to-many关系的所有者一边定义。如果没有定义JoinTable,使用JoinTable的默认值。
元数据属性说明:
table:这个join table的Table定义。
joinColumns:定义指向所有者主表的外键列,数据类型是JoinColumn数组。
inverseJoinColumns:定义指向非所有者主表的外键列,数据类型是JoinColumn数组。
下面的代码定义了一个连接表CUST和PHONE的join table。join table的表名是CUST_PHONE,包含两个外键,一个外键是CUST_ID,指向表CUST的主键ID,另一个外键是PHONE_ID,指向表PHONE的主键ID。

@JoinTable( 
table
=@Table(name=CUST_PHONE), 
joinColumns
=@JoinColumn(name="CUST_ID", referencedColumnName="ID"), 
inverseJoinColumns
=@JoinColumn(name="PHONE_ID"c
分享到:
评论

相关推荐

Global site tag (gtag.js) - Google Analytics