SpringMVC REST 风格请求介绍及简单实践

REST:即 Representational State Transfer。(资源)表现层状态转化。是目前 最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便, 所以正得到越来越多网站的采用

• 资源(Resources):网络上的一个实体,或者说是网络上的一个具体信息。它 可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的存在。 可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的 URI 。要 获取这个资源,访问它的URI就可以,因此 URI 即为每一个资源的独一无二的识 别符。

表现层(Representation):把资源具体呈现出来的形式,叫做它的表现层 (Representation)。比如,文本可以用 txt 格式表现,也可以用 HTML 格 式、XML 格式、JSON 格式表现,甚至可以采用二进制格式。

• 状态转化(State Transfer):每发出一个请求,就代表了客户端和服务器的一 次交互过程。HTTP协议,是一个无状态协议,即所有的状态都保存在服务器 端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生“ 状态转化”(State Transfer)。而这种转化是建立在表现层之上的,所以就是 “ 表现层状态转化” 。具体说,就是 HTTP 协议里面,四个表示操作方式的动 词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET 用来获 取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资源。

是通过 org.springframework.web.filter.HiddenHttpMethodFilter 把 POST 请求转化为 PUT 和 DELETE 请求

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.filter;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import org.springframework.http.HttpMethod;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

public class HiddenHttpMethodFilter extends OncePerRequestFilter {
    private static final List<String> ALLOWED_METHODS;
    public static final String DEFAULT_METHOD_PARAM = "_method";
    private String methodParam = "_method";

    public HiddenHttpMethodFilter() {
    }

    public void setMethodParam(String methodParam) {
        Assert.hasText(methodParam, "'methodParam' must not be empty");
        this.methodParam = methodParam;
    }

    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        HttpServletRequest requestToUse = request;
        if("POST".equals(request.getMethod()) && request.getAttribute("javax.servlet.error.exception") == null) {
            String paramValue = request.getParameter(this.methodParam);
            if(StringUtils.hasLength(paramValue)) {
                String method = paramValue.toUpperCase(Locale.ENGLISH);
                if(ALLOWED_METHODS.contains(method)) {
                    requestToUse = new HiddenHttpMethodFilter.HttpMethodRequestWrapper(request, method);
                }
            }
        }

        filterChain.doFilter((ServletRequest)requestToUse, response);
    }

    static {
        ALLOWED_METHODS = Collections.unmodifiableList(Arrays.asList(new String[]{HttpMethod.PUT.name(), HttpMethod.DELETE.name(), HttpMethod.PATCH.name()}));
    }

    private static class HttpMethodRequestWrapper extends HttpServletRequestWrapper {
        private final String method;

        public HttpMethodRequestWrapper(HttpServletRequest request, String method) {
            super(request);
            this.method = method;
        }

        public String getMethod() {
            return this.method;
        }
    }
}

        从 HiddenHttpMethodFilter 的源码可以看出,Spring 根据请求中的 _method 参数进行转化,因此如果想发起 REST 风格的 DELETE 或者 PUT 请求,只需要在表单中带上 _method 参数,并且把 _method 的值设置为 DELETE 或者 PUT(大写) 即可。详细例子如下:

  1. 在 web.xml 中配置 HiddenHttpMethodFilter
  2. 编写 handler 代码
  3. 编写页面

1.在 web.xml 中配置 HiddenHttpMethodFilter

 <!-- 
	配置 org.springframework.web.filter.HiddenHttpMethodFilter: 可以把 POST 请求转为 DELETE 或 POST 请求 
	-->
	<filter>
		<filter-name>HiddenHttpMethodFilter</filter-name>
		<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
	</filter>
	
	<filter-mapping>
		<filter-name>HiddenHttpMethodFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>

2) 编写页面

   <form action="restfulTest/testRest/1" method="post">
         <input type="hidden"  name="_method" value="DELETE"/>
         <input type="submit" value="TestRest DELETE"/>
      </form>
       <br><br>
       
       <form action="restfulTest/testRest/1" method="post">
         <input type="hidden"  name="_method" value="PUT"/>
         <input type="submit" value="TestRest PUT"/>
      </form>
      <br><br>
      
      <form action="restfulTest/testRest" method="post">
        <input type="submit" value="TestRest Post"/>
      </form>
      <br><br>
       <a href="restfulTest/testRest/1">TestRest Get </a>

3)编写 handler 代码

@RequestMapping("/restfulTest")
@Controller
public class RestTestHandler {

	private static final String SUCCESS="success";
	/**
	 * 1. 使用 @RequestMapping 注解来映射请求的 URL
	 * 2. 返回值会通过视图解析器解析为实际的物理视图, 对于 InternalResourceViewResolver 视图 
     解析器, 会做如下的解析:
	 * 通过 prefix + returnVal + 后缀 这样的方式得到实际的物理视图, 然会做转发操作
	 * 
	 * /WEB-INF/views/success.jsp
	 * 
	 * @return
	 */
	 @RequestMapping(value="/testRest/{id}",method=RequestMethod.DELETE)
	   public String testDelete(@PathVariable Integer id){
		   System.out.println(" TestRest DELETE:"+id);
		   return SUCCESS;
	   }

	   @RequestMapping(value="/testRest/{id}",method=RequestMethod.PUT)
	   public String testPut(@PathVariable Integer id){
		   System.out.println(" TestRest PUT:"+id);
		   return SUCCESS;
	   }
	   
	   @RequestMapping(value="/testRest",method=RequestMethod.POST)
	   public String testPost(){
		   System.out.println(" TestRest POST:");
		   return SUCCESS;
	   }
	
	
   @RequestMapping(value="/testRest/{id}",method=RequestMethod.GET)
   public String testRest(@PathVariable Integer id){
	   System.out.println(" TestRest Get:"+id);
	   return SUCCESS;
   }
	
}

注:handler 中 @RequestParam 注解必须加上 required 参数,否则访问页面会出现400错误

1)、RestfulCRUD:CRUD满足Rest风格;

URI: /资源名称/资源标识 HTTP请求方式区分对资源CRUD操作

实验具体内容

示例:

– /order/1 HTTP GET :得到 id = 1 的 order

– /order/1 HTTP DELETE:删除 id = 1的 order

– /order/1 HTTP PUT:更新id = 1的 order

– /order HTTP POST:新增 order • HiddenHttpMethodFilter:浏览器 form 表单只支持 GET 与 POST 请求,而DELETE、PUT 等 method 并不支 持,Spring3.0 添加了一个过滤器,可以将这些请求转换 为标准的 http 方法,使得支持 GET、POST、PUT 与 DELETE 请求。

猜你喜欢

转载自blog.csdn.net/qq_36697880/article/details/81630840
今日推荐