Springmvc构造RESTful详细讲解

你的名字 2022-08-18 10:49 184阅读 0赞

Rest介绍

![None.gif][] / blog / 1 　HTTP　GET　 => 　　得到id　 = 　1的blog  
![None.gif][] / blog / 1 　HTTP　DELETE　 => 　删除　id　 = 　1的blog  
![None.gif][] / blog / 1 　HTTP　PUT　 => 　　更新id　 = 　1的blog  
![None.gif][] / blog　　　HTTP　POST　 => 　　新增BLOG

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

首先，我们带着如下两个问题查看本文。

1.如何在java构造没有扩展名的RESTful url,如 /forms/1,而不是 /forms/1.do

2.浏览器的form标签不支持提交delete,put请求，如何曲线解决

springmvc rest 实现

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

1 ![None.gif][] @RequestMapping(value = " /blog/\{id\} " ,method = RequestMethod.DELETE)  
 2 ![ExpandedBlockStart.gif][] public 　ModelAndView　delete(@PathVariable　Long　id,HttpServletRequest　request,HttpServletResponse　response)　 \{  
3![InBlock.gif][]　 blogManager.removeById(id);  
4![InBlock.gif][]　 return　new　ModelAndView(LIST\_ACTION);  
5![ExpandedBlockEnd.gif][]\}

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

1 ![None.gif][] @RequestMapping(value = " /blog/\{blogId\}/message/\{msgId\} " ,method = RequestMethod.DELETE)  
 2 ![ExpandedBlockStart.gif][] public 　ModelAndView　delete(@PathVariable( " blogId " )　Long　blogId,  
55![ExpandedSubBlockStart.gif][]　 @PathVariable( " msgId " )　Long　msgId,HttpServletRequest　request,  
55![ExpandedSubBlockStart.gif][]　 HttpServletResponse　response)　 \{  
3![ExpandedBlockEnd.gif][]\}

1.springmvc web.xml配置

1 ![None.gif][]    
  2 ![None.gif][]　  < servlet-mapping >   
  3 ![None.gif][]　  < servlet-name > default </ servlet-name >   
  4 ![None.gif][]　  < url-pattern > /static/\* </ url-pattern >   
  5 ![None.gif][]　  </ servlet-mapping >   
  6 ![None.gif][]　  < servlet >   
  7 ![None.gif][]　　　  < servlet-name > springmvc </ servlet-name >   
  8 ![None.gif][]　　　  < servlet-class > org.springframework.web.servlet.DispatcherServlet </ servlet-class >   
  9 ![None.gif][]　　　  < load-on-startup > 1 </ load-on-startup >   
 10 ![None.gif][]　  </ servlet >   
 11 ![None.gif][]  
 12 ![None.gif][]　     
 13 ![None.gif][]　  < filter >   
 14 ![None.gif][]　  < filter-name > UrlRewriteFilter </ filter-name >   
 15 ![None.gif][]　  < filter-class > org.tuckey.web.filters.urlrewrite.UrlRewriteFilter </ filter-class >   
 16 ![None.gif][]　  < init-param >   
 17 ![None.gif][]　　　　  < param-name > confReloadCheckInterval </ param-name >   
 18 ![None.gif][]　　　　  < param-value > 60 </ param-value >   
 19 ![None.gif][]　　　  </ init-param >   
 20 ![None.gif][]　  < init-param >   
 21 ![None.gif][]　　　　　　　  < param-name > logLevel </ param-name >   
 22 ![None.gif][]　　　　　　　  < param-value > DEBUG </ param-value >   
 23 ![None.gif][]　　　　　  </ init-param >   
 24 ![None.gif][]　  </ filter >   
 25 ![None.gif][]　  < filter-mapping >   
 26 ![None.gif][]　  < filter-name > UrlRewriteFilter </ filter-name >   
 27 ![None.gif][]　  < url-pattern > /\* </ url-pattern >   
 28 ![None.gif][]　  </ filter-mapping >   
 29 ![None.gif][]  
 30 ![None.gif][]　     
 31 ![None.gif][]　  < servlet-mapping >   
 32 ![None.gif][]　　　  < servlet-name > springmvc </ servlet-name >   
 33 ![None.gif][]　　　  < url-pattern > / </ url-pattern >   
 34 ![None.gif][]　  </ servlet-mapping >   
 35 ![None.gif][]  
 36 ![None.gif][]　     
 37 ![None.gif][]　  < filter >   
 38 ![None.gif][]　  < filter-name > HiddenHttpMethodFilter </ filter-name >   
 39 ![None.gif][]　  < filter-class > org.springframework.web.filter.HiddenHttpMethodFilter </ filter-class >   
 40 ![None.gif][]　  </ filter >   
 41 ![None.gif][]  
 42 ![None.gif][]　  < filter-mapping >   
 43 ![None.gif][]　  < filter-name > HiddenHttpMethodFilter </ filter-name >   
 44 ![None.gif][]　  < servlet-name > springmvc </ servlet-name >   
 45 ![None.gif][]　  </ filter-mapping >

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

