Springmvc构造RESTful详细讲解

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Springmvc构造RESTful详细讲解相关的知识,希望对你有一定的参考价值。

/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.浏览器的form标签不支持提交delete,put请求,如何曲线解决

    springmvc rest 实现

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

 

1技术分享@RequestMapping(value="/blog/{id}",method=RequestMethod.DELETE)
2技术分享public ModelAndView delete(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) {
3技术分享  blogManager.removeById(id);
4技术分享  return new ModelAndView(LIST_ACTION);
5技术分享}

 

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

 

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

 

    1.springmvc web.xml配置

 1技术分享<!-- 该servlet为tomcat,jetty等容器提供,将静态资源映射从/改为/static/目录,如原来访问 http://localhost/foo.css ,现在http://localhost/static/foo.css -->
 2技术分享  <servlet-mapping>
 3技术分享  <servlet-name>default</servlet-name>
 4技术分享  <url-pattern>/static/*</url-pattern>
 5技术分享  </servlet-mapping>
 6技术分享  <servlet>
 7技术分享    <servlet-name>springmvc</servlet-name>
 8技术分享    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 9技术分享    <load-on-startup>1</load-on-startup>
10技术分享  </servlet>
11技术分享
12技术分享  <!-- URL重写filter,用于将访问静态资源http://localhost/foo.css 转为http://localhost/static/foo.css -->
13技术分享  <filter>
14技术分享  <filter-name>UrlRewriteFilter</filter-name>
15技术分享  <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>
16技术分享  <init-param>
17技术分享     <param-name>confReloadCheckInterval</param-name>
18技术分享     <param-value>60</param-value>
19技术分享    </init-param>
20技术分享  <init-param>
21技术分享        <param-name>logLevel</param-name>
22技术分享        <param-value>DEBUG</param-value>
23技术分享      </init-param>
24技术分享  </filter>
25技术分享  <filter-mapping>
26技术分享  <filter-name>UrlRewriteFilter</filter-name>
27技术分享  <url-pattern>/*</url-pattern>
28技术分享  </filter-mapping>
29技术分享
30技术分享  <!-- 覆盖default servlet的/, springmvc servlet将处理原来处理静态资源的映射 -->
31技术分享  <servlet-mapping>
32技术分享    <servlet-name>springmvc</servlet-name>
33技术分享    <url-pattern>/</url-pattern>
34技术分享  </servlet-mapping>
35技术分享
36技术分享  <!-- 浏览器不支持put,delete等method,由该filter将/blog?_method=delete转换为标准的http delete方法 -->
37技术分享  <filter>
38技术分享  <filter-name>HiddenHttpMethodFilter</filter-name>
39技术分享  <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
40技术分享  </filter>
41技术分享
42技术分享  <filter-mapping>
43技术分享  <filter-name>HiddenHttpMethodFilter</filter-name>
44技术分享  <servlet-name>springmvc</servlet-name>
45技术分享  </filter-mapping>

 

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

 

 

1技术分享<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>   
2技术分享<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>  
3技术分享

 

    3.Controller编写

 1技术分享/**
 2技术分享  * @RequestMapping("/userinfo") 具有层次关系,方法级的将在类一级@RequestMapping之一,
 3技术分享  * 如下面示例, 访问方法级别的@RequestMapping("/new"),则URL为 /userinfo/new
 4技术分享  */
 5技术分享@Controller
 6技术分享@RequestMapping("/userinfo")
 7技术分享public class UserInfoController extends BaseSpringController{
 8技术分享  //默认多列排序,example: username desc,createTime asc
 9技术分享  protected static final String DEFAULT_SORT_COLUMNS = null;
10技术分享
11技术分享  private UserInfoManager userInfoManager;
12技术分享
13技术分享  private final String LIST_ACTION = "redirect:/userinfo";
14技术分享
15技术分享  /**
16技术分享  * 通过spring自动注入
17技术分享  **/
18技术分享  public void setUserInfoManager(UserInfoManager manager) {
19技术分享  this.userInfoManager = manager;
20技术分享  }
21技术分享
22技术分享  /** 列表 */
23技术分享  @RequestMapping
24技术分享  public ModelAndView index(HttpServletRequest request,HttpServletResponse response,UserInfo userInfo) {
25技术分享  PageRequest<Map> pageRequest = newPageRequest(request,DEFAULT_SORT_COLUMNS);
26技术分享  //pageRequest.getFilters(); //add custom filters 
27技术分享
28技术分享  Page page = this.userInfoManager.findByPageRequest(pageRequest);
29技术分享  savePage(page,pageRequest,request);
30技术分享  return new ModelAndView("/userinfo/list","userInfo",userInfo);
31技术分享  }
32技术分享
33技术分享  /** 进入新增 */
34技术分享  @RequestMapping(value="/new")
35技术分享  public ModelAndView _new(HttpServletRequest request,HttpServletResponse response,UserInfo userInfo) throws Exception {
36技术分享  return new ModelAndView("/userinfo/new","userInfo",userInfo);
37技术分享  }
38技术分享
39技术分享  /** 显示 */
40技术分享  @RequestMapping(value="/{id}")
41技术分享  public ModelAndView show(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) throws Exception {
42技术分享  UserInfo userInfo = (UserInfo)userInfoManager.getById(id);
43技术分享  return new ModelAndView("/userinfo/show","userInfo",userInfo);
44技术分享  }
45技术分享
46技术分享  /** 编辑 */
47技术分享  @RequestMapping(value="/{id}/edit")
48技术分享  public ModelAndView edit(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) throws Exception {
49技术分享  UserInfo userInfo = (UserInfo)userInfoManager.getById(id);
50技术分享  return new ModelAndView("/userinfo/edit","userInfo",userInfo);
51技术分享  }
52技术分享
53技术分享  /** 保存新增 */
54技术分享  @RequestMapping(method=RequestMethod.POST)
55技术分享  public ModelAndView create(HttpServletRequest request,HttpServletResponse response,UserInfo userInfo) throws Exception {
56技术分享  userInfoManager.save(userInfo);
57技术分享  return new ModelAndView(LIST_ACTION);
58技术分享  }
59技术分享
60技术分享  /** 保存更新 */
61技术分享  @RequestMapping(value="/{id}",method=RequestMethod.PUT)
62技术分享  public ModelAndView update(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) throws Exception {
63技术分享  UserInfo userInfo = (UserInfo)userInfoManager.getById(id);
64技术分享  bind(request,userInfo);
65技术分享  userInfoManager.update(userInfo);
66技术分享  return new ModelAndView(LIST_ACTION);
67技术分享  }
68技术分享
69技术分享  /** 删除 */
70技术分享  @RequestMapping(value="/{id}",method=RequestMethod.DELETE)
71技术分享  public ModelAndView delete(@PathVariable Long id,HttpServletRequest request,HttpServletResponse response) {
72技术分享  userInfoManager.removeById(id);
73技术分享  return new ModelAndView(LIST_ACTION);
74技术分享  }
75技术分享
76技术分享  /** 批量删除 */
77技术分享  @RequestMapping(method=RequestMethod.DELETE)
78技术分享  public ModelAndView batchDelete(HttpServletRequest request,HttpServletResponse response) {
79技术分享  String[] items = request.getParameterValues("items");
80技术分享  for(int i = 0; i < items.length; i++) {
81技术分享   java.lang.Long id = new java.lang.Long(items[i]);
82技术分享   userInfoManager.removeById(id);
83技术分享  }
84技术分享  return new ModelAndView(LIST_ACTION);
85技术分享  }
86技术分享
87技术分享}
88技术分享

 

