在 Visual Web 应用程åºä¸­ä½¿ç”¨ Java Persistence API

执行 SQL 语å¥

å¯ä»¥ä½¿ç”¨ Services 窗å£ä¸­çš„ Databases 节点将 Users 表添加到 sample Derby æ•°æ®åº“。å¯ä»¥ä»Žä¸€ä¸ªæ–‡ä»¶æ‰§è¡Œ SQL 脚本创建此表或者å•ç‹¬æ‰§è¡Œæ¯è¡Œ SQL 代ç ã€‚Services 窗å£ï¼ˆä»¥å‰ç§°ä½œ Runtime 窗å£ï¼‰ä¸­çš„æ•°æ®åº“表节点上下文èœå•å‡½æ•°åŒ…括用于创建新表和执行 SQL 代ç çš„函数。

图 1：SQL 执行命令

Execute Command 功能打开一个 Editor 窗å£ï¼Œå¯ä»¥å‘其中输入一行或多行 SQL 代ç ã€‚å•å‡» Run 按钮执行窗å£çš„å†…å®¹ã€‚è¯·ç¡®ä¿ Connection 字段指示您已连接到 sample æ•°æ®åº“。

图 2： 创建 Users 表的 SQL 代ç 

定义主键值

å¯ä»¥ä½¿ç”¨ä»¥ä¸‹ä»£ç åœ¨ Derby sample æ•°æ®åº“中创建 Users 表。注æ„å­å¥ GENERATED ALWAYS AS IDENTITY 指示 Derby DBMS å°†ç”Ÿæˆ user_id 主键值，并且当添加一个新纪录时该主键值自动递增。如果å‘此表中手动添加记录，比如使用 INSERT INTO 代ç ï¼Œè¯·ç¡®ä¿ä½¿ç”¨ä¿ç•™å­— DEFAULT æ¥æŒ‡ç¤º user_id 的值是由数æ®åº“æ供的。

create table "APP"."USERS" (
    userName VARCHAR(50), password VARCHAR(12), email_address VARCHAR (50),
           user_id INTEGER GENERATED always AS IDENTITY);
alter table Users add constraint usersPK PRIMARY KEY (user_id);
INSERT INTO Users VALUES ('Joe', 'joepw', 'joe@email.com',DEFAULT);
INSERT INTO Users VALUES ('Sarah', 'mypassword', 'sarah@sun.com', DEFAULT);
INSERT INTO Users VALUES ('Jane Doe', 'janie', 'jane@hotmail.com', DEFAULT);
               

还有使用 Derby 定义主键值的其他方法。除了 Apache Derby 站点 上的 Derby Reference Manual 之外，还å¯ä»¥å‚考 Brian Leonard 撰写的关于此项目的 åšå®¢æ–‡ç« ã€‚

但是请记ä½ï¼Œä¸åŒçš„æ•°æ®åº“管ç†ç³»ç»Ÿå¤„ç†ä¸»é”®å€¼çš„æ–¹å¼ä¹Ÿä¸åŒã€‚例如，对于 MySQL，用于生æˆå’Œè‡ªåŠ¨é€’增主键的表定义为：

`user_id` int(10) unsigned NOT NULL auto_increment, ...

然åŽï¼Œå°†ä»Žæ­¤æ•°æ®åº“表定义生æˆä¸€ä¸ªå®žä½“类。生æˆçš„实体类是数æ®åº“表的 Java Persistence 表示。因为 TopLink 是 JPA çš„å‚考实现，å¯ä»¥å‚考 TopLink 文档 获得关于 id 生æˆçš„更多信æ¯ã€‚使用 Derby，必须å‘生æˆçš„类手动添加注释，以对主键指示生æˆçš„值策略（@GeneratedValue）)。使用 MySQL，无需在此实体类中指定生æˆçš„值策略。

创建项目

创建 Java SE 应用程åºé¡¹ç›®ã€‚首先创建 Java SE 应用程åºé¡¹ç›®ï¼Œè¿™æ˜¯ä¸€ä¸ªæ™®é€šçš„ Java 项目。å•å‡»å·¥å…·æ ä¸Šçš„ New Project 图标（Ctrl+Shift+N），然åŽåœ¨ Categories 列表中选择 Java，在 Project 列表中选择 Java Application。然åŽå•å‡» Next 按钮。

