原文： http://zetcode.com/articles/servletfreemarker/

在本教程中，我们将创建一个具有基本 CRUD 操作的简单 Java Web 应用。 我们使用 FreeMarker 模板引擎，Servlet 技术和JdbcTemplate库。 MySQL 用于存储数据。 该应用最终部署在 Tomcat 服务器上。

该教程的资源可从作者的 Github 存储库中获得。

CRUD（创建，读取，更新和删除）是持久性存储的四个基本功能。 对于关系数据库，它们等效于INSERT，SELECT，UPDATE和DELETE语句。

FreeMarker 是 Java 编程语言的流行模板引擎。 模板以 FreeMarker 模板语言（FTL）编写。 模板引擎将静态数据与动态数据结合起来以生成内容。 模板是内容的中间表示。 它指定如何产生输出。

JDBCTemplate是用于简化 JDBC 编程的 Spring 库。 它处理乏味且容易出错的底层细节，例如处理事务，清理资源以及正确处理异常。 它包含在 Spring 的 spring-jdbc 模块中。

管理用户

我们的应用将管理用户。 它允许添加新用户，对其进行修改，删除它并列出所有可用用户。

  1. mysql> CREATE TABLE Users(Id INTEGER PRIMARY KEY AUTO_INCREMENT, 
  2.                           Firstname TEXT, Lastname TEXT, Email TEXT);

我们在 MySQL testdb数据库中创建Users表。

Excerpt from pom.xml

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>javax</groupId>
  4.         <artifactId>javaee-web-api</artifactId>
  5.         <version>7.0</version>
  6.         <scope>provided</scope>
  7.     </dependency>
  9.     <dependency>
  10.         <groupId>org.springframework</groupId>
  11.         <artifactId>spring-jdbc</artifactId>
  12.         <version>4.2.6.RELEASE</version>
  13.     </dependency>
  15.     <dependency>
  16.         <groupId>mysql</groupId>
  17.         <artifactId>mysql-connector-java</artifactId>
  18.         <version>6.0.2</version>
  19.     </dependency>        
  21.     <dependency>
  22.         <groupId>org.freemarker</groupId>
  23.         <artifactId>freemarker</artifactId>
  24.         <version>2.3.25-incubating</version>
  25.     </dependency>                        
  27. </dependencies>

在 Maven pom.xml文件中，我们提供四个依赖项：javaee-web-api是用于开发 Java Web 应用的一组库，spring-jdbc模块包含 JDBCTemplate 库，mysql-connector-java是 MySQL Java 驱动程序，而freemarker是 FreeMarker 库。

context.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Context path="/ServletFreemarkerEx">
  4.     <Resource name="jdbc/testdb" 
  5.               auth="Container"
  6.               type="javax.sql.DataSource" 
  7.               username="user7" 
  8.               password="s$cret"              
  9.               driverClassName="com.mysql.jdbc.Driver"
  10.               url="jdbc:mysql://localhost:3306/testdb"
  11.               maxActive="10" 
  12.               maxIdle="4"/>
  14. </Context>

在context.xml文件中，我们定义了应用上下文路径（其名称）和一个 MySQL 数据源。

