LightURL——打造零配置的Struts2开发方式

背景
Struts2已经日益成为Web层比较主流的开发框架，它来源于Webwork2，是一个非常优秀的MVC框架。在Webwork2设计之处，Annotation和Ruby on Rails还没有像现在那么火，所以整个框架在配置方面还是沿用了Web框架惯用的XML作为主要的配置方式。

随着时代的发展，对于Web程序员来说，如何简化配置成了一个很重要的课题。在这方面，Struts2也有一些探索。在Struts2的官方网站上，我们可以找到一些优秀的plugin来做这些工作：

http://cwiki.apache.org/S2PLUGINS/codebehind-plugin.html

http://cwiki.apache.org/S2PLUGINS/smarturls-plugin.html
LightURL的目的是为了吸取这些优秀的plugin的优点，并支持更方便的配置方式。

版本提示

目前LightURL是基于struts2.0.X的版本写出来的。由于struts2.1.X尚属于beta版本，而且与之对应的XWork在IoC这块做了重大的修改，所以，我也暂不打算支持到struts2.1.X。如果使用struts2.1.X结合lighturl发生问题的朋友，请退回到struts的稳定版本。

安装
1. 将struts2-lighturl-plugin.jar加入到classpath下

2. 配置你的web.xml

        
        <!-- Struts Filter -->
    <filter>
        <filter-name>struts</filter-name>
        <filter-class>com.demo2do.lighturl.LightURLFilter</filter-class>
    </filter>

    <!-- Struts URL Definition -->
    <filter-mapping>
        <filter-name>struts</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>    

3. 需要指定你的action package所在位置和一些基本配置

这一步一般在struts.properties中完成。你可以建一个struts.properties的配置文件，并放到classpath下，并指定如下配置

## action package config
lighturl.action.packages=com.demo2do.lighturl.action

## action mapping implementation class
struts.mapper.class=com.demo2do.lighturl.LightURLActionMapper

## default parent package
lighturl.action.default.parent.package=lighturl

## define your entity package (optional)
# lighturl.entity.package=com.demo2do.lighturl.entity

在完成以上的步骤后，lighturl的所有配置即告完成，现在你已经可以使用所有lighturl所提供的特性。

Namespace, ActionName和URL映射

lighturl所提供的最基本的特性是根据你的Action所在的package，确定namespace和actionName，并进行对应的URL映射。

举例说明，你在上面所讲述的struts.properties中，已经指定了你的action package

lighturl.action.packages=com.demo2do.lighturl.action

那么，如果你有以下的Action类，那么lighturl将根据如下的规则来确定每个Action类所对应的namespace，actionName和url映射关系

1. 根据lighturl.action.packages的配置的package到你的Action类的相对package来确定namespace，如果其中有驼峰法命名，那么转化成"-"连接的单词

• com.demo2do.lighturl.action.Index  ----> /
• com.demo2do.lighturl.action.user.Search ----> /user
• com.demo2do.lighturl.action.blog.category.Index ----> /blog/category
• com.demo2do.lighturl.action.accoutDetail.View ----> /account-detail

2. 将Action类的类名转化成actionName。如果碰到的Action类以"Action"结尾，则去掉末尾的"Action"，如果其中有驼峰法命名,那么转化成"-"连接的单词

• com.demo2do.lighturl.action.Index ----> index
• com.demo2do.lighturl.action.user.SearchAction ----> search
• com.demo2do.lighturl.action.blog.CategoryBlog ----> category-blog

3. 将namespace与actionName拼起来，就成构成映射到具体Action类的url

• http://host:port/app/user/index ---> com.demo2do.lighturl.action.user.Index
• http://host:port/app/blog/category-blog ---> com.demo2do.lighturl.action.blog.CategoryBlog

上面的这种URL匹配方式，我称之为：package匹配

特殊形式的URL

应该说根据package来进行Action映射，可以解决绝大多数从url到action的映射配置问题。不过有的时候，我们可能需要支持一些特殊形式的url。LightURL在默认情况下，支持下列2种特殊形式的URL

1. 支持将名为Index的Action直接映射到package上

