Java 后端 Web 应用教程第一部分：用七个步骤构建一个最小化应用程序

JavaBean 类和实体类

一个JavaBean 类（或简单地称为bean 类）是一个具有默认构造函数的 Java 类，其中所有属性都是可序列化的，并且具有 get 和 set 方法（也称为“getter”和“setter”）。Java bean 是使用 bean 类创建的对象。

一个JPA 实体类（或简单地称为实体类）是一个带有 @Entity 注释的 JavaBean 类，这意味着 JavaEE 运行时环境（如TomEE PLUS Web 服务器提供的）将负责其实例的持久化存储。

在第一步中，我们为应用程序代码设置文件夹结构。本章中的应用程序名称将是“Public Library”，我们将使用相应的应用程序文件夹名称“publicLibrary”。然后我们创建应用程序结构。有许多方法可以做到这一点，例如使用Eclipse 开发环境（并创建和配置一个动态 Web 项目）。在本教程中，我们将展示如何手动完成，因此除了ANT 之外，无需使用特殊工具即可更轻松地编译和部署应用程序。为了方便起见，我们提供了一个 ANT 脚本（可在本教程末尾下载），该脚本能够创建 Web 应用程序的文件夹结构，将其编译为Web 应用程序Archive (WAR) 文件，然后将其部署到 TomEE Web 服务器执行。应用程序结构（与 Eclipse 的动态 Web 项目结构兼容，因此可以导入到 Eclipse 中）如下所示：

publicLibrary
  src
    pl
      model
      ctrl
    META-INF
      persistence.xml
  WebContent
    views
      books
    WEB-INF
      templates
      faces-config.xml
      web.xml

此文件夹结构包含以下部分

在第二步中，我们为我们的应用创建模型类，每种模型类使用一个单独的 Java 源文件（扩展名为 .java）。在上面图 1.1 中显示的信息设计模型中，只有一个类代表 Book 对象类型。因此，我们在 src/pl/model 文件夹中创建一个文件 Book.java，其代码如下：

@Entity @Table( name="books")
public class Book {
  @Id private String isbn;
  private String title;
  private int year;
  // default constructor, required for entity classes
  public Book() {}
  // constructor
  public Book( String isbn, String title, int year) {
    this.setIsbn( isbn);
    this.setTitle( title);
    this.setYear( year);
  }
  // getter and setter methods
  public String getIsbn() {return isbn;}
  public void setIsbn( String isbn) {this.isbn = isbn;}
  public String getTitle() {return title;}
  public void setTitle( String title) {this.title = title;}
  public int getYear() {return year;}
  public void setYear( int year) {this.year = year;}
  // CRUD data management methods
  public static void add(...) {...}
  public static List<Book> retrieveAll(...) {...}
  public static Book retrieve(...) {...}
  public static void update(...) {...}
  public static void destroy(...) {...}
  public static void clearData(...) {...}
  public static void createTestData(...) {...}
}

请注意，模型类 Book 被编码为JPA 实体类，这是一个 JavaBean 类，并添加了以下 JPA 注释：

在实体类 Book 中，我们还定义了以下静态（类级别）方法：

这些方法将在以下各节中讨论。

JPA 用于数据管理和对象到存储映射的体系结构基于实体管理器的概念，该实体管理器提供数据管理方法 persist 用于保存新创建的实体，find 用于检索实体，remove 用于删除实体。

由于实体管理器对数据库的访问操作是在事务的上下文中执行的，因此我们的数据管理方法具有 UserTransaction 类型的参数 ut。在实体管理器能够调用数据库写方法 persist 之前，需要使用 ut.begin() 启动事务。在执行完所有写（和状态更改）操作后，使用 ut.commit() 完成事务（并提交所有更改）。

CREATE TABLE IF NOT EXISTS books (
  isbn VARCHAR(10) NOT NULL PRIMARY KEY,
  title VARCHAR(128),
  year SMALLINT
);

public static void add( EntityManager em, UserTransaction ut, 
    String isbn, String title, int year) throws Exception {
  ut.begin();
  Book book = new Book( isbn, title, year);
  em.persist( book);
  ut.commit();
}