web.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  4.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  6.          version="3.1">
  8.     <servlet>
  9.         <servlet-name>freemarker</servlet-name>
  10.         <servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class>
  12.         <init-param>
  13.             <param-name>TemplatePath</param-name>
  14.             <param-value>/WEB-INF/template/</param-value>
  15.         </init-param>
  16.         <init-param>
  17.             <param-name>NoCache</param-name>
  18.             <param-value>true</param-value>
  19.         </init-param>
  20.         <init-param>
  21.             <param-name>ResponseCharacterEncoding</param-name>
  22.             <param-value>fromTemplate</param-value>
  23.         </init-param>
  24.         <init-param>
  25.             <param-name>ExceptionOnMissingTemplate</param-name>
  26.             <param-value>true</param-value>
  27.         </init-param>
  28.         <init-param>
  29.             <param-name>incompatible_improvements</param-name>
  30.             <param-value>2.3.25-incubating</param-value>
  31.         </init-param>
  32.         <init-param>
  33.             <param-name>template_exception_handler</param-name>
  34.             <param-value>html_debug</param-value>
  35.         </init-param>
  36.         <init-param>
  37.             <param-name>template_update_delay</param-name>
  38.             <param-value>0 s</param-value>
  39.         </init-param>
  40.         <init-param>
  41.             <param-name>default_encoding</param-name>
  42.             <param-value>UTF-8</param-value>
  43.         </init-param>
  44.         <init-param>
  45.             <param-name>output_encoding</param-name>
  46.             <param-value>UTF-8</param-value>
  47.         </init-param>
  48.         <init-param>
  49.             <param-name>locale</param-name>
  50.             <param-value>en_US</param-value>
  51.         </init-param>
  52.         <init-param>
  53.             <param-name>number_format</param-name>
  54.             <param-value>0.##########</param-value>
  55.         </init-param>
  56.         <load-on-startup>1</load-on-startup>
  57.     </servlet>
  59.     <servlet-mapping>
  60.         <servlet-name>freemarker</servlet-name>
  61.         <url-pattern>*.ftl</url-pattern>
  62.     </servlet-mapping>
  64.     <security-constraint>
  65.         <web-resource-collection>
  66.             <web-resource-name>FreeMarker MVC Views</web-resource-name>
  67.             <url-pattern>*.ftl</url-pattern>
  68.         </web-resource-collection>
  69.         <auth-constraint>
  70.         </auth-constraint>
  71.     </security-constraint>    
  73.     <session-config>
  74.         <session-timeout>
  75.             30
  76.         </session-timeout>
  77.     </session-config>
  78. </web-app>

在web.xml文件中，我们设置了FreemarkerServlet，该文件用于处理 FreeMarker .ftl文件。

User.java

  1. package com.zetcode.bean;
  3. public class User {
  5.     private Long id;
  6.     private String firstName;
  7.     private String lastName;
  8.     private String email;
  10.     public Long getId() {
  11.         return id;
  12.     }
  14.     public void setId(Long id) {
  15.         this.id = id;
  16.     }
  18.     public String getFirstName() {
  19.         return firstName;
  20.     }
  22.     public void setFirstName(String firstName) {
  23.         this.firstName = firstName;
  24.     }
  26.     public String getLastName() {
  27.         return lastName;
  28.     }
  30.     public void setLastName(String lastName) {
  31.         this.lastName = lastName;
  32.     }
  34.     public String getEmail() {
  35.         return email;
  36.     }
  38.     public void setEmail(String email) {
  39.         this.email = email;
  40.     }    
  41. }

我们有一个User bean，其中包含四个属性：id，firstName，lastName和email。

ServiceLocator.java

  1. package com.zetcode.util;
  3. import java.util.logging.Level;
  4. import java.util.logging.Logger;
  5. import javax.naming.Context;
  6. import javax.naming.InitialContext;
  7. import javax.naming.NamingException;
  8. import javax.sql.DataSource;
  10. public class ServiceLocator {
  12.     public static DataSource getDataSource(String jndiName) {
  14.         Context ctx = null;
  15.         DataSource ds = null;
  17.         try {
  18.             ctx = new InitialContext();
  19.             ds = (DataSource) ctx.lookup(jndiName);
  20.         } catch (NamingException ex) {
  21.             Logger.getLogger(ServiceLocator.class.getName()).log(
  22.                 Level.SEVERE, null, ex);
  23.         }
  25.         return ds;
  26.     }
  27. }

ServiceLocator包含用于查找数据源的代码。 它使用 JNDI API 来完成这项工作。

