SpringMVC笔记--3 REST

最新推荐文章于 2022-08-05 11:07:44 发布

hancoder

最新推荐文章于 2022-08-05 11:07:44 发布

阅读量187

点赞数

分类专栏： Spring 文章标签： REST

blog.csdn.net/hancoder 可以打赏后索要离线md文件，打赏码在谷粒笔记的文尾。博主目前就职于阿里云，有需要可内推

本文链接：https://blog.csdn.net/hancoder/article/details/103451445

版权

Spring 专栏收录该内容

31 篇文章 28 订阅

订阅专栏

第3章 REST

3.1参考资料：

1）理解本真的REST架构风格: http://kb.cnblogs.com/page/186516/

2）REST: http://www.infoq.com/cn/articles/rest-introduction

3.2 REST是什么？

1） 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 用来删除资源。

更关心的是请求动作

2）URL风格

示例：

发送url	请求方式	解释
order/1	HTTP GET	得到 id = 1 的 order
order/1	HTTP DELETE	删除 id = 1的 order
order	HTTP PUT	更新order
order	HTTP POST	新增 order

超链接是GET，form表单可以选择post。那么怎么发put和delete呢？我们可以使用过滤器进行转化

3）HiddenHttpMethodFilter过滤器

浏览器 form 表单只支持 GET 与 POST 请求，而DELETE、PUT 等 method 并不支持，Spring3.0 添加了一个【过滤器】，可以将这些请求转换为标准的 http 方法，使得支持 GET、POST、PUT 与 DELETE 请求。

3.3 HiddenHttpMethodFilter过滤器源码

为什么请求隐含参数名称必须叫做”_method”

HiddenHttpMethodFilter源码：
public class HiddenHttpMethodFilter extends OncePerRequestFilter {
 
	/** Default method parameter: {@code _method} */
	public static final String DEFAULT_METHOD_PARAM = "_method"; //常量字符串
 
	private String methodParam = DEFAULT_METHOD_PARAM;
 
 
	/**
	 * Set the parameter name to look for HTTP methods.
	 * @see #DEFAULT_METHOD_PARAM
	 */
	public void setMethodParam(String methodParam) {
		Assert.hasText(methodParam, "'methodParam' must not be empty");
		this.methodParam = methodParam;
	}
 
	@Override
	protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
			throws ServletException, IOException {
 
		String paramValue = request.getParameter(this.methodParam);//通过请求参数_method对应的value
		if ("POST".equals(request.getMethod()) && StringUtils.hasLength(paramValue)) {
            // 查看请求方式是不是POST && 获取到的值到底有咩有
            // 都满足的话就满足了请求转换的条件
			String method = paramValue.toUpperCase(Locale.ENGLISH);//转大写PUT
			HttpServletRequest wrapper = new HttpMethodRequestWrapper(request, method);//调用包装类 // 传入大写PUT 转到内部类
			filterChain.doFilter(wrapper, response);//传的是wrapper
		}
		else {
			filterChain.doFilter(request, response);
		}
	}
 
 
	/**
	 * Simple {@link HttpServletRequest} wrapper that returns the supplied method for
	 * {@link HttpServletRequest#getMethod()}.
	 */
	private static class HttpMethodRequestWrapper extends HttpServletRequestWrapper {
 
		private final String method;
 
		public HttpMethodRequestWrapper(HttpServletRequest request, String method) {
			super(request);
			this.method = method;//构造函数赋值
		}
 
		@Override
		public String getMethod() {
			return this.method;
		}
	}
 
}

首先我们可以看到HiddenHttpMethodFilter它集成了一个叫OncePerRequestFilter的类，我们可以先浏览一下整体代码，很显然的可以发现这个Filter类没有三个方法（生死以及doFilter），那我们就顺着OncePerRequestFilter找，发现OncePerRequestFilter果然有这三个方法，那说明HiddenHttpMethodFilter都是继承了父类的三个方法，那我们接着看。