图 3： 创建 Java 应用程åºï¼ˆå•å‡»æ”¾å¤§å›¾åƒï¼‰

在 New Java Application 窗å£ä¸­ï¼Œå°†é¡¹ç›®å称设置为 TestModelApp。还需è¦å°†åŒ…设置为 com.samples.model。å¯ä»¥é€šè¿‡å°†é»˜è®¤çš„ Create Main Class æ¡ç›®ç”± textmodelapp.Main 更改为 com.samples.model.Main æ¥å®žçŽ°ã€‚å•å‡» Finish 按钮。

图 4： 设置项目和包å称（å•å‡»æ”¾å¤§å›¾åƒï¼‰

创建 Visual Web 项目。在 New Project 对è¯æ¡†ä¸­é€‰æ‹© Web 类别，并选择 Web Application 项目，然åŽå•å‡» Next 按钮。

图 5：创建 Web 项目（å•å‡»æ”¾å¤§å›¾åƒï¼‰

在 New Web Application 对è¯æ¡†ä¸­ï¼Œå°†é¡¹ç›®å称设置为 TestWebApp。项目ä½ç½®åº”该默认与 TestModelApp 项目ä½ç½®ç›¸åŒã€‚å•å‡» Next 按钮转到下一å±å¹•ï¼Œåœ¨å…¶ä¸­é€‰æ‹©æ¡†æž¶ã€‚

图 6： 设置 Web 项目å称和ä½ç½®ï¼ˆå•å‡»æ”¾å¤§å›¾åƒï¼‰

为框架选择 Visual Web JavaServer Faces。当这样选择时，å±å¹•æ˜¾ç¤ºé…置设置。将 Default Java Package 设置由 testwebapp 更改为 com.samples.web。完æˆè¿™ä¸€æ­¥ä¹‹åŽï¼ŒTestModelApp å’Œ TestWebApp 会作为节点出现在 Project 窗å£ä¸­ã€‚å•å‡» Finish 按钮。

图 7： 设置 Web 应用程åºæ¡†æž¶å’ŒåŒ…

将项目链接起æ¥

现在需è¦å°†ä¸¤ä¸ªé¡¹ç›®é“¾æŽ¥èµ·æ¥ã€‚具体æ¥è¯´ï¼Œéœ€è¦è®© TestModelApp 作为 TestWebApp 项目的ä¾èµ–项。è¦å°† TestModelApp 作为 TestWebApp çš„ä¾èµ–项目，需è¦å°† TestModelApp.jar 文件添加到 TestWebApp 项目。下é¢æ˜¯æ“作方法：

在 Projects 窗å£ä¸­å³é”®å•å‡» TestWebApp 项目节点，然åŽä»Žä¸Šä¸‹æ–‡èœå•ä¸­é€‰æ‹© Properties 选项。 在 Project Properties 对è¯æ¡†ä¸­ï¼Œåœ¨å·¦ä¾§çš„ Categories 部分å•å‡» Libraries 节点。然åŽï¼Œå•å‡» Add Project 按钮。

图 8： 添加编译时库（å•å‡»æ”¾å¤§å›¾åƒï¼‰

在 Add Project 窗å£ï¼Œæµè§ˆåˆ° TestModelApp 项目的ä½ç½®ç„¶åŽé€‰æ‹©å®ƒã€‚然åŽï¼Œå•å‡» Add Project JAR Files 按钮。此步骤将 TestModelApp jar 文件添加到 TestWebApp 项目的è¿è¡Œæ—¶åº“中，而且 TestModelApp 会出现在 Project Properties å±å¹•ä¸­ã€‚å•å‡» Project Properties å±å¹•ä¸­çš„ OK 按钮，完æˆæ­¤è¿‡ç¨‹ã€‚

图 9： 添加 JAR 文件（å•å‡»æ”¾å¤§å›¾åƒï¼‰

连接到数æ®åº“