public static List<Book> retrieveAll( EntityManager em) {
  Query query = em.createQuery( "SELECT b FROM Book b", Book.class);
  List<Book> books = query.getResultList();
  return books;
}

public static void update( EntityManager em, 
    UserTransaction ut, String isbn, String title, 
    int year) throws Exception {
  ut.begin();
  Book book = em.find( Book.class, isbn);
  if (!title.equals( book.getTitle())) book.setTitle( title);
  if (year != book.getYear()) book.setYear( year);
  ut.commit();
}

public static void destroy( EntityManager em, 
    UserTransaction ut, String isbn) throws Exception {
  ut.begin();
  Book book = em.find( Book.class, isbn);
  em.remove( book);
  ut.commit();
}

public static void createTestData( EntityManager em, 
    UserTransaction ut) throws Exception {
  Book book = null;
  Book.clearData( em, ut);  // first clear the books table
  ut.begin();
  book = new Book("006251587X","Weaving the Web", 2000);
  em.persist( book);
  book = new Book("0465026567","Gödel, Escher, Bach", 1999);
  em.persist( book);
  book = new Book("0465030793","I Am A Strange Loop", 2008);
  em.persist( book);
  ut.commit();
}

public static void clearData( EntityManager em, 
    UserTransaction ut) throws Exception {
  ut.begin();
  Query deleteStatement = em.createQuery( "DELETE FROM Book");
  deleteStatement.executeUpdate();
  ut.commit();
}

在本节中，我们将展示如何：

EntityManagerFactory emf = 
    Persistence.createEntityManagerFactory("MinimalApp");
EntityManager em = emf.createEntityManager();
EntityTransaction et = em.getTransaction();

public class BookController {
  @PersistenceContext( unitName="MinimalApp")
  private EntityManager em;
  @Resource() UserTransaction ut;

  public List<Book> getBooks() {...}
  public void refreshObject( Book book) {...}
  public String add( String isbn, String title, 
      int year) {...}
  public String update( String isbn, 
      String title, int year) {...}
  public String destroy( String isbn) {...}
}

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.1" xmlns="http://java.sun.com/xml/ns/persistence" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <persistence-unit name="MinimalApp">
    <class>pl.model.Book</class>
    <properties>	
      <!-- Request auto-generation of the database schema -->
      <property name="javax.persistence.schema-generation.database.action" 
          value="create"/>
      <!-- Use the JPA annotations for creating the database schema -->
      <property name="javax.persistence.schema-generation.create-source" 
          value="metadata"/>
    </properties>
    <jta-data-source>jdbc/MinimalApp</jta-data-source>
  </persistence-unit>
</persistence>

<?xml version="1.0" encoding="UTF-8"?>
<TomEE>
  <Resource id="MinimalApp" type="DataSource"> 
    JdbcDriver com.mysql.jdbc.Driver 
    JdbcUrl jdbc:mysql://:3306/minimalapp
    UserName minimalapp 
    Password minimalapp 
    JtaManaged true 
  </Resource> 
</TomEE>

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:ui="http://java.sun.com/jsf/facelets"
      xmlns:h="http://java.sun.com/jsf/html">
  <h:head>
    <title><ui:insert name="title">Public Library</ui:insert></title>
    <link href="#{facesContext.externalContext.requestContextPath}/resources/css/style.css" 
          rel="stylesheet" type="text/css" />
  </h:head>
  <body>
    <div id="header">
      <ui:insert name="header">
        <ui:include src="/WEB-INF/templates/header.xhtml"/>
      </ui:insert>
    </div>
    <div id="main">
      <ui:insert name="main"/>
    </div>
    <div id="footer">
      <ui:insert name="footer">
        <ui:include src="/WEB-INF/templates/footer.xhtml"/>
      </ui:insert>
    </div>
  </body>
</html>

<div><h2>Public Library</h2></div>

<div>Copyright 2014-2015, Gerd Wagner and Mircea Diaconescu</div>

