内容


面向 Java 开发人员的 Scala 指南

Scala 和 servlet

将 Scala 与 servlet 结合使用

Comments

系列内容:

此内容是该系列 # 部分中的第 # 部分: 面向 Java 开发人员的 Scala 指南

敬请期待该系列的后续内容。

此内容是该系列的一部分:面向 Java 开发人员的 Scala 指南

敬请期待该系列的后续内容。

Scala 显然是一门有趣的语言,很适合体现语言理论和创新方面的新思想,但最终它要用在 “现实” 环境中,它必须能满足开发人员的某些需求并在 “现实” 环境中有一定的实用性。

了解 Scala 语言的一些核心功能之后,就能认识到 Scala 语言的一些灵活性,并能放心使用 Scala 创建 DSL。现在我们进入实际应用程序使用的环境,看看 Scala 如何适应环境。在本系列的新阶段中,我们将首先讨论大部分 Java™ 应用程序的核心:Servlet API。

servlet 回顾

回忆一下 Servlet 101 课程和教程,servlet 环境的核心实际上就是通过一个套接字(通常是端口 80)使用 HTTP 协议的客户机-服务器交换。客户机可以是任何 “用户-代理”(由 HTTP 规范定义),服务器是一个 servlet 容器。servlet 容器在我编写的一个类上查找、加载和执行方法,该类最终必须实现 javax.servlet.Servlet 接口。