DatabaseService.java

  1. package com.zetcode.service;
  3. import com.zetcode.bean.User;
  4. import com.zetcode.util.ServiceLocator;
  5. import java.util.List;
  6. import javax.sql.DataSource;
  7. import org.springframework.jdbc.core.BeanPropertyRowMapper;
  8. import org.springframework.jdbc.core.JdbcTemplate;
  10. public class DatabaseService {
  12.     public static User getUserById(Long id) {
  14.         String sql = "SELECT * FROM Users WHERE Id = ?";
  16.         JdbcTemplate jtm = getJDBCTempate();
  17.         User user = (User) jtm.queryForObject(sql, new Object[]{id},
  18.                 new BeanPropertyRowMapper(User.class));
  20.         return user;
  21.     }
  23.     public static void addUser(User user) {
  25.         String sql = "INSERT INTO Users(Firstname, Lastname, Email) VALUES(?, ?, ?)";
  27.         JdbcTemplate jtm = getJDBCTempate();
  28.         jtm.update(sql, new Object[] {user.getFirstName(), 
  29.             user.getLastName(), user.getEmail()});
  30.     }
  32.     public static void deleteUser(Long id) {
  34.         String sql = "DELETE From Users WHERE Id = ?";
  36.         JdbcTemplate jtm = getJDBCTempate();
  37.         jtm.update(sql, new Object[] {id});
  38.     }
  40.     public static void updateUser(User user) {
  42.         String sql = "UPDATE Users SET Firstname=?, Lastname=?, Email=? WHERE Id=?";
  44.         JdbcTemplate jtm = getJDBCTempate();
  45.         jtm.update(sql, new Object[] {user.getFirstName(), 
  46.             user.getLastName(), user.getEmail(), user.getId()});
  48.     }
  50.     public static List<User> getAllUsers() {
  52.         String sql = "SELECT * FROM Users";
  54.         JdbcTemplate jtm = getJDBCTempate();
  56.         List<User> users = (List<User>) jtm.query(sql,
  57.                 new BeanPropertyRowMapper(User.class));
  59.         return users;
  60.     }
  62.     private static JdbcTemplate getJDBCTempate() {
  64.         DataSource ds = ServiceLocator.getDataSource("java:comp/env/jdbc/testdb");
  65.         JdbcTemplate jtm = new JdbcTemplate(ds);
  67.         return jtm;
  68.     }
  69. }

在DatabaseService中，我们有利用JDBCTemplate库执行数据库操作的方法。

  1. public static User getUserById(Long id) {
  3.     String sql = "SELECT * FROM Users WHERE Id = ?";
  5.     JdbcTemplate jtm = getJDBCTempate();
  6.     User user = (User) jtm.queryForObject(sql, new Object[]{id},
  7.             new BeanPropertyRowMapper(User.class));
  9.     return user;
  10. }

getUserById()方法返回由其 ID 标识的用户。 queryForObject()运行指定的 SQL 语句并返回一个对象。 BeanPropertyRowMapper将返回的行转换为目标类（用户）。

  1. public static List<User> getAllUsers() {
  3.     String sql = "SELECT * FROM Users";
  5.     JdbcTemplate jtm = getJDBCTempate();
  7.     List<User> users = (List<User>) jtm.query(sql,
  8.             new BeanPropertyRowMapper(User.class));
  10.     return users;
  11. }

getAllUsers()方法返回表中的所有用户。 query()方法返回类型列表。