@Entity @Table( name="books")
@RequestScoped @ManagedBean( name="book")
public class Book { ... }

@SessionScoped @ManagedBean( name="bookCtrl")
public class BookController { ... }

创建用例涉及在主内存中创建一个新对象，然后使用 add 方法将其保存到持久化存储中。

下面显示了 src/pl/ctrl/BookController.java 中相应的 add 操作方法代码：

public class BookController {
  ...
  public String add( String isbn, String title, int year) {
    try {
      Book.add( em, ut, isbn, title, year);
      // clear the form after saving the Book record
      FacesContext fContext = FacesContext.getCurrentInstance();
      fContext.getExternalContext().getRequestMap().remove("book");
    } catch ( Exception e) {
      e.printStackTrace();
    } 
    return "create";
  }
}

BookController::add 操作方法调用 Book.add 模型类方法来创建和保存 Book 实例。它返回在触发该操作的视图所在的文件夹中找到的视图文件的名称。该文件（在本例中为 create.xhtml）将在执行操作后显示。在上面的第 5 行和第 6 行，使用 FacesContext 对象，在创建 Book 实例后清除表单。 src/pl/model/Book.java 中 add 方法的代码如下：

public class Book {
  ...
  public static void add( EntityManager em, UserTransaction ut,
      String isbn, String title, int year) throws Exception {
    ut.begin();
    Book book = new Book( isbn, title, year);
    em.persist( book);
    ut.commit();
  }
}

现在我们需要为创建用例创建 facelet 视图文件 WebContent/views/books/create.xhtml。这样的 facelet 文件本质上定义了一个带有数据绑定和动作绑定的 HTML 表单。

数据绑定是指将模型类属性绑定到表单（输入或输出）字段。例如，在下面的 facelet 代码片段中，实体属性 book.isbn 被绑定到表单输入字段“isbn”。

<h:outputLabel for="isbn" value="ISBN: " />
<h:inputText id="isbn" value="#{book.isbn}" />

动作绑定是指将方法调用表达式绑定到可操作的 UI 元素，其中被调用的方法通常是控制器操作方法，可操作的 UI 元素通常是表单按钮。例如，在下面的 facelet 代码片段中，方法调用表达式 bookCtrl.add(...) 被绑定到表单的提交按钮。

<h:commandButton value="Create" 
    action="#{bookCtrl.add( book.isbn, book.title, book.year)}"/>

在讨论了数据绑定和动作绑定之后，是时候查看 facelet 的完整代码了。

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="..."
      xmlns:h="..." xmlns:p="...">
  <ui:composition template="/WEB-INF/templates/page.xhtml">
    <ui:define name="main">
      <h:form id="createBookForm">
        <h:panelGrid columns="2">
          <h:outputLabel for="isbn" value="ISBN: " />
          <h:inputText id="isbn" value="#{book.isbn}" />
          <h:outputLabel for="title" value="Title: " />
          <h:inputText id="title" value="#{book.title}" />
          <h:outputLabel for="year" value="Year: " />
          <h:inputText id="year" p:type="number" value="#{book.year}" />
        </h:panelGrid>
        <h:commandButton value="Create" 
            action="#{bookCtrl.add( book.isbn, book.title, book.year)}"/>
      </h:form>
      <h:button value="Main menu" outcome="index" />
    </ui:define>
  </ui:composition>
</html>

此 facelet 替换 page.xhtml 中定义的模板的 main 区域，因为 ui:define 元素的 name 属性已设置为“main”。

h:outputLabel 元素可用于创建表单字段标签，而 h:inputText 元素用于创建 HTML 输入元素。可以通过使用特殊命名空间前缀（xmlns:p="http://xmlns.jcp.org/jsf/passthrough"）来指定 type 属性的 HTML5 类型，强制将其“传递”。这样，year 输入字段可以定义为 number 类型，以便由浏览器中的相应数字控件呈现。

