Struts2中的零配置与CoC（Convention over Configration）

Struts2中的零配置与CoC（Convention over Configration）

摘要：介绍Struts2中的零配置（Zero Configuration），以及如何用COC来更好地简化Struts2的配置。在第一章，我使用Maven来创建一个起点项目；第二章，以该项目为例，讲解如何使用Struts2的零配置；第三章，论述第二章中的实现方式的缺陷，然后讲解如何使用COC来改进这些缺陷，并进一步简化Struts2的配置。附件是这篇文章用到的示例代码。


一、从零开始
这里，我将建立一个新的示例项目，作为讲解的起点。我使用JDK 6、Maven 2、Eclipse 3.3来建立这个示例，如果读者对Maven2不熟也没关系，这只是个示例。
首先，运行下边的命令：
                mvn archetype:create -DgroupId=demo.struts -DartifactId=demo-struts-coc -DarchetypeArtifactId=maven-archetype-webapp
这会建立如下的目录结构：
|- POM.xml
|- src
     |- main
         |- resources
         |- webapp
             |- index.jsp
             |- WEB-INF
                 |- web.xml
然后我们在src/main目录下新建一个名为java的目录，用来放置java代码。在src下建立test目录，并在test目录下建立java目录，用来放置测试代码。另外，我这个示例不想使用JSP，所以我将src/main/webapp目录下的index.jsp改为index.html。
现在，需要配置该项目要用到哪些lib。在POM.xml中加入struts2-core：

xml 代码

<dependency>   
    <groupId>org.apache.struts</groupId>   
    <artifactId>struts2-core</artifactId>   
    <version>2.0.9</version>   
</dependency>   

另外，我想在Eclipse里使用jetty来启动项目并进行测试，所以在POM.xml中再加入jetty、jetty-util、servlet-api等的依赖，详情见附件。
我希望使用Eclipse来作为这个项目的IDE，所以，我在命令行状态下，进入这个项目所在的目录，运行：
                mvn eclipse:eclipse
然后使用Eclipse导入这个项目。如果你是第一次用Eclipse导入用Maven生成的项目，那你需要在Eclipse里配置一个名叫M2_REPO的Variable，指向你的Maven 2的repository目录。缺省情况下，它应该位于${user.home}/.m2/repository。
OK！现在我们已经可以在Eclipse中进行工作了。
修改src/main/webapp/WEB-INF/web.xml，加入struts2的FilterDispatcher并设置filter-mapping。在这个示例中我将url-pattern设为"/app/*"，也就是说，url的匹配是基于路径来做的。这只是我的个人喜好而已，你也可以将它设成"*"。
既然是在讲struts2的零配置，当然是可以不要任何配置文件的。但是为了更好地进行“配置”，我还是建立了struts.xml文件（在src/main/resources目录下）。我不喜欢url最后都有个action后缀，现在，我在struts.xml中配置struts.action.extension，将这个后缀去掉：

xml 代码

<struts>   
    <constant name="struts.action.extension" value="" />   
</struts>   

然后我在src/test/java下建立demo/RunJetty.java文件，main方法如下：

java 代码

public static void main(String[] args) throws Exception {   
    Server server = new Server(8080); //也可以改成其它端口   
    File rootDir = new File(RunJetty.class.getResource("/").getPath()).getParentFile().getParentFile();   
    String webAppPath = new File(rootDir, "src/main/webapp").getPath();   
    new WebAppContext(server, webAppPath, "/");   
    server.start();   
}   

现在，在Eclipse里运行或调试这个RunJetty.java，用浏览器打开http://localhost:8080/看看吧。如果不出问题，应该可以访问到webapp目录下的index.html了。有了Jetty，你还在用MyEclipse或其它插件么？


