JPA ElementCollection字符串映射示例

JPA教程 - JPA ElementCollection字符串映射示例

JPA(Java Persistence API)是 Sun 官方提出的 Java 持久化規(guī)范。它為Java開發(fā)人員提供了一種對象/關(guān)系映射工具來管理Java應(yīng)用中的關(guān)系數(shù)據(jù)
JPA規(guī)范要求在類路徑的 META-INF 目錄下放置 persistence.xml
JPA 中將一個類注解成實體類 (entity class) 有兩種不同的注解方式：基于屬性 (property-based) 和基于字段 (field-based) 的注解
基于字段的注解, 就是直接將注解放置在實體類的字段的前面
基于屬性的注解, 就是直接將注解放置在實體類相應(yīng)的getter方法前面(這一點和 Spring 正好相反),但是同一個實體類中必須并且只能使用其中一種注解方式
Entity、Table、Id、GeneratedValue、Basic、Column、Temporal、Transient、Lob、Transient、SecondaryTable、Embeddable、Embedded
JPA注解
(1)Entity
@javax.persistence.Entity(name="xxx") 
name 指定實體Bean的名稱,默認(rèn)值為 bean class 的非限定類名,select o from xxx o where o.id=?1
(2)Table
@javax.persistence.Table(catalog="xx",name="xx",schema="xx",uniqueConstraints={ @UniqueConstraint(columnNames={"xx","xx"})})
name:指定表的名稱
catalog:指定數(shù)據(jù)庫名稱
schema:指定數(shù)據(jù)庫的用戶名
uniqueConstraints:指定唯一性字段約束,如為personid 和name 字段指定唯一性約束
uniqueConstraints={ @UniqueConstraint(columnNames={"personid", "name"})}
(3)Id
@javax.persistence.Id()
映射到數(shù)據(jù)庫表的主鍵的屬性,一個實體只能有一個屬性被映射為主鍵.
(4)GeneratedValue
@javax.persistence.GeneratedValue(generator="xxx",strategy=GenerationType.AUTO)
strategy:表示主鍵生成策略,有 AUTO,INDENTITY,SEQUENCE 和 TABLE 4種
分別表示讓 ORM 框架自動選擇,根據(jù)數(shù)據(jù)庫的Identity字段生成,根據(jù)數(shù)據(jù)庫表的 Sequence 字段生成,以有根據(jù)一個額外的表生成主鍵,默認(rèn)為 AUTO 
generator:表示主鍵生成器的名稱,這個屬性通常和 ORM 框架相關(guān),例如,Hibernate 可以指定 uuid 等主鍵生成方式. 
Hibernate UUID
@Id @GeneratedValue(generator="system-uuid")
@GenericGenerator(name="system-uuid",strategy = "uuid")
(5)Basic
@javax.persistence.Basic(fetch=FetchType.LAZY,optional=true)
fetch:抓取策略,延時加載與立即加載
optional:指定在生成數(shù)據(jù)庫結(jié)構(gòu)時字段是否允許為 null
(6)Column
@javax.persistence.Column(length=15,nullable=false,columnDefinition="",insertable=true,scale=10,table="",updatable=true)
@Column 注解指定字段的詳細(xì)定義
name:字段的名稱,默認(rèn)與屬性名稱一致 
nullable:是否允許為 null,默認(rèn)為 true
unique:是否唯一,默認(rèn)為 false 
length:字段的長度,僅對 String 類型的字段有效 
columnDefinition:表示該字段在數(shù)據(jù)庫中的實際類型
通常 ORM 框架可以根據(jù)屬性類型自動判斷數(shù)據(jù)庫中字段的類型,
但是對于 Date 類型仍無法確定數(shù)據(jù)庫中字段類型究竟是 DATE,TIME 還是 TIMESTAMP,
此外,String 的默認(rèn)映射類型為 VARCHAR,如果要將 String 類型映射到特定數(shù)據(jù)庫的 BLOB 或 TEXT 字段類型,該屬性非常有用
如: @Column(name="BIRTH",nullable="false",columnDefinition="DATE") 
insertable:默認(rèn)情況下,JPA 持續(xù)性提供程序假設(shè)所有列始終包含在 SQL INSERT 語句中。
如果該列不應(yīng)包含在這些語句中，請將 insertable 設(shè)置為 false 
updatable：列始終包含在 SQL UPDATE 語句中。如果該列不應(yīng)包含在這些語句中，請將 updatable 設(shè)置為 false 
table:實體的所有持久字段都存儲到一個其名稱為實體名稱的數(shù)據(jù)庫表中,如果該列與 @SecondaryTable 表關(guān)聯(lián)
需將 name 設(shè)置為相應(yīng)輔助表名稱的String名稱
(7)Temporal
@javax.persistence.Temporal(TemporalType.DATE)
value:TemporalType.DATE,TemporalType.TIME,TemporalType.TIMESTAMP時間類型格式
(8)Enumerated
@javax.persistence.Enumerated(EnumType.STRING)
value:EnumType.STRING,EnumType.ORDINAL
枚舉類型成員屬性映射,EnumType.STRING 指定屬性映射為字符串,EnumType.ORDINAL 指定屬性映射為數(shù)據(jù)序
(9)Lob
@javax.persistence.Lob
用于標(biāo)注字段類型為 Clob 和 Blob 類型
Clob(Character Large Ojects) 類型是長字符串類型,實體的類型可為 char[]、Character[]、或者String 類型
Blob(Binary Large Objects) 類型是字節(jié)類型,實體的類型可為 byte[]、Byte[] 或者實現(xiàn)了 Serializable 接口的類。
通常使用惰性加載的方式, @Basic(fetch=FetchType.LAZY)
(10)Transient
@javax.persistence.Transient
@Transient 表示該屬性并非一個到數(shù)據(jù)庫表的字段的映射,ORM框架將忽略該屬性
(11)SecondaryTable 
@javax.persistence.SecondaryTable
將一個實體映射到多個數(shù)據(jù)庫表中
如：
@Entity
@SecondaryTables({ 
@SecondaryTable(name = "Address"), 
@SecondaryTable(name = "Comments") 
})
public class Forum implements Serializable {
@Column(table = "Address", length = 100) 
private String street; 
@Column(table = "Address", nullable = false) 
private String city; 
@Column(table = "Address") 
private String conutry; 
@Column(table = "Comments") 
private String title; 
@Column(table = "Comments") 
private String Comments; 
@Column(table = "Comments") 
}
table 屬性的值指定字段存儲的表名稱
沒有用 @Column 注解改變屬性默認(rèn)的字段將會存在于 Forum 表
(12)@Embeddable
@javax.persistence.Embeddable
嵌套映射,在被嵌套的類中使用 Embeddable 注解,說明這個就是一個可被嵌套的類,使用 @Embedded
當(dāng)同一個類被不同的注解方式的類嵌套時，可能會出現(xiàn)一些錯誤，使用 @Access(AccessType. FIELD)設(shè)定被嵌套類的注解方式 