h:commandButton 元素允许创建作为 input 元素（type="submit"）呈现的提交按钮，并将其绑定到单击按钮时要执行的操作。 action 属性的值是方法调用表达式。在我们创建用例中，我们希望在单击按钮时，创建并保存一个具有相应表单字段提供的值的 Book 实例。

此用例对应于 Create-Retrieve-Update-Delete (CRUD) 四个基本数据管理用例中的“检索/读取”。

首先，对于列出对象用例，我们必须在控制器类（src/pl/ctrl/BookController.java 文件）中添加一个方法，该方法从 books 数据库表中读取所有 Book 记录，然后将此信息传递给视图。控制器操作方法代码如下：

public class BookController {
  ...
  public List<Book> getBooks() {
    return Book.retrieveAll( em);
  }
  ...
}

getBooks 方法返回一个 Book 实例列表，这些实例是通过调用 Book 模型类的静态 retrieveAll 方法获得的。 Book.retrieveAll 方法的代码如下：

public class Book {
  ...
  public static List<Book> retrieveAll( EntityManager em) {
    Query query = em.createQuery( "SELECT b FROM Book b");
    List<Book> books = query.getResultList();
    return books;
  }
  ...
}

代码很简单，并且如第 2.3 节中已讨论的，它使用 JPQL 语句从 books 表中检索 Book 记录并创建相应的 Book 实例。执行 JPQL 查询所需的 EntityManager 对象是从 BookController 对象传递给 Book.retrieveAll 的，如第 3.1 节所述。

现在，是时候定义用于显示数据库中所有记录的表的 facelet 视图了。我们应用程序对应的视图文件位于 WebContent/views/books 文件夹下。对于检索/列出所有用例，我们创建一个名为 listAll.xhtml 的文件，其内容如下：

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="..."
      xmlns:h="..." xmlns:f="...">
  <ui:composition template="/WEB-INF/templates/page.xhtml">
    <ui:define name="main">
      <h:dataTable value="#{bookCtrl.books}" var="b">
        <h:column>
          <f:facet name="header">ISBN: </f:facet>
          #{b.isbn}
        </h:column>
        <h:column>
          <f:facet name="header">Title: </f:facet>
          #{b.title}
        </h:column>
        <h:column>
          <f:facet name="header">Year: </f:facet>
          #{b.year}
        </h:column>
      </h:dataTable>
      <h:button value="Main menu" outcome="index" />
    </ui:define>
  </ui:composition>
</html>

ui:composition 元素指定了应用哪个模板（即 template="/WEB-INF/templates/page.xhtml"）以及渲染时由该 facelet 替换哪个视图块（<ui:define name="main">）。

h:dataTable 元素为一组记录定义了一个表视图，然后该视图被渲染为 HTML 表。它的 value 属性定义了一个记录集合的数据绑定，而 var 属性定义了一个变量名，用于从该集合中迭代访问记录。 value 属性中提供的表达式通常指定一个集合值属性（此处：books），该属性通过控制器类 BookController 中定义的相应 getter（此处：getBooks）访问。在此特定情况下，定义 getBooks 方法就足够了，因为控制器类中不需要 books 属性。无论如何，value 不允许调用方法，因此我们不能直接调用 getBooks。相反，我们必须使用（可能是虚拟的）属性 books，它在内部求值为对 getBooks 的调用，而无需检查 books 属性是否存在。

h:button JSF 元素允许创建重定向按钮。 outcome 属性的值通过省略 .xhtml 扩展名来指定 JSF 视图文件的名称（即视图文件名是 index.xhtml）。

此用例对应于 Create-Read-Update-Delete (CRUD) 四个基本数据管理用例中的“更新”。

与创建对象用例一样，在 BookController 类（src/pl/ctrl/BookController.java 文件）中定义了一个控制器操作方法，代码如下：

public String update( String isbn, String title, int year) {
  try {
    Book.update( em, ut, isbn, title, year);
  } catch ( Exception e) {
    e.printStackTrace();
  } 
  return "update";
}

Book.update 负责更新并持久化更新由提供的 isbn 值标识的书籍条目的更改，如下所示：