这种匹配我称之为：Namespace匹配。这一个特性很直观。如果你在某个Action的package下面有一个名为Index的Action类，那么如果你直接访问这个package，那么你可以访问到这个类：

• com.demo2do.lighturl.action.Index ---> http://host:port/app/
• com.demo2do.lighturl.action.user.Index ---> http://host:port/app/user
• com.demo2do.lighturl.action.blog.category.Index ---> http://host:port/app/blog/category

2. 支持类似: /entity/${id}形式的URL

这种匹配我通常称之为：entity匹配。这个特性也比较简单，如果你有某个entity，并且在你的Action package下有一个与entity同名的package。同时在这个package下有一个叫View的Action，那么上述形式的URL会被映射到该Action。

• com.demo2do.lighturl.action.user.View ---> http://host:port/app/user/3456
• com.demo2do.lighturl.action.blog.View ---> http://host:port/app/blog/1113

你可以通过在struts.properties中指定你entity所在的package来对哪些url可以具备这些特性，如果你输入的url不在你所指定的package中含有entity，那么这个url将无法被识别。
针对有些情况，数据库的主键可能不是数字。此时，你可以通过自己实现com.demo2do.lighturl.config.EntityPrimaryKeyIdentifier的接口来指定你的url中id具备什么特点。默认的实现是将主键识别为数字。

不过一般而言，典型的entity匹配是无法满足我们的要求的。因为我们往往不会针对某个entity直接为action建立package，而是会对某个entity，对应到某个Action，它位于某个具体的package。所以针对这样的需求，我对entity匹配做了一定的扩展：

• com.demo2do.lighturl.action.user.admin.View ---> http://host:port/app/user/user/3456
• com.demo2do.lighturl.action.blog.category.View ---> http://host:port/app/blog/category/1113

也就是说，某个具体的package中，名字为View的Action，会对应到类似相同package下增加${id}的url。

使用Annotation来指定映射
除了上述这些基本特性以外，还可以通过Annotaion来指定URL映射。目前情况下，LightURL所支持的Annotation有两种类型:

1. URL完整匹配

URL完整匹配是指如果某个url完整匹配于Annotation中所指定的内容，那么这个URL将被映射到Annotation所在的Action类的method

package com.demo2do.lighturl.action.user;

import com.demo2do.lighturl.annotation.Action;
import com.opensymphony.xwork2.ActionSupport;

/**
 * @author Downpour
 *
 */
public class Search extends ActionSupport {
	
	private static final long serialVersionUID = -1728616675239859226L;
	/* (non-Javadoc)
	 * @see com.opensymphony.xwork2.ActionSupport#execute()
	 */
	@Override
	@Action("/all/search-user")
	public String execute() throws Exception {
		return super.execute();
	}
}

例如，上述的Action类有一个Annotation，那么这个Action和method将被映射到对应的URL:http://host:port/app/all/search-user。
注意，此时，虽然从url上来看，这是一个没有什么规则的url，但是其所对应的namespace和actionName还是根据com.demo2do.lighturl.action.user.Search来进行计算的。

2. URL Template

URL Template是指，url可以匹配Annotaion中指定的某种URL Template，并将其中的可变部分作为参数映射到Action中。

package com.demo2do.lighturl.action.blog;

import com.demo2do.lighturl.annotation.Action;
import com.opensymphony.xwork2.ActionSupport;

/**
 * @author Downpour
 *
 */
public class Category extends ActionSupport {

	private static final long serialVersionUID = -1535992103374733252L;

        private Long id;	
	private int year;	
	private int month;	
	private int day;

	/* (non-Javadoc)
	 * @see com.opensymphony.xwork2.ActionSupport#execute()
	 */
	@Override
	@Action("/blogs/${year}/${month}/${day}")
	public String execute() throws Exception {
		return super.execute();
	}
        
        @Action("/blog/${id}/edit")
	public String edit() throws Exception {
		return super.execute();
	}

        @Action("/blogs/common/*")
	public String common() throws Exception {
		return super.execute();
	}
        // setters and getters
	
}

在上述的例子中，可以发现，在Annotation中所指定的内容是一个URL Template，如果你有一个url，可以匹配上面的URL Template，那么url将匹配到这个Action的method，并且将对应位置的值注入到Action中的同名参数中。

