kapok

範例 4︰多對多的單向關係

多對多關係

多對多關係聽起來極其難以實作。實際上，它和一對一關係一樣容易實作。EJB 容器替您做了所有最難做的工作。

對於這個範例，您將新增使用者可能處於的不同角色。單個使用者可能處於多個角色。並且一個角色可以與多個使用者相關聯。

在這個範例中，您將做下面這些事︰

1. 定義 RoleBean。
2. 在配置描述子中定義從 UserBean 到 RoleBean 的關係。
3. 將一個 CMR 集合欄位新增到 UserBean 中。
4. 將程式碼新增到 UserManagement Session bean 中以使用這種關係。
5. 將程式碼新增到客戶端以使用 UserManagement Session bean 中的新程式碼。

定義 RoleBean

RoleBean 與上一範例中的 UserInfoBean 類似。和所有其它Entity bean 一樣，它有 CMP 欄位。它還有一個本地 home、一個local interface和一個Entity bean 實作。

與上一個範例中的 UserInfoBean 不同，RoleBean 沒有 <cmr-field>。下面列出 RoleBean 完整的清單。

清單 8︰RoleBean local interface

package com.rickhightower.auth; 
import javax.ejb.EJBLocalObject; 

public interface LocalRole extends EJBLocalObject {
    public abstract String getName(); 
    public abstract String getDescription(); 
}
                         

清單 9︰RoleBean Home interface

package com.rickhightower.auth; 
import javax.ejb.EJBLocalHome; 
import javax.ejb.CreateException; 
import javax.ejb.FinderException; 
import java.util.Collection; 

public interface LocalRoleHome extends EJBLocalHome { 
    public LocalRole create (String name, String description) throws CreateException; 
    public LocalRole findByPrimaryKey (String email) throws FinderException; 
    public Collection findAll() throws FinderException; 
} 
                         

清單 10︰RoleBean Entity bean 實作類別

package com.rickhightower.auth; 
import javax.ejb.EntityBean; 
import javax.ejb.EntityContext; 
import javax.ejb.CreateException; 
import javax.naming.*; 

public abstract class RoleBean implements EntityBean { 

    public String ejbCreate(String name, String description) throws CreateException { 
        setName(name);
        setDescription(description); 
        return null; 
    } public 

    void ejbPostCreate(String name, String description) throws CreateException{ } 

    public abstract String getName(); 
    public abstract void setName(String name); 

    public abstract String getDescription(); 
    public abstract void setDescription(String description);

    public void setEntityContext(EntityContext context){ } 
    public void unsetEntityContext(){ } 
    public void ejbRemove(){ } 
    public void ejbLoad(){ }
    public void ejbStore(){ } 
    public void ejbPassivate(){ } 
    public void ejbActivate(){ } 
} 
                          

清單 11︰RoleBean 配置描述子

    <entity>
      <display-name>RoleBean</display-name>
      <ejb-name>RoleBean</ejb-name>

      <local-home>com.rickhightower.auth.LocalRoleHome</local-home>
      <local>com.rickhightower.auth.LocalRole</local>
      <ejb-class>com.rickhightower.auth.RoleBean</ejb-class>

      <persistence-type>Container</persistence-type>
      <prim-key-class>java.lang.String</prim-key-class>

      <reentrant>False</reentrant>
      <cmp-version>2.x</cmp-version>

      <abstract-schema-name>RoleBean</abstract-schema-name>

      <cmp-field>
        <description>no description</description>
        <field-name>name</field-name>
      </cmp-field>
      <cmp-field>
        <description>no description</description>
        <field-name>description</field-name>
      </cmp-field>
      <primkey-field>name</primkey-field>
      <security-identity>
        <description></description>
        <use-caller-identity></use-caller-identity>
      </security-identity>

      <query>
        <description></description>
        <query-method>
          <method-name>findAll</method-name>
          <method-params />
        </query-method>
        <ejb-ql>select Object(o) from RoleBean </ejb-ql>
      </query>

    </entity>

  </enterprise-beans>

在配置描述子中定義關係