public static void update( EntityManager em, UserTransaction ut,
    String isbn, String title, int year) throws Exception {
  ut.begin();
  Book book = em.find( Book.class, isbn);
  book.setTitle( title);
  book.setYear( year);
  ut.commit();
}

现在，我们创建视图，用户可以在其中选择一本书籍，以便编辑 title 和 year 属性，然后保存更改。此视图的代码存储在 WebContent/views/books/update.xhtml 文件中，其内容如下：

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:ui="..."
      xmlns:h="..." xmlns:f="..." xmlns:p="...">
  <ui:composition template="/WEB-INF/templates/page.xhtml">
    <ui:define name="main">
      <h:form id="updateBookForm">
        <h:panelGrid columns="2">
          <h:outputLabel for="selectBook" value="Select book: " />
          <h:selectOneMenu id="selectBook" value="#{book.isbn}">
            <f:selectItem itemValue="" itemLabel="---" />
            <f:selectItems value="#{bookCtrl.books}" var="b" 
                itemValue="#{b.isbn}" itemLabel="#{b.title}" />
            <f:ajax listener="#{bookCtrl.refreshObject( book)}" 
             render="isbn title year"/>
          </h:selectOneMenu>
          <h:outputLabel for="isbn" value="ISBN: " />
          <h:outputText id="isbn" value="#{book.isbn}" />
          <h:outputLabel for="title" value="Title: " />
          <h:inputText id="title" value="#{book.title}" />
          <h:outputLabel for="year" value="Year: " />
          <h:inputText id="year" p:type="number" value="#{book.year}" />
        </h:panelGrid>
        <h:commandButton value="Update" 
            action="#{bookCtrl.update( book.isbn, book.title, book.year)}"/>
      </h:form>
      <h:button value="Main menu" outcome="index" />
    </ui:define>
  </ui:composition>
</html>

在此视图中，使用 h:selectOneMenu 创建了一个单选列表（select）元素。 @value 属性允许通过将其分配给对象的属性来保存选择的值。在我们的例子中，由于选定的 Book 由其 isbn 属性值标识，该值存储在 book.isbn 属性中。使用 f:selectItems 元素填充书籍记录列表，该元素需要一个记录列表（使用 @value 属性），并定义一个变量名（使用 @var 属性），该变量绑定到列表中用于在内部用于填充选择列表的循环中光标所在的元素。属性 @itemValue 和 @itemLabel 用于在渲染视图时提供用于创建 option HTML5 元素的信息，通过指定 option 元素的内容（即 @itemLabel 属性的值）和 option/@value 属性的值（即 @itemValue 属性的值）。

在更新视图中，用户从下拉列表中选择一本书籍，而表单的其余部分将自动填充所选书籍的详细信息（isbn、title 和 year）。ISBN 我们已经知道，它是下拉列表的选择值。但是，我们还需要显示所选书籍的 title 和 year。为此，我们使用 f:ajax JSF 元素，它允许执行一个请求（AJAX 请求），该请求会导致调用指定的方法。该方法将托管的 book 实例作为参数，并通过从数据库读取来更新其 title 和 year 属性。所使用的方法是 BookController 类的一部分，名为 refreshObject。此方法代码如下：

public void refreshObject( Book book) {
  Book foundBook = Book.retrieve( em, book.getIsbn());
  book.setTitle( foundBook.getTitle());
  book.setYear( foundBook.getYear());
}

它只是使用 Book.retrieve 方法，该方法返回给定 isbn 值存储在数据库中的 Book 实例。然后，更新方法的引用参数（即 book），以便 title 和 year 具有正确的值。在视图代码中，我们将 book 的引用解析为 refreshObject 方法的值。 book 属性与 h:inputText 和 h:outputText（对于必须只读的 isbn）JSF 元素连接，这意味着表单输入元素将显示 book 属性的值。为了强制刷新表单（这是必需的，因为表单仅在提交操作时自动更新），以便显示更新的 isbn、title 和 year 值，f:ajax JSF 元素允许指定要更新的表单（f:ajax 是其子元素）元素，即 f:ajax/@render="isbn title year"。

