SpringMVC —— 6、RESTful

目录

1、RESTful 简介

1.1、资源

1.2、资源的表述

1.3、状态转移

2、RESTful的实现

3、 HiddenHttpMethodFilter

4、 CharacterEncodingFilter 和 HiddenHttpMethodFilter 的配置顺序问题

5、使用 RESTFul 模拟操作用户资源


1、RESTful 简介

REST:Representational State Transfer,表现层资源状态转移。

1.1、资源

资源是一种看待服务器的方式,即,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称,也是资源在Web上的地址。对某个资源感兴趣的客户端应用,可以通过资源的URI与其进行交互。

1.2、资源的表述

资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移(交换)。资源的表述可以有多种格式,例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。

1.3、状态转移

状态转移说的是:在客户端和服务器端之间转移(transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的。

2、RESTful的实现

具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。

它们分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资源

REST 风格提倡 URL 地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性。

操作 传统方式 REST风格
查询操作 getUserById?id=1 user/1 --> get请求方式
保存操作 saveUser user --> post请求方式
删除操作 deleteUser?id=1 user/1-->delete请求方式
更新操作 updateUser user-->put请求方式

3、 HiddenHttpMethodFilter

由于浏览器只支持发送get和post方式的请求,那么该如何发送put和delete请求呢?

SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求

HiddenHttpMethodFilter 处理put和delete请求的条件:

        a> 当前请求的请求方式必须为post

        b> 当前请求必须传输请求参数_method,并且是PUT、DELETE、PATCH三者之一

满足以上条件,HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数_method的值,因此请求参数_method的值才是最终的请求方式

查看 HiddenHttpMethodFilter 源码的 doFilterInternal 方法,其作用就是将POST请求替换为PUT、DELETE、PATCH三者之一

    // 若请求为POST请求,且含有_method请求参数并且是PUT、DELETE、PATCH三者之一时,将请求方式替换为_method所代表的请求方式
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {

        HttpServletRequest requestToUse = request;

        //只有为POST请求时才会进入该if语句(第二个判断条件表示没有错误和异常的意思)
        if ("POST".equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) {
            String paramValue = request.getParameter(this.methodParam);//获取 _method 请求参数
            //在 _method 参数不为空的情况下进入该if语句
            if (StringUtils.hasLength(paramValue)) { //hasLength :是否有长度,即是否为空
                //将 _method 参数转为大写
                String method = paramValue.toUpperCase(Locale.ENGLISH);
                //判断 _method 参数是否是 ALLOWED_METHODS 中的PUT、DELETE、PATCH三者之一,若是,则进入该if语句
                if (ALLOWED_METHODS.contains(method)) {
                    //将当前request对象的method替换为 _method 的值后赋值给 requestToUse
                    requestToUse = new HiddenHttpMethodFilter.HttpMethodRequestWrapper(request, method);
                }
            }
        }

        filterChain.doFilter(requestToUse, response);
    }

在web.xml中注册HiddenHttpMethodFilter

    
    
        HiddenHttpMethodFilter
        org.springframework.web.filter.HiddenHttpMethodFilter
    
    
        HiddenHttpMethodFilter
        /*
    

4、 CharacterEncodingFilter 和 HiddenHttpMethodFilter 的配置顺序问题

在 web.xml 中配置多个 Filter 时,过滤器的执行顺序由 filter-mapping 的配置顺序决定,配置的越靠前,就越先执行

由于在 HiddenHttpMethodFilter 中获取了 _method 请求参数,而 CharacterEncodingFilter 设置字符集需要在获取请求参数之前设置才有效,所以若 HiddenHttpMethodFilter 先执行,CharacterEncodingFilter 会失效出现乱码,所以 CharacterEncodingFilter 需要在 HiddenHttpMethodFilter 之前执行。

5、使用 RESTFul 模拟操作用户资源

在 SpringMVC-demo3 模块的基础上进行模拟,其中 delete 请求在 RESTFul案例 中再写

① 创建 UserController 控制器类

@Controller
public class UserController {

    /**
     * 使用RESTFul模拟用户资源的增删改查
     * /user        GET         查询所有用户信息
     * /user/1      GET         根据用户id查询用户信息
     * /user        POST        添加用户信息
     * /user/1      DELETE      删除用户信息
     * /user        PUT         修改用户信息
     */

    @RequestMapping(value = "/user", method = RequestMethod.GET)
    public String getAllUser(){
        System.out.println("查询所有用户信息");
        return "success";
    }

    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    public String getUserById(@PathVariable("id")Integer id){
        System.out.println("查询id为" + id + "的用户信息");
        return "success";
    }

    @RequestMapping(value = "/user", method = RequestMethod.POST)
    public String insertUser(String username, String password){
        System.out.println("添加的用户名是" + username + ", 密码是" + password);
        return "success";
    }

    @RequestMapping(value = "/user", method = RequestMethod.PUT)
    public String update(String username, String password){
        System.out.println("修改的用户名是" + username + ", 密码是" + password);
        return "success";
    }

}

② 在 web.xml 中配置HiddenHttpMethodFilter,用来发送PUT和DELETE请求

    
    
        HiddenHttpMethodFilter
        org.springframework.web.filter.HiddenHttpMethodFilter
    
    
        HiddenHttpMethodFilter
        /*
    

③ 创建 test_rest.html 页面,用来存放跳转的链接




    
    使用RESTFul模拟操作用户资源


    查询所有用户信息
根据查询用户信息
用户名:
密码:
用户名:
密码:

你可能感兴趣的:(SpringMVC学习笔记,restful,后端,java)