加入多對多關係的 XML 元素和技術與加入一對一關係的 XML 元素和技術基本相同。唯一的關鍵的不同之處是 multiplicity。RoleBean 的 <ejb-relationship-role> 沒有 CMR 欄位元素，因為從 UserBean 到 RoleBean 的關係是單向的。RoleBean 不知道 UserBean。下面列出了 <ejb-relation> 元素︰

		  
public abstract class UserBean implements EntityBean {
             
    public abstract Collection getRoles();
    public abstract void setRoles(Collection roles);
    	 
}
		   

package com.rickhightower.auth; 
import javax.ejb.EJBLocalObject; 
import java.util.Collection; 

public interface LocalUser extends EJBLocalObject { 

    public Collection getRoles(); 
    public void setRoles(Collection roles); 

    public String getEmail(); 
    public String getPassword(); 
    public LocalUserInfo getUserInfo(); 
    public void setUserInfo(LocalUserInfo userInfo); 
} 
                   

public void addRole(String email, String roleName){ 
    
    LocalUser user = userHome.findByPrimaryKey(email); 
    LocalRole role = roleHome.findByPrimaryKey(roleName); 
    Collection roles = user.getRoles();
    roles.add(role); 
     
}                          

範例 5︰一對多的雙向關係

一對多關係

一對多關係和其它關係非常相似。和前面一樣，EJB 容器完成最艱巨的工作。

在這個範例中，您將做下面這些事︰

1. 定義 GroupBean。
2. 在配置描述子中定義從 UserBean 到 GroupBean 的雙向關係。
3. 將一個 CMR 集合欄位新增到 UserBean 中。
4. 將程式碼新增到 UserManagement Session bean 中以使用這個關係。
5. 將程式碼新增到客戶端中以使用 UserManagement Session bean 中的新程式碼。

定義 GroupBean

GroupBean 類似於前兩個範例中的 UserInfoBean 和 RoleBean。和所有其它的Entity bean 一樣，它有 CMP 欄位。它還有本地 home、local interface和Entity bean 實作。

和第一個關係範例中的 UserInfoBean 一樣，GroupBean 有一個參照 UserBean 的 <cmr-field>。和 UserInfoBean 不同，GroupBean 中的 <cmr-field> 的使用者是 UserBean 的集合。下面列出 GroupBean 完整的清單︰

清單 14︰GroupBean local interface

package com.rickhightower.auth;
import javax.ejb.EJBLocalObject;
import java.util.Collection;

public interface LocalGroup extends EJBLocalObject { 

    public abstract Collection getUsers(); 
    public abstract void setUsers(Collection collection);

    public abstract String getName();
    public abstract String getDescription(); 
}
				

清單 15︰GroupBean Home interface

package com.rickhightower.auth;
 
import javax.ejb.EJBLocalHome; 
import javax.ejb.CreateException; 
import javax.ejb.FinderException; 
import java.util.Collection; 

public interface LocalGroupHome extends EJBLocalHome { 
    public LocalGroup create (String name, String description) throws CreateException; 
    public LocalGroup findByPrimaryKey (String name) throws FinderException; 

    public Collection findAll() throws FinderException; 
} 

清單 16︰GroupBean Entity bean 實作類別

package com.rickhightower.auth; 

import javax.ejb.EntityBean; 
import javax.ejb.EntityContext; 
import javax.ejb.CreateException; 
import java.util.Collection; 
import javax.naming.*;

public abstract class GroupBean implements EntityBean { 

    public String ejbCreate(String name, String description) throws CreateException {
        setName(name); 
        setDescription(description); 
        return null; 
    } 

    public void ejbPostCreate(String name, String description) throws CreateException{ } 

    public abstract Collection getUsers(); 
    public abstract void setUsers(Collection collection); 

    public abstract String getName(); 
    public abstract void setName(String name); 

    public abstract String getDescription(); 
    public abstract void setDescription(String description); 

    public void setEntityContext(EntityContext context){ } 
    public void unsetEntityContext(){ }
    public void ejbRemove(){ } 
    public void ejbLoad(){ } 
    public void ejbStore(){ }
    public void ejbPassivate(){ } 
    public void ejbActivate(){ } 
} 