通常,实际的 Java 开发人员不会编写直接实现接口的类。因为最初的 servlet 规范是用于为 HTTP 之外的其他协议提供一个通用 API,所以 servlet 命名空间被分为了两部分:

  • 一个 “通用” 包(javax.servlet
  • 一个特定于 HTTP 的包(javax.servlet.http

这样,将在一个称为 javax.servlet.GenericServlet 的抽象基类的通用包中实现一些基本的功能;然后在派生类 javax.servlet.http.HttpServlet 中实现其他特定于 HTTP 的功能,该类通常用作 servlet 实际 “内容” 的基类。HttpServlet 提供了一个 Servlet 的完整实现,将 GET 请求委托给一个将要被覆盖的 doGet 方法,将 POST 请求委托给一个将要被覆盖的 doPut 方法,依此类推。

Hello, Scala 与 Hello, Servlet

显然,任何人编写的第一个 servlet 都是普遍的 “Hello, World” servlet;Scala 的第一个 servlet 示例也是如此。回忆一下许多年之前介绍的 servlet 教程,当时基本的 Java “Hello, World” servlet 只是输出清单 1 所示的 HTML 响应:

清单 1. 预期的 HTML 响应
<HTML>
   <HEAD><TITLE>Hello, Scala!</TITLE></HEAD>
   <BODY>Hello, Scala! This is a servlet.</BODY>
</HTML>

用 Scala 编写一个简单的 servlet 来实现这个操作非常简单,而且这个 servlet 与其相应的 Java 形式几乎一样,如清单 2 所示:

清单 2. Hello, Scala servlet!
import javax.servlet.http.{HttpServlet,
  HttpServletRequest => HSReq, HttpServletResponse => HSResp}

class HelloScalaServlet extends HttpServlet
{
  override def doGet(req : HSReq, resp : HSResp) =
    resp.getWriter().print("<HTML>" +
      "<HEAD><TITLE>Hello, Scala!</TITLE></HEAD>" +
      "<BODY>Hello, Scala! This is a servlet.</BODY>" +
      "</HTML>")
}

注意,我使用了一些适当的导入别名来缩短请求的类型名称和相应类型;除此之外,这个 servlet 几乎与其 Java servlet 形式一样。编译时请记得在 servlet-api.jar(通常随 servlet 容器一起发布;在 Tomcat 6.0 发行版中,它隐藏在 lib 子目录中)中包含一个引用,否则将找不到 servlet API 类型。

这还准备得不够充分;根据 servlet 规范,它必须使用一个 web.xml 部署描述符部署到 Web 应用程序目录中(或一个 .war 文件中),该描述符描述 servlet 应该与哪个 URL 结合。对于这样一个简单的例子,使用一个相当简单的 URL 来配合它最容易,如清单 3 所示:

清单 3. 部署描述符 web.xml
<!DOCTYPE web-app 
    PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" 
    "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
  <servlet>
    <servlet-name>helloWorld</servlet-name>
    <servlet-class>HelloScalaServlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>helloWorld</servlet-name>
    <url-pattern>/sayHello</url-pattern>
  </servlet-mapping>
</web-app>

从这里开始,我假设读者会在必要时调整/修改部署描述符,因为这跟 Scala 没有关系。

当然,格式良好的 HTML 与格式良好的 XML 非常相似;鉴于这一点,Scala 对 XML 字面值的支持使编写这个 servlet 简单得多(参阅 参考资料 中的 “Scala 和 XML” 一文)。Scala 不是在传递给 HttpServletResponse 的 String 中直接嵌入消息,它可以分离逻辑和表示形式(非常简单),方法是利用此支持将消息放在 XML 实例中,然后再传递回去:

清单 4. Hello, Scala servlet!
import javax.servlet.http.{HttpServlet,
  HttpServletRequest => HSReq, HttpServletResponse => HSResp}

class HelloScalaServlet extends HttpServlet
{
  def message =
    <HTML>
      <HEAD><TITLE>Hello, Scala!</TITLE></HEAD>
      <BODY>Hello, Scala! This is a servlet.</BODY>
    </HTML>

  override def doGet(req : HSReq, resp : HSResp) =
    resp.getWriter().print(message)
}

Scala 的内联表达式求值工具使用 XML 字面值,这意味着能够轻松地使 servlet 更有趣。例如,将当前日期添加到消息中与将 Calendar 表达式添加到 XML 中一样简单,不过增加了几行 { Text(java.util.Calendar.getInstance().getTime().toString() ) }。这似乎显得有点冗长,如清单 5 所示:

清单 5. Hello, timed Scala servlet!
import javax.servlet.http.{HttpServlet,
  HttpServletRequest => HSReq, HttpServletResponse => HSResp}

class HelloScalaServlet extends HttpServlet
{
  def message =
    <HTML>
      <HEAD><TITLE>Hello, Scala!</TITLE></HEAD>
      <BODY>Hello, Scala! It's now { currentDate }</BODY>
    </HTML>
  def currentDate = java.util.Calendar.getInstance().getTime()

  override def doGet(req : HSReq, resp : HSResp) =
    resp.getWriter().print(message)
}

实际上,Scala 编译器与 XML 对象消息一起整合到一个 scala.xml.Node 中,然后在将它传递给响应的 Writerprint 方法时将其转换为一个 String。

不要小看这一点 — 表达形式从逻辑中分离出来完全在一个类内部进行。这条 XML 消息将进行编译时检查,以确保语法正确和格式良好,并获得一些标准 servlet(或 JSP)不具备的好处。由于 Scala 可以进行类型推断,因此可以省略有关 messagecurrentDate 的实际类型消息,使得这就像动态语言 Groovy/Grails 一样。初次使用效果不错。

当然,只读 servlet 相当麻烦。

Hello, Scala。这些是参数。

大多数 servlet 不会只返回类似静态内容或者当前日期和时间的简单消息,它们带有 POST 形式的内容,检查内容并进行相应的响应。例如,可能 Web 应用程序需要知道使用者的身份,并询问其姓名:

清单 6. 挑战!
<HTML>
  <HEAD><TITLE>Who are you?</TITLE></HEAD>
  <BODY>
Who are you? Please answer:
<FORM action="/scalaExamples/sayMyName" method="POST">
Your first name: <INPUT type="text" name="firstName" />
Your last name: <INPUT type="text" name="lastName" />
<INPUT type="submit" />
</FORM>
  </BODY>
</HTML>

这个方法不会在任何用户界面设计大赛中夺冠,但是它达到了目的:这是一个 HTML 表单,它会将数据发送给一个新的 Scala servlet(绑定到 sayMyName 的相对 URL)。这些数据将根据 servlet 规范存储在一个名称-值对集合中,可通过 HttpServletRequest.getParameter() API 调用获得。在此调用中,我们将 FORM 元素的名称作为一个参数传递给 API 调用。

从 Java 代码直接转换相对容易一些,如清单 7 中的 servlet 所示:

清单 7. 响应(v1)
class NamedHelloWorldServlet1 extends HttpServlet
{
  def message(firstName : String, lastName : String) =
    <HTML>
      <HEAD><TITLE>Hello, {firstName} {lastName}!</TITLE></HEAD>
      <BODY>Hello, {firstName} {lastName}! It is now {currentTime}.</BODY>
    </HTML>
  def currentTime =
    java.util.Calendar.getInstance().getTime()

  override def doPost(req : HSReq, resp : HSResp) =
  {
    val firstName = req.getParameter("firstName")
    val lastName = req.getParameter("lastName")
  
    resp.getWriter().print(message(firstName, lastName))
  }
}

但这缺少了我之前提到的消息分离的一些好处,因为现在消息定义必须显式使用参数 firstNamelastName;如果响应 get 中使用的元素个数超过 3 个或 4 个,情况就会变得比较复杂。此外,doPost 方法在将参数传递给消息进行显示之前,必须自行提取每一个参数 — 这样的编码很繁琐,并且容易出错。

一种解决方法是将参数提取和 doPost 方法本身的调用添加到一个基类,如清单 8 中的版本 2 所示:

清单 8. 响应(v2)
abstract class BaseServlet extends HttpServlet
{
  import scala.collection.mutable.{Map => MMap}
  
  def message : scala.xml.Node;
  
  protected var param : Map[String, String] = Map.empty
  protected var header : Map[String, String] = Map.empty
  
  override def doPost(req : HSReq, resp : HSResp) =
  {
    // Extract parameters
    //
    val m = MMap[String, String]()
    val e = req.getParameterNames()
    while (e.hasMoreElements())
    {
      val name = e.nextElement().asInstanceOf[String]
      m += (name -> req.getParameter(name))
    }
    param = Map.empty ++ m
    
    // Repeat for headers (not shown)
    //
  
    resp.getWriter().print(message)
  }
}
class NamedHelloWorldServlet extends BaseServlet
{
  override def message =
    <HTML>
      <HEAD><TITLE>Hello, {param("firstName")} {param("lastName")}!</TITLE></HEAD>
      <BODY>Hello, {param("firstName")} {param("lastName")}! It is now {currentTime}.
      </BODY>
    </HTML>

  def currentTime = java.util.Calendar.getInstance().getTime()
}

这个版本使 servlet 显示变得比较简单(相对上一版本而言),而且增加了一个优点,即 paramheader 映射保持不变(注意,我们可以将 param 定义为一个引用请求对象的方法,但这个请求对象必须已经定义为一个字段,这将引发大规模的并发性问题,因为 servlet 容器认为每一个 do 方法都是可重入的)。

当然,错误处理是处理 Web 应用程序 FORM 的重要部分,而 Scala 作为一种函数性语言,保存的内容都是表达式,这意味着我们可以将消息编写为结果页面(假设我们喜欢这个输入),或编写为错误页面(如果我们不喜欢这个输入)。因此,检查 firstNamelastName 的非空状态的验证函数可能如清单 9 所示:

清单 9. 响应(v3)
class NamedHelloWorldServlet extends BaseServlet
{
  override def message =
    if (validate(param))
	  <HTML>
		<HEAD><TITLE>Hello, {param("firstName")} {param("lastName")}!
             </TITLE></HEAD>
		<BODY>Hello, {param("firstName")} {param("lastName")}! 
                It is now {currentTime}.</BODY>
	  </HTML>
    else
      <HTML>
        <HEAD><TITLE>Error!</TITLE></HEAD>
        <BODY>How can we be friends if you don't tell me your name?!?</BODY>
      </HTML>

  def validate(p : Map[String, String]) : Boolean =
  {
    p foreach {
      case ("firstName", "") => return false
      case ("lastName", "") => return false
	  //case ("lastName", v) => if (v.contains("e")) return false
	  case (_, _) => ()
    }
    true
  }

  def currentTime = java.util.Calendar.getInstance().getTime()
}

注意,模式匹配可以使编写比较简单的验证规则变得很容易。利用模式匹配绑定到原始值(比如上一个例子),或者绑定到一个本地变量(比如我们要排除任何姓名中有 “e” 的人,比如上一个注释)。

显然,还有事情需要做!困扰 Web 应用程序的典型问题之一是 SQL 注入攻击,它由通过 FORM 传入的未转义 SQL 命令字符引入,并且在数据库中执行之前连接到包含 SQL 结构的原始字符串。使用 scala.regex 包中的正则表达式支持,或者一些解析器组合子(在本系列最后三篇文章中讨论)可以确认 FORM 验证是否正确。事实上,整个验证过程会提交给使用默认验证实现的基类,该验证实现默认情况下只返回 true(因为 Scala 是函数性语言,所以不要忽略好的对象设计方法)。

结束语

虽然 Scala servlet 框架的功能不像其他一些 Java Web 框架的那样完整,但是我这里创建的这个小 Scala servlet 有两个基本用途:

  • 展示以有趣的方式利用 Scala 的功能,使 JVM 编程更简单。
  • 简单介绍将 Scala 用于 Web 应用程序,这自然会引入 “lift” 框架(参见 参考资料 小节)。

本期到此结束,我们下一期再见!


下载资源


相关主题


评论

添加或订阅评论,请先登录注册

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Java technology
ArticleID=367683
ArticleTitle=面向 Java 开发人员的 Scala 指南: Scala 和 servlet
publish-date=02022009