spring 3.0 应用springmvc 构造RESTful URL 详细讲解

badqiu

浏览: 676257 次
性别:
来自: 珠海

最近访客更多访客>>

szr6991130

baoyang1989

ldn4869

gang_bj

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

Spring 应用服务器 REST Servlet CSS

在线springmvc_rest demo

由于下一版本的rapid-framwork需要集成spring RESTful URL,所以研究了一下怎么搭建. 并碰到了一下问题。

springmvc 3.0 中增加 RESTful URL功能，构造出类似javaeye现在的URL。 rest介绍 , 这里还有struts2 rest构造的一篇文章: 使用 Struts 2 开发 RESTful 服务

简单例子如下,比如如下URL

/blog/1  HTTP GET =>    得到id = 1的blog
/blog/1  HTTP DELETE => 删除 id = 1的blog
/blog/1  HTTP PUT  =>   更新id = 1的blog
/blog     HTTP POST =>   新增BLOG

以下详细解一下spring rest使用.

首先，我们带着如下三个问题查看本文。
1. 如何在java构造没有扩展名的RESTful url,如 /forms/1,而不是 /forms/1.do

2. 由于我们要构造没有扩展名的url本来是处理静态资源的容器映射的，现在被我们的spring占用了，冲突怎么解决?
3. 浏览器的form标签不支持提交delete,put请求，如何曲线解决?

springmvc rest 实现

springmvc的resturl是通过@RequestMapping 及@PathVariable annotation提供的,通过如@RequestMapping(value="/blog/{id}",method=RequestMethod.DELETE)即可处理/blog/1 的delete请求.

@RequestMapping(value="/blog/{id}",method=RequestMethod.DELETE)
public ModelAndView delete(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) {
	blogManager.removeById(id);
	return new ModelAndView(LIST_ACTION);
}

@RequestMapping @PathVariable如果URL中带参数，则配合使用，如

@RequestMapping(value="/blog/{blogId}/message/{msgId}",method=RequestMethod.DELETE)
public ModelAndView delete(@PathVariable("blogId") Long blogId,@PathVariable("msgId") Long msgId,HttpServletRequest request,HttpServletResponse response) {
}

spring rest配置指南

1. springmvc web.xml配置

	<!-- 该servlet为tomcat,jetty等容器提供,将静态资源映射从/改为/static/目录，如原来访问 http://localhost/foo.css ,现在http://localhost/static/foo.css -->
	<servlet-mapping>
		<servlet-name>default</servlet-name>
		<url-pattern>/static/*</url-pattern>
	</servlet-mapping>
	<servlet>
	    <servlet-name>springmvc</servlet-name>
	    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	    <load-on-startup>1</load-on-startup>
	</servlet>
	
	<!-- URL重写filter,用于将访问静态资源http://localhost/foo.css 转为http://localhost/static/foo.css -->
	<filter>
		<filter-name>UrlRewriteFilter</filter-name>
		<filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>
		<init-param>
		    	<param-name>confReloadCheckInterval</param-name>
		    	<param-value>60</param-value>
    		</init-param>
		<init-param>
            		<param-name>logLevel</param-name>
            		<param-value>DEBUG</param-value>
        	</init-param>    	
	</filter>
	<filter-mapping>
		<filter-name>UrlRewriteFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>
	
	<!-- 覆盖default servlet的/, springmvc servlet将处理原来处理静态资源的映射 -->
	<servlet-mapping>
	    <servlet-name>springmvc</servlet-name>
	    <url-pattern>/</url-pattern>
	</servlet-mapping>
	
	<!-- 浏览器不支持put,delete等method,由该filter将/blog?_method=delete转换为标准的http delete方法 -->
	<filter>
		<filter-name>HiddenHttpMethodFilter</filter-name>
		<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
	</filter>
	
	<filter-mapping>
		<filter-name>HiddenHttpMethodFilter</filter-name>
		<servlet-name>springmvc</servlet-name>
	</filter-mapping>

2. webapp/WEB-INF/springmvc-servlet.xml配置,使用如下两个class激活@RequestMapping annotation

    <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>
    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

完整配置

<beans default-autowire="byName"   >

	<!-- 自动搜索@Controller标注的类 -->
	<context:component-scan base-package="com.**.controller"/>
	
    <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>

    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

    <!-- Default ViewResolver -->
    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="prefix" value="/pages"/>
        <property name="suffix" value=".jsp"></property>
    </bean>
    
    <bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource" p:basename="i18n/messages"/>

    <!-- Mapping exception to the handler view -->
    <bean id="exceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    	<!-- to /commons/error.jsp -->
        <property name="defaultErrorView" value="/commons/error"/>
        <property name="exceptionMappings">
            <props>
            </props>
        </property>
    </bean>
        
</beans>

3. Controller编写

/**
 * @RequestMapping("/userinfo") 具有层次关系，方法级的将在类一级@RequestMapping之一,
 * 如下面示例, 访问方法级别的@RequestMapping("/new"),则URL为 /userinfo/new
 */