清單 17︰GroupBean 配置描述子項目

    <entity>
      <display-name>GroupBean</display-name>
      <ejb-name>GroupBean</ejb-name>

      <local-home>com.rickhightower.auth.LocalGroupHome</local-home>
      <local>com.rickhightower.auth.LocalGroup</local>
      <ejb-class>com.rickhightower.auth.GroupBean</ejb-class>

      <persistence-type>Container</persistence-type>
      <prim-key-class>java.lang.String</prim-key-class>

      <reentrant>False</reentrant>
      <cmp-version>2.x</cmp-version>

      <abstract-schema-name>GroupBean</abstract-schema-name>

      <cmp-field>
        <description>The group name</description>
        <field-name>name</field-name>
      </cmp-field>
      <cmp-field>
        <description>The description of the group</description>
        <field-name>description</field-name>
      </cmp-field>

      <primkey-field>name</primkey-field>

      <security-identity>
        <description></description>
        <use-caller-identity></use-caller-identity>
      </security-identity>

      <query>
        <description></description>
        <query-method>
          <method-name>findAll</method-name>
          <method-params />
        </query-method>
        <ejb-ql>select Object(group) from GroupBean group</ejb-ql>
      </query>

    </entity>

在配置描述子中定義關係

用來加入一對多關係的 xml 元素和技術與加入一對一和多對多關係的 xml 元素和技術幾乎相同。唯一的關鍵的不同之處是 multiplicity。GroupBean 的 <ejb-relationship-role> 有一個 CMR 欄位元素，因為從 UserBean 到 GroupBean 的關係是雙向的。GroupBean 有一個名為 users 的 CMR 欄位。UserBean 有一個名為 group 的 CMR 欄位。下面列出了 <ejb-relation> 元素︰

    <ejb-relation>

      <ejb-relation-name>GroupsHaveUsers</ejb-relation-name>

      <ejb-relationship-role>
        <ejb-relationship-role-name>GroupHasUsers</ejb-relationship-role-name>
        <multiplicity>One</multiplicity>

        <relationship-role-source>
          <ejb-name>GroupBean</ejb-name>
        </relationship-role-source>

        <cmr-field>
          <cmr-field-name>users</cmr-field-name>
          <cmr-field-type>java.util.Collection</cmr-field-type>
        </cmr-field>

      </ejb-relationship-role>

      <ejb-relationship-role>

        <ejb-relationship-role-name>UsersInGroup</ejb-relationship-role-name>
        <multiplicity>Many</multiplicity>

        <relationship-role-source>
          <ejb-name>UserBean</ejb-name>
        </relationship-role-source>

        <cmr-field>
          <cmr-field-name>group</cmr-field-name>
        </cmr-field>

      </ejb-relationship-role>

    </ejb-relation>
			 
			 

請注意，GroupHasUsers 的 multiplicity 為 One，因為在這個關係中有一個群組，並且和上一個範例 GroupHasUsers 的 <cmr-field> 一樣，有一個子元素 <cmr-field-type>，如下所示︰

        <cmr-field>
          <cmr-field-name>users</cmr-field-name>
          <cmr-field-type>java.util.Collection</cmr-field-type>
        </cmr-field>

欄位關係的類型是 java.util.Collection，CMR 欄位名稱是 users。

關係的另一方 UsersInGroup 的 <multiplicity> 為 Many，因為這個群組裡有很多使用者。另請注意將 <cmr-field> 設定為 group。

將 CMR 欄位群組新增到 UserBean

CMR 欄位 group 容許您將這個使用者設定到一個群組中或者取得使用者所在的群組。這樣，和 UserInfo 的一對一關係的 CMR 欄位一樣，您可以設定並取得與群組相關聯的集合︰

清單 18︰UserBean Entity bean 實作類別
 
public abstract class UserBean implements EntityBean {
            
    public abstract LocalGroup getGroup();
    public abstract void setGroup(LocalGroup group);
     
}

清單 19︰UserBean local interface

package com.rickhightower.auth; 