开始之å‰ï¼Œéœ€è¦å°†æ•°æ®åº“连接到 TestWebApp 项目中的 Users 表。如果使用示例 Derby æ•°æ®åº“而且还没有与之连接，那么打开 Services 窗å£ï¼Œå±•å¼€ Databases 节点，打开 jdbc:derby://localhost:1527/sample [app on APP] 节点的上下文èœå•å¹¶é€‰æ‹© Connect。如果使用ä¸åŒçš„ DBMS，那么如果需è¦ï¼Œå¯ä»¥ä¸ºæ•°æ®åº“设置一个驱动程åºï¼Œå¹¶æ ¹æ®å¿…须的连接å‚数创建一个新连接。（如果将数æ®åº“å称作为示例，将会更加容易执行剩下的步骤）。

如果还未创建 Users 表，那么现在是时候创建了：å‚阅 创建数æ®åº“表。

创建表示 Users æ•°æ®åº“表的 Java æŒä¹…实体类

创建一个表示 Users 表的实体类。正如å‰é¢æ到的，实体类是数æ®åº“表定义的 Java Persistence 表示。JPA 使用 Java 语言注释功能将 POJO 标记为带有对象关系映射信æ¯çš„ JPA 实体。使用 Entity Classes from Database 函数在 TestModelApp 中创建实体类。

在 Projects（或 Files）窗å£ä¸­å³é”®å•å‡» TestModelApp 项目。从上下文èœå•ä¸­é€‰æ‹© New > Entity Classes from Database 选项。 此时将显示 New Entity Classes from Database Database Tables 对è¯æ¡†ã€‚如果 Database Connection 字段是空的，则从下拉列表中选择示例数æ®åº“。Available Tables 列显示示例数æ®åº“中的所有表，包括 Users 表。选择 USERS 表并å•å‡» 按钮Add å°† Users 移动到 Selected Tables 列。移动 Users 表åŽå•å‡» Next 按钮。

图 10： 为实体类选择数æ®åº“表（å•å‡»æ”¾å¤§å›¾åƒï¼‰

此时将出现 Entity Classes 对è¯æ¡†ã€‚IDE 显示数æ®åº“表å称 Users，并建议一个类å Users。（如果需è¦ï¼ŒåŒå‡»ç±»å进行更改）。对è¯æ¡†è¿˜æŒ‡ç¤ºåŒ…为 com.samples.model。å•å‡» Create Persistence Unit 按钮。

图 11： 创建æŒä¹…å•å…ƒï¼ˆå•å‡»å›¾åƒæ”¾å¤§ï¼‰

创建æŒä¹…å•å…ƒ

在 Create Persistence Unit 对è¯æ¡†ä¸­ï¼Œå°† Persistence Unit Name 设置为 samplePU。ä¿ç•™å…¶ä»–字段的默认值。å•å‡» Create 按钮，然åŽåœ¨ Entity Classes å±å¹•ä¸­å•å‡» Finish 按钮完æˆæ“作并创建 samplePU æŒä¹…å•å…ƒã€‚

图 12： 为æŒä¹…å•å…ƒå‘½å

验è¯æŒä¹…å•å…ƒæ˜¯å¦æ­£ç¡®åˆ›å»ºï¼Œè¿™æ˜¯ä¸€ä¸ªä¸é”™çš„想法。为此，展开 TestModelApp Source Packages > META-INF 节点并åŒå‡» persistence.xml 文件。Design 窗å£å°†æ˜¾ç¤ºå…³äºŽæŒä¹…å•å…ƒçš„ä¿¡æ¯ï¼Œè€Œ Navigator 窗å£å°†æ˜¾ç¤º XML 属性。

图 13： 验è¯æŒä¹…å•å…ƒï¼ˆå•å‡»æ”¾å¤§å›¾åƒï¼‰

å•å‡» XML 标签查看完整的 XML 清å•ã€‚文件中的属性应该正确å射到数æ®åº“å称ã€urlã€é©±åŠ¨ç¨‹åºã€å¯†ç ï¼Œä»¥åŠåŒ…和类å（com.samples.model.Users）。事务类型为 RESOURCE_LOCAL，æ供者为 oracle.toplink.essentials.PersistenceProvider。é‡ç‚¹æ³¨æ„：确ä¿æ­£ç¡®å¡«å†™äº†å¯†ç å­—段。

图 14： æŒä¹…å•å…ƒ XML 定义（å•å‡»æ”¾å¤§å›¾åƒï¼‰

@Id 和 @GeneratedValue 注释