既然HiddenHttpMethodFilter通常用在RESTful风格里头，多出来的删除和编辑要用put和delete方法，那就需要用_method代替原来的method，接着我们可以从头两句代码可以看出，HiddenHttpMethodFilter先是定义了一个字符串，default_method。那猜都能猜到等会肯定要覆盖这个默认的方法名变成我们的方法名。

当我们接受request（HttpServletRequest）请求时，它会告诉我们它传过来的时“POST”还是“GET”请求，从上面代码可知，我们只有“POST”请求的时候才能根据_method改变method方法名。接着它会帮我们把方法名变成全部大写，然后调用一个HttpMethodRequestWrapper类的构造方法，request依旧不动，但是method变成了我们传进来的参数，也就是我们要改成的方法名。wrapper作为了一个新的HttpServletRequest回到了过滤器链之中。

3.4 实验代码

1） web.xml

配置HiddenHttpMethodFilter过滤器（第二步）

<!-- 支持REST风格的过滤器：可以将POST请求转换为PUT或DELETE请求 -->
<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>

这里写/*。从浏览器到springDispatcherServlet，中间的Filter与springDispatcherServlet没有关系，springDispatcherServlet是/。

2） mapping.java

代码（第三步）

/**
 * 1.测试REST风格的  GET,POST,PUT,DELETE 操作
 * 以CRUD为例：
 * 新增: /order POST
 * 修改: /order/1 PUT           update?id=1
 * 获取: /order/1 GET                get?id=1
 * 删除: /order/1 DELETE        delete?id=1
 
 * 2.如何发送PUT请求或DELETE请求?
 * ①.配置HiddenHttpMethodFilter
 * ②.需要发送POST请求
 * ③.需要在发送POST请求时携带一个 name="_method"的隐含域，值为PUT或DELETE
 
 * 3.在SpringMVC的目标方法中如何得到id值呢?
 *   使用@PathVariable注解
 */
-----------------------------------------------------------------
@RequestMapping(value="/testRESTGet/{id}",method=RequestMethod.GET)//要求的请求方式
public String testRESTGet(@PathVariable(value="id") Integer id){
    System.out.println("testRESTGet id="+id);
    return "success";
}
-----------------------------------------------------------------
@RequestMapping(value="/testRESTPost",method=RequestMethod.POST)
public String testRESTPost(){
    System.out.println("testRESTPost");
    return "success";
}
-----------------------------------------------------------------
@RequestMapping(value="/testRESTPut/{id}",method=RequestMethod.PUT)
public String testRESTPut(@PathVariable("id") Integer id){
    System.out.println("testRESTPut id="+id);
    return "success";
}
-----------------------------------------------------------------
@RequestMapping(value="/testRESTDelete/{id}",method=RequestMethod.DELETE)
public String testRESTDelete(@PathVariable("id") Integer id){
    System.out.println("testRESTDelete id="+id);
    return "success";
}

3） index.jsp

请求链接（第一步）

<!-- 实验1 测试 REST风格 GET 请求 -->
<a href="springmvc/testRESTGet/1">testREST GET</a><br/><br/>
-----------------------------------------------------------------
<!-- 实验2 测试 REST风格 POST 请求 -->
<form action="springmvc/testRESTPost" method="POST">
    <input type="submit" value="testRESTPost">
</form>
-----------------------------------------------------------------
<!-- 实验3 测试 REST风格 PUT 请求 -->
<form action="springmvc/testRESTPut/1" method="POST">
    <input type="hidden" name="_method" value="PUT">
    <input type="submit" value="testRESTPut">
</form>
-----------------------------------------------------------------
<!-- 实验4 测试 REST风格 DELETE 请求 -->
<form action="springmvc/testRESTDelete/1" method="POST">
    <input type="hidden" name="_method" value="DELETE">
    <input type="submit" value="testRESTDelete">
</form>