JPA註解介紹

1. @Entity(name=”EntityName”)

必須,name爲可選,對應數據庫中一的個表

@Entity //標識這個pojo是一個jpa實體     
public class Users implements Serializable {     
} 

2. @Table(name=”“,catalog=”“,schema=”“)

可選,通常和@Entity配合使用,只能標註在實體的class定義處,表示實體對應的數據庫表的信息

name:可選,表示表的名稱.默認地,表名和實體名稱一致,只有在不一致的情況下才需要指定表名

catalog:可選,表示Catalog名稱,默認爲Catalog(“”).

schema:可選,表示Schema名稱,默認爲Schema(“”).

@Entity     
@Table(name = "users") //指定表名爲users     
public class Users implements Serializable {     
}  

3. @id

必須,@id定義了映射到數據庫表的主鍵的屬性,一個實體只能有一個屬性被映射爲主鍵.置於getXxxx()前.

public class Users implements Serializable {     
@Id     
private String userCode;  

4. @GeneratedValue(strategy=GenerationType,generator=”“)

可選

strategy:表示主鍵生成策略,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4種,分別表示讓ORM框架自動選擇,

根據數據庫的Identity字段生成,根據數據庫表的Sequence字段生成,以有根據一個額外的表生成主鍵,默認爲AUTO

generator:表示主鍵生成器的名稱,這個屬性通常和ORM框架相關,例如,Hibernate可以指定uuid等主鍵生成方式.

public class Users implements Serializable {     
@Id     
@GeneratedValue(strategy=GenerationType.IDENTITY)//主鍵自增，注意，這種方式依賴於具體的數據庫，如果數據庫不支持自增主鍵，那麼這個類型是沒法用的     
@Column(name = "user_id", nullable = false)     
private int userId;     
}

public class Users implements Serializable {     
@Id     
@GeneratedValue(strategy=GenerationType.TABLE)//通過一個表來實現主鍵id的自增，這種方式不依賴於具體的數據庫，可以解決數據遷移的問題     
@Column(name = "user_code", nullable = false)     
private String userCode;     
}  

public class Users implements Serializable {     
@Id     
@GeneratedValue(strategy=GenerationType.SEQUENCE)//通過Sequence來實現表主鍵自增，這種方式依賴於數據庫是否有SEQUENCE，如果沒有就不能用     
@SequenceGenerator(name="seq_user")     
@Column(name = "user_id", nullable = false)     
private int userId;    
}

5. @Basic(fetch=FetchType,optional=true)

可選

@Basic表示一個簡單的屬性到數據庫表的字段的映射,對於沒有任何標註的getXxxx()方法,默認即爲@Basic

fetch: 表示該屬性的讀取策略,有EAGER和LAZY兩種,分別表示主支抓取和延遲加載,默認爲EAGER.

optional:表示該屬性是否允許爲null,默認爲true

@Basic(optional=false) 
public String getAddress() { 
  return address; 
} 

6. @Column

可選

@Column描述了數據庫表中該字段的詳細定義,這對於根據JPA註解生成數據庫表結構的工具非常有作用.

name:表示數據庫表中該字段的名稱,默認情形屬性名稱一致

nullable:表示該字段是否允許爲null,默認爲true

unique:表示該字段是否是唯一標識,默認爲false

length:表示該字段的大小,僅對String類型的字段有效

insertable:表示在ORM框架執行插入操作時,該字段是否應出現INSETRT語句中,默認爲true

updateable:表示在ORM框架執行更新操作時,該字段是否應該出現在UPDATE語句中,默認爲true.對於一經創建就不可以更改的字段,該屬性非常有用,如對於birthday字段.

columnDefinition:表示該字段在數據庫中的實際類型.通常ORM框架可以根據屬性類型自動判斷數據庫中字段的類型,但是對於Date類型仍無法確定數據庫中字段類型究竟是DATE,TIME還是TIMESTAMP.此外,String的默認映射類型爲VARCHAR,如果要將String類型映射到特定數據庫的BLOB或TEXT字段類型,該屬性非常有用.

@Column(name = "user_code", nullable = false, length=32)//設置屬性userCode對應的字段爲user_code，長度爲32，非空     
private String userCode;     
@Column(name = "user_wages", nullable = true, precision=12, scale=2)//設置屬性wages對應的字段爲user_wages，12位數字可保留兩位小數，可以爲空     
private double wages;     
@Temporal(TemporalType.DATE)//設置爲時間類型     
private Date joinDate; 

7. @Transient

可選

@Transient表示該屬性並非一個到數據庫表的字段的映射,ORM框架將忽略該屬性.

如果一個屬性並非數據庫表的字段映射,就務必將其標示爲@Transient,否則,ORM框架默認其註解爲@Basic

@Transient     
private int tempValue;     

public int getTempValue(){     
return tempValue;     
}     

public void setTempValue(int value){     
this.tempValue = value;     
}    

8. @ManyToOne(fetch=FetchType,cascade=CascadeType)

可選

@ManyToOne表示一個多對一的映射,該註解標註的屬性通常是數據庫表的外鍵

optional:是否允許該字段爲null,該屬性應該根據數據庫表的外鍵約束來確定,默認爲true

fetch:表示抓取策略,默認爲FetchType.EAGER

cascade:表示默認的級聯操作策略,可以指定爲ALL,PERSIST,MERGE,REFRESH和REMOVE中的若干組合,默認爲無級聯操作

targetEntity:表示該屬性關聯的實體類型.該屬性通常不必指定,ORM框架根據屬性類型自動判斷targetEntity.

9. @OneToMany(fetch=FetchType,cascade=CascadeType)

可選

@OneToMany描述一個一對多的關聯,該屬性應該爲集體類型,在數據庫中並沒有實際字段.

fetch:表示抓取策略,默認爲FetchType.LAZY,因爲關聯的多個對象通常不必從數據庫預先讀取到內存

cascade:表示級聯操作策略,對於OneToMany類型的關聯非常重要,通常該實體更新或刪除時,其關聯的實體也應當被更新或刪除

例如:實體User和Order是OneToMany的關係,則實體User被刪除時,其關聯的實體Order也應該被全部刪除

有T_One和T_Many兩個表，他們是一對多的關係，註解範例如下

// 主Pojo 

@Entity     
@Table(name = "T_ONE")     
public class One implements Serializable {     
private static final long serialVersionUID = 1L;     
@Id     
@Column(name = "ONE_ID", nullable = false)     
private String oneId;     
@Column(name = "DESCRIPTION")     
private String description;     
@OneToMany(cascade = CascadeType.ALL, mappedBy = "oneId")//指向多的那方的pojo的關聯外鍵字段     
private Collection<Many> manyCollection;     


// 子Pojo 
@Entity     
@Table(name = "T_MANY")     
public class Many implements Serializable {     
private static final long serialVersionUID = 1L;     
@Id     
@Column(name = "MANY_ID", nullable = false)     
private String manyId;     
@Column(name = "DESCRIPTION")     
private String description;     

@JoinColumn(name = "ONE_ID", referencedColumnName = "ONE_ID")//設置對應數據表的列名和引用的數據表的列名     
@ManyToOne//設置在“一方”pojo的外鍵字段上     
private One oneId;    

10. @JoinColumn

可選

@JoinColumn和@Column類似,介量描述的不是一個簡單字段,而一一個關聯字段,例如.描述一個@ManyToOne的字段.

name:該字段的名稱.由於@JoinColumn描述的是一個關聯字段,如ManyToOne,則默認的名稱由其關聯的實體決定.

例如,實體Order有一個user屬性來關聯實體User,則Order的user屬性爲一個外鍵,

其默認的名稱爲實體User的名稱+下劃線+實體User的主鍵名稱

11. @OneToOne(fetch=FetchType,cascade=CascadeType)

可選

@OneToOne描述一個一對一的關聯

fetch:表示抓取策略,默認爲FetchType.LAZY

cascade:表示級聯操作策略

// 主Pojo 
@Entity     
@Table(name = "T_ONEA")     
public class OneA implements Serializable {     
private static final long serialVersionUID = 1L;     
@Id     
@Column(name = "ONEA_ID", nullable = false)     
private String oneaId;     
@Column(name = "DESCRIPTION")     
private String description;     
@OneToOne(cascade = CascadeType.ALL, mappedBy = "oneA")//主Pojo這方的設置比較簡單，只要設置好級聯和映射到從Pojo的外鍵就可以了。     
private OneB oneB;    

// 從Pojo 
@Entity     
@Table(name = "T_ONEB")     
public class OneB implements Serializable {     
private static final long serialVersionUID = 1L;     
@Id     
@Column(name = "ONEA_ID", nullable = false)     
private String oneaId;     
@Column(name = "DESCRIPTION")     
private String description;     
@JoinColumn(name = "ONEA_ID", referencedColumnName = "ONEA_ID", insertable = false, updatable = false)//設置從方指向主方的關聯外鍵，這個ONEA_ID其實是表T_ONEA的主鍵     
@OneToOne     
private OneA oneA;     

12. @ManyToMany

可選

@ManyToMany 描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM框架自動處理

targetEntity:表示多對多關聯的另一個實體類的全名,例如:package.Book.class

mappedBy:表示多對多關聯的另一個實體類的對應集合屬性名稱

// 第一個Pojo 
@Entity     
@Table(name = "T_MANYA")     
public class ManyA implements Serializable {     
private static final long serialVersionUID = 1L;     
@Id     
@Column(name = "MANYA_ID", nullable = false)     
private String manyaId;     
@Column(name = "DESCRIPTION")     
private String description;     
@ManyToMany     
@JoinTable(name = "TMANY1_TMANY2", joinColumns = {@JoinColumn(name = "MANYA_ID", referencedColumnName = "MANYA_ID")}, inverseJoinColumns = {@JoinColumn(name = "MANYB_ID", referencedColumnName = "MANYB_ID")})     
private Collection<ManyB> manybIdCollection;     

// 第二個Pojo 
@Entity     
@Table(name = "T_MANYB")     
public class ManyB implements Serializable {     
private static final long serialVersionUID = 1L;     
@Id     
@Column(name = "MANYB_ID", nullable = false)     
private String manybId;     
@Column(name = "DESCRIPTION")     
private String description;     
@ManyToMany(mappedBy = "manybIdCollection")     
private Collection<ManyA> manyaIdCollection;    

兩個實體間相互關聯的屬性必須標記爲@ManyToMany,並相互指定targetEntity屬性, 需要注意的是,有且只有一個實體的@ManyToMany註解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱

利用ORM工具自動生成的表除了T_MANYA和T_MANYB表外,還自動生成了一個TMANY1_TMANY2表,用於實現多對多關聯

13. @MappedSuperclass

可選

@MappedSuperclass可以將超類的JPA註解傳遞給子類,使子類能夠繼承超類的JPA註解

@MappedSuperclass 
public class Employee() { 
   .... 
}  

@Entity 
public class Engineer extends Employee { 
   ..... 
} 

@Entity 
public class Manager extends Employee { 
   ..... 
} 

14. @Embedded

可選

@Embedded將幾個字段組合成一個類,並作爲整個Entity的一個屬性.

例如User包括id,name,city,street,zip屬性.

我們希望city,street,zip屬性映射爲Address對象.這樣,User對象將具有id,name和address這三個屬性.

Address對象必須定義爲@Embededable

@Embeddable 
public class Address {city,street,zip} 

@Entity 
public class User { 
   @Embedded 
   public Address getAddress() { 
       .......... 
   } 
} 

15. @OrderBy

在加載數據的時候可以爲其指定順序，使用@OrderBy註解實現

@Table(name = "USERS")     
public class User {     
    @OrderBy(name = "group_name ASC, name DESC")     
    private List books = new ArrayList();     
}    

16. @Lob

大字段

@Lob //對應Blob字段類型     
@Column(name = "PHOTO")     
private Serializable photo;     
@Lob //對應Clob字段類型     
@Column(name = "DESCRIPTION")     
private String description;    

---

轉載自：http://fenglyn.iteye.com/blog/844304