@Controller
@RequestMapping("/userinfo")
public class UserInfoController extends BaseSpringController{
	//默认多列排序,example: username desc,createTime asc
	protected static final String DEFAULT_SORT_COLUMNS = null; 
	
	private UserInfoManager userInfoManager;
	
	private final String LIST_ACTION = "redirect:/userinfo";
	
	/** 
	 * 通过spring自动注入
	 **/
	public void setUserInfoManager(UserInfoManager manager) {
		this.userInfoManager = manager;
	}
	
	/** 列表 */
	@RequestMapping
	public ModelAndView index(HttpServletRequest request,HttpServletResponse response,UserInfo userInfo) {
		PageRequest<Map> pageRequest = newPageRequest(request,DEFAULT_SORT_COLUMNS);
		//pageRequest.getFilters(); //add custom filters
		
		Page page = this.userInfoManager.findByPageRequest(pageRequest);
		savePage(page,pageRequest,request);
		return new ModelAndView("/userinfo/list","userInfo",userInfo);
	}
	
	/** 进入新增 */
	@RequestMapping(value="/new")
	public ModelAndView _new(HttpServletRequest request,HttpServletResponse response,UserInfo userInfo) throws Exception {
		return new ModelAndView("/userinfo/new","userInfo",userInfo);
	}
	
	/** 显示 */
	@RequestMapping(value="/{id}")
	public ModelAndView show(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) throws Exception {
		UserInfo userInfo = (UserInfo)userInfoManager.getById(id);
		return new ModelAndView("/userinfo/show","userInfo",userInfo);
	}
	
	/** 编辑 */
	@RequestMapping(value="/{id}/edit")
	public ModelAndView edit(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) throws Exception {
		UserInfo userInfo = (UserInfo)userInfoManager.getById(id);
		return new ModelAndView("/userinfo/edit","userInfo",userInfo);
	}
	
	/** 保存新增 */
	@RequestMapping(method=RequestMethod.POST)
	public ModelAndView create(HttpServletRequest request,HttpServletResponse response,UserInfo userInfo) throws Exception {
		userInfoManager.save(userInfo);
		return new ModelAndView(LIST_ACTION);
	}
	
	/** 保存更新 */
	@RequestMapping(value="/{id}",method=RequestMethod.PUT)
	public ModelAndView update(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) throws Exception {
		UserInfo userInfo = (UserInfo)userInfoManager.getById(id);
		bind(request,userInfo);
		userInfoManager.update(userInfo);
		return new ModelAndView(LIST_ACTION);
	}
	
	/** 删除 */
	@RequestMapping(value="/{id}",method=RequestMethod.DELETE)
	public ModelAndView delete(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) {
		userInfoManager.removeById(id);
		return new ModelAndView(LIST_ACTION);
	}

