二、SpringBoot2核心功能--02web开发-03-Rest解析映射及解析源码

最新推荐文章于 2024-06-18 21:45:11 发布

小码哥呀

最新推荐文章于 2024-06-18 21:45:11 发布

阅读量92

点赞数

分类专栏： SpringBoot2

本文链接：https://blog.csdn.net/qq_46112274/article/details/116347884

版权

SpringBoot2 专栏收录该内容

39 篇文章 1 订阅

订阅专栏

03-Rest解析映射及解析源码

1、rest风格原理与使用

1、rest风格原理与使用

1.1、前言

@xxxMapping；
Rest风格支持（使用HTTP请求方式动词来表示对资源的操作）
1、以前：/getUser 获取用户 /deleteUser 删除用户 /editUser 修改用户 /saveUser 保存用户
2、现在： /user GET-获取用户 DELETE-删除用户 PUT-修改用户 POST-保存用户

1.2、前端请求为put和delete时，后端响应却为get请求。案例代码

在这里插入图片描述

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>springboot，欢迎您</h1>
测试REST风格
<form action="/user" method="get">
    <input type="submit" value="REST-GET">
</form>
<form action="/user" method="post">
    <input type="submit" value="REST-POST">
</form>
<form action="/user" method="delete">
    <input type="submit" value="REST-DELETE">
</form>
<form action="/user" method="put">
    <input type="submit" value="REST-PUT">
</form>
</body>
</html>

控制层：

@RestController
public class HelloController {

    @RequestMapping("/zhifubao.jpg")
    public String hello(){
        return "aaa";
    }

    @RequestMapping(value="/user",method = RequestMethod.GET)
    public String getUser(){
        return "GET-张三";
    }

    @RequestMapping(value="/user",method=RequestMethod.POST)
    public String postUser(){
        return "POST-张三";
    }

    @RequestMapping(value="/user",method = RequestMethod.PUT)
    public String putUser(){
        return "PUT-张三";
    }

    @RequestMapping(value="/user",method = RequestMethod.DELETE)
    public String deleteUser(){
        return "DELETE-张三";
    }
}

在这里插入图片描述当前端请求为put和delete时，响应结果都是经过了后端get请求的处理。

1.3、源码解析：如何在springboot项目中使用Rest风格

找到org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration
在这里插入图片描述

//从这段源码可以在springboot中使用REST风格，需要在配置文件中开启该功能：spring.mvc.hiddenmethod.filter.enabled=true
@Bean
@ConditionalOnMissingBean(HiddenHttpMethodFilter.class)
	@ConditionalOnProperty(prefix = "spring.mvc.hiddenmethod.filter", name = "enabled", matchIfMissing = false)
	public OrderedHiddenHttpMethodFilter hiddenHttpMethodFilter() {
		return new OrderedHiddenHttpMethodFilter();
	}

//通过以下源码可知，我们需要在表单中添加一个隐藏域，值（name）为_method,同时该表单method必须为post。如下图所示。
public class OrderedHiddenHttpMethodFilter 
extends HiddenHttpMethodFilter 
implements OrderedFilter {
}


public class HiddenHttpMethodFilter extends OncePerRequestFilter {

	public static final String DEFAULT_METHOD_PARAM = "_method";
	
	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);
	    }

}

在这里插入图片描述

1.4、如何在springboot项目中使用Rest风格？解决1.1的问题

1、首先：表单请求中的method=”post“，然后添加隐藏域 _method=put

<from action="/user" method="post">
<!--要想在springboot中使用Rest风格，首先需要将method的值设为post,
然后在表单提交时添加一个隐藏域。表单中的隐藏域的值即为实际的请求方式-->
    <input type="hidden" name="_method" value="DELETE">
    <input type="submit" value="REST-POST">
</from>

2、SpringBoot要想使用Rest风格，还需要在配置文件中手动开启，因为这个功能默认是关闭的（为何关闭可以查看源码本文档第一个图的源码）。开启方式如下所示：

# 手动开启Rest风格，默认为false，不开启
spring:
  mvc:
    hiddenmethod:
      filter:
        enabled: true

1.5、源码解析：Springboot为何需要手动开启Rest风格

核心Filter；HiddenHttpMethodFilter。这里说明了Springboot为何需要手动开启Rest风格

//Springboot为何需要手动开启Rest风格，可以查看
//WebMvcAutoConfiguration类中的hiddenHttpMethodFilter方法
//spring.mvc.hiddenmethod.filter默认值为false,即默认不开启Rest风格
@Bean
@ConditionalOnMissingBean(HiddenHttpMethodFilter.class)
@ConditionalOnProperty(prefix = "spring.mvc.hiddenmethod.filter", name = "enabled", matchIfMissing = false)
public OrderedHiddenHttpMethodFilter hiddenHttpMethodFilter() {
	return new OrderedHiddenHttpMethodFilter();
}

1.6、总结Rest原理

Rest原理（表单提交要使用REST的时候）

1、表单提交会带上_method=PUT
2、请求过来被HiddenHttpMethodFilter拦截
2.1、查看请求是否正常，并且是POST

获取到_method的值。
兼容以下请求；PUT.DELETE.PATCH
原生request（post），包装模式requesWrapper重写了getMethod方法，返回的是传入的值。
过滤器链放行的时候用wrapper。以后的方法调用getMethod是调用requesWrapper的。

Rest使用客户端工具

• 如PostMan直接发送Put、delete等方式请求，无需Filter。

1.7、注解简化

可以用以下注解做替换
在这里插入图片描述

1.8、扩展：如何把_method 这个名字换成我们自己喜欢的。

新建配置类：
在这里插入图片描述

@Configuration(proxyBeanMethods = false)
public class WebConfig {

    @Bean
    public HiddenHttpMethodFilter hiddenHttpMethodFilter(){
        HiddenHttpMethodFilter methodFilter = new HiddenHttpMethodFilter();
        methodFilter.setMethodParam("_m");
        return methodFilter;
    }
}