二、零配置
首先要澄清一点，这里说的零配置并不是一点配置都没有，只是说配置很少而已。
Struts2（我只用过Struts 2.0.6和2.0.9，不清楚其它版本是否支持零配置）引入了零配置的新特性，元数据可以通过规则和注解来表达：A "Zero Configuration" Struts application or plugin uses no additional XML or properties files. Metadata is expressed through convention and annotation.
目前，这个新特性还在测试阶段，但经过一段时间的使用，我觉得这个特性已经可用。下面我讲一下如何使用它。
1. Actions的定位
以前需要在xml配置文件中配置Action的name和class，如果使用零配置，所带来的一个问题就是如何定位这些Action。我们需要在web.xml中找到struts2的filter的配置，增加一个名为actionPackages的init-param，它的值是一个以逗号分隔的Java包名列表，比如：demo.actions1,demo.actions2。struts2将会扫描这些包（包括这些包下边的子包），在这些包下，所有实现了Action接口的或者是类名以“Action”结尾的类都会被检查到，并被当做Action。
以前，我们写Action必须要实现Action接口或者继承ActionSupport。但是，上面提到的类名以"Action"结尾的类并不需要这样做，它可以是一个POJO，Struts2支持POJO Action！
下面是actionPackages的配置示例：

xml 代码

<filter>   
  <filter-name>struts2</filter-name>   
  <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>   
  <init-param>   
    <param-name>actionPackages</param-name>   
    <param-value>demo.actions1,demo.actions2</param-value>   
  </init-param>   
</filter>   

2. 示例
现在我们建立demo.actions1.app.person和demo.actions2.app.group两个包，在demo.actions1.app.person包下建立ListPeopleAction.java，在demo.actions2.app.group下建立ListGroupAction.java。作为示例，这两个类只是包含一个execute方法，返回"success"或"error"，其它什么都不做：

java 代码

public String execute() {   
    return "success";   
}   

在Filter的配置中，我指定actionPackages为demo.actions1,demo.actions2，当系统启动时，Struts2就会在这两个包下扫描到demo.actions1.app.person.ListPeopleAction和demo.actions2.app.group.ListGroupAction。

3. Action and Package name
Struts2扫描到Action后，从actionPackages指定的包开始，子包名会成为这个Action的namespace，而Action的name则由这个Action的类名决定。将类名首字母小写，如果类名以Action结尾，则去掉"Action"后缀，形成的名字就是这个Action的名字。在如上所述的示例中，actionPackages指定为demo.actions1,demo.actions2，那么你可以这样访问demo.actions1.app.person.ListPeopleAction：
                http://localhost:8080/app/person/listPeople

4. Results
Struts2是通过"Result"和"Results"两个类级别的annotations来指定Results的。
作为示例，我们在webapp目录下建两个html文件：success.html和error.html，随便写点什么内容都可以。现在假设我们访问/app/person/listPeople时，或Action返回success就转到success.html页面，若是error就转到error.html页面，这只需要在ListPeopleAction类上加上一段注解就可以了：

java 代码

@Results({   
    @Result(name="success", type=NullResult.class, value = "/success.html", params = {}),   
    @Result(name="error", type=NullResult.class, value = "/error.html", params = {})   
})   
public class ListPeopleAction {   
    public String execute() {   
        return "success";   
    }   
}   

同上，我们给ListGroupAction也加上注解。
现在，我们已经完成了一个零配置的示例。我们并没有在xml文件里配置ListPeopleAction和ListGroupAction，但它们已经可以工作了！
用Eclipse运行RunJetty，然后用浏览器访问http://localhost:8080/app/person/listPeople和http://localhost:8080/app/group/listGroup看看，是不是正是success.html（或error.html）的内容？

5. Namespaces
如上所述，namespace由包名所形成，但我们可以使用"Namespace"注解来自己指定namespace。

6. Parent Package
这个配置用得较少。Struts2提供一个"ParentPackage"注解来标识Action应该是属于哪个package。


