day02-REST和SpringMVC映射请求数据

day02-REST和SpringMVC映射请求数据

REST和SpringMVC映射请求数据

7.REST-优雅的url请求风格

7.1REST基本介绍

REST风格详细介绍

  1. REST:即 Representational State Transfer,表述性状态传递。它结构清晰,同时可以隐藏行为。

  2. 通过一个url来直观展示传统风格与REST风格的区别:

    • 传统风格:
      当我们在浏览器上访问一些资源时,可以看到有些网页的url为

      http://localhost/students/selectById?id=1 (该地址表示查找id为1的students对象)

      http://localhost/students/saveStudent(该地址表示保存students信息)

    • REST风格:
      http://localhosts/student/1

      http://localhosts/student

    通过这两种风格的对比,我们可以看到REST风格的一部分优点:

    (1)可以隐藏资源访问行为(如隐藏了selectById等),这样就无法通过地址得知对资源进行了哪种操作

    (2)可以明显的看到其书写简化了,不仅书写简化了,在开发时代码也可以简化。

  3. HTTP 协议里,四个表示操作方式的动词:GET,POST,PUT,DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源,PUT用来更新资源,DELETE用来删除资源。

  4. 传统的url通过参数说明 crud的类型,而rest则是通过 get/post/put/delete 来说明 crud的类型

  • REST的核心过滤器
    1. 当前的浏览器只支持 post/get 请求,因此为了得到 put/delete 的请求方式,需要使用 Spring 提供的HiddenHttpMethodFilter 过滤器进行转换。
    2. HiddenHttpMethodFilter :浏览器form表单只支持GET 和 POST请求,而DELETE、PUT 等method并不支持,Spring 添加了一个过滤器,可以将这些请求转换为标准的http方法,使得支持这四种请求方式。
    3. 需要特别注意:HiddenHttpMethodFilter 只能对 post请求方式进行转换
    4. 这个过滤器需要在web.xml中配置

7.2Rest风格的url-完成crud操作

7.2.1需求说明

image-20230204205731358

