使用 Translator 模式构建更好的网站
dW 中国站点 Donald S Bell
使用 Translator 模式构建更好的网站
使用 Translator 模式转换输入字符串
Donald S Bell
IBM 的 IT 专家
2001 年 2 月
本文介绍 Translator 模式，并说明如何在 JSP 技术和 servlet 环境中使用 Translator 模式。读完本文以后，您将能够利用本文提供的代码示例成功实现这一模式。
在使用 JSP 文件和 servlet 构建 Web 应用程序时，应用程序的界面多半会是 HTML。浏览器翻译后的 HTML 就是一个大型字符串。构成应用程序的业务对象只有少数属性为字符串，其余属性则为日期、数字甚至其他业务对象。在构建 Web 应用时，如何将业务对象所包含的信息转换为浏览器可识别的 HTML 是个大问题。几乎每个应用程序都会以 HTML 格式收集信息，而这些信息又会作为字符串发送给服务器。因此现在还存在如何将所提交的信息转换为业务对象可识别的值这一问题。
Translator 模式通过提供一个与 JSP 文件、servlet 和业务对象协同工作的 Translator 对象解决了这两个问题。Translator 对象将三个不同对象结合在一起，从而使每个对象都专用于完成一项给定的任务。Translator 对象之所以可充当这个纽带，是因为它封装了要完成的全部转换逻辑。JSP 文件与 Translator 对象通信，专用于显示信息。这使 JSP 文件变得比较“干净”，即 JSP 文件中几乎没有 Java 代码。servlet 专门处理业务对象的持久性和屏幕之间的导航流。有了 servlet 专门处理这些任务，JSP 文件就几乎不需要 Java 代码了，从而使 JSP 文件变得更加“干净”。
更详细一点
如前所述，Translator 模式由三个基本部分组成，分别是专用的 Translator 对象、servlet 和 JSP 文件。
JSP 文件的唯一职责就是充当用户界面类。这是可能的，因为 JSP 文件从 Translator 对象获取预先格式化好的字符串值（稍后讨论）。JSP 文件应包含尽可能少的 Java 代码，因为负责开发 JSP 文件的网页设计者通常对 Java 编程语言知之甚少，或者干脆就一无所知。使内嵌在 JSP 文件中的 Java 代码尽可能达到最少，这样就使 JSP 文件更像纯 HTML 页面。与整篇都纠缠着 Java 代码的 JSP 文件相比，纯 HTML 页面的修改要容易得多。
Translator 对象是一种专用的类，它类似于 MVC 模式中的模型 (model) 类。Translator 对象将业务对象与 JSP 文件中的显示域联系起来。网页设计者将调用 Translator 对象的一个 getter 方法在 JSP 文件中显示动态信息。Translator 对象将返回一个预先格式化好的字符串，因此网页设计者需要做的全部工作就是将它发送到一个输出流中。Translator 对象能够提供此信息，因为它在内部变量中存储着需要显示的全部值。这些变量是由 syncGuiToModel() 和 processForm() 方法设置的。这两个方法专门处理屏幕和 Translator 之间的信息同步。小组中的 Java 开发人员负责构建这个 Translator 对象。
最后，servlet 专用于处理导航流和业务对象的持久性。当 servlet 接收到提交表单时，它将获得 Translator 对象的一个实例，并使用 processForm() 方法将对表单的分析委派给 Translator 对象。在表单的分析完成以后，servlet 就会让 Translator 对象使用 syncModelToGui() 方法将业务对象的值同步为表单中所提交的值。在成功转换所提交的值并将它们设置到业务对象上之后，servlet 将对业务对象执行持久化，并向网页访问者显示确认页。
给我显微镜
下面我们仔细查看 Translator 模式的三个部分：JSP 文件、servlet 和 Translator 对象。（本文的示例遵循的是 Servlet 2.1 规范和 JSP 1.0 规范。这些示例是在 WebSphere 3.02 和 WebSphere 3.5 环境下构建和测试的。）
JSP 文件
使用 Translator 模式的典型 JSP 输入表单如下所示：
<%@ page extends="com.ibm.igs.ispkcm.translator.JspBase"
import="com.ibm.developerworks.translatorpattern.LoanTranslator,
Java.util.Hashtable"%>
<HTML>
<%
LoanTranslator ltLoan = LoanTranslator.getInstance(request);
Hashtable htErrors = ltLoan.getErrors();
%>
<HEAD>
</HEAD>
<BODY>
<%= displayErrors(htErrors) %>
<action="/servlet/com.ibm.developerworks.translatorpattern.LoanRegistrationServlet">
<%= hightLightErrors(ltLoan.BORROWER_LAST_NAME, htErrors) %>Borrower Last Name:
<INPUT name="<%= ltLoan.BORROWER_LAST_NAME %>"
value="<%= ltLoan.getBorrowerLastName() %>">
</FORM>
</BODY>
</HTML>
在 Translator 模式中，所有表单都是 JSP 文件，而非 HTML 文件，所以输入域的值可以是动态的。这一点很重要，因为我们网站的访问者是实实在在的人，他们会犯输入错误。比让网站通知您它不接受您的输入更糟糕的唯一一件事情是，让它通知您它不接受您在某个域中输入的内容，并要求您重新键入其他 20 个域，因为某个程序员正忙于检查股市报价，没有时间来提高输入表单的用户友好性。在 Translator 模式中，输入表单的每个输入域的值都是动态设置的，因此如果因存在输入错误而需要向网站访问者重新显示输入页，他们就会看到突出显示的错误，但其他输入项仍然保留。
请记住，JSP 文件是由对 Java 代码知之甚少或一无所知的网站设计者编写和维护的。鉴于这个原因，我们希望 JSP 文件包含尽可能少的 Java 代码。但我们在上一段的说明听起来好像需要编写大量的 Java 代码。该 JSP 文件示例只有少量 Java 代码，但它们主要位于表达式 (<%= x %>) 中。它们能够使用这些众多的功能，因为 JSP 文件从它的超类 com.ibm.igs.ispkcm.translator.JspBase 中继承了这些代码，并将大量代码放在 Translator 对象中。
在此 JSP 文件中，要注意的第一点是它有一个 page 指令标记。这是因为它需要继承一个超类，并需要导入两个类。JSP 文件继承了超类 com.ibm.igs.ispkcm.translator.JspBase，因为 JspBase 包括一些很好的实用函数，它使得 JSP 文件可包含更少的代码。该 JSP 文件所用的主要实用函数是 displayErrors() 和 highLightErrors()。该 page 指令导入 LoanTranslator 和 Hashtable，因为 JSP 文件中引用了这两个类，导入这两个类是为了以后在此 JSP 代码中引用这两个类时不必使用它们完全限定的类名。以下代码显示了 import 语句的一个示例：
<%@ page extends="com.ibm.igs.ispkcm.translator.JspBase"
import="com.ibm.developerworks.translatorpattern.LoanTranslator,
Java.util.Hashtable"%>
JSP 文件中第一行真正的 Java 代码获取 Translator 对象的一个实例，然后获取一个 Hashtable，其中存储着属于 Translator 对象的那个实例的错误。因为 JSP 文件（在编译后）是一个 servlet，所以它是一个无状态的服务对象。Translator 对象将在特定 JSP 文件或 servlet 的不同往返之间维护必要的状态信息。状态信息应仅限于网站访问者输入的值和要向网站访问者显示的任何处理错误。因为 Translator 对象的每个实例都与一个特定的网站访问者相关联，所以 JSP 文件调用 Translator 对象的 getInstance(HttpServletRequest) 方法。由于为该方法传递的是一个 HttpServletRequest 对象，所以该方法将能够检索与该网站访问者的 HttpSession 相关的 Translator 实例。
<%
LoanTranslator ltLoan = LoanTranslator.getInstance(request);
Hashtable htErrors = ltLoan.getErrors();
%>
在此 JSP 文件示例中，网站访问者将在表单的顶部看到所有处理错误。用来显示这些错误消息的 HTML 是使用 <%= displayErrors(htErrors) %> 表达式输出的。displayErrors() 方法是从 JSP 文件的超类 JspBase 中继承而来的。有了 displayErrors()，用于显示错误消息的所有逻辑都被集中在一起，从而简化了维护工作。
下面这段代码模板适用于表单上的每个输入域：
<%= hightLightErrors(ltLoan.BORROWER_LAST_NAME, htErrors) %>Borrower Last Name:
<INPUT name="<%= ltLoan.BORROWER_LAST_NAME %>"
value="<%= ltLoan.getBorrowerLastName() %>">
highLightErrors() 是从 JSP 文件的超类 JspBase 中继承而来的。如果某个输入域有错误，该方法将突出显示该输入域的标签。该方法接收两个参数：String 和Hashtable。该 Hashtable 是其中存储着从 Translator 的实例检索而来的错误的 Translator。String 是正在检查其是否有错误的输入域的名称。如果存在与该域相关的错误，highLightErrors() 就会返回突出显示此输入域的标签的 HTML。
在此代码模板中，须注意的重要一点是：INPUT 标记的 name 属性是由一个表达式设置的，该表达式使用 LoanTranslator 对象的 BORROWER_LAST_NAME 常量。因为在 JSP 文件中引用此域名时使用了一个常量，所以 Translator 对象和 servlet 的调试变得更加容易。使用常量更为容易，因为无论何时开发人员更改此域的名称，他们都会获得一个编译错误，而非运行时错误。查找编译错误要容易得多，因为编译器会立即指出错误，而运行时错误到调试和测试期间才能被发现。
有关此代码模板的最后一个（也是最重要的一个）注意事项是：INPUT 标记的 value 属性是由一个表达式设置的，该表达式使用了 Translator 的一个 getter 方法。value="<%= ltLoan.getBorrowerLastName() %> 这行代码是此模式最重要的部分之一，因为它就是使输入域的值缺省为网站访问者最初输入的值的代码。通过将此值缺省设置为网站访问者最初输入的值，访问者就能看到他最初输入的内容，并很容易地修正他的错误。这节省了网站访问者的时间，并能使其获得更好的用户体验。
servlet
下面是一个典型的简化 servlet：
public void doPost(HttpServletRequest request, HttpServletResponse response)
{
// 缺省设置是使用户返回输入页。
String sRedirect = LOAN_JSP;
// 获取 Translator 的正确实例
LoanTranslator ltTrans = LoanTranslator.getInstance(request);
// 现在有了 Translator 的一个实例
ltTrans.processForm(request);
// 获取 Loan 的正确版本的逻辑
Loan lnTheLoan = null;
if (ltTrans.isNew () == true)
{
// 创建新 Loan
}
else
{
// 获得现有的 loan
}
// Sync the Loan object values to values in the submitted form.
ltTrans.syncModelToGui(lnTheLoan);
// 确保未出现任何错误
if (ltTrans.hasErrors() == false)
{
// 提交 Loan 信息，然后将重定向设置为正确的尾随页
sRedirect = LOAN_CONFIRMATION;
}
// 将网站访问者重定向为当前工资。
try {
response.sendRedirect(sRedirect);
}
catch (Exception e)
{
// 错误逻辑
}
}
servlet 的主要用途是控制 JSP 文件之间的导航流以及对业务对象执行持久化。此 servlet 的代码很简单。
servlet 执行的第一个操作就是从 HttpServletRequest 中获取 Translator 对象的一个实例。
随后 servlet 使用 processForm() 方法将对所提交的 HTML 表单的处理委派给 Translator。
在 Translator 分析表单之后，servlet 将确定是否需要从第二存储中创建或检索业务对象（示例中的 Loan）。
在 servlet 拥有业务对象的一个实例之后，servlet 就会调用 Translator 对象的 syncModelToGui()。syncModelToGui() 随后将网站访问者提交的全部值转换为业务对象可识别的值。
在 Translator 完成值的同步之后，servlet 将检查当试图转换网站访问者输入的值时，Translator 是否记录了任何错误。
如果没有记录任何错误，servlet 就会将网站访问者重定向到确认页（通常是另一个 JSP 文件，它同样能显示来自 Translator 的值）。
如果记录了错误，servlet 就将网站访问者重定向到输入表单，这样他就可以修正错误。
Translator 对象
因为 Translator 对象是 JSP 文件、servlet 和业务对象之间的联系纽带，所以要求它是有状态的，并且要求它在 HTTP 请求（或线程）之间维护状态。为了符合这个标准，Translator 对象需要起到类似伪孤子 (pseudo singleton) 那样的作用。Translator 类有五个主要部分，另外还有一个前面未曾提及的 Object Translator 类库。
getInstance()
syncGuiToModel()
若干 getter 方法
processForm()
syncModelToGui()
Object Translators 库
为了调用 Translator 对象的一个实例，调用程序必须调用静态方法 getInstance(HttpServletRequest)。getInstance() 方法将确定是否应返回 Translator 的一个新实例，或者是否应从 HttpSession 中重用某个实例。该方法通过查看定制参数 action 来实现这一点。此参数是随 HTTP 请求（例如，http://localhost/registerLoan.jsp?action=new）一起传递的。下面的样例代码段显示了 getInstance() 的内容：
public static LoanRegistrationTranslator getInstance(HttpServletRequest request)
{
// 声明返回值变量。
LoanRegistrationTranslator lrtRV = null;
// HttpSession 是必需的，因此在此处将它提取出来。
HttpSession session = request.getSession();
// 从 request 对象中检索 action 参数。
String sAction = parseString(request, ACTION);
// 确定我们要返回哪种 Translator。
if (ACTION_PROCESS.equals(sAction) == true)
{
// 因为 action 参数被设置为 process，这表示我们正在处理一个现有的
// Translator，所以从 HttpSession 中将这个 translator 提取出来。
lrtRV = (LoanRegistrationTranslator)
session.getValue(HttpSessionValueKeys.LOAN_REGISTRATION_TRANSLATOR);
}
else if (sAction == null || "".equals(sAction) == true ||
ACTION_NEW.equals(sAction) == true)
{
// 由于未设置或根本未传递 action，所以缺省操作是创建一个新的 translator。
// 另一种可能是 action 为 "new"
lrtRV = new LoanRegistrationTranslator();
session.putValue(HttpSessionValueKeys.LOAN_REGISTRATION_TRANSLATOR, lrtRV);
}
else
{
// 由于 action 不满足前面的任何检查，即 action 值是位于辅助存储器中的
// 一个现有 Loan 的 ID，所以这次创建一个 LoanRegistrationTranslator，
// 其值被预设为已保存的 loan 中的值。
lrtRV = new LoanRegistrationTranslator(sAction);
session.putValue(HttpSessionValueKeys.LOAN_REGISTRATION_TRANSLATOR, lrtRV);
}
// 返回 Translator 对象的一个实例。
return lrtRV;
}
对于要在 JSP 文件中显示的每个业务对象值，Translator 都提供了一个 getter 方法。这些 getter 方法由 JSP 文件调用。必须在 JSP 文件中显示的每个业务对象属性都有一个 getter 方法。getter 方法总是返回一个 String。返回的 String 值已被预先格式化，以便直接在 JSP 文件中显示。预先格式化 String 是为了使 JSP 文件中的 Java 代码尽可能少。对这些值的格式化改为在 syncGuiToModel() 中进行。
Translator 使用 processForm() 清除以前显示的错误，并从提交的表单中分析此信息。当 servlet 接收到一个提交的表单时，它就会将对该表单的处理委托给 Translator。在本委托期间，Translator 分析提交表单的值，并将这些值分别存储在 String 变量中。这些存储变量随后通过 syncModelToGui()（由 servlet 调用）转换为业务对象的值。
syncGuiToModel() 和 syncModelToGui() 是两个类似的方法，顾名思义，其中一个方法按某个方向对值执行同步，而另一个方法按相反的方向执行同步。syncGuiToModel() 从业务对象的属性中提取这些值，并使用 Object Translator 预先格式化每个属性值。Object Translator 将值预先格式化为要在屏幕上显示的值。随后，它将 Translator 的对应 String 变量设置为这个值。syncModelToGui() 执行的操作相同，但方向相反。下面是从典型的 syncGuiToModel() 中摘出的一小段代码：
DoubleTranslator dtDouble = new DoubleTranslator();
String sTemp = dtDouble.translate(loan.getInterestRate());
setInterestRate(sTemp);
为了使转换代码具有最大的可重用性，并为整个站点提供一种共同的转换，syncGuiToModel() 和 syncModelToGui() 使用的都是 Object Translator 类。Object Translators 与 Translator 对象联系得如此紧密，以致于几乎可将它们看作是 Translator 对象的规则。Object Translator 类是一个简单的类，它的唯一用途就是将一种数据类型转换为格式化字符串，以及将格式化字符串转换为它的数据类型。下面是一个很简单的 Object Translator 类的代码：
public class DoubleTranslator extends ObjectTranslator
{
public String translate(double doubleValue)
{
return Double.toString(doubleValue);
}
public double translate(String stringToBeTranslated) throws Exception
{
double dRV = 0.0;
try {
Double dbDouble = Double.valueOf(stringToBeTranslated);
dRV = dbDouble.doubleValue();
}
catch(Exception e)
{
Exception eTranslation =
new Exception("Please enter a numeric value like 1.0 or 1.25");
throw eTranslation;
}
return dRV;
}
}
当这个样例 Object Translator 将 double 转换为格式化的 String 时，它只需调用 Double.toString()。这个方法可实现更强大的功能，例如，可以添加几行代码，使得当格式化类似 1000.25 这样的大 double 值时，可预格式化这个值，以便显示为 1,000.25。
对于 DoubleTranslator.translate(String)，须注意的重要一点是，它会发出一个可读性很好的异常，而不是标准的 Java.lang.NumberFormatException 异常。JSP 文件将此异常的消息直接显示给网站访问者，因此，让网站的普通访问者很容易地理解该方法发出的异常是非常重要的。
小结
使用 Translator 模式框架的优点很多，不仅可以降低网站的成本，而且可以提高用户的满意度。由于不同组件都只执行专门的任务，因而网站的构建成本降低了。这些专门任务分配给生产小组，如 HTML 小组或 Java 程序员小组。因为 Translator 模式的 ObjectTranslators 在整个网站重用，所有全部格式化和分析都是以相同的方式进行的。因为每项任务都以相同的方式完成，所以网站访问者就能够以一致的方式查看整个网站的信息。这进一步提高了用户的满意度。
参考资源
下载本文所用示例的源代码。
下面的 developerWorks 教程可帮助您进一步了解 servlet 和 JSP 文件：
Building Java HTTP servlets
Building servlets with session tracking
Introduction to JavaServer Pages technology
作者简介
Donald Bell 是 IBM 全球服务中心的 IT 专家，他为客户提供有关基于 Web 的技术应用指导。可以通过 [email protected] 与他联系。
发布人:netbull 来自:LinuxAid