import javax.ejb.EJBLocalObject; 
import java.util.Collection; 

public interface LocalUser extends EJBLocalObject { 

    public LocalGroup getGroup(); 
    public void setGroup(LocalGroup group); 

    public Collection getRoles(); 
    public void setRoles(Collection roles); 

    public String getEmail(); 
    public String getPassword(); 
    public LocalUserInfo getUserInfo(); 
    public void setUserInfo(LocalUserInfo userInfo); 
} 

它和其它關係範例沒有太大區別。接下來我將講解使用多對多關係的 UserManagement Session bean 中的方法。

在 UserManagement 中使用一對多關係

UserManagementBean 加入四個方法，每個方法都作業 Groups 以及 User 和 Groups 之間的關係，如下所示︰inGroup()、moveUserToGroup()、addRoleToUsers()、getUsersInGroup()、createGroup()、removeGroup()、getGroups() 和 getRoles()。

createGroup() 和 removeGroup() 方法都只是將群組新增到資料儲存中以及從資料儲存刪除群組的範本化程式碼 ─ 又是沒有什麼新內容。加入方法 getRoles() 和 getGroups() 來顯示可用的角色和群組 。

inGroup()

inGroup() 方法檢查一個使用者是否在某個群組中︰

public boolean inGroup(String email, String groupName){ 
     
    LocalUser user = userHome.findByPrimaryKey(email); 
    return user.getGroup().getName().equals(groupName); 
     
}

moveUserToGroup() 

moveUserToGroup() 將使用者移到另一個群組中︰