创建 Users 实体类之åŽï¼Œéœ€è¦ä¿®æ”¹è¯¥ç±»ï¼Œä»¥ä¾¿è®©æ•°æ®åº“自动生æˆä¸»é”®å­—段（用户 id 字段）。JPA 使用 @Id 注释标识主键。å‘主键添加第二个注释，指示生æˆä¸»é”®å€¼çš„策略：@GeneratedValue(strategy=GenerationType.<...>)，其中策略å­å¥æ˜¯å¯é€‰çš„。注æ„，选择的生æˆç­–略必须与数æ®åº“的性能相关è”。

使用 Derby æ•°æ®åº“生æˆä¸»é”®å€¼

因为 Derby æ•°æ®åº“æ”¯æŒ IDENTITY 列类型，因此å¯ä»¥ä¸ºä¸»é”®ç”Ÿæˆä¸€ä¸ªæƒŸä¸€å€¼ï¼Œè¿™ä¸ªä»»åŠ¡å¯ä»¥ç”±æ•°æ®åº“æ¥å®Œæˆã€‚因此，å‘主键定义中添加以下代ç è¡Œï¼š@GeneratedValue(strategy = GenerationType.IDENTITY).

进行修改之åŽï¼Œå®šä¹‰è¡¨çš„ Users.java 代ç åº”该如下所示：

public class Users implements Serializable {
  @Column(name = "USERNAME")
  private String username;
  @Column(name = "PASSWORD")
  private String password;
  @Column(name = "EMAIL_ADDRESS")
  private String emailAddress;
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  @Column(name = "USER_ID", nullable = false)
  private Integer userId;
               ...

使用 Fix Imports 功能

æ³¨æ„ @GeneratedValue 标记需è¦ä¸¤ä¸ªç±»ï¼šjavax.persistence.GeneratedValue å’Œ javax.persistence.GenerationType。使用 Fix Imports 函数导入这些类。å³é”®å•å‡»æºä»£ç ç¼–辑窗å£çš„任何地方，并从弹出èœå•é€‰æ‹© Fix Imports。Fix Imports 函数将这两个导入语å¥æ·»åŠ åˆ°ç±»ï¼š

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;

正如上é¢æ到的，其他数æ®åº“å¯èƒ½éœ€è¦å¯¹ Users.java 代ç è¿›è¡Œä¸åŒçš„修改，或者根本ä¸ä½œä¿®æ”¹ã€‚例如，对于 MySQL æ•°æ®åº“，ä¸éœ€è¦åŒ…å« @GeneratedValue 注释，因为如果在创建表定义时为 user_id 列指定了 auto_increment，数æ®åº“会自动生æˆä¸»é”®å€¼ã€‚

创建实体控制器类

继续在 TestModelApp 项目中æ“作，在 com.samples.model 包中创建一个å«åš UserController 的新类。（我们将在下é¢æ供此类的代ç ï¼Œå¯ä»¥å°†å®ƒç²˜è´´åˆ°æ‚¨çš„类中）。

展开 TestModelApp > Source Packages > com.samples.model 节点。注æ„包中已ç»æœ‰ä¸¤ä¸ªç±»ï¼šMain.java å’Œ Users.java。å³é”®å•å‡» com.samples.model 节点并选择 New > Java Class 选项。在 New Java Class 对è¯æ¡†ä¸­ï¼Œå°†ç±»å称设置为 UserController（将其ä½ç½®ä¿ç•™ä¸º Source Packages 并将包å称ä¿ç•™ä¸º com.samples.model）。

图 15： 创建 UserController 类（å•å‡»æ”¾å¤§å›¾åƒï¼‰

在 Edit 窗å£ä¸­åº”该å¯ä»¥çœ‹è§æºä»£ç æ¡†æž¶ã€‚å‘类添加如下代ç ï¼š