MyController.java

  1. package com.zetcode.web;
  3. import com.zetcode.bean.User;
  4. import com.zetcode.service.DatabaseService;
  5. import java.io.IOException;
  6. import java.util.List;
  7. import javax.servlet.RequestDispatcher;
  8. import javax.servlet.ServletException;
  9. import javax.servlet.annotation.WebServlet;
  10. import javax.servlet.http.HttpServlet;
  11. import javax.servlet.http.HttpServletRequest;
  12. import javax.servlet.http.HttpServletResponse;
  14. @WebServlet(name = "MyController", urlPatterns = {"/MyController"})
  15. public class MyController extends HttpServlet {
  17.     private static final String ADD_USER_VIEW = "addUser.ftl";
  18.     private static final String UPDATE_USER_VIEW = "updateUser.ftl";
  19.     private static final String LIST_USERS_VIEW = "listUsers.ftl";
  21.     private static final String USER_ADDED_VIEW = "userAdded.html";
  22.     private static final String USER_DELETED_VIEW = "userDeleted.html";
  23.     private static final String USER_MODIFIED_VIEW = "userUpdated.html";
  25.     private static final String DELETE_ACTION = "deleteUser";
  26.     private static final String ADD_ACTION = "addUser";
  27.     private static final String UPDATE_ACTION = "updateUser";
  28.     private static final String LIST_ACTION = "listUsers";
  30.     @Override
  31.     protected void doGet(HttpServletRequest request, HttpServletResponse response)
  32.             throws ServletException, IOException {
  34.         response.setContentType("text/html;charset=UTF-8");
  36.         String path = "";
  38.         String action = request.getParameter("action");
  40.         if (DELETE_ACTION.equals(action)) {
  41.             Long userId = Long.parseLong(request.getParameter("userId"));
  42.             DatabaseService.deleteUser(userId);
  44.             path = USER_DELETED_VIEW;
  45.         } else if (ADD_ACTION.equals(action)) {
  47.             path = ADD_USER_VIEW;
  49.         } else if (UPDATE_ACTION.equals(action)) {
  51.             Long userId = Long.parseLong(request.getParameter("userId"));
  52.             User user = DatabaseService.getUserById(userId);
  53.             request.setAttribute("user", user);
  54.             path = UPDATE_USER_VIEW;
  56.         } else if (LIST_ACTION.equals(action)) {
  58.             List<User> users = DatabaseService.getAllUsers();
  59.             request.setAttribute("users", users);
  60.             path = LIST_USERS_VIEW;
  61.         }
  63.         RequestDispatcher dispatcher = request.getRequestDispatcher(path);
  64.         dispatcher.forward(request, response);
  65.     }
  67.     @Override
  68.     protected void doPost(HttpServletRequest request, HttpServletResponse response)
  69.             throws ServletException, IOException {
  71.         String path = "";
  73.         response.setContentType("text/html;charset=UTF-8");
  75.         String action = request.getParameter("action");
  77.         if (ADD_ACTION.equals(action)) {
  79.             User user = new User();
  80.             user.setFirstName(request.getParameter("firstName"));
  81.             user.setLastName(request.getParameter("lastName"));
  82.             user.setEmail(request.getParameter("email"));
  84.             DatabaseService.addUser(user);
  85.             path = USER_ADDED_VIEW;
  87.         } else if (UPDATE_ACTION.equals(action)) {
  89.             User user = new User();
  90.             user.setId(Long.parseLong(request.getParameter("id")));
  91.             user.setFirstName(request.getParameter("firstName"));
  92.             user.setLastName(request.getParameter("lastName"));
  93.             user.setEmail(request.getParameter("email"));
  95.             DatabaseService.updateUser(user);
  96.             path = USER_MODIFIED_VIEW;
  97.         }
  99.         response.sendRedirect(path);
  100.     }
  101. }

MyController是一个控制器类，用于管理传入的请求并委托给特定的服务方法。 我们有两种方法：doGet()处理 HTTP GET 请求，doPost()处理 HTTP POST 请求。

  1. private static final String ADD_USER_VIEW = "addUser.ftl";
  2. private static final String UPDATE_USER_VIEW = "updateUser.ftl";
  3. private static final String LIST_USERS_VIEW = "listUsers.ftl";

这是三个 FreeMarker 模板视图。

  1. private static final String USER_ADDED_VIEW = "userAdded.html";
  2. private static final String USER_DELETED_VIEW = "userDeleted.html";
  3. private static final String USER_MODIFIED_VIEW = "userUpdated.html";