1 ![None.gif][] < bean  class ="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping" />      
 2 ![None.gif][] < bean  class ="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" />     
 3 ![None.gif][]

3.Controller编写

1 ![ExpandedBlockStart.gif][] /\*\*  
 2![InBlock.gif][]　 \*　@RequestMapping("/userinfo")　具有层次关系，方法级的将在类一级@RequestMapping之一,  
 3![InBlock.gif][]　 \*　如下面示例,　访问方法级别的@RequestMapping("/new"),则URL为　/userinfo/new  
 4![ExpandedBlockEnd.gif][]　 \*/   
  5 ![None.gif][]@Controller  
  6 ![None.gif][]@RequestMapping( " /userinfo " )  
  7 ![ExpandedBlockStart.gif][] public 　 class 　UserInfoController　 extends 　BaseSpringController \{  
 8![InBlock.gif][]　 //默认多列排序,example:　username　desc,createTime　asc  
 9![InBlock.gif][]　 protected　static　final　String　DEFAULT\_SORT\_COLUMNS　=　null;  
10![InBlock.gif][]  
11![InBlock.gif][]　 private　UserInfoManager　userInfoManager;  
12![InBlock.gif][]  
13![InBlock.gif][]　 private　final　String　LIST\_ACTION　=　"redirect:/userinfo";  
14![InBlock.gif][]  
15![ExpandedSubBlockStart.gif][]　 /\*\*  
16![InBlock.gif][]　 \*　通过spring自动注入  
17![ExpandedSubBlockEnd.gif][]　 \*\*/  
18![ExpandedSubBlockStart.gif][]　 public　void　setUserInfoManager(UserInfoManager　manager)　\{  
19![InBlock.gif][]　 this.userInfoManager　=　manager;  
20![ExpandedSubBlockEnd.gif][]　 \}  
21![InBlock.gif][]  
22![ExpandedSubBlockStart.gif][]　 /\*\*　列表　\*/  
23![InBlock.gif][]　 @RequestMapping  
24![ExpandedSubBlockStart.gif][]　 public　ModelAndView　index(HttpServletRequest　request,  
55![ExpandedSubBlockStart.gif][]　 HttpServletResponse　response,  
55![ExpandedSubBlockStart.gif][]

UserInfo　userInfo)　 \{  
25![InBlock.gif][]　 PageRequest<Map>　pageRequest　=　newPageRequest(request,DEFAULT\_SORT\_COLUMNS);  
26![InBlock.gif][]　 //pageRequest.getFilters();　//add　custom　filters　  
27![InBlock.gif][]  
28![InBlock.gif][]　 Page　page　=　this.userInfoManager.findByPageRequest(pageRequest);  
29![InBlock.gif][]　 savePage(page,pageRequest,request);  
30![InBlock.gif][]　 return　new　ModelAndView("/userinfo/list","userInfo",userInfo);  
31![ExpandedSubBlockEnd.gif][]　 \}   
 32 ![InBlock.gif][]  
 33 ![ExpandedSubBlockStart.gif][]　  /\*\*　进入新增　\*/   
 34 ![InBlock.gif][]　 @RequestMapping(value = " /new " )  
 35 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　\_new(HttpServletRequest　request,  
55![ExpandedSubBlockStart.gif][]　 HttpServletResponse　response,

UserInfo　userInfo)　 throws 　Exception　 \{  
36![InBlock.gif][]　 return　new　ModelAndView("/userinfo/new","userInfo",userInfo);  
37![ExpandedSubBlockEnd.gif][]　 \}   
 38 ![InBlock.gif][]  
 39 ![ExpandedSubBlockStart.gif][]　  /\*\*　显示　\*/   
 40 ![InBlock.gif][]　 @RequestMapping(value = " /\{id\} " )  
 41 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　show(@PathVariable　Long　id,  
55![ExpandedSubBlockStart.gif][]　 HttpServletRequest　request,

HttpServletResponse　response)　 throws 　Exception　 \{  
42![InBlock.gif][]　 UserInfo　userInfo　=　(UserInfo)userInfoManager.getById(id);  
43![InBlock.gif][]　 return　new　ModelAndView("/userinfo/show","userInfo",userInfo);  
44![ExpandedSubBlockEnd.gif][]　 \}   
 45 ![InBlock.gif][]  
 46 ![ExpandedSubBlockStart.gif][]　  /\*\*　编辑　\*/   
 47 ![InBlock.gif][]　 @RequestMapping(value = " /\{id\}/edit " )  
 48 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　edit(@PathVariable　Long　id,  
55![ExpandedSubBlockStart.gif][]　 HttpServletRequest　request,

HttpServletResponse　response)　 throws 　Exception　 \{  
49![InBlock.gif][]　 UserInfo　userInfo　=　(UserInfo)userInfoManager.getById(id);  
50![InBlock.gif][]　 return　new　ModelAndView("/userinfo/edit","userInfo",userInfo);  
51![ExpandedSubBlockEnd.gif][]　 \}   
 52 ![InBlock.gif][]  
 53 ![ExpandedSubBlockStart.gif][]　  /\*\*　保存新增　\*/   
 54 ![InBlock.gif][]　 @RequestMapping(method = RequestMethod.POST)  
 55 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　create(HttpServletRequest　request,  
55![ExpandedSubBlockStart.gif][]　 HttpServletResponse　response,  
55![ExpandedSubBlockStart.gif][]　 UserInfo　userInfo)　 throws 　Exception　 \{  
56![InBlock.gif][]　 userInfoManager.save(userInfo);  
57![InBlock.gif][]　 return　new　ModelAndView(LIST\_ACTION);  
58![ExpandedSubBlockEnd.gif][]　 \}   
 59 ![InBlock.gif][]  
 60 ![ExpandedSubBlockStart.gif][]　  /\*\*　保存更新　\*/   
 61 ![InBlock.gif][]　 @RequestMapping(value = " /\{id\} " ,method = RequestMethod.PUT)  
 62 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　update(@PathVariable　Long　id,  
55![ExpandedSubBlockStart.gif][]　 HttpServletRequest　request,  
55![ExpandedSubBlockStart.gif][]

HttpServletResponse　response)　 throws 　Exception　 \{  
63![InBlock.gif][]　 UserInfo　userInfo　=　(UserInfo)userInfoManager.getById(id);  
64![InBlock.gif][]　 bind(request,userInfo);  
65![InBlock.gif][]　 userInfoManager.update(userInfo);  
66![InBlock.gif][]　 return　new　ModelAndView(LIST\_ACTION);  
67![ExpandedSubBlockEnd.gif][]　 \}   
 68 ![InBlock.gif][]  
 69 ![ExpandedSubBlockStart.gif][]　  /\*\*　删除　\*/   
 70 ![InBlock.gif][]　 @RequestMapping(value = " /\{id\} " ,method = RequestMethod.DELETE)  
 71 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　delete(@PathVariable　Long　id,HttpServletRequest　request,

HttpServletResponse　response)　 \{  
72![InBlock.gif][]　 userInfoManager.removeById(id);  
73![InBlock.gif][]　 return　new　ModelAndView(LIST\_ACTION);  
74![ExpandedSubBlockEnd.gif][]　 \}   
 75 ![InBlock.gif][]  
 76 ![ExpandedSubBlockStart.gif][]　  /\*\*　批量删除　\*/   
 77 ![InBlock.gif][]　 @RequestMapping(method = RequestMethod.DELETE)  
 78 ![ExpandedSubBlockStart.gif][]　  public 　ModelAndView　batchDelete(HttpServletRequest　request,  
55![ExpandedSubBlockStart.gif][]　 HttpServletResponse　response)　 \{  
79![InBlock.gif][]　 String\[\]　items　=　request.getParameterValues("items");  
80![ExpandedSubBlockStart.gif][]　 for(int　i　=　0;　i　<　items.length;　i\++)　\{  
81![InBlock.gif][]　　 java.lang.Long　id　=　new　java.lang.Long(items\[i\]);  
82![InBlock.gif][]　　 userInfoManager.removeById(id);  
83![ExpandedSubBlockEnd.gif][]　 \}  
84![InBlock.gif][]　 return　new　ModelAndView(LIST\_ACTION);  
85![ExpandedSubBlockEnd.gif][]　 \}   
 86 ![InBlock.gif][]  
 87 ![ExpandedBlockEnd.gif][]\}   
 88 ![None.gif][]