 private EntityManagerFactory emf;
 private EntityManager getEntityManager() {
 if(emf == null){
    emf = Persistence.createEntityManagerFactory("samplePU");
 }
    return emf.createEntityManager();
 }
 public Users[] getUsers() {
    EntityManager em = getEntityManager();
    try{
        javax.persistence.Query q = em.createQuery("select c from Users as c");
        return (Users[]) q.getResultList().toArray(new Users[0]);
    } finally {
        em.close();
    }
               }

使用 Fix Imports 函数导入需è¦çš„类。（在æºä»£ç ç¼–辑窗å£ä¸­å³é”®å•å‡»ï¼Œä»Žå¼¹å‡ºèœå•é€‰æ‹© Fix Imports 选项）。这样å¯ä»¥å°†ä»¥ä¸‹ 3 个导入语å¥æ·»åŠ åˆ°ç±»ä¸­ï¼š

import javax.persistence.EntityManager;

import javax.persistence.EntityManagerFactory;

import javax.persistence.Persistence;

å¯ä»¥ä½¿ç”¨ Format 函数（在åŒä¸€ä¸ªå¼¹å‡ºèœå•ä¸­ï¼‰è®¾ç½®ä»£ç å¯¹é½çš„æ ¼å¼ã€‚

æ³¨æ„ UserController 类包å«æ–¹æ³• getUsers，该方法调用 javax.persistence.EntityManager 接å£ä¸Šçš„ createQuery 方法创建一个查询，该查询从 Users 表返回数æ®çš„行。查询的结果作为一个数组返回。

在 Session Bean 中创建一个属性

在 NetBeans IDE 中，å¯ä»¥åœ¨ä¸€äº›ä½ç½®æ‰¾åˆ°æ‰˜ç®¡ bean：在 Navigator 窗å£ï¼Œåœ¨ Projects 窗å£çš„æºä»£ç åŒ…节点中，以åŠåœ¨ Files 窗å£çš„ src > java > project-name 节点中。

在 SessionBean1 中创建一个返回 Users 对象数组的属性。在 Navigator 窗å£ä¸­ï¼ŒåŒå‡» SessionBean1 在 Java Source Editor 中打开。或者，从 Projects çª—å£ TestWebApp > Source Packages > com.samples.web 节点中åŒå‡» SessionBean1。如果没有看到 Navigator 窗å£ï¼Œé‚£ä¹ˆå°è¯•åœ¨ Design 窗å£æ˜¾ç¤º TestWebApp 的一个页é¢ï¼Œæ¯”如 Page1。Navigator 窗å£åº”该显示在 Projects 窗å£çš„下é¢ã€‚如果还是看ä¸åˆ° Navigator 窗å£ï¼Œåœ¨ Design 窗å£å•å‡» Design 标签。 å‘ SessionBean1 添加一个 users 属性。键入以下代ç ï¼šprivate Users[] users; ä¿®å¤å¯¼å…¥ã€‚刚输入的代ç å¾ˆå¯èƒ½è¢«æ ‡è®°ä¸ºé”™è¯¯ã€‚如果是这样，使用æºä»£ç ç¼–辑器的上下文èœå• Fix Imports 函数æ¥ä¿®å¤æ­¤é”™è¯¯ã€‚（确ä¿åœ¨ç»§ç»­ä¹‹å‰æ”¹æ­£è¿™ä¸ªé”™è¯¯ï¼‰ã€‚è¦ä¿®å¤æ­¤é”™è¯¯ï¼Œæ·»åŠ ä»¥ä¸‹å¯¼å…¥è¯­å¥ï¼š import com.samples.model.Users; 为 users å±žæ€§ç”Ÿæˆ get å’Œ set 方法。å³é”®å•å‡»é”®å…¥çš„代ç è¡Œå¹¶é€‰æ‹© Insert Code 动作。从弹出èœå•é€‰æ‹© Getter å’Œ Setter。然åŽï¼Œé€‰æ‹© users:Users[]。

图 16： å‘ SsessionBean1 添加用户属性（å•å‡»æ”¾å¤§å›¾ç‰‡ï¼‰

使用 Insert Code 动作添加公共的 get å’Œ set 方法。完æˆä¹‹åŽï¼ŒSessionBean1 应该包å«ä»¥ä¸‹ä»£ç ï¼š

代ç ç¤ºä¾‹ 3：用户属性的 get å’Œ set 方法