在这里，我们有三个 HTML 视图。 它们用于确认我们的任务。

  1. private static final String DELETE_ACTION = "deleteUser";
  2. private static final String ADD_ACTION = "addUser";
  3. private static final String UPDATE_ACTION = "updateUser";
  4. private static final String LIST_ACTION = "listUsers";

我们有四个不同的操作：删除用户，添加新用户，更新用户以及列出所有用户。

  1. if (DELETE_ACTION.equals(action)) {
  2.     Long userId = Long.parseLong(request.getParameter("userId"));
  3.     DatabaseService.deleteUser(userId);
  5.     path = USER_DELETED_VIEW;
  6. }

收到删除操作后，我们从请求中找到 ID，然后调用DatabaseService的deleteUser()方法。 然后选择一个视图。

  1. } else if (UPDATE_ACTION.equals(action)) {
  3.     Long userId = Long.parseLong(request.getParameter("userId"));
  4.     User user = DatabaseService.getUserById(userId);
  5.     request.setAttribute("user", user);
  6.     path = UPDATE_USER_VIEW;
  8. }

当我们单击更新链接时，将执行此代码。 从数据库中检索用户，并将User对象添加到请求对象。 UPDATE_USER_VIEW将应用转发到模板文件，该文件具有用于更新用户的形式。 提交表单后，将 POST 请求发送到控制器，并执行其doPost()方法。

  1. } else if (LIST_ACTION.equals(action)) {
  3.     List<User> users = DatabaseService.getAllUsers();
  4.     request.setAttribute("users", users);
  5.     path = LIST_USERS_VIEW;
  6. }

在这里，我们检索所有用户并将用户列表设置为请求对象。 我们选择LIST_USERS_VIEW视图。

  1. response.sendRedirect(path);

遵循发布/重定向/获取模式，我们将重定向到doPost()方法中的视图。 这样可以防止提交多个表单。 （例如，我们可能不小心多次添加了一个用户）。

addUser.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Add new user</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.         </head>
  8.     <body>
  10.         <form action="MyController?action=addUser" method="post"> 
  12.             <label for="fname">First name:</label>
  13.             <input id="fname" type="text" name="firstName">
  14.             <br>
  16.             <label for="lname">Last name:</label>
  17.             <input id="lname" type="text" name="lastName">
  18.             <br>
  20.             <label for="email">Email:</label>
  21.             <input id="email" type="text" name="email">            
  22.             <br>
  24.             <button type="submit">Submit</button>
  26.         </form>
  28.     </body>
  29. </html>

addUser.ftl是一个模板文件，其中包含用于添加新用户的表单。

  1. <form action="MyController?action=addUser" method="post">

该表单调用MyController servlet，并将action参数设置为addUser。

updateUser.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Update user</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.         <style>
  8.             input[readonly] {
  9.                 background-color:lightGray;
  10.             }
  11.         </style>
  12.         </head>
  13.     <body>
  15.         <form action="MyController?action=updateUser" method="post"> 
  17.             <label for="id">Id:</label>
  18.             <input id="id" type="text" name="id" readonly value="${user.id}">
  19.             <br>                
  21.             <label for="fname">First name:</label>
  22.             <input id="fname" type="text" name="firstName" value="${user.firstName}">
  23.             <br>
  25.             <label for="lname">Last name:</label>
  26.             <input id="lname" type="text" name="lastName" value="${user.lastName}">
  27.             <br>
  29.             <label for="email">Email:</label>
  30.             <input id="email" type="text" name="email" value="${user.email}">            
  31.             <br>
  33.             <button type="submit">Submit</button>
  35.         </form>
  37.     </body>
  38. </html>

addUser.ftl模板文件包含用于更新特定用户的表单。

  1. <style>
  2.     input[readonly] {
  3.         background-color:lightGray;
  4.     }
  5. </style>

这种 CSS 样式将浅色的只读输入标签的背景绘制为灰色。

  1. <label for="id">Id:</label>
  2. <input id="id" type="text" name="id" readonly value="${user.id}">
  3. <br>