1 ![None.gif][] /userinfo　　=>　index()  
 2 ![None.gif][]　 /userinfo/new　=>　\_new()  
 3 ![None.gif][]　 /userinfo/\{id\}　=>　show()  
 4 ![None.gif][]　 /userinfo/\{id\}/edit　　=>　edit()  
 5 ![None.gif][]　 /userinfo　POST　=>　create()  
 6 ![None.gif][]　 /userinfo/\{id\}　PUT　=>　update()  
 7 ![None.gif][]　 /userinfo/\{id\}　DELETE　=>　delete()  
 8 ![None.gif][]　 /userinfo　DELETE　=>　batchDelete()  
 9 ![None.gif][]

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

4.jsp 编写

1 ![None.gif][] < form:form　 action ="$\{ctx\}/userinfo$\{userInfo.userId\}" 　method ="put" >   
 2 ![None.gif][] </ form:form >

生成的html内容如下, 生成一个hidden的\_method=put,并于web.xml中的HiddenHttpMethodFilter配合使用，

在服务端将post请求改为put请求

1 ![None.gif][] < form　 id ="userInfo" 　action ="/springmvc\_rest\_demo/userinfo/2" 　method ="post" >   
 2 ![None.gif][]　  < input　 type ="hidden" 　name ="\_method" 　value ="put" />   
 3 ![None.gif][] </ form >

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