 private Users[] users;
    public Users[] getUsers() {
    return users;
 }
    public void setUsers(Users[] users) {
    this.users = users;
               }

创建åˆå§‹åŒ–方法

å‘ SessionBean1 添加一个 updateUsers 属性。此方法将用æ¥åˆå§‹åŒ– users 属性。以下是此方法的代ç ï¼š

代ç ç¤ºä¾‹ 4：updateUsers 方法

public void updateUsers(){
     UserController usersController = new UserController();
     users = usersController.getUsers();
                     } 

使用 Fix Imports å‡½æ•°ä¿®å¤ updateUsers 需è¦çš„导入。如果代ç ä¸­åŒ…å«é”™è¯¯ï¼Œæ‰§è¡Œ Save All files 清除这些错误。 å°† updateUsers 方法的调用添加到 SessionBean1 init 方法中：updateUsers();.SessionBean1 init 方法应该如下所示（未显示注释行）：

代ç ç¤ºä¾‹ 5：SessionBean1 init 方法

public void init(){
     super.init();
     try {
          _init();
     } catch (Exception e) {
          log("SessionBean1 Initialization Failure", e);
          throw e instanceof FacesException ? (FacesException) e: new FacesException(e);
     }
     updateUsers();
                     } 

ä¿å­˜æ‰€æœ‰æ–‡ä»¶ã€‚ 构建 TestModelApp å’Œ TestWebApp 项目。

将属性绑定到表组件

现在已ç»å°†åˆšæ·»åŠ çš„ users 绑定到一个 Table 组件了。

在 TestWebApp > Web Pages 中，åŒå‡» Page1.jsp 在 Design 窗å£ä¸­æ‰“开此页é¢ã€‚ å°† Table 组件从 Palette 拖到 Design 窗å£ä¸­çš„页é¢ä¸Šã€‚应该如下图所示：

图 17： å‘ Page1 添加 Table 组件

å³é”®å•å‡»é¡µé¢ä¸Šçš„ Table 组件并在上下文èœå•ä¸­å•å‡» Bind to Data。在 Get Data From 下拉列表中选择 users（从 SessionBean1）作为绑定数组。（注æ„如果在下拉列表中没有 users 属性，å³é”®å•å‡» Design 窗å£å¹¶å•å‡»ä¸Šä¸‹æ–‡èœå•ä¸­çš„ Refresh 选项。或者在工具æ ä¸Šå•å‡» Refresh 按钮。如果还是未在下拉列表中看到 users 属性，那么选择并é‡æ–°æ‰“å¼€ TestWebApp 项目）。å•å‡» OK 按钮。

图 18：在 Bind to Data 对è¯æ¡†ä¸­é€‰æ‹©ç”¨æˆ·

Design 中显示的 Table 组件的更改如下。如果需è¦ï¼Œè°ƒæ•´æ˜¾ç¤ºçš„列。

图 19： Design 窗å£ä¸­ç»‘定到用户数组的 Table 组件

部署和è¿è¡Œ TestWebApp 项目。显示 Table 组件，并且如果为数æ®åº“表创建了示例数æ®åº“，那么数æ®åº”该显示为如下形å¼ï¼š

图 20： æµè§ˆå™¨ä¸­ Page1 上的 Table 组件

结æŸè¯­

本文讨论了使用 Visual Web 应用程åºçš„ Java Persistence API çš„å¿…è¦æ­¥éª¤ã€‚展示了如何设置 Java SE 项目和 Visual Web JSF 项目并将它们链接起æ¥ã€‚也展示了如何创建数æ®åº“表和需è¦çš„键，以åŠä½¿ç”¨ Java Persistence API 绑定到数æ®åº“。本文æ供了访问数æ®åº“表所需的定制 Java 代ç ï¼Œæ­¤ä»£ç æ¼”示了如何创建实体 bean ä¿å­˜è¡¨æ•°æ®ã€‚最åŽï¼Œè¿˜å±•ç¤ºäº†å¦‚何将实体 bean 绑定到 Visual Web Table ç»„ä»¶ï¼Œä»¥åŠ Table 如何简化数æ®åº“表数æ®çš„显示。

第 2 篇文章（“使用 Java Persistence API 修改数æ®åº“表行”）将å‘您展示如何使用此 API 添加ã€æ›´æ–°å’Œåˆ é™¤æ•°æ®åº“表行。此外，本文还包括一些技巧，用于最大é™åº¦åœ°åˆ©ç”¨ NetBeans IDE åŠå…¶å¯è§†çš„ web 函数。

更多信æ¯