================================================================================================
(1)
@Entity注解定義
@Target(TYPE) @Retention(RUNTIME)
public @interface Entity{
String name() default ""; //實體bean的名稱
}


(2)
@Table注解定義
@Target(value = {ElementType.TYPE}) 
@Retention(value = RetentionPolicy.RUNTIME) 
public @interface Table { 
public String name() default ""; //表的名稱
public String catalog() default ""; //數(shù)據(jù)庫名稱
public String schema() default ""; //數(shù)據(jù)庫用戶名
public UniqueConstraint[] uniqueConstraints() default {}; //指定多個字段唯一性約束 
}


(3)
@UniqueConstraint注解定義
public @interface UniqueConstraint{
String[] columnNames( ); //唯一字段屬性名稱
}


(4)
@Id注解定義
@Target({METHOD, FIELD}) @Retention(RUNTIME) 
public @interface Id{ }


(5)
@注解GeneratedValue定義
@Target({METHOD, FIELD}) @Retention(RUNTIME)
public @interface GeneratedValue{
GenerationType strategy() default AUTO; //主鍵生成策略
String generator() default "";
}


(6)
@Column注解定義
@Target(value = {ElementType.METHOD, ElementType.FIELD}) 
@Retention(value = RetentionPolicy.RUNTIME) 
public @interface Column { 
public String name() default ""; //數(shù)據(jù)庫中的列名
public boolean unique() default false; //該列是否唯一
public boolean nullable() default true; //是否可以為空
public boolean insertable() default true; 
public boolean updatable() default true; 
public String columnDefinition() default ""; 
public String table() default ""; 
public int length() default 255; //該列的最大長度
public int precision() default 0; 
public int scale() default 0; 
}