不仅如此，LightURL还能够支持AntPath的URL匹配。这样可以通过书写/blogs/common/*或者/blogs/**来匹配多个不同的URL映射。

针对上面的例子：
http://host:port/app/blogs/2008/08/07将被映射到这个Action的execute，并且2008，08和07分别映射到year，month和day中。
http://host:port/app/blog/2345/edit将被映射到Action的edit方法，并且2345映射到id中作为参数
http://host:port/app/blogs/common/abcd将被映射到Action的common方法。


URL的匹配顺序与重复配置的校验

在上面的例子中，介绍了那么多的url映射到Action中的方式。他们之间可能会出现冲突，有些冲突，LightURL会在系统启动时为你检查出来，并强制要求你纠正它，而有些冲突，则通过优先级匹配的方式进行。

下列冲突将被认为是你必须在系统启动前就进行纠正的：
1. Annotation中定义的URL Template互相之间冲突

例如：/blogs/${year}/${month}/${day}和/blogs/${category}/${id}/edit就是冲突的。

2. Annotation中定义的URL Template与其他Annotation中定义的完全匹配URL冲突

例如：/blogs/${year}/${month}和/blogs/category/index就是冲突的。

3. Annotation中定义的URL Template与形如/entity/${id}的url定义冲突

例如：/user/${id}形式的Annotation定义可能会与系统默认支持的冲突。

在其他情况下，如果你定义的URL映射互相直接有冲突，那么LightURL将根据某个顺序进行URL匹配，并找到第一个匹配的映射方式，然后放弃查找。这个顺序为：
1. 首先进行Namespace匹配，如果url恰好能匹配某个namespace，并且其对应的package下有Index作为Action，那么直接进行匹配。
2. 其次查看所有的Annotation定义中，是否存在完整的URL匹配，如果找到，那么进行直接匹配。
3. 接着进行package匹配，将url分解成相应的namespace和actionName，与已有的配置进行匹配，如果找到，那么直接匹配。
4. 然后进行entity匹配，看看url是否形如:/entity/${id}，如果是，那么直接匹配。
5. 最后进行Annotation定义的Url Template匹配。

如果所有的五种情况都无法进行匹配，那么这个URL将无法被LightURL识别，继续交由Struts2进行后续处理。


上面所描述的内容都是Url到Action的映射。下面的部分，描述的是如何在Action执行完毕之后，转到相应的结果view。

Codebehind

LightURL支持codebehind。有关codebehind的相关知识，可以参考struts2的相关文档：
http://struts.apache.org/2.x/docs/codebehind-plugin.html

有了codebehind的支持，那么从Action转到类似jsp，ftl或者vm的view层组件就不需要任何配置，只要符合一定的命名规范，就可以直接进行转向。

在这里，LightURL不仅实现了Codebehind的所有功能。而且，LightURL还对Codebehind的规则做出了扩展。

Codebehind在寻址JSP等资源时，顺序按照以下的规则进行：

1. /namespace/actionName-<resultCode>.<ext>

2. /namespace/actionName.<ext>


而LightURL在寻址JSP等资源时，增加了一定的规则，并且按照如下顺序进行：

1. /namespace/actionName-<resultCode>.<ext>

2. /namespace/<resultCode>.<ext>

3. /namespace/actionName.<ext>

4. /namespace/namespace-actionName-<resultCode>.<ext>

5. /namespace/namespace-<resultCode>.<ext>

6. /namespace/namespace-actionName.<ext>

这样一来，大家就有更加宽广的选择范围，进行默认资源的寻址匹配了。

ResultCode的识别

但是在很多情况下，我们需要的是全方位的Result类型的支持。例如，有的时候我们需要返回JSON Result，有的时候，我们可能需要Redirect到一个新的Action。此时，我们不得不为此增加一些配置，或者借助Annotation来完成。

为此，LightURL提供了一种根据ResultCode进行识别的命名方式来匹配你所指定的Result。

以JSON Result为例，你可以这么写：

package com.demo2do.lighturl.action.user;

import com.demo2do.lighturl.entity.User;
import com.opensymphony.xwork2.ActionSupport;

/**
 * @author Downpour
 *
 */