ID 是一个只读参数。 ${user.id}是一个 FreeMarker 插值，可解析为用户 ID。 在到达updateUser.ftl文件之前，该请求获得一个将要修改的用户对象。

listUsers.ftl

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>List users</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.         </head>
  8.     <body>
  9.         <table>
  10.             <thead>
  11.                 <tr>
  12.                     <th>User Id</th>
  13.                     <th>First Name</th>
  14.                     <th>Last Name</th>
  15.                     <th>Email</th>
  16.                     <th colspan="2">Action</th>
  17.                 </tr>
  18.             </thead>
  19.             <tbody>
  20.                 <#list users as user>
  21.                     <tr>
  22.                         <td>${user.id}</td>
  23.                         <td>${user.firstName}</td>
  24.                         <td>${user.lastName}</td>
  25.                         <td>${user.email}</td>
  26.                         <td><a href="MyController?action=updateUser&userId=${user.id}">Update</a></td>
  27.                         <td><a href="MyController?action=deleteUser&userId=${user.id}">Delete</a></td>
  28.                     </tr>
  29.                 </#list>
  30.             </tbody>
  31.         </table>
  33.         <p>
  34.             <a href="MyController?action=addUser">Add new user</a>
  35.         </p>
  36.     </body>
  37. </html>

listUsers.ftl模板文件列出了Users数据库表中的所有用户。

  1. <#list users as user>

FreeMarker #list指令遍历users集合的所有元素。

  1. <td>${user.id}</td>
  2. <td>${user.firstName}</td>
  3. <td>${user.lastName}</td>
  4. <td>${user.email}</td>

这些 FreeMarker 插值显示用户数据。

  1. <td><a href="MyController?action=updateUser&userId=${user.id}">Update</a></td>

该链接将更新操作发送到应用控制器； 它还发送要修改的用户的 ID。

  1. <td><a href="MyController?action=deleteUser&userId=${user.id}">Delete</a></td>

该链接将删除操作发送到应用控制器。 它还发送要删除的用户的 ID。

  1. <a href="MyController?action=addUser">Add new user</a>

该链接将添加用户操作发送到控制器。

index.html

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>Main page</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <a href="MyController?action=listUsers">List all users</a>
  10.     </body>
  11. </html>

这是一个带有链接的主页，该链接将列表用户的操作发送到控制器。

userAdded.html

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>User added</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <p>
  10.             New user has been added successfully. 
  11.             <a href="MyController?action=listUsers">List all users</a>
  12.         </p>
  13.     </body>
  14. </html>

该视图通知用户已成功添加到数据库表中。

userDeleted.html

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>User deleted</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <p>
  10.             User has been successfully deleted.
  11.             <a href="MyController?action=listUsers">List all users</a>
  12.         </p>
  13.     </body>
  14. </html>

此视图通知用户删除。

userUpdated.html

  1. <!DOCTYPE html>
  2. <html>
  3.     <head>
  4.         <title>User modified</title>
  5.         <meta charset="UTF-8">
  6.         <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     </head>
  8.     <body>
  9.         <p>
  10.             User has been modified successfully. 
  11.             <a href="MyController?action=listUsers">List all users</a>
  12.         </p>
  13.     </body>
  14. </html>

该视图通知用户的修改。

Servlet FreeMarker `JdbcTemplate`教程 - CRUD 操作 - 图1

图：用户 Web 应用

在上面的屏幕截图中，我们可以看到用户列表。 该应用部署在 NetBeans 内置的 Tomcat 服务器上，该服务器正在监听端口 8084。

在本教程中，我们创建了一个执行 CRUD 操作的 Java Web 应用。 它使用了 FreeMarker，Servlet 和JDBCTemplate。 您可能也对相关教程感兴趣： JdbcTemplate教程， FreeMarker 教程， Java 教程，游戏入门， Spark 简介或 Strips 简介。