使用 Struts 2 开发 RESTful 服务

通过查看 RestActionMapper 的 API 说明，我们发现它可接受如下几个参数：

• struts.mapper.idParameterName：用于设置 ID 请求参数的参数名，该属性值默认是 id。
• struts.mapper.indexMethodName：设置不带 id 请求参数的 GET 请求调用 Action 的哪个方法。该属性值默认是 index。
• struts.mapper.getMethodName：设置带 id 请求参数的 GET 请求调用 Action 的哪个方法。该属性值默认是 show。
• struts.mapper.postMethodName：设置不带 id 请求参数的 POST 请求调用 Action 的哪个方法。该属性值默认是 create。
• struts.mapper.putMethodName：设置带 id 请求参数的 PUT 请求调用 Action 的哪个方法。该属性值默认是 update。
• struts.mapper.deleteMethodName：设置带 id 请求参数的 DELETE 请求调用 Action 的哪个方法。该属性值默认是 destroy。
• struts.mapper.editMethodName：设置带 id 请求参数、且指定操作 edit 资源的 GET 请求调用 Action 的哪个方法。该属性值默认是 edit。
• struts.mapper.newMethodName：设置不带 id 请求参数、且指定操作 edit 资源的 GET 请求调用 Action 的哪个方法。该属性值默认是 editNew。

  在 RestActionMapper 的方法列表中，我们看到 setIdParameterName、setIndexMethodName、setGetMethodName、setPostMethodName、setPutMethodName、setDeleteMethodName、setEditMethodName、setNewMethodName 等方法，这些方法对应为上面列出的方法提供 setter 支持。

  通常情况下，我们没有必要改变 RestActionMapper 的参数，直接使用这些参数的默认值就可支持 Rails 风格的 REST。根据前面介绍可以看出：支持 REST 风格的 Action 至少包含如下 7 个方法：

  • index：处理不带 id 请求参数的 GET 请求。
  • show：处理带 id 请求参数的 GET 请求。
  • create：处理不带 id 请求参数的 POST 请求。
  • update：处理带 id 请求参数的 PUT 请求。
  • destroy：处理带 id 请求参数的 DELETE 请求。
  • edit：处理带 id 请求参数，且指定操作 edit 资源的 GET 请求。
  • editNew：处理不带 id 请求参数，且指定操作 edit 资源的 GET 请求。

    如果请求需要向服务器发送 id 请求参数，直接将请求参数的值附加在 URL 中即可。表 1 显示了 RestActionMapper 对不同 HTTP 请求的处理结果。

    
    表 1. RestActionMapper 对 HTTP 请求的处理
    
    

    从上面粗体字代码可以看出，BookService 提供了 4 个方法，用于实现对 Book 对象的 CRUD 操作。

    下面开始定义支持 REST 的 Action 类了，这个 Action 类与前面介绍 Struts 2 的普通 Action 存在一些差异——因为该 Action 不再用 execute() 方法来处理用户请求，而是使用前面介绍的 7 个标准方法来处理用户请求。除此之外，该 Action 总是需要处理 id 请求参数，因此必须提供 id 请求参数，并为之提供对应的 setter 和 getter 方法。

    因为本系统已经提供了 Book Model 类，并且为了更好的模拟 Rails 中 ActiveController（Controller）直接访问 ActiveRecord（Model）的方式，本系统采用了 ModelDriven 的开发方式，下面是本系统中支持 REST 的 Action 类的代码。

    
    

    上面 Action 代码中粗体字代码定义了 7 个方法，这 7 个方法正是前面提到的标准方法。除此之外，该 Action 里还包含一个额外的 deleteConfirm() 方法，这个方法用于处理带 id 参数、且指定操作 deleteConfirm 资源的 GET 请求。也就是说，当用户请求 /book/1/deleteConfirm 时，该请求将由该方法负责处理。实际上，RestActionMapper 不仅可以将对 /book/1/edit 的请求映射到 Book 控制器的 edit() 方法，而 1 将作为 id 请求参数。实际上，它可以将任意 /book/1/xxx 的请求映射到 Book 控制器的 xxx() 方法，而 1 是请求参数。上面 Action 类使用了 @Results 进行修饰，这表明当 Action 的任何方法返回“success”逻辑视图时，系统将重定向到 book.action。

    可能有读者会对 index()、create()、show() 三个方法的返回值感到疑惑：它们不再直接返回普通字符串作为逻辑视图名字，而是返回一个以字符串为参数的 DefaultHttpHeaders 对象？其实读者不必对 DefaultHttpHeaders 感到疑惑，其实 DefaultHttpHeaders 只是普通字符串的加强形式，用于 REST 对处理结果进行更多额外的控制。当 Action 类的处理方法返回字符串作为逻辑视图时，Struts 2 只能将其当成一个简单的视图名，仅能根据该视图名映射到实际视图资源，仅此而已。如果使用 DefaultHttpHeaders 作为逻辑视图，DefaultHttpHeaders 除了可以包含普通字符串作为逻辑视图名之外，还可以额外增加更多的控制数据，从而可以增强对 Response 的控制。关于 HttpHeaders 和 DefaultHttpHeaders 的介绍请参考 REST 插件的 API。

    还有一点需要指出，上面的 BookController 控制器实现类的类名并不以 Action 结尾，而是以 Controller 结尾，因此我们可以在 struts.xml 文件中配置如下常量：

    
    

    
    

    上面 JSP 页面非常简单，它负责迭代输出 Action 里包含的集合数据，向该应用 book.action 发送请求将看到如图 1 所示页面。

    
    图 1 使用 Struts 2 开发的 REST 服务
    ?
    

    Struts 2 的 REST 插件支持一种资源具有多少表示形式，当浏览者向 book.xml 发送请求将可以看到如图 2 所示页面。

    
    图 2 REST 服务的 XML 形式
    ?
    

    从图 2 可以看出，该页面正是 Action 所包含的全部数据，当使用 XML 显示时 REST 插件将会负责把这些数据转换成 XML 文档。

    除此之外，REST 插件还提供了 JSON 格式的显示方式，当开发者向 book.json 发送请求将看到如图 3 所示页面。

    
    图 3 REST 服务的 JSON 形式
    ?
    

    Struts 2 的 REST 插件默认支持 XHTML、XML 和 JSON 三种形式的数据。

    当浏览者单击页面右边的“编辑”链接，将会向 book/idVal/edit 发送请求，这是一个包含 ID 请求参数、且指定操作 edit 资源的请求，因此将由 BookController 的 edit() 方法负责处理，处理结束后进入 book-edit.jsp 页面。浏览器里将看到如图 4 所示页面。

    
    图 4 编辑指定图书
    ?
    

    该页面单击“修改”按钮时需要修改图书信息，也就是需要使用 PUT 操作，但由于 HTML 不支持 PUT 操作，因此需要为该表单页增加一个额外的请求参数：_method，该请求参数的值为 put。该表单页的代码如下：

    
    

    该表单将提交给 BookController 的 update() 方法处理，update() 方法将负责修改系统里指定 ID 对应的图书信息。

    与之类似的是，当请求需要执行 DELETE 操作时，一样需要增加名为 _method 的请求参数，并将该请求参数值设置为 delete。

    
    

    参考资料

    • “编写 REST 服务”（developerWorks，2007 年 11 月）：本教程讨论了 REST 和 Atom 发布协议（Atom Publishing Protocol，APP）的概念，并展示如何在服务中进行应用。
      
      
    • “构建 RESTful Web 服务”（developerWorks，2008 年 8 月）：本教程从 REST 的基本概念开始，逐步指导您使用 Restlet 框架构建应用程序。
      
      
    • “基于 REST 的 Web 服务：基础”（developerWorks，2008 年 12 月）： 在本文中，Alex Rodriguez 将向您介绍 REST 的基本原理。
      
      
    • “进一步提升 Struts 2 对 Velocity 的支持力度”（developerWorks，2007 年 7 月）：本文主要介绍如何解决 Struts 2 和最新版本的 Velocity 结合的问题以及进一步提升 Struts 2 对 Velocity 的支持力度。
      
      
    • “基于 Struts 2 构建 WebSphere Portal 上的 Portlet 应用”（developerWorks，2008 年 2 月）：本文的目的就是通过在 IBM 的 WebSphere Portal Server 上开发和部署一个基于 Struts 2 的 Porlet 应用，向读者介绍利用 Struts 2 进行 Portlet 应用开发的优势和关键流程。
      
      
    • “基于 Struts 2 拦截器实现细粒度的基于角色的存取控制”（developerWorks，2008 年 9 月）：本文介绍如何利用 Struts 2 拦截器来为 Java Web 应用添加应用管理的基于角色的存取控制的设计和实现方法。
      
      
    • 参考本文作者李刚编著的图书：《 Struts 2.1 权威指南——基于 WebWork 核心的 MVC 开发》。?
      
      
    • 参考：Struts 2 官方站点。?
      
      
    • 阅读技术文章：Go Light with Apache Struts 2 and REST。?
      
      
    • Java 技术专区：寻找 Java 编程各方面的技术文章。

      ?