7.2.2代码实现

  1. 修改web.xml添加 HiddenHttpMethodFilter过滤器,它的作用是将post请求转换为指定的delete或put请求

    <!--配置HiddenHttpMethodFilter过滤器
        1.它的作用是将以post方式提交的delete请求和put请求进行转换
        2.配置url-pattern为/*,表示所有请求都经过hiddenHttpMethodFilter过滤
        -->
    <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. 在SpringDispatcherServlet-servlet.xml添加两个常规的配置

    <!--加入两个常规的配置-->
    <!--支持SpringMVC的高级功能,比如:JSR303校验,映射动态请求-->
    <mvc:annotation-driven></mvc:annotation-driven>
    <!--将SpringMVC不能处理的请求,交给tomcat处理,比如css,js-->
    <mvc:default-servlet-handler/>
    

    注意:mvc:annotion添加的是后缀为mvc的命名空间:

    image-20230205162517025

  3. 创建rest.jsp

    Idea中导入jquery无法生效的解决方法

    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>rest</title>
        <script type="text/javascript" src="script/jquery-3.6.0.min.js"></script>
        <script type="text/javascript">
            $(function () {
                $("#deleteBook").click(function () {
                    //将当前的超链接的href的值,赋给hiddenForm表单的action属性
                    $("#hiddenForm").attr("action", this.href);
                    $(":hidden").val("DELETE");//给hidden的_method参数赋值为delete
                    $("#hiddenForm").submit();//提交表单
                    return false;//改变超链接行为,不再提交
                })
    
                //与上同理,不一样的是这里原本就是表单post请求
                $("#updateBook").click(function () {
                    //带上目标请求格式,HiddenHttpMethodFilter会自动将post请求转成你指定的格式
                    $(":hidden").val("PUT");//给hidden的_method参数赋值为put
                })
            })
        </script>
    </head>
    <body>
    <h2>Rest风格的crud操作案例</h2>
    <hr/>
    
    <h3>rest风格的url 查询书籍[get]</h3>
    <a href="user/book/200">点击查询书籍</a>
    <hr/>
    
    <h3>rest风格的url 添加书籍[post]</h3>
    <form action="user/book" method="post">
        name:<input name="bookName" type="text"/><br/>
        <input type="submit" value="添加书籍"/>
    </form>
    <hr/>
    
    <h3>rest风格的url 删除书籍[delete]</h3>
    <%--说明:
    1.在默认情况下,超链接是get请求
    2.要将get请求转成SpringMVC可以识别的delete,就要考虑HiddenHttpMethodFilter机制:
       public static final String DEFAULT_METHOD_PARAM = "_method";
       -------------------------------------
       private static final List<String> ALLOWED_METHODS =
          Collections.unmodifiableList(Arrays.asList(HttpMethod.PUT.name(),
              HttpMethod.DELETE.name(), HttpMethod.PATCH.name()));
       -------------------------------------
       //获取请求的方式,如果是post方式,就进行处理
       if ("POST".equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) {
             String paramValue = request.getParameter(this.methodParam);
             if (StringUtils.hasLength(paramValue)) {
                String method = paramValue.toUpperCase(Locale.ENGLISH);
                if (ALLOWED_METHODS.contains(method)) {//若指定method在ALLOWED_METHODS中存在
                   //进行包装,转换为springmvc可以解析的请求
                    requestToUse = new HttpMethodRequestWrapper(request, method);
                }
             }
          }
       --------------------------------------
    3.从上述代码可以看到,HiddenHttpMethodFilter 过滤器可以对以
        Post方式提交的delete,put,patch转换成springmvc识别的RequestMethod.DElETE,RequestMethod.PUT...
    4.但是当前的超链接为 get请求,怎么将get请求转换成 post的请求方式呢?
    5.我们可以使用jquery来进行处理,让用户点击超链接的时候,走一个表单的请求
    --%>
    <a href="user/book/600" id="deleteBook">删除指定id的书籍</a>
    <form action="" method="post" id="hiddenForm">
        <input type="hidden" name="_method"/>
    </form>
    <hr/>
    
    <h3>rest风格的url 修改书籍[put]</h3>
    <form action="user/book/666" method="post" id="updateBook">
        <input type="hidden" name="_method">
        <input type="submit" value="修改书籍"/>
    </form>
    </body>
    </html>
    
  4. BookHandle.java

    1. 下面的代码中可以看到,许多方法的REST风格匹配的url是一样的,但是由于它们的请求方式不同,所以匹配到的方法不同。这也是rest风格的优点:不仅简化了url,而且隐藏了行为。
    2. 所以实际上SpringMVC的Controller层的url是可以相同的,会另外根据请求方式的不同来匹配方法
    package com.li.web.rest;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.*;
    
    /**
     * @author 李
     * @version 1.0
     * 用于处理rest风格的请求-crud
     */
    @RequestMapping(value = "/user")
    @Controller
    public class bookHandler {
        //查询[get]
        @RequestMapping(value = "/book/{id}", method = RequestMethod.GET)
        public String getBook(@PathVariable("id") String id) {
            System.out.println("查询书籍 id=" + id);
            return "success";
        }
    
        //添加[post]
        @PostMapping(value = "/book")
        public String addBook(String bookName) {//注意参数名字要和表单提交的参数名称一致
            System.out.println("添加书籍 bookName=" + bookName);
            return "success";
        }
    
        //删除[delete]
        @DeleteMapping(value = "/book/{id}")
        public String delBook(@PathVariable("id") String id) {
            System.out.println("删除书籍 id=" + id);
            //return "success";//这样写,返回会报错:HTTP Status 405 - JSPs only permit GET POST or HEAD
            //redirect:/user/success 重定向,会被解析成 /web工程路径/user/success,然后返回给浏览器解析
            return "redirect:/user/success";//重定向到一个没有指定method的 Handler方法
        }
    
        //如果请求是 /user/success,就转发到success.jsp
        @RequestMapping(value = "/success")
        public String successGeneral() {
            return "success";//该方法转发到success.jsp页面
        }
    
        @PutMapping(value = "/book/{id}")
        public String updateBook(@PathVariable("id") String id) {
            System.out.println("修改书籍 id=" + id);
            return "redirect:/user/success";//同理
        }
    }
    
  5. success.jsp

    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>操作成功</title>
    </head>
    <body>
    <h1>恭喜,操作成功!</h1>
    </body>
    </html>
    
  6. 测试,redeployTomcat,访问:http://localhost:8080/springmvc/rest.jsp,在分别点击四种提交方式,前端页面和后台输出如下:

    image-20230205202322764 image-20230205203330172