5.静态资源的URL重写

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

如 /foo.gif, 现在访问该文件将是 /static/foo.gif.

那如何避免这个前缀呢，那就是应用URL rewrite,现我们使用 [http://tuckey.org/urlrewrite/][http_tuckey.org_urlrewrite], 重写规则如下

1 ![None.gif][] < urlrewrite >   
 2 ![None.gif][]　　     
 3 ![None.gif][]　　  < rule >   
 4 ![None.gif][]　　　  < condition　 operator ="notequal" 　next ="and" 　type ="request-uri" > .\*.jsp </ condition >   
 5 ![None.gif][]　　　  < condition　 operator ="notequal" 　next ="and" 　type ="request-uri" > .\*.jspx </ condition >   
 6 ![None.gif][]　　　　  < from > ^(/.\*\\..\*)$ </ from >   
 7 ![None.gif][]　　　　  < to > /static$1 </ to >   
 8 ![None.gif][]　　  </ rule >   
 9 ![None.gif][] </ urlrewrite >

[None.gif]: /images/20220731/42d282a27e5e493cb3d01bc023be6017.png
[ExpandedBlockStart.gif]: /images/20220731/f9bfaa0d9c3a441c89962ce5f19b75c3.png
[InBlock.gif]: /images/20220731/817bf2a01ab64588bbf1f82c3da8c510.png
[ExpandedBlockEnd.gif]: /images/20220731/ba753f0e3b374eb991d581916e3e9254.png
[ExpandedSubBlockStart.gif]: /images/20220731/0e286fddd19a490b9d6c9398fef8e71a.png
[ExpandedSubBlockEnd.gif]: /images/20220731/b94a73b1acb74c34bc0ea93abefa0564.png
[http_tuckey.org_urlrewrite]: http://tuckey.org/urlrewrite/