public class Index extends ActionSupport {

	private static final long serialVersionUID = -5017825114664788765L;

	private User user;
	
	/* (non-Javadoc)
	 * @see com.opensymphony.xwork2.ActionSupport#execute()
	 */
	@Override
	public String execute() throws Exception {
		return "j:user";
	}

        // setters and getters
}

在这里，你可以发现，resultCode变成了j:user。那么此时，LightURL会将这个resultCode识别成：请返回JSON Result，并且JSON的Result的root为user对象。

再例如：

package com.demo2do.lighturl.action.user;

import com.demo2do.lighturl.entity.User;
import com.opensymphony.xwork2.ActionSupport;

/**
 * @author Downpour
 *
 */
public class Index extends ActionSupport {

	private static final long serialVersionUID = -5017825114664788765L;

	private User user;
	
	/* (non-Javadoc)
	 * @see com.opensymphony.xwork2.ActionSupport#execute()
	 */
	@Override
	public String execute() throws Exception {
		return "r:/user/add-user";
	}

        // setters and getters
}

在这里，"r:/user/add-user"会被识别成：请返回Redirect Result。Redirect的URL为/user/add-user。

LightURL默认情况下，实现了对Redirect Result和JSON Result的ResultCode识别，并将他们的前缀分别定制为："r:"("redirect:")或者"j:"("json:")。

当然，你可以根据你自己的情况，实现你自己的ResultCode的识别程序，你只需要实现com.demo2do.lighturl.result.ResultCodeConfig接口即可。并在struts.properties中指定你希望LightURL进行ResultCode匹配的顺序。

lighturl.result.code.config=yourpackage.ResultCodeConfigImpl1,yourpackage.ResultCodeConfigImpl2

这样，LightURL会根据你所指定的顺序，依次进行ResultCode的匹配，直到找到第一个匹配的Result Type为之。

当然，默认情况下，LightURL的匹配顺序为：

codebehind -> 你自定义的ResultCode识别实现 -> json -> redirect

评论

16 楼 downpour 2008-09-28  

robbin 写道

很棒的尝试。不过何不参考Rails的REST URL机制进行URL规则的设计呢？

之前是这么想的，不过又不想限制得太死，所以暂时就采用了annotation的方式，允许类Url模板的形式出现。

我想下一个版本可能会考虑与Rails的RESTFUL URL机制一致。

15 楼 robbin 2008-09-28  

很棒的尝试。不过何不参考Rails的REST URL机制进行URL规则的设计呢？

14 楼 jyasa 2008-09-28  

小日本一直看不惯的就是“配置”
叫的口号也一直是“简化配置”

13 楼 downpour 2008-09-28  

h521999 写道

  感觉不错，省去了xml文件的配置，方便、简单许多！
  但是我有一个问题请教？
假如到后面要做些配置的更改，那岂不是又要重新编译类，如果是写在xml文件里的话，是否比写在类里更方便呢？

不要被那些所谓的修改配置不用编译源文件的假象骗了。

目前的情况下，绝大多数的系统配置，是在系统启动的时候load到内存中，在运行过程中不再做修改。struts虽然有reload的选项，但是在生产环境中，我们绝不可能采用这种选项。那么配置写在xml和写在源文件中有什么本质区别呢？我认为唯一的区别就在于配置是否需要分离关注点。至于是否重新编译，并不是问题的关键。

其实这个帖子的重点并不在于省去什么配置，或者把配置挪了个位置，而在于我们对url的正确规划和设计。举例来说，就在我回帖的时候，浏览器的url地址是这样：
http://www.iteye.com/forums/39/topics/242838/posts/682362/quote

至今为止，我还没有见到一个Java的Framework可以做到支持上面这样的表述完整而清晰的url，这可能是rails占有其很大优势的地方。所以我一直试图把url的正确规划和设计引入到Java中来。LightURL就是为了实现这一点。

所以希望大家不要仅仅把关注点集中在配置多少、配置放在什么地方来考虑问题，而把更多的关注点放在你如何来安排你的表示层url和你的Action代码上去。