7.3注意事项和使用细节

  1. HiddenHttpMethodFilter在将 post请求转成 delete/put请求时,是按照 _method 参数名来读取的

    image-20230205203712186

  2. 如果web项目是运行在 Tomcat8及以上,会发现被过滤成 DELETE和 PUT请求后,到达控制器Controller时能顺利执行,但是返回(forward)会报HTTP 405 提示:HTTP Status 405 – JSPs only permit GET POST or HEAD。意为JSP只允许GET POST 或 HEAD

    (1)解决方式1:使用Tomcat7

    (2)解决方式2:将请求转发(forward)改为重定向(redirect),重定向到一个Handler,由Handler转发到页面。

    image-20230205204252465

  3. 页面测试时,如果出现点击修改书籍,仍然走的是删除url,可能是浏览器缓存等原因,换成Chrome即可。如果再不行,使用js修改表单的hidden的_method的值

8.SpringMVC映射请求数据

8.1获取参数值

在开发中,如何获取到 http://xxx/url?参数名1=参数值1&参数名2=参数值2 中的参数?

之前的案例中我们知道:提交的url的参数名必须和映射的方法中的形参名保持一致。否则方法获取的是null。

但是如果url的参数名和方法的形参名不一致,又要获取该参数,应该解决这个问题呢?

答案是使用 @RequestParam 注解。

应用实例

  1. request_parameter.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>测试request_parameter</title>
</head>
<body>
<h2>获取到超链接参数值</h2>
<a href="vote/vote01?name=jack">获取超链接的参数</a>
</body>
</html>
  1. VoteHandler.java:
package com.li.web.requestparam;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * @author 李
 * @version 1.0
 */
@RequestMapping(value = "/vote")
@Controller
public class VoteHandler {

    /**
     * 1.获取到超链接传递的数据
     * 请求为 http://localhost:8080/springmvc/vote/vote01?name=xxx
     * (即提交的参数名和方法形参名不一致)
     * 2.@RequestParam 表示会接收提交的参数
     * 3.value = "name" 表示提交的参数名是name
     * 4.required = false 表示该参数可以没有(默认true,表示必须有该参数)
     * 5.当我们使用了 @RequestParam(value = "name", required = false) 后,
     * 请求的参数名和方法形参名可以不一致
     *
     * @param username
     * @return
     */
    @RequestMapping(value = "/vote01")
    public String test01(@RequestParam(value = "name", required = false) String username) {
        System.out.println("获取到的username=" + username);
        return "success";
    }

}
  1. 访问http://localhost:8080/springmvc/request_parameter.jsp,点击超链接。

    image-20230205200906238

  2. 后台输出如下,说明在提交参数和方法形参名不一致的情况下,通过@RequestParam 注解可以获取到参数

    image-20230205201018260

8.2获取http请求消息头

开发中,如何获取到http请求的消息头信息(使用较少)

在映射的方法的形参前添加@RequestHeader(value="要获取的Header参数"),即可获取相关信息,然后将其值赋给方法的形参。

应用实例

  1. 在VoteHandler.java
package com.li.web.requestparam;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * @author 李
 * @version 1.0
 */
@RequestMapping(value = "/vote")
@Controller
public class VoteHandler {

    //需求:获取请求头的Accept-Encoding和 Host
    @RequestMapping(value = "/vote02")
    public String test02(@RequestHeader("Accept-Encoding") String ae,
                         @RequestHeader(value = "Host") String host) {
        System.out.println("Accept-Encoding=" + ae);
        System.out.println("Host=" + host);
        return "success";
    }
}
  1. 浏览器地址栏发送请求 http://localhost:8080/springmvc/vote/vote02,后台输出:

    image-20230205211624109

8.3获取Javabean形式的数据

  • 在开发中,如何获取到Javabean的数据?即如何按照java对象的形式来接收数据?

使用场景说明:例如,在实际开发中提交一个表单。表单提交后,希望在后端handler接收到表单数据时,自动地将这些数据封装到某个Javabean中。

应用实例

  1. Pet.java
package com.li.entity;

/**
 * @author 李
 * @version 1.0
 * entity
 */
public class Pet {
    private Integer id;
    private String name;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Pet{" +
                "id=" + id +
                ", name="" + name + """ +
                "}";
    }
}
  1. Master.java
package com.li.entity;

/**
 * @author 李
 * @version 1.0
 * entity
 */
public class Master {
    private Integer id;
    private String name;
    private Pet pet;//对象的属性级联

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Pet getPet() {
        return pet;
    }

    public void setPet(Pet pet) {
        this.pet = pet;
    }

    @Override
    public String toString() {
        return "Master{" +
                "id=" + id +
                ", name="" + name + """ +
                ", pet=" + pet +
                "}";
    }
}
  1. VoteHandler.java
hmoban主题是根据ripro二开的主题,极致后台体验,无插件,集成会员系统
自学咖网 » day02-REST和SpringMVC映射请求数据