EJB3.0開發指南:實體Bean

 在EJB3.0中開發實體Bean非常簡單，你可以象開發一般的java bean一樣編程，只需做少量的注釋。一個實體bean不需要實現Home介面或者Remote、Local介面。

實體Bean通過EntityManager產生、尋找、和持久層結合、從持久層收回等操作。

JBoss的EJB3.0架構在Hibernate之上。

 
注釋:

@Entity：如果你要建立一個實體Bean的類，你必須在類上加上這個注釋，用來告訴容器這個類是實體Bean。這個Bean的主鍵由@Id指定。

這個注釋的聲明如下：

@Target(TYPE) @Retention(RUNTIME)

public @interface Entity {

String name() default "";

EntityType entityType() default CMP;

AccessType access() default PROPERTY;

int version() default 3;

}
name用來指定實體Bean的名稱，預設和類名相同。

EntityType用來指定此bean是容器管理的持久實體Bean還是Bean管理的持久實體Bean。可以是CMP和BMP兩種方式。

AccessType用來指定容器訪問此EJB的持久化資料的方式。PROPERTY用來告訴容器使用get/set訪問持久化的資料（就是無Transient注釋的資料），FILED告訴容器直接存取欄位，欄位應該聲明稱protected類型。

為了提供給其他會話Bean等用戶端使用，這個Bean應實現Serializable介面。

實體Bean必須由一個無參數的構造方法。

可持久化的屬性包括：java的基本類型(int,long等)、String、BigInteger、BigDecimal、 java.util.Date、Calendar、java.sql.Date、java.sql.Time、java.sql.Timestamp、 byte[]、char[]、其他實體Bean類型、其他實體Bean的集合(Collection、Set，不支援List)。

 

@Table

用來指定此實體Bean使用的主表，有時候可能需要其他的表，參看後面的章節的介紹。UniqueConstraint注釋用來添加約束條件。

@Id

用來指定此實體Bean的主鍵。它可以有多種產生方式：

TABLE：容器指定用底層的資料表確保唯一。

SEQUENCE：使用資料庫的SEQUENCE列來保證唯一

IDENTITY：使用資料庫的INDENTIT列來保證唯一

AUTO：由容器挑選一個合適的方式來保證唯一
NONE：容器不負責主鍵的產生，由調用程式來完成。

 

@OnetoMany

兩個實體Bean之間可能有一對多、多對一、一對一、多對多的關係，後面兩個關係在後面的例子中介紹。

比如學生和各課分數之間就是一對多的關係。

在EJB3.0中，一對多的關聯必須是雙向的，也就是說，必定有各多對一的關聯和它對應。

OnetoMany注釋聲明如下：

 

@Target({METHOD, FIELD}) @Retention(RUNTIME)

public @interface OneToMany {

String targetEntity() default "";

CascadeType[] cascade() default {};

FetchType fetch() default LAZY;

}
 

當我們使用這個注釋為get方法注釋時，如果使用JDK5.0的通用編程，返回集合Collection<目標實體類型>，那麼就不需要指定 targetEntity的類型，否則傳回型別聲明為普通的Collection的話，就必須聲明targetEntity的類型。

CascadeType指定了當這個實體Bean建立或者Merge的時候，與之關聯的實體需要怎樣的處理：

MERGE：當主實體Bean被merge的時候、關聯的實體Bean也被merge

CREATE：當主實體Bean被create的時候、關聯的實體Bean也被create

REMOVE：當主實體Bean被evict的時候、關聯的實體Bean也被evict

ALL：包括以上的情況

 

FetchType指定從資料中讀取的方式:LAZY還是EAGER。LAZY只有當第一次訪問的時候，才從資料庫中得到相關的實體bean，EAGER則很積極，同主實體Bean一同產生。

 

@ManytoOne

我們知道一對多的關聯是雙向的。在關聯的實體Bean中必定聲明了由ManyToOne注釋的方法。

@JoinColumn

我們知道兩個實體可以關聯，但對應到Table中需要指定一個列作為外鍵。假如不指定name，那麼認為主表中的列和附表中的主鍵有相同名稱的作為外鍵。如果不指定referencedColumnName，則認為外鍵對應副表的主鍵。

@JoinColumns

用來指示符合主鍵，在後面的章節中介紹。

這個例子主要有以下幾個檔案，這個例子主要實現了管理學生分數的功能。Student是一個實體Bean，管理學生的基本資料（姓名和各課分數），其中學生的分數又是一個實體Bean。TacherBean是一個無狀態的會話Bean，用來調用實體Bean。和前面的例子一樣，我們還是使用Client測試。

 

Student.java：實體Bean。

Score.java：實體Bean。

Teacher.java：會話Bean的業務介面

TeacherBean.java：會話Bean的實作類別

Client.java：測試EJB的用戶端類。

jndi.properties：jndi屬性檔案，提供訪問jdni的基本配置屬性。

Build.xml：ant 設定檔，用以編譯、發布、測試、清除EJB。

下面針對每個檔案的內容做一個介紹。

 

Student.java

package com.kuaff.ejb3.entity;

 

import javax.ejb.CascadeType;

import javax.ejb.Entity;

import javax.ejb.FetchType;

import javax.ejb.GeneratorType;

import javax.ejb.Id;