12 楼 h521999 2008-09-27  

  感觉不错，省去了xml文件的配置，方便、简单许多！
  但是我有一个问题请教？
假如到后面要做些配置的更改，那岂不是又要重新编译类，如果是写在xml文件里的话，是否比写在类里更方便呢？

11 楼 downpour 2008-09-27  

zhudp.cn 写道

前半部分的那几种基本匹配觉得还不错，后面的感觉并没有减少配置数，就像kjj说的

引用

配置从xml分散到源文件中了

还有几个问题，下面这个例子是不是有点错误啊？

引用

com.demo2do.lighturl.action.user.View ---> http://host:port/app/user/3456
com.demo2do.lighturl.action.blog.View ---> http://host:port/app/user/1113

下面这个代码，怎么感觉不像Java代码呢，  
@Override 
@Action("/all/search-user")
能编译通过吗？还是要装了插件才能通过？ 

    /* (non-Javadoc)  
     * @see com.opensymphony.xwork2.ActionSupport#execute()  
     */  
    @Override  
    @Action("/all/search-user")   
    public String execute() throws Exception {   
        return super.execute();   
    }   

这是Annotation，如何会编译不过？

com.demo2do.lighturl.action.blog.View ---> http://host:port/app/user/1113 写错了，正确的应该对应：
com.demo2do.lighturl.action.blog.View ---> http://host:port/app/blog/1113

10 楼 zhudp.cn 2008-09-27  

前半部分的那几种基本匹配觉得还不错，后面的感觉并没有减少配置数，就像kjj说的

引用

配置从xml分散到源文件中了

还有几个问题，下面这个例子是不是有点错误啊？

引用

com.demo2do.lighturl.action.user.View ---> http://host:port/app/user/3456
com.demo2do.lighturl.action.blog.View ---> http://host:port/app/user/1113

下面这个代码，怎么感觉不像Java代码呢，  
@Override 
@Action("/all/search-user")
能编译通过吗？还是要装了插件才能通过？ 

    /* (non-Javadoc)  
     * @see com.opensymphony.xwork2.ActionSupport#execute()  
     */  
    @Override  
    @Action("/all/search-user")   
    public String execute() throws Exception {   
        return super.execute();   
    }   

9 楼 四输五金 2008-09-27  

不错，有机会要尝试一下

8 楼 ahuaxuan 2008-09-27  

很不错,我会在下个项目中使用

7 楼 simon511 2008-09-27  

谢谢楼主分享，有空要看看.
用package的配制方式不较不错，annotation就感觉不好

6 楼 downpour 2008-09-27  

kjj 写道

配置从xml分散到源文件中了

不愿意写annotation的，可以用package匹配，这样就没有任何配置了。

mycybyb 写道

配置方式太多反而麻烦，为什么不只使用一种呢？

最近做的一个框架就支持自动匹配Action和其中的方法，支持各种返回，如jsp，ftl，vm，json，xml。当然也可以自定义。实现一个接口就行。

这个插件的目的主要是为了优化你的url，同时兼容原有的基于命名的匹配方式。

yoohoo.lai 写道

有一个问题想问一下, struts2的拦截器,应该怎么配

拦截器你可以自己根据需要，编写你自己的拦截器堆栈配置，并配置成某个struts.xml中的package.  一般默认情况下，会有一个default的package定义，你可以在struts.properties里面定义。如果针对某个action有特定的拦截器定义，你可以在action的class级别定义annotation，指定@parentPackage来覆盖你的拦截器配置。

5 楼 yoohoo.lai 2008-09-27  

有一个问题想问一下, struts2的拦截器,应该怎么配

4 楼 mycybyb 2008-09-27  

配置方式太多反而麻烦，为什么不只使用一种呢？

最近做的一个框架就支持自动匹配Action和其中的方法，支持各种返回，如jsp，ftl，vm，json，xml。当然也可以自定义。实现一个接口就行。

3 楼 kjj 2008-09-27  

配置从xml分散到源文件中了

2 楼 Jackphone 2008-09-26  

看起来相当不错，我要试试

1 楼 downpour 2008-09-26  

更新了jar包和对应的source。