(7)
@Temporal注解定義
public enum TemporalType{
DATE, //代表 date類型 java.sql.Date 2008-08-08 
TIME, //代表時間類型 java.sql.Time 20:00:00
TIMESTAMP //代表時間 java.sql.Timestamp 2008-08-08 20:00:00.000000001
}
public enum TemporalType{
DATE, //代表 date類型 //java.sql.Date 2008-08-08 
TIME, //代表時間類型 //java.sql.Time 20:00:00
TIMESTAMP //代表時間 //java.sql.Timestamp 2008-08-08 20:00:00.000000001
}

以下部分顯示如何將Java java.util.Map映射到數(shù)據(jù)庫表。

例子

以下代碼來自Employee.java。

package cn.w3cschool.common;


import java.util.Map;

import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.ManyToOne;
import javax.persistence.MapKeyColumn;

@Entity
public class Employee {
    @Id @GeneratedValue(strategy=GenerationType.IDENTITY)
    private int id;
    private String name;
    private long salary;

    @ElementCollection
    @CollectionTable(name="EMP_PHONE")
    @MapKeyColumn(name="PHONE_TYPE")
    @Column(name="PHONE_NUM")
    private Map<String, String> phoneNumbers;
            
    @ManyToOne
    private Department department;

    
    public int getId() {
        return id;
    }
    
    public void setId(int id) {
        this.id = id;
    }
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }

    public long getSalary() {
        return salary;
    }

    public void setSalary(long salary) {
        this.salary = salary;
    }
    
    public Department getDepartment() {
        return department;
    }
    
    public void setDepartment(Department department) {
        this.department = department;
    }

    public Map<String, String> getPhoneNumbers() {
        return phoneNumbers;
    }

    public void setPhoneNumbers(Map<String, String> phoneNumbers) {
        this.phoneNumbers = phoneNumbers;
    }

    public String toString() {
        StringBuffer aBuffer = new StringBuffer("Employee ");
        aBuffer.append(" id: ");
        aBuffer.append(id);
        aBuffer.append(" with dept: ");
        if(null != department) {
            aBuffer.append(department.getName());
        }
        aBuffer.append(" phoneNumbers: ");
        for (Map.Entry e : phoneNumbers.entrySet()) {
            aBuffer.append(e.getKey() + "[" + e.getValue() + "] ");
        }        
        return aBuffer.toString();
    }
}

下載 ElementCollection_String_Map.zip

這里是數(shù)據(jù)庫表轉(zhuǎn)儲。

Table Name: DEPARTMENT
 Row:
    Column Name: ID,
    Column Type: INTEGER:
    Column Value: 1

    Column Name: NAME,
    Column Type: VARCHAR:
    Column Value: test





Table Name: EMPLOYEE
 Row:
    Column Name: ID,
    Column Type: INTEGER:
    Column Value: 1

    Column Name: NAME,
    Column Type: VARCHAR:
    Column Value: Tom

    Column Name: SALARY,
    Column Type: BIGINT:
    Column Value: 0

    Column Name: DEPARTMENT_ID,
    Column Type: INTEGER:
    Column Value: 1





Table Name: EMP_PHONE