最后，h:commandButton 指定 action 是调用 BookController 的 update 操作方法，并带有 isbn、title 和 year 参数，从而使更改持久化。

此用例对应于 Create-Read-Update-Delete (CRUD) 四个基本数据管理用例中的“删除”。

下面显示了 src/pl/ctrl/BookController.java 中相应的 destroy 操作方法代码：

public String destroy( String isbn) {
  try {
    Book.destroy( em, ut, isbn);
  } catch ( Exception e) {
    e.printStackTrace();
  } 
  return "delete";
}

控制器操作方法的主要功能是调用 Book.destroy 方法，并提供要删除的 Book 条目的 isbn。 Book.destroy 方法负责根据标准标识符（即 isbn）的给定值查找正确的条目，以及将其从数据库中删除。

public static void destroy( EntityManager em, UserTransaction ut, String isbn) 
       throws Exception, HeuristicRollbackException, RollbackException {
  ut.begin();
  Book book = em.find( Book.class, isbn);
  em.remove( book);
  ut.commit();
}

通过使用 EntityManager 对象的内置 find 方法（参见 第 2.4 节）可以轻松找到具有给定 isbn 值的 Book 条目。通过调用 EntityManager 对象的 remove 方法（更多详细信息：第 2.5 节）可以从数据库中删除 Book 条目。

我们最后需要做的是创建相关的删除操作视图。该视图包含一个下拉列表，允许选择要删除的 Book，然后一个“删除”按钮执行书籍的删除。视图（WebContent/views/books/delete.xhtml）的代码如下：

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:ui="..."
      xmlns:h="..."
      xmlns:f="...">

  <ui:composition template="/WEB-INF/templates/page.xhtml">
    <ui:define name="main">
      <h:form id="deleteBookForm">
        <h:panelGrid columns="2">
          <h:outputText value="Select book: " />
          <h:selectOneMenu value="#{book.isbn}">
            <f:selectItems value="#{bookCtrl.books}" var="b" 
                itemValue="#{b.isbn}" itemLabel="#{b.title}" />
          </h:selectOneMenu>
        </h:panelGrid>
        <h:commandButton value="Delete" 
            action="#{bookCtrl.destroy( book.isbn)}"/>
      </h:form>
      <h:button value="Main menu" outcome="index" />
    </ui:define>
  </ui:composition>
</html>

与更新对象用例一样，使用 h:selectOneMenu JSF 元素创建并填充包含所有书籍的下拉列表，以便我们可以选择要删除的书籍。单击“删除” h:commandButton 会执行关联的操作，该操作使用所选书籍的 isbn 值调用控制器 destroy 操作方法，从而从数据库中删除 Book 条目。

您可以在我们的服务器上运行最小化应用，或下载代码作为 ZIP 压缩文件。

要在您的计算机上运行最小化应用，请先下载代码并编辑 ANT 脚本文件，方法是按照第 3.5 节中的说明修改 server.folder 属性值。然后，您可能需要使用 bin/shutdown.bat（Windows）或 bin/shutdown.sh（Linux）停止您的 Tomcat/TomEE 服务器。现在在您的控制台或终端中执行以下命令： ant deploy -Dappname=minimalapp。最后，启动您的 Tomcat Web 服务器（使用 bin/startup.bat（Windows OS）或 bin/startup.sh（Linux））。请耐心等待，这可能需要一些时间，具体取决于您计算机的速度。当控制台显示以下信息时，它将准备就绪： INFO: Initializing Mojarra [一些库版本和路径显示在此处] for context '/minimalapp'。最后，打开您喜欢的浏览器并输入：https://:8080/minimalapp/faces/views/books/index.xhtml

对于新项目，您可能希望下载依赖库。

此应用程序的代码应通过以下方式进行扩展：

我们将在后续教程《构建 Java Web 应用教程 第二部分：添加约束验证》中展示如何做到这一点。

我们简要讨论了三个进一步的注意事项：样板代码、代码清晰度、使用资源 URL 和架构分离关注点。