JPA注释标记表

JPA注释标记一览表  Table/ r4 E' R) ?( J% M/ G Table用来定义entity主表的name，catalog，schema等属性。  元数据属性说明： 0 \+ j& Y1 v9 E+ c) P( } 8 N! a2 x8 W( U+ L1 r name: 表名 " H  Y# a! D2 E5 L7 [$ r catalog: 对应关系数据库中的catalog 6 y! z8 _: h& F, U schema：对应关系数据库中的schema  UniqueConstraints:定义一个UniqueConstraint数组，指定需要建唯一约束的列 9 A% p% L0 i0 P9 G5 `, T, E      @Entity4 R& }" W4 Y6 x5 @ @Table(name="CUST") public class Customer { ... } 　　6 o$ N4 t9 o" M1 }3 H SecondaryTable 一个entity class可以映射到多表，SecondaryTable用来定义单个从表的名字，主键名字等属性。   Q. l  t! ^8 q+ T; G6 X 元数据属性说明：  name: 表名  catalog: 对应关系数据库中的catalog % B* |5 N8 W2 c! ~8 ]9 [" r schema：对应关系数据库中的schema . c3 ~$ d2 d! e/ v  U8 l" u& j pkJoin: 定义一个PrimaryKeyJoinColumn数组，指定从表的主键列   ?) R2 u7 T& X1 |1 ~! Z UniqueConstraints:定义一个UniqueConstraint数组，指定需要建唯一约束的列  下面的代码说明Customer类映射到两个表，主表名是CUSTOMER，从表名是CUST_DETAIL，从表的主键列和主表的主键列类型相同，列名为CUST_ID。                   @Entity @Table(name="CUSTOMER") @SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"))' p9 Z' s. X9 p public class Customer { ... } SecondaryTables9 i" U) f% J0 n/ ~0 p5 E 当一个entity class映射到一个主表和多个从表时，用SecondaryTables来定义各个从表的属性。 $ X7 q, _+ R  e9 P% z9 G2 T4 \ 元数据属性说明：   R, L6 f8 g$ L$ A* b5 T) R  b + A- j) P& Q  g: Q" Y+ r% p value： 定义一个SecondaryTable数组，指定每个从表的属性。 6 n3 z6 y2 U$ B! O. o' I                 5 V& T5 D% d; Y8 N' V. C @Table(name = "CUSTOMER"); [8 M+ v6 Z/ n* m* ]( G6 { @SecondaryTables( value = {" W% S" |+ {, J$ f/ R& U @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 {} ' Q8 V+ K: ^/ {4 | UniqueConstraint) Y: }) C& n% \/ \' I UniqueConstraint定义在Table或SecondaryTable元数据里，用来指定建表时需要建唯一约束的列。  元数据属性说明：  2 x+ B0 ]7 J) ?, F$ e columnNames:定义一个字符串数组，指定要建唯一约束的列名。 + H( r; \$ m3 Q                 # _; u/ h% D  f/ A @Entity @Table(name="EMPLOYEE", uniqueConstraints={@UniqueConstraint(columnNames={"EMP_ID", "EMP_NAME"})}/ U4 n: f8 N: c/ ~ )! e* e1 a9 k9 j/ R public class Employee { ... } Column* ~$ l/ q3 r' K! O0 ]4 m: n Column元数据定义了映射到数据库的列的所有属性：列名，是否唯一，是否允许为空，是否允许更新等。  % \; m2 |7 `# I$ J- W/ C# X% o) j  ^- f3 Y 元数据属性说明：  ' p& b' \3 l% e4 z/ f# W: {. j+ @ name:列名。  unique: 是否唯一  nullable: 是否允许为空  insertable: 是否允许插入 # n) L2 i4 j) }. ? updatable: 是否允许更新  columnDefinition: 定义建表时创建此列的DDL # s* W  H2 S7 [ secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。 : i4 e0 V0 T: ~4 R         / ^+ g9 w0 M9 v/ q/ H 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;- C; o6 E1 L/ b JoinColumn% t: V6 V, X4 G+ K 如果在entity class的field上定义了关系（one2one或one2many等），我们通过JoinColumn来定义关系的属性。JoinColumn的大部分属性和Column类似。 + G% |4 @, g/ ^8 O 元数据属性说明：  name:列名。  referencedColumnName:该列指向列的列名（建表时该列作为外键列指向关系另一端的指定列）  unique: 是否唯一  nullable: 是否允许为空 . e- I/ ^3 ]$ o) \3 Z  F insertable: 是否允许插入  updatable: 是否允许更新   \7 C5 [& b# a# M columnDefinition: 定义建表时创建此列的DDL  secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。 0 x5 [" m2 M; N  x* n- ^" F; x0 s 下面的代码说明Custom和Order是一对一关系。在Order对应的映射表建一个名为CUST_ID的列，该列作为外键指向Custom对应表中名为ID的列。 * i; f7 `% I9 A8 u. _  u' |                  public class Custom { ( i/ N3 H9 m6 Q/ L2 W; ? @OneToOne @JoinColumn( name="CUST_ID", referencedColumnName="ID", unique=true, nullable=true, updatable=true) public Order getOrder() {. J( Y6 r9 |  ?0 ]4 G return order;' G7 c( [( P- f6 i( R: @/ @8 ^  B9 J }4 c) Q8 G$ \1 O; j2 C/ W6 F# f; p - {, f; x, u7 P4 @4 ?8 b , o/ \2 g7 A4 [, j JoinColumns 如果在entity class的field上定义了关系（one2one或one2many等），并且关系存在多个JoinColumn，用JoinColumns定义多个JoinColumn的属性。 % c) p$ Y+ i! q+ a: [; B 9 ~1 P7 P1 q" H2 L 元数据属性说明：  + h6 }$ G' |' ~& D value: 定义JoinColumn数组，指定每个JoinColumn的属性。  下面的代码说明Custom和Order是一对一关系。在Order对应的映射表建两列，一列名为CUST_ID，该列作为外键指向Custom对应表中名为ID的列,另一列名为CUST_NAME，该列作为外键指向Custom对应表中名为NAME的列。) v2 Y5 j- M& |6 e+ K& A( Q                 0 i1 k5 @8 u* ~3 G# [ public class Custom { @OneToOne) Y0 |$ I' k6 Y2 ]" ^) k0 `" n @JoinColumns({% B, ]4 A! t9 n" i* V* i% g @JoinColumn(name="CUST_ID", referencedColumnName="ID"), @JoinColumn(name="CUST_NAME", referencedColumnName="NAME")% @, u. T% ~0 V; ]" Q })* }% t& G% `0 n6 ^( U& y public Order getOrder() {" W5 a4 Y6 a8 z- l2 x  Y return order;6 u' X6 u9 Y( a0 R, J0 t7 @ }, o2 P/ y5 Z2 l Id 声明当前field为映射表中的主键列。id值的获取方式有五种：TABLE, SEQUENCE, IDENTITY, AUTO, NONE。Oracle和DB2支持SEQUENCE，SQL Server和Sybase支持IDENTITY,mysql支持AUTO。所有的数据库都可以指定为AUTO，我们会根据不同数据库做转换。NONE (默认)需要用户自己指定Id的值。元数据属性说明：  ' f7 Y3 _: Y8 q& q# _ generate():主键值的获取类型  generator():TableGenerator的名字（当generate=GeneratorType.TABLE才需要指定该属性） 6 p. V2 X7 J" }6 `) } 下面的代码声明Task的主键列id是自动增长的。(Oracle和DB2从默认的SEQUENCE取值，SQL Server和Sybase该列建成IDENTITY，mysql该列建成auto increment。)  0 }* J: u) G2 U8 G( {! \                  @Entity# v6 E/ l- u' e1 E @Table(name = "OTASK") public class Task { @Id(generate = GeneratorType.AUTO) public Integer getId() { return id;  g( f, ~" M' w$ e9 j6 ?3 z  f } }) d& [4 }( z$ O% q9 a , c5 [+ {) `2 u3 i5 [ * L  D: S7 ]6 U IdClass 当entity class使用复合主键时，需要定义一个类作为id class。id class必须符合以下要求:类必须声明为public，并提供一个声明为public的空构造函数。必须实现Serializable接，覆写 equals()和hashCode（）方法。entity class的所有id field在id class都要定义，且类型一样。  元数据属性说明：  3 b4 f5 s" @( N2 T value: id class的类名 4 J& D- y9 e, V3 f+ A- e* t    1 p  l5 W; H) z/ h* U& j7 F$ T4 z                 3 W7 F. F5 j1 J7 u0 u6 ~% r public class EmployeePK implements java.io.Serializable{9 Z9 \+ A' Q) Z* a9 k8 ~ String empName; Integer empAge; ! e- I9 P, ?7 d3 b public EmployeePK(){}5 a, y2 c4 F* p! }! T' y9 i8 S public boolean equals(Object obj){ ......}! e9 W( ]; L0 U( v" ~ public int hashCode(){......} }  @% T4 h$ P8 G( V4 h$ q- l @IdClass(value=com.acme.EmployeePK.class) @Entity(access=FIELD) public class Employee { @Id String empName;( w1 {$ r- b/ H2 J2 L. s; @ @Id Integer empAge; } ( Z& C  w4 I9 `5 n% Y" ?0 J) H5 U MapKey 在一对多，多对多关系中，我们可以用Map来保存集合对象。默认用主键值做key，如果使用复合主键，则用id class的实例做key，如果指定了name属性，就用指定的field的值做key。  元数据属性说明： / G) {9 ^; D5 R name: 用来做key的field名字  下面的代码说明Person和Book之间是一对多关系。Person的books字段是Map类型，用Book的isbn字段的值作为Map的key。                  9 C, p2 M3 T8 y* N- ?* m" {3 G3 Q @Table(name = "PERSON")9 U( }4 G$ w) k7 T3 Q public class Person { @OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person"): `% u# x1 R2 o: O: ] @MapKey(name = "isbn") private Map books = new HashMap();9 F0 L- B1 g1 F. c } ! V' `9 i, ~, T0 B9 r7 C6 w7 u OrderBy 在一对多，多对多关系中，有时我们希望从数据库加载出来的集合对象是按一定方式排序的，这可以通过OrderBy来实现，默认是按对象的主键升序排列。  元数据属性说明：  . i; E, q2 L$ W& n3 |; x1 } value: 字符串类型，指定排序方式。格式为"fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],......",排序类型可以不指定，默认是ASC。 2 b7 w9 g+ @. l1 ^ 下面的代码说明Person和Book之间是一对多关系。集合books按照Book的isbn升序，name降序排列。                   @Table(name = "MAPKEY_PERSON")0 i# P8 v4 U) }1 M' s7 a* I$ \# ] public class Person { ' [/ G- d* Q2 ]  w' e' c @OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")  [/ \/ m0 D+ u, a' ]1 ]' q @OrderBy(name = "isbn ASC, name DESC") private List books = new ArrayList();8 |: s3 W' o6 E" y/ h- p; v }* F8 t. E* R- Y0 U6 [ # Y" C! G6 y- h0 f6 ^ " F' L( a- g2 f, e* N PrimaryKeyJoinColumn. w* [3 U4 X- _# l4 ?7 h- L 在三种情况下会用到PrimaryKeyJoinColumn。  ; X" g2 w+ I0 Y3 o- C* H 继承。  entity class映射到一个或多个从表。从表根据主表的主键列（列名为referencedColumnName值的列），建立一个类型一样的主键列，列名由name属性定义。  one2one关系，关系维护端的主键作为外键指向关系被维护端的主键，不再新建一个外键列。    5 B+ B8 S  }' Q& s: @ 4 w* Z4 G/ \! C" q/ A, G8 K 元数据属性说明： 0 b8 O) m: d! Z 7 a  @% {" U" z* f- x; x name:列名。  referencedColumnName:该列引用列的列名  columnDefinition: 定义建表时创建此列的DDL  下面的代码说明Customer映射到两个表，主表CUSTOMER,从表CUST_DETAIL，从表需要建立主键列CUST_ID，该列和主表的主键列id除了列名不同，其他定义一样。 7 }/ E8 J! @4 j7 A             3 d, l) M- T7 G/ l' [5 z @Entity/ j+ m& O3 l6 @  k( S( t @Table(name="CUSTOMER")' c" |+ A# s& F8 h* w2 ]3 u: ^8 s @SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"，referencedColumnName="id")) public class Customer { - a/ S2 S0 r% ~) u3 i$ J2 ^- f9 d @Id(generate = GeneratorType.AUTO) public Integer getId() { return id;& `5 Z- K" X$ {) p( @ }( p% T4 j# p3 n' n& V }7 \; K: R1 r: o# w' j 下面的代码说明Employee和EmployeeInfo是一对一关系，Employee的主键列id作为外键指向EmployeeInfo的主键列INFO_ID。               @Table(name = "Employee") public class Employee {( ]  K; v; J- J7 H @OneToOne @PrimaryKeyJoinColumn(name = "id", referencedColumnName="INFO_ID"), f3 R0 U( f3 G4 O5 W: { EmployeeInfo info;; ^4 x8 u: S$ j2 T9 } } ! `( A0 c6 Z1 l PrimaryKeyJoinColumns3 @( g- |' o" m& u& s; g' V 如果entity class使用了复合主键，指定单个PrimaryKeyJoinColumn不能满足要求时，可以用PrimaryKeyJoinColumns来定义多个PrimaryKeyJoinColumn。  - w4 m6 w. Z- { 元数据属性说明：  ) ~: |0 ^; G) C2 b6 b+ e' Z) D+ l value: 一个PrimaryKeyJoinColumn数组，包含所有PrimaryKeyJoinColumn。   F; Q8 K3 }9 m 下面的代码说明了Employee和EmployeeInfo是一对一关系。他们都使用复合主键，建表时需要在Employee表建立一个外键，从Employee的主键列id,name指向EmployeeInfo的主键列INFO_ID和INFO_NAME. * x( C0 d- z0 @9 @- i; q              @Entity @IdClass(EmpPK.class)7 x" O0 p% Y; g- v6 S5 P' ~ @Table(name = "EMPLOYEE") public class Employee {: x! e6 _3 \! o# m/ I$ Y " ], m( V8 b# q* R1 O. V private int id;; c1 Z. x1 z" L! P- h, C( h: u 5 {% d2 l- y* X" I" d3 W' H private String name;! m+ V( L5 R, y$ E" d- I private String address; @OneToOne(cascade = CascadeType.ALL) @PrimaryKeyJoinColumns({ @PrimaryKeyJoinColumn(name="id", referencedColumnName="INFO_ID"),: ^7 S) R9 s1 f  }/ M @PrimaryKeyJoinColumn(name="name" , referencedColumnName="INFO_NAME")})0 s8 I# j4 c8 l* y0 v8 I( |/ b6 x  v EmployeeInfo info;. Z" _% R$ S# z7 J0 C" W$ }5 [+ Q }$ w% U& S  E$ g& X( U" _, e* @ @Entity @IdClass(EmpPK.class) @Table(name = "EMPLOYEE_INFO") public class EmployeeInfo { @Id, f+ p5 ]* i3 G$ U$ q4 C  v @Column(name = "INFO_ID"), R  S( l% y$ {9 }& _. a7 G private int id; / T7 f! p# x+ T% }; s7 m @Id @Column(name = "INFO_NAME")9 H4 \( {/ ^0 U; z private String name; }) z# ]5 _: P6 H( d; R) {5 q+ M ) j8 R7 Y3 \2 n( P$ `5 r6 k- | $ c7 Y- ]: _: X5 q; M  I Transient Transient用来注释entity的属性，指定的这些属性不会被持久化，也不会为这些属性建表。  3 c: }. U' i6 Q      @Transient7 p8 s' ?; x/ i private String name; Version. A* h% P* z# B' C2 u Version指定实体类在乐观事务中的version属性。在实体类重新由EntityManager管理并且加入到乐观事务中时，保证完整性。每一个类只能有一个属性被指定为version，version属性应该映射到实体类的主表上。 ( O! I" @" K9 o2 Q/ K 3 R/ d6 @: v! ?0 ^% L 下面的代码说明versionNum属性作为这个类的version，映射到数据库中主表的列名是OPTLOCK。  " m! M/ d" P) H: k2 B0 B3 y                  @Version. K8 ?6 t0 c. ~9 t; C  T' w @Column("OPTLOCK") protected int getVersionNum() { return versionNum; } ; T( |5 ?! Q5 e5 @ , ^% q0 v4 s9 i7 o/ S2 ? Lob Lob指定一个属性作为数据库支持的大对象类型在数据库中存储。使用LobType这个枚举来定义Lob是二进制类型还是字符类型。  ; l" K4 v# E2 G# E LobType枚举类型说明：  6 M2 w. B! [5 U$ a* z3 _ BLOB 二进制大对象，Byte[]或者Serializable的类型可以指定为BLOB。  CLOB 字符型大对象，char[]、Character[]或String类型可以指定为CLOB。  元数据属性说明：  fetch： 定义这个字段是lazy loaded还是eagerly fetched。数据类型是FetchType枚举，默认为LAZY,即lazy loaded. + X0 `: R- r. Z& } type： 定义这个字段在数据库中的JDBC数据类型。数据类型是LobType枚举，默认为BLOB。  下面的代码定义了一个BLOB类型的属性和一个CLOB类型的属性。  ; [! W! T$ [1 l: w6 ^# z) c$ i                  @Lob/ G% X7 c: L7 y5 n/ V @Column(name="PHOTO" columnDefinition="BLOB NOT NULL") protected JPEGImage picture; ' @# T! [7 w) A* b  S @Lob(fetch=EAGER, type=CLOB)* J$ R+ u' [' z: p: F @Column(name="REPORT")! V/ q" `: k# \, Z# h# W' Y protected String report; : w: _" o" ?2 e JoinTable8 d9 a3 y  Z7 x% |- z JoinTable在many-to-many关系的所有者一边定义。如果没有定义JoinTable，使用JoinTable的默认值。  元数据属性说明： 8 v7 o- I+ g" ~% K" P" i, f7 U table:这个join table的Table定义。  joinColumns:定义指向所有者主表的外键列，数据类型是JoinColumn数组。 " I0 L% `% W$ h- r8 F" |$ ~ inverseJoinColumns:定义指向非所有者主表的外键列，数据类型是JoinColumn数组。  下面的代码定义了一个连接表CUST和PHONE的join table。join table的表名是CUST_PHONE，包含两个外键，一个外键是CUST_ID，指向表CUST的主键ID，另一个外键是PHONE_ID，指向表PHONE的主键ID。 * T/ k# c. V1 E0 B2 F( Q                  @JoinTable(* S. I+ D6 t6 I% l' j table=@Table(name=CUST_PHONE)," R4 N0 B: m: E3 }; F1 E joinColumns=@JoinColumn(name="CUST_ID", referencedColumnName="ID"), inverseJoinColumns=@JoinColumn(name="PHONE_ID", referencedColumnName="ID") )1 x7 [$ T4 _9 r; O3 h4 K 4 [+ M- i5 s6 b$ K 2 E; i* a8 H( P& X, K TableGenerator TableGenerator定义一个主键值生成器，在Id这个元数据的generate＝TABLE时，generator属性中可以使用生成器的名字。生成器可以在类、方法或者属性上定义。  + r- J4 |6 ~9 _+ z  P! M 生成器是为多个实体类提供连续的ID值的表，每一行为一个类提供ID值，ID值通常是整数。 3 L. U1 X7 q- M0 r+ a: h9 `  L 元数据属性说明： ( q: d) z' t+ m # G' k: p& x9 h9 K4 U name:生成器的唯一名字，可以被Id元数据使用。 ; C2 ]  g6 M3 O$ R) q0 r9 e table:生成器用来存储id值的Table定义。  pkColumnName:生成器表的主键名称。  valueColumnName:生成器表的ID值的列名称。  pkColumnValue:生成器表中的一行数据的主键值。 & L4 ~3 o9 |' h- v. }4 C" l initialValue:id值的初始值。 ( c1 m3 ^5 X3 ?: K; ~  _# t$ v8 ?' E4 m allocationSize:id值的增量。  下面的代码定义了两个生成器empGen和addressGen，生成器的表是ID_GEN。                  ) c: a% M: V# W @Entity public class Employee { ...2 f) D: t5 ^! u$ Y& C9 { @TableGenerator(name="empGen", table=@Table(name="ID_GEN"),5 \  d/ w* m+ S: t9 B pkColumnName="GEN_KEY",) k/ |/ W2 `! V1 { valueColumnName="GEN_VALUE",' u8 u& [. B/ m2 F! `0 e0 c pkColumnValue="EMP_ID",, ^: d+ q8 K' h* ]% v allocationSize=1) @Id(generate=TABLE, generator="empGen")9 k% @9 m6 W# Q$ b5 u, v public int id;/ }$ r7 x5 Q0 m7 m# u  S: A ... } @Entity public class Address {+ a7 d6 w; ~2 ~( v2 C% O9 u ...9 Q% m$ ?$ I! \8 p @TableGenerator(name="addressGen", table=@Table(name="ID_GEN"), pkColumnValue="ADDR_ID")* t/ ~4 I9 Q3 J! ~2 _- G @Id(generate=TABLE, generator="addressGen") public int id; ...) n: N* L0 B1 B0 k# Z }7 W  u6 R" z3 C2 W! h! t 6 @! a/ I* b8 N; E3 P9 J SequenceGenerator# f/ [2 v0 I* K% v8 p SequenceGenerator定义一个主键值生成器，在Id这个元数据的generator属性中可以使用生成器的名字。生成器可以在类、方法或者属性上定义。生成器是数据库支持的sequence对象。 2 W7 ]0 C+ [. t! I3 K/ E2 D 元数据属性说明： " w4 h$ @# n5 x. y2 r3 f6 K name:生成器的唯一名字，可以被Id元数据使用。  sequenceName:数据库中，sequence对象的名称。如果不指定，会使用提供商指定的默认名称。  initialValue:id值的初始值。  allocationSize:id值的增量。   b  M! M9 e% {! K 下面的代码定义了一个使用提供商默认名称的sequence生成器。    J" d7 E) @2 P, N                 0 T$ ~: U* ]1 [( ] @SequenceGenerator(name="EMP_SEQ", allocationSize=25)        + f- Q' K' h! Q+ o DiscriminatorColumn DiscriminatorColumn定义在使用SINGLE_TABLE或JOINED继承策略的表中区别不继承层次的列。  " I) b7 j4 a1 ~: R1 a  f 元数据属性说明： * L5 M& x: Y" a- |. q) [ name:column的名字。默认值为TYPE。 # Q4 S$ J. }3 ~! i8 I0 i columnDefinition:生成DDL的sql片断。  length:String类型的column的长度，其他类型使用默认值10。  下面的代码定义了一个列名为DISC，长度为20的String类型的区别列。 3 X! i+ Q  b& x6 N                 / j2 j. e7 S1 Q& W! l @Entity @Table(name="CUST")2 ?+ b/ ?/ e9 t  e% V# O9 W. ]% p @Inheritance(strategy=SINGLE_TABLE,' S7 U) m+ B: _4 Q$ i5 n9 L' J discriminatorType=STRING, discriminatorValue="CUSTOMER") @DiscriminatorColumn(name="DISC", length=20)7 Q; _/ R) D' [: g6 I public class Customer { ... }