public void moveUserToGroup(String email, String groupName){ 
    
    LocalUser user = userHome.findByPrimaryKey(email); 
    LocalGroup group = groupHome.findByPrimaryKey(groupName);
				
    user.setGroup(group);

    /* The relationship works both way so this would work too! */ 

    //<emph>group.getUsers().add(user);
     

addRoleToUsers()

addRoleToUsers() 使用群組到使用者和角色到使用者的兩種關係。它將 Role 新增到一個群組裡的每個使用者中。

public void addRoleToUsers(String groupName, String roleName){ 
     
    LocalGroup group = groupHome.findByPrimaryKey(groupName);
    LocalRole role = roleHome.findByPrimaryKey(roleName); 
    Collection users = group.getUsers(); 
    Iterator iterator = users.iterator();

    while(iterator.hasNext()){ 
        LocalUser user = (LocalUser)iterator.next();
        user.getRoles().add(role); 
    }     
}

getUsersInGroup()

getUsersInGroup() 使用使用者到 <userInfo> 的關係以及使用者到群組的關係，傳回一個字串陣列，每個字串包括群組中每個使用者的名、姓和電子郵件。

public String[] getUsersInGroup(String groupName){ 
    LocalGroup group = groupHome.findByPrimaryKey(groupName); 
    Collection users = group.getUsers(); 
    Iterator iterator = users.iterator(); 
    ArrayList userList = new ArrayList (50); 
    while(iterator.hasNext()){ 
        LocalUser user = (LocalUser)iterator.next(); 

        String firstName = user.getUserInfo().getFirstName(); 
        String lastName = user.getUserInfo().getLastName(); 
        String email = user.getEmail(); 

        StringBuffer sUser = new StringBuffer(80); 
        sUser.append(firstName + ", ");
        sUser.append(lastName + ", "); 
        sUser.append(email);
        userList.add(sUser.toString()); 
    } 
    return (String []) userList.toArray(new String[userList.size()]); 
     
}

現在，我們來修改客戶端，以便可以使用這種程式碼。

使用 UserManagement 的 inGroup()、moveUserToGroup()、addRoleToUsers() 和 getUsersInGroup() 方法

客戶端使用所有新的 UserManagement 的方法，如下所示︰

System.out.println("Create and Display groups");
userMgmt.createGroup("marketing", "Marketing group");
userMgmt.createGroup("engineering", "Engineering group");
userMgmt.createGroup("sales", "Sales group"); 
userMgmt.createGroup("IT","Information Technology group"); 

    /** Display the created groups */ 
String [] groups = userMgmt.getGroups(); 

for (int index=0; index < groups.length; index++){ 
    System.out.println(groups[index]); 
} 

createUsers(userMgmt); //updated for section 3 

    /** Section 5 Add role to users */ 
String group = "engineering"; 
String role = "super_user"; 
userMgmt.addRoleToUsers(group,role);

group = "IT"; 
role = "admin"; 
userMgmt.addRoleToUsers(group,role); 

group = "marketing"; 
role = "user"; 
userMgmt.addRoleToUsers(group,role); 


    /** Section 5 -- list users in group engineering */ 
String [] users = userMgmt.getUsersInGroup("engineering"); 
System.out.println("Users in the engineering group"); 

for (int index=0; index < users.length; index++){
     System.out.println(users[index]); 
} 

    /** Section 5 -- Is Andy in group Engineering ? */ 

if (userMgmt.inGroup("andy@rickhightower.com","engineering")){
    System.out.println("Andy is in the engineering group"); 
} 

    /** Section 5 -- 
      Is Andy in group the super_user role that was assigned 
      to all users in engineering? */ 
if (userMgmt.inRole("andy@rickhightower.com","super_user")){
    System.out.println("Andy is a super_user"); 
} 

/** Section 5 -- Move Andy to marketing */ 
userMgmt.moveUserToGroup("andy@rickhightower.com", "marketing");

/** Section 5 -- Is Andy in group Engineering ? */ 
if (userMgmt.inGroup("andy@rickhightower.com","engineering")){
    System.out.println("Andy is in the engineering group"); 
} else if(userMgmt.inGroup("andy@rickhightower.com","marketing")){
    System.out.println("Andy is now in the marketing group"); 
}

/**Section 5 **/ 
userMgmt.removeGroup("marketing"); 
userMgmt.removeGroup("engineering");
userMgmt.removeGroup("sales"); 
userMgmt.removeGroup("IT"); 

編譯和佈署一對多範例

同樣的技術也可以用來建置、包裹、佈署和執行客戶端。請參閱本技術教學第一部分的第 8 章，重溫一下怎樣建置和執行這個範例應用程式。請檢視 cmpCmr/section5 下的程式碼和建置文件。

請務必執行 ant clean 來刪除舊範例的文件。

結論

現在，您已經完成本技術教學系列最前面的五個範例以及兩篇技術教學的學習。看起來您已經達到預定目標了。

您已經建立一對一、一對多以及多對多關係。您使用集合將Entity新增到其它Entity中，而 EJB 容器將行新增到底層的連線表和欄位中。

總結一下，您可以用 deploytool 檢視 Entity .jar 文件中的關係，如圖 2 和圖 3 所示。

圖 2︰本技術教學中您建立的所有關係

圖 3︰Group 的 CMR 和 CMP 欄位

在本技術教學系列的第三篇，即最後一部分技術教學中，我將說明 EJB-QL 的功能。

參考資料

• 這裡是全部的程式碼  zip 文件
• 一本優秀的關於 EJB CMP/CMR 和 EJB-QL 的技術教學
• Sun 的 J2EE 技術教學

參考書籍

• Ed Roman、Scott W. Ambler、Tyler Jewell、Floyd Marinescu 合著的 Mastering Enterprise JavaBeans (2nd Edition)，
  EJB 的百科全書﹗
• Richard Monson-Haefel 所著的 Enterprise JavaBeans (3rd Edition)，也請買下這本書﹗
• Richard Hightower、Nicholas Lesiecki 合著的 Java Tools for Extreme Programming，講述了用 EJB 建置和佈署 J2EE。

作者

Rick Hightower，eBlox 的開發主管，具有十多年的軟體工作人員經驗。他領導採用新過程（比如，極端編碼）和新技術（比如 CMP 和 CMR）。

Rick 的出版品包括 Java Tools for eXtreme Programming，它講述了佈署和測試 J2EE 工程（由 John Wiley 出版）；他參與合著的 Java Developer's Journal（由 Sams 出版），還有 Java Developer's Journal 中發表過幾篇的文章。