import javax.ejb.JoinColumn;

import javax.ejb.OneToMany;

import javax.ejb.Table;

 

import java.util.ArrayList;

import java.util.Collection;

import java.io.Serializable;

 

@Entity

@Table(name = "STUDENT")

public class Student implements Serializable

{

    //主鍵

private int id;

//學生名

private String name;

//學生的分數

    private Collection<Score> scores;

    //主鍵自動產生

    @Id(generate = GeneratorType.AUTO)

    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 void addScores(String name,int number)

    {

        if (scores == null)

        {

            scores = new ArrayList<Score>();

        }

        Score score = new Score();

        score.setName(name);

        score.setNumber(number);

        score.setStudent(this);

        scores.add(score);

    }

    

    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)

    @JoinColumn(name = "student_id")

    public Collection<Score> getScores()

    {

       return scores;

    }

 

    public void setScores(Collection<Score> scores)

    {

       this.scores = scores;

    }

}

 
 

Student.java實現了Student實體Bean，它提供學生的基本情況以及學生的得分情況，得分是另外一個實體Bean。Student實體Bean和Score實體Bean是一對多的關係，站在Score的角度看是多對一的關係。

實體Bean需要使用@Entity做注釋，另外它指定這個實體Bean與表STUDENT對應（通過注釋@Table(name = "STUDENT")），你可以在JBOSS的資料庫中看到這個表。

 

Score.java

package com.kuaff.ejb3.entity;

 

import java.io.Serializable;

import javax.ejb.Entity;

import javax.ejb.GeneratorType;

import javax.ejb.Id;

import javax.ejb.JoinColumn;

import javax.ejb.ManyToOne;

import javax.ejb.Table;

 

@Entity

@Table(name = "Score")

public class Score implements Serializable

{

    private int id;

    private String name;

    private int number;

    private Student student;

    //主鍵自動產生

    @Id(generate = GeneratorType.AUTO)

    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 int getNumber()

    {

       return number;

    }

 

    public void setNumber(int number)

    {

       this.number = number;

    }

    

    @ManyToOne

    @JoinColumn(name = "student_id")

    public Student getStudent()

    {

       return student;

    }

 

    public void setStudent(Student student)

    {

       this.student = student;

    }

    

}
這個實體Bean存放學生的分數。
 

Teacher.java

package com.kuaff.ejb3.entity;

 

import javax.ejb.Remote;

import javax.ejb.Remove;

import java.util.Map;

 

@Remote

public interface Teacher

{

    public void addScore(String studentName,Map<String,Integer> map);

    

    public Student getStudent();

    

    @Remove

    public void leave();

}
這個會話Bean介面提供增加分數和得到使用者的方法。

 

TeacherBean.java

package com.kuaff.ejb3.entity;

 

import javax.ejb.EntityManager;

import javax.ejb.Inject;

import javax.ejb.Remove;

import javax.ejb.Stateful;

import java.util.Map;

import java.util.Set;

 

@Stateful

public class TeacherBean implements Teacher

{

    @Inject

    private EntityManager manager;

    private Student student;

 

    public Student getStudent()

    {

        return student;

    }

    public void addScore(String studentName, Map<String,Integer> map)

    {

        if (student == null)

        {

            student = new Student();

        }

        student.setName(studentName);

        Set<String> set = map.keySet();

        for (String sname:set)

        {

            student.addScores(sname,map.get(sname).intValue());

        }

    }

    

    @Remove

    public void leave()

    {

        manager.create(student);

    }

 

}
這個是會話Bean的實作類別。

 

Client.java

 

package com.kuaff.ejb3.entity;

 

import java.util.Map;

import java.util.HashMap;

import java.util.Collection;

import javax.naming.InitialContext;

import javax.naming.NamingException;

 

public class Client

{

 

    public static void main(String[] args) throws NamingException

    {

        InitialContext ctx = new InitialContext();

        Teacher teacher = (Teacher) ctx.lookup(Teacher.class.getName());

        Map<String,Integer> map = new HashMap<String,Integer>();

        map.put("語文",new Integer(98));

        map.put("化學",new Integer(149));

        map.put("物理",new Integer(143));

        teacher.addScore("smallnest",map);

        Student student = teacher.getStudent();

        String name = student.getName();

        System.out.printf("顯示%s的分數:%n",name);

        Collection<Score> c = student.getScores();

        

        for (Score score:c)

        {

            System.out.printf("%s:%s%n",score.getName(),score.getNumber()+"");

        }

        

    }

}
這個用戶端增加學生的分數，並且測試顯示這個學生的相關資訊。

 

請運行{$JBOSS_HOME}/bin目錄下的run.bat:  run ?c all,啟動JBOSS。

http://localhost:8080/jmx-console/HtmlAdaptor?action=inspectMBean&name=jboss%3Aservice%3DHypersonic%2Cdatabase%3DlocalDB，然後調用startDatabaseManager()方法，開啟HSQL管理工具管理資料庫。

在Eclipse的Ant視圖中執行ejbjar target。或者在命令列下，進入到此工程目錄下，執行ant ejbjar,將編譯打包發布此EJB。

在Eclipse的Ant視圖中執行run target。或者在命令列下，進入到此工程目錄下，執行ant run,測試這個EJB。