三、使用COC
如上所述，Struts2用注解来实现零配置。然而，这不是我喜欢的方式。在我看来，这不过是将配置从XML格式换成了注解方式，并不是真的零配置。而且，这种方式也未必比XML形式的配置更好。另外，对元数据的修改必然会导致项目的重新编译和部署。还有，现在的Struts2版本似乎对Result注解中的params的处理有些问题。
其实，Struts2的actionPackages配置已经使用了COC，那为什么不能为Results也实现COC，从而去除这些每个Action都要写的注解？
在严谨的项目中，package、action的名称和页面的路径、名称一定存在着某种关系。比如，页面的路径可能和package是对应的，页面的名称可能和action的名称是对应的，或是根据某种法则运算得到。我们知道webwork2和struts2有个配置叫global-results。我们为什么不能根据这些对应规则写个Result，将它配到global-results中，从而真正免去result的配置？
事实上，我推荐Struts2的使用者只用Struts2输出XML或JSON，放弃UI，页面这层还是使用标准的HTML、CSS和一些JS组件来展现。许多人反映Struts2慢，确实，Struts2是慢，很慢！慢在哪儿？很大一部分因素是UI这层引起的，特别是使用了过多的Struts2的tag，并使用了ajax theme。但是，如果我们放弃了Struts2的笨拙的UI，Result只输出XML或JSON，UI则使用标准的HTML+CSS，使用JS组件（DOJO、Adobe Spry Framework、YUI-Ext等）来操作Struts2的输出数据，情况将会如何？我们会得到一个高性能、高可配的、UI和应用服务器的职责分割更为明确、合理的、更易于静态化部署的开发组合。
这似乎是阉割了Struts2，但是这样阉割过的Struts2摆脱了性能低下的包袱，更轻、更现代化。
有些扯远了，言归正传，不管是让Struts2输出XML或JSON，还是输出页面，我们都有办法根据项目的规则写一个Result，将它配到global-results中，从而大大减少Result的配置。
假设我们让Struts2只输出JSON，有个jsonplugin可以做这件事。使用JsonResult时，不再需要知道页面的位置、名称等信息，它仅仅是数据输出，那么我们就可以将这个Result配成全局的，大部分Action将不再需要Result的配置。
作为示例，我假设我的例子中输出的两个html页面（success.html和error.html）是JSON，我们看看怎么免去我例子中的两个Action的Result注解。
首先，我们删去ListPeopleAction和ListGroupAction两个Action的注解，并修改struts.xml文件，加入：

xml 代码

<package name="demo-default" extends="struts-default">   
<global-results>   
<result name="success">/success.html</result>   
</global-results>   
</package>   

请记住这只是一个示例，为了方便，我没在项目中加入jsonplugin来作真实的演示，我只是假设这个success是json输出，读者可以自行使用jsonplugin来作实验。

现在，离成功不远了，但是项目仍然不能正常运行。我们的Action返回success，但并不会匹配到global-results中配置。为什么呢？因为，我们这里是把global-results配置到"demo-default"这个package下的，而Struts2根据actionPackages找到的Action不会匹配到这个package上。解决办法也很简单，还记得上面讲到的Parent Package吧？给Action加个注解，指定ParentPackage为"demo-default"。但这样可不是我喜欢的，其实有更好的办法，我们在struts.xml中加个constant就好了：

xml 代码

<constant name="struts.configuration.classpath.defaultParentPackage" value="demo-default" />   

现在，大功告成！运行RunJetty来测试下吧！你可以访问/app/person/listPeople，可以访问/app/group/listGroup，而所有的配置仅仅是web.xml和struts.xml中的几行，我们的Java代码中也没有加注解。如果再加上几百个Action呢？配置仍然就这几行。
可是，某些Action确实需要配置怎么办？对这些Action，你可以加注解，也可以针对这些Action来写些XML配置。一个项目中，大部分Action的配置是可以遵从一定规则的，可以使用规则来简化配置，只有少部分需要配置，这就是COC。

注：附件demo-struts-annotations.zip是使用注解实现零配置的示例代码，附件demo-struts-coc.zip是使用global-results后的示例代码。
另外，我以前写过一篇文章《改写Restful2ActionMapper让Struts2支持REST风格的URL映射》，这里所说的零配置并不适用于支持REST。也就是说，你要用REST风格的URL映射，你就必须配置。不过还好，使用REST风格后，配置并不复杂。
另外我见到不少人使用Spring来配置和管理Action，其实完全没有必要！设置struts.objectFactory 等于spring就可以了，如果在Action中有setService1，这个service1在Spring中有配置的话，它会自动注入的。Javaeye论坛中早有相关的讨论。

参考：
    http://struts.apache.org/2.x/docs/zero-configuration.html
    http://struts.apache.org/2.x/doc ... ation-scanning.html