1技术分享/userinfo  => index()
2技术分享  /userinfo/new => _new()
3技术分享  /userinfo/{id} => show()
4技术分享  /userinfo/{id}/edit  => edit()
5技术分享  /userinfo POST => create()
6技术分享  /userinfo/{id} PUT => update()
7技术分享  /userinfo/{id} DELETE => delete()
8技术分享  /userinfo DELETE => batchDelete()
9技术分享

 

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


 

    4.jsp 编写

1技术分享<form:form action="${ctx}/userinfo${userInfo.userId}" method="put">
2技术分享</form:form>

 

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

1技术分享<form id="userInfo" action="/springmvc_rest_demo/userinfo/2" method="post">
2技术分享  <input type="hidden" name="_method" value="put"/>
3技术分享</form>

 

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

    5.静态资源的URL重写

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

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

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

    

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

静态资源访问<mvc:resources>

如果在DispatcherServlet中设置url-pattern为 /则必须对静态资源进行访问处理。

spring mvc <mvc:resources mapping="" location="">实现对静态资源进行映射访问。

如下是对js文件访问配置:

<mvc:resources location="/js/" mapping="/js/**"/>

以上是关于Springmvc构造RESTful详细讲解的主要内容,如果未能解决你的问题,请参考以下文章

springmvc4 相关注解的详细讲解

springmvc4 相关注解的详细讲解

springmvc学习总结 -- maven+springmvc+spring+mybatis+mysql详细搭建整合过程讲解

restful 风格 加上springmvc

RESTful风格的Web服务框架:Swagger

RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查