	/** 批量删除 */
	@RequestMapping(method=RequestMethod.DELETE)
	public ModelAndView batchDelete(@RequestParam("items") Long[] items,HttpServletRequest request,HttpServletResponse response) {
		
		for(int i = 0; i < items.length; i++) {
			
			userInfoManager.removeById(items[i]);
		}
		return new ModelAndView(LIST_ACTION);
	}
	
}

上面是rapid-framework 新版本生成器生成的代码,以后也将应用此规则,rest url中增删改查等基本方法与Controller的方法映射规则

	/userinfo 			=> index()
	/userinfo/new		=> _new()
	/userinfo/{id}		=> show()
	/userinfo/{id}/edit 		=> edit()
	/userinfo 	POST		=> create()
	/userinfo/{id} 	PUT	=> update()
	/userinfo/{id} 	DELETE	=> delete()
	/userinfo 	DELETE		=> batchDelete()

注(不使用 /userinfo/add => add() 方法是由于add这个方法会被maxthon浏览器当做广告链接过滤掉,因为包含ad字符)

4. jsp 编写

<form:form action="${ctx}/userinfo/${userInfo.userId}" method="put">
</form:form>

生成的html内容如下, 生成一个hidden的_method=put,并于web.xml中的HiddenHttpMethodFilter配合使用，在服务端将post请求改为put请求

<form id="userInfo" action="/springmvc_rest_demo/userinfo/2" method="post">
	<input type="hidden" name="_method" value="put"/>
</form>

另外一种方法是你可以使用ajax发送put,delete请求.

5. 静态资源的URL重写

如上我们描述，现因为将default servlet映射至/static/的子目录，现我们访问静态资源将会带一个/static/前缀.

如 /foo.gif, 现在访问该文件将是 /static/foo.gif.
那如何避免这个前缀呢，那就是应用URL rewrite,现我们使用 http://tuckey.org/urlrewrite/, 重写规则如下

<urlrewrite>
    <!-- 访问jsp及jspx将不rewrite url,其它.js,.css,.gif等将重写,如 /foo.gif => /static/foo.gif -->
    <rule>
    	<condition operator="notequal" next="and" type="request-uri">.*.jsp</condition>
    	<condition operator="notequal" next="and" type="request-uri">.*.jspx</condition>
        <from>^(/.*\..*)$</from>
        <to>/static$1</to>
    </rule>
</urlrewrite>

另笔者专门写了一个 RestUrlRewriteFilter来做同样的事件，以后会随着rapid-framework一起发布. 比这个更加轻量级.

并且该代码已经贡献给spring,不知会不会在下一版本发布

在线DEMO地址: http://demo.rapid-framework.org.cn:8080/springmvc_rest_demo/userinfo

76
顶

4
踩

分享到：

ibatis3 (mybatis) 实例代码下载兼ibatis3 ... | rapid-framework发布v2.5.0版本

2009-09-21 14:35
浏览 100329
评论(47)
分类:企业架构
查看更多

47 楼 springdata_springmvc 2015-07-27

spring mvc demo教程源代码下载，地址：
http://www.zuidaima.com/share/kspringmvc-p1-s1.htm

46 楼 xining 2014-07-10

这种情况权限怎么拦截？？

45 楼 ZUOZUO 2014-06-03

很好很好很好很好很好很好很好很好很好很好很好很好很好很好

44 楼 huangsky 2014-05-19

如果要提交一个查询表单，里面字段比较多，有些可能为空，例如
userInfo/{userId}/{name}/{mobile}/{email}
如果某个字段空了，前后变成双斜杠，这样会报错，该怎么办？填个默认值上去？

43 楼大程熙 2013-11-19

42 楼 zhuzi1982 2012-10-20

canca 写道

到处加filter,跑起来一个字慢！！！

2个filter而已，你做过大型应用吗？

41 楼 theoffspring 2012-09-16

