SpringBoot中REST风格传参使用

最新推荐文章于 2023-01-01 08:27:48 发布

有翅膀的猫

最新推荐文章于 2023-01-01 08:27:48 发布

阅读量1.2k

点赞数 1

本文链接：https://blog.csdn.net/weixin_48321825/article/details/121149169

版权

Java 同时被 2 个专栏收录

36 篇文章 5 订阅

订阅专栏

SpringBoot

12 篇文章 0 订阅

订阅专栏

SpringBoot中REST风格传参使用

学习目标

- SpringBoot中REST风格传参使用

1、rest使用与原理

● @xxxMapping；
● Restful风格支持（使用HTTP请求方式动词来表示对资源的操作）
○ 以前：/getUser 获取用户 /deleteUser 删除用户 /editUser 修改用户 /saveUser 保存用户
○ 现在： /user GET-获取用户 DELETE-删除用户 PUT-修改用户 POST-保存用户
○ 核心Filter；HiddenHttpMethodFilter
■ 用法：表单method=post，隐藏域 _method=put
■ SpringBoot中手动开启

2、REST源码解析：

/**
 *  1、@ConditionalOnMissingBean  
 *     缺少该配置属性时是否可以加载。如果为true，没有该配置属性时也会正常加载；反之则不会生        效
 *     容器中没有的时候才放，你配了就按照你的，你没有配就按默认
 *     虽然给容器中 放了 HiddenHttpMethodFilter，但是条件是 容器中没有的时候才放
 *     就是说要不要开启我们 REST风格 ，默认 是不开启的，我们还得在 yaml里手动开启
 
 *  2、@ConditionalOnPropert
 *     判断我们的配置文件中会放一个属性，叫spring.mvc.hiddenmethod.filter，
 *     prefix为配置文件中的前缀,name为配置的名字
 *     matchIfMissing = false  （默认false）
 *     
 *  
 *  3、手动开启 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();
	}
	

//自定义filter
    @Bean
    public HiddenHttpMethodFilter hiddenHttpMethodFilter(){
        HiddenHttpMethodFilter methodFilter = new HiddenHttpMethodFilter();
        methodFilter.setMethodParam("_m");
        return methodFilter;
    }

 protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
       //原来的requestToUse 是原生的 request，
        HttpServletRequest requestToUse = request;
//1、请求是否正常，并且是POST  并且  request.getAttribute 获取我们里面有没有错误
        if ("POST".equals(request.getMethod()) && request.getAttribute("javax.servlet.error.exception") == null) {
//2、request.getParameter 获取请求参数，这个就是 _method
            String paramValue = request.getParameter(this.methodParam);
//3、获取的DELETE是表单里面的value=DELETE
//    StringUtils.hasLength：如果字符序列不为 null 值,并且字符序列的长度大于 0 ,则返回 true
            if (StringUtils.hasLength(paramValue)) {
                //表单里 value=delete 大小写都行，这里会转为大写
                String method = paramValue.toUpperCase(Locale.ENGLISH);
 //4、判断 允许的请求方式 里面，是否包含 这个DELETE
                if (ALLOWED_METHODS.contains(method)) {
 //5、HttpMethodRequestWrapper 还是实现了 HttpServletRequest，还是原生的request 请求
 // 不同的是，这个Wrapper里面接受一个 method 传参，把现在新的请求方式传了进来
                    requestToUse = new HiddenHttpMethodFilter.HttpMethodRequestWrapper(request, method);
                }
            }
        }
     
     
     
private static class HttpMethodRequestWrapper extends HttpServletRequestWrapper {
//这里Wrapper 把新的请求方式 保存到 这个参数里面，然后重写了HttpServletRequest getMethod()方法 
        private final String method;

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

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

代码示例：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
测试REST风格：
<form action="/user" method="get">
    <input value="REST-GET 提交" type="submit">
</form>

<form action="/user" method="post">
    <input value="REST-POST" type="submit">
</form>

<form action="/user" method="post">
    <input name="_method" type="hidden" value="DELETE">
    <input value="REST-DELETE" type="submit">
</form>

<form action="/user" method="post">
    <input name="_method" type="hidden" value="PUT">
    <input value="REST-PUT" type="submit">
</form>

</body>
</html>

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

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


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

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

表单提交会带上**_method=PUT**
请求过来被HiddenHttpMethodFilter拦截(Filter就是一个过滤器)
请求是否正常，并且是POST
-获取到**_method**的值。
兼容以下请求；PUT.DELETE.PATCH
原生request（post），包装模式requesWrapper重写了getMethod方法，返回的是传入的值。
过滤器链放行的时候用wrapper。以后的方法调用getMethod是调用requestWrapper的。

装饰器模式：在不必改变原类文件和使用继承的情况下，动态的扩展一个对象的功能。它是通过创建一个包装对象，也就是装饰来包裹真实的对象

methodParam参数：
在这里插入图片描述

ALLOWED_METHODS 的包含参数：
在这里插入图片描述

4、Rest使用客户端工具测试

spring:
  mvc:
    hiddenmethod:
      filter:
        enabled: true   #开启页面表单的Rest功能

如果我们不做页面开发，那后来我们的SpringBoot应用，我们最多是用来做微服务开发提供接口，别人给我们发请求，我们返回json数据，所以可能经常都不交互页面前后端分离，页面是别人写的，所以我们选择性开启

有翅膀的猫

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot中REST风格传参使用

SpringBoot中REST风格传参使用1、rest使用与原理● @xxxMapping；● Restful风格支持（使用HTTP请求方式动词来表示对资源的操作）○ 以前：/getUser 获取用户 /deleteUser 删除用户 /editUser 修改用户 /saveUser 保存用户○ 现在： /user GET-获取用户 DELETE-删除用户 PUT-修改用户 POST-保存用户○ 核心Filter；HiddenHttp
复制链接

扫一扫