删除的时候，如果不用表单提交，而直接通过url请求，delete就无效了。delete只能用于表单提交吧。

40 楼 canca 2011-08-31

到处加filter,跑起来一个字慢！！！

39 楼 bluerose 2011-05-07

我发现问题所在了我2台机子上的tomcat版本不一样一个是6.0.32 一个是6.0.x
6.0.32访问静态文件都是404.

38 楼 bluerose 2011-05-07

另外我发现一个特奇怪的问题啊
我在我本本上系统为 winxp sp3上的http://localhost:8086/asd/styles/global.css路径是正常的我通过firebug也可以看得到文件内容

我在我的台式机一个服务器虚拟出来的一个虚拟机上操作系统为windows server 2008.相同的发布包运行访问http://localhost:8086/asd/styles/global.css 却报404错误 firebug查看也一样

彻底无语晕。这是怎么回事啊。除了操作系统不一样.其他都一样，但是后者居然访问不到静态资源。。。。。。。郁闷

37 楼 bluerose 2011-05-07

请教
为什么我的css还是通过正常路径访问呢
http://localhost:8086/asd/styles/global.css
而不用加static?确实没明白麻烦楼主解释下谢谢

36 楼 a123456603 2011-02-22

呵呵, 看的有点明白

35 楼 lovefly_zero 2010-08-04

如果引入了tiles,在tiles-definitions中要如何定义/userinfo/show方法呢？
像
<definition name="/userinfo/show" extends="standard-layout">
<put-attribute name="title" value="UserInfo Search" />
<put-attribute name="body" value="/WEB-INF/controllers/userinfo/detials.jsp" />
</definition>
那么/userinfo/show之后的参数会带过去吗？

34 楼 badqiu 2010-06-19

sijuven 是不厚道的回复，可能是自己扩展搞了一个notmap.
貌似还以为是spring提供该功能。

不过大家可以参考一下。都是为了实现同一个功能。

33 楼 feigme 2010-06-18

woxiangbo 写道

bonny 写道

搞的巨复杂了

我觉得让springmvc的 DispatcherServlet不要映射指定url就可以了

现有的的语法是
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

增加
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet
        </servlet-class>

        <init-param>
            <param-name>notmap</param-name>
            <param-value>/image/**,/css/**,....</param-value>
        </init-param>
               <load-on-startup>2</load-on-startup>
    </servlet>

改写DispatcherServlet不要映射着几个url就可以了。

个人才疏学浅，个人觉得按照楼主添加static前缀比较的绕，反正我是没看懂~，不过你这样的notmap 配制方法也不行，这样配置我也尝试过了，不行~

呵呵，不好意思，我太笨，后来寻思一解决方法，我QQ:273040644，可以加我一起交流哈

我试了也没成功 - -|||
这样倒是可以
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.css</url-pattern>
     </servlet-mapping>

    <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.gif</url-pattern>
     </servlet-mapping>

    <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.jpg</url-pattern>
    </servlet-mapping>

    <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.js</url-pattern>
    </servlet-mapping>

<servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.html</url-pattern>
    </servlet-mapping>

<servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.xml</url-pattern>
    </servlet-mapping>

32 楼 woxiangbo 2010-06-14

bonny 写道

31 楼 sijuven 2010-06-01

bonny 写道

我试着这么改的，怎么不行呢，请教一下，具体怎么配的呢

30 楼 badqiu 2010-05-12

不错，是不知道有这个功能啊，哈！！

29 楼 bonny 2010-05-11

28 楼 badqiu 2010-01-26

gtman 写道

如果应用是nginx与apache做的前端，静态资源都被重写后，这两者的解释静态资源的功能不就都废了？

这个跟你要不要使用nginx处理静态资源完全没有关系，你完全可以使用nginx拦截掉静态资源的处理请求。

发表评论

您还没有登录,请您登录后再发表评论

最近访客更多访客>>

博主相关

文章分类

社区版块

存档分类

最新评论