【第6章】spring-mvc之rest和filter

已于 2024-07-12 22:10:49 修改
阅读量737 收藏 30
点赞数 22
分类专栏： # springmvc 文章标签： spring mvc java
于 2024-05-03 09:47:48 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44824164/article/details/138290468
版权

文章目录

前言

REST（Representational State Transfer，表现层状态转移）是一种软件架构风格，它定义了一组设计原则和约束条件，用于创建Web服务。REST的核心思想是将网络资源视为一系列可以通过HTTP协议进行操作的抽象实体，这些实体以某种形式的表现层来展现其状态，客户端通过操作这些资源的状态来实现与Web服务的交互。

REST的主要原则包括：

  1. 客户端-服务器架构：将用户界面关注点与应用服务器关注点分离，允许它们独立进化。

  2. 无状态：服务器不会在客户端请求之间保留应用状态。每个请求都必须包含理解该请求所必需的信息（通常是通过包含先前服务器返回的所有状态）。

  3. 分层系统：允许将系统分解为若干层，每一层对下一层隐藏其内部实现细节。客户端不需要知道它与之交互的中间层的存在。

  4. 统一接口：通过四个接口约束（识别资源、通过表述操作资源、自描述消息、超媒体作为应用状态的引擎）来简化并解耦组件。

    • 资源识别：每个资源都有一个唯一的URL。
    • 通过表述操作资源：客户端通过HTTP方法对资源进行操作（如GET、POST、PUT、DELETE）。
    • 自描述消息：消息必须能够自我描述，以便客户端能够正确理解和处理。
    • 超媒体作为应用状态的引擎：客户端可以通过阅读返回的文档（通常包含超链接）来发现可以执行的操作。

  5. 按需代码（可选）：通过下载并执行代码来扩展客户端功能。

RESTful Web服务使用HTTP协议的方法（GET、POST、PUT、DELETE等）对资源进行操作，并且通常返回JSON或XML格式的响应。RESTful API的设计目标是简单、可预测和易于使用，使得不同平台和语言之间的交互变得更加容易。

RESTful API的设计通常会遵循一些最佳实践，如使用适当的HTTP方法、使用名词作为资源路径、使用HTTP状态码来传达操作结果等。这些实践有助于确保API的一致性和易用性。

总的来说，REST是一种用于构建Web服务的架构风格，它强调资源的状态和客户端与服务器的交互，通过HTTP协议和统一的接口约束来实现这一目标。

一、rest

1. JSP

<%--
  Created by IntelliJ IDEA.
  User: 张军国001
  Date: 2024/4/28
  Time: 20:06
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>rest</title>
</head>
<body>
<form action="/rest/user/1" method="get">
    <button type="submit">查询</button>
</form>
<form action="/rest/user/1" method="post">
    <button type="submit">新增</button>
</form>
<form action="/rest/user/1" method="put">
    <button type="submit">更新</button>
</form>
<form action="/rest/user/1" method="delete">
    <button type="submit">删除</button>
</form>
</body>
</html>

2. Controller

package org.example.springmvc.params.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * Create by zjg on 2024/4/28
 */
@Controller
@RequestMapping("/rest")
public class RestController {
    String rest="redirect:/params/rest.jsp";
    @RequestMapping("/hello-rest")
    public String params(){//重定向
        return rest;
    }
    @GetMapping("/user/{id}")
    public String queryUser(@PathVariable Integer id){
        System.out.println("查询用户信息:"+id);
        return rest;
    }
    @PostMapping("/user/{id}")
    public String addUser(@PathVariable Integer id){
        System.out.println("新增用户信息:"+id);
        return rest;
    }
    @PutMapping("/user/{id}")
    public String updateUser(@PathVariable Integer id){
        System.out.println("更新用户信息:"+id);
        return rest;
    }
    @DeleteMapping("/user/{id}")
    public String deleteUser(@PathVariable Integer id){
        System.out.println("删除用户信息:"+id);
        return rest;
    }
}

3. 结果

查询用户信息:1
新增用户信息:1
查询用户信息:1
查询用户信息:1

通过JSP测试发现put和delete走进了get方法，未达到预期效果

截止到当前时间（2024年4月28日），HTML规范本身并不直接支持PUT和DELETE方法。虽然HTML允许自定义表单方法，但大多数浏览器主要支持GET和POST方法。这主要有两方面的原因：

  1. 浏览器兼容性问题：不同浏览器对于PUT和DELETE方法的支持程度不同。由于PUT和DELETE方法在早期互联网应用中使用较少，浏览器开发者没有将其作为高优先级的功能进行开发和测试。因此，在一些浏览器中，对于PUT和DELETE方法的支持存在不一致甚至无法正确处理的情况。
  2. 安全性问题：PUT和DELETE方法相对于GET和POST方法，操作更加危险，因为它们可能会对服务器上的资源进行更改或删除。对于普通网页中的表单提交，这种操作可能会带来潜在的风险和滥用，因此浏览器厂商倾向于限制对这些方法的支持，以减少安全威胁。

尽管HTML表单本身不支持PUT和DELETE方法，但开发者可以通过JavaScript脚本或其他技术实现这些接口。例如，在RESTful Web服务中，尽管HTML表单只支持GET和POST，但可以通过JavaScript或其他后端技术来处理PUT和DELETE请求。

二、filter

html会将我们的请求转换为get请求，我们可以添加标志位拦截请求，在请求到达控制器之前将请求重新包装，以达到触发rest的效果。
现实中不建议大家这样做,直接用postman测试即可。

1.JSP

增加标识隐藏域_method,作为请求类型转换依据

<%--
  Created by IntelliJ IDEA.
  User: 张军国001
  Date: 2024/4/28
  Time: 20:06
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>rest</title>
</head>
<body>
<form action="/rest/user/1" method="get">
    <button type="submit">查询</button>
</form>
<form action="/rest/user/1" method="post">
    <button type="submit">新增</button>
</form>
<form action="/rest/user/1" method="put">
    <input hidden="hidden" name="_method" value="put">
    <button type="submit">更新</button>
</form>
<form action="/rest/user/1" method="delete">
    <input hidden="hidden" name="_method" value="delete">
    <button type="submit">删除</button>
</form>
</body>
</html>

2.自定义过滤器

2.1 RequestFilter

请求过滤器的作用为：当接收到带有标识的请求，根据标识值转换请求类型并存储原请求类型。

package org.example.springmvc.params.controller.filter;

import jakarta.servlet.DispatcherType;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletRequestWrapper;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.http.HttpMethod;
import org.springframework.util.StringUtils;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import java.io.IOException;
import java.util.List;
import java.util.Locale;

/**
 * Create by zjg on 2024/4/28
 */
@WebFilter(urlPatterns = "/*",dispatcherTypes = DispatcherType.REQUEST)
public class RequestFilter extends HiddenHttpMethodFilter {
    private static final List<String> ALLOWED_METHODS;
    private String methodParam = "_method";
    static {
        ALLOWED_METHODS = List.of(HttpMethod.PUT.name(), HttpMethod.DELETE.name());
    }
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        String paramValue = request.getParameter(this.methodParam);
        String method = request.getMethod();
        if ("GET".equals(method) && request.getAttribute("jakarta.servlet.error.exception") == null) {
            if (StringUtils.hasLength(paramValue)) {
                request.setAttribute(this.methodParam,method);
                String newMethod = paramValue.toUpperCase(Locale.ENGLISH);
                if (ALLOWED_METHODS.contains(newMethod)) {
                    request = new HttpMethodRequestWrapper(request, newMethod);
                }
            }
        }
        System.out.println("RequestFilter-before");
        filterChain.doFilter(request, response);
        System.out.println("RequestFilter-after");
    }
    private static class HttpMethodRequestWrapper extends HttpServletRequestWrapper {
        private final String method;

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

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

2.2 ForwardFilter

转发过滤器的作用为：在转发之前判断请求是否带有标识，有标识则获取原请求类型并进行转换。

package org.example.springmvc.params.controller.filter;

import jakarta.servlet.DispatcherType;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletRequestWrapper;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.http.HttpMethod;
import org.springframework.util.StringUtils;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import java.io.IOException;
import java.util.List;
import java.util.Locale;

/**
 * Create by zjg on 2024/4/28
 */
@WebFilter(urlPatterns = "/*",dispatcherTypes = DispatcherType.FORWARD)
public class ForwardFilter extends HiddenHttpMethodFilter {
    private static final List<String> ALLOWED_METHODS;
    private String methodParam = "_method";
    static {
        ALLOWED_METHODS = List.of(HttpMethod.GET.name(), HttpMethod.POST.name());
    }
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        String paramValue = request.getParameter(this.methodParam);
        String method = request.getMethod();
        if (paramValue!=null && method.equals(paramValue.toUpperCase(Locale.ENGLISH))) {
            String newMethod = request.getAttribute(this.methodParam)==null?"":String.valueOf(request.getAttribute(this.methodParam)).toUpperCase(Locale.ENGLISH); ;
            if (StringUtils.hasLength(newMethod)) {
                if (ALLOWED_METHODS.contains(newMethod)) {
                    request = new HttpMethodRequestWrapper(request, newMethod);
                }
            }
        }
        System.out.println("ForwardFilter-before");
        filterChain.doFilter(request, response);
        System.out.println("ForwardFilter-after");
    }
    private static class HttpMethodRequestWrapper extends HttpServletRequestWrapper {
        private final String method;

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

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

3. 执行结果

RequestFilter-before
删除用户信息:1
ForwardFilter-before
ForwardFilter-after
RequestFilter-after

总结

回到顶部

目前这种方式很少涉及到，我这样使用也是为了给大家展示一个过滤器的使用案例。
纸上得来终觉浅，绝知此事要躬行。
与诸君共勉！

spring-boot-jpa-rest-demo-filter-paging-sorting：具有过滤器，分页和排序功能的Spring Boot Data JPA
01-30
春天启动jpa休息演示过滤器分页排序使用Spring引导MVC的示例应用程序Spring Data JPA能够执行过滤，分页和排序。过滤REST API按照演示应用程序中的说明处理过滤器。 它将以下概念解析并转换为org.springframework....
【架构】RESTful API 表现层状态转移
IN THE ZONE
12-07 915
RESTFUL API 介绍 本质： 基于资源的一种软件架构风格 核心： 面向资源 解决的问题： 降低开发复杂 提高系统可伸缩性 开发一套RESTFUL API可以向所有提供服务 设计概念和准则： 网络上所有事物都可以抽象为资源 每个资源都有唯一资源标示，对资源的操作不会改变这些标示（比如删除行为：删除后的资源标示依然存在，只是资源标示所代表的资源不存在） 所有操作都是无状态的（所有操作都没有关系...
RESTful的一次理解（对状态转移的认识）
菜鸟在路上
03-27 629
RESTful 中午全称：(资源)表现层状态转移 英文全称：(Resource)Representational State Transfer 先从名字理解起来，REST省略了资源这个词，这里加上方便理解。将词分割进行理解，分别如下： 资源：服务器上的实体，例如图片，文本文件，视频等，要有个唯一标识。 在Web中这个唯一标识就是URI(Uniform Resource Identifier)。 表现层：也就是格式，json呢，xml格式呢，还是jpg格式呢。 资源的表述包括数据和描述数据的元数据，
【Springboot】第五章 接口架构风格 — RESTful
爱写bug的王六六
12-06 3764
第五章 接口架构风格 — RESTful 接口： API（Application Programming Interface，应用程序接口）是一些预先定义的接口（如函数、HTTP接口），或指软件系统不同组成部分衔接的约定。 用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。 接口（API）： 可以指访问servlet、controller的url， 调用其他程序的函数 架构风格： API 组织方式（样子） 就是一个传统的： http://localho
表示层状态转换：restful
MR_FENGG的博客
08-05 1293
RESTful 一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 REST，即Representational State Transfer的缩写         参考文章 http://www.ruanyifeng.com/blog/2011/09/re
远程过程调用(RPC)和表现层状态转移(restful)的理解
如切如磋，如琢如磨
07-10 624
这段时间接触了一些跨应用程序通信的技术，感觉眼前豁然开朗，现大略总结之。 （简单画的图，希望能大概表达清楚） 1.普通的应用程序 看图简单的说，最早，位于不同计算机上的程序肯定是不能当作一个程序的来用的，也就是C/S的那种思路。 2.restful 风格 restful是从web开发当中成长起来的风格模式，是http协议的起草者之一在2000年的博士论文中提出的，简答的说就是直接...
确保rest-api-spring-security：Spring Boot 2.2.x + Spring 5.2.x Rest Api安全示例
01-30
在这个示例中，我们将探讨如何在Spring Boot 2.2.x版本和Spring 5.2.x框架下，利用Spring Security确保REST API的安全。 首先，让我们了解核心概念： 1. **认证**：验证用户的身份，通常通过用户名和密码完成。 2. ...
spring-framework-3.0.5.RELEASE
04-17
- **国际化与本地化**：Spring MVC提供了对国际化和本地化支持，可以根据用户的语言和地区提供不同版本的内容。 - **异常处理**：Spring MVC允许自定义异常处理器，统一处理应用中的异常，提供更友好的错误页面。 ...
spring_servlet3:Spring MVC Servlet 3.0博客的源代码-mvc source code
03-24
Spring MVC 是一个基于 Java 的轻量级 Web 开发框架，它是 Spring 框架的一部分，专为构建可扩展和高性能的 MVC（Model-View-Controller）应用程序而设计。Servlet 3.0 是 Java Servlet API 的一个重要版本，它引入...
spring-json-crypt:Spring框架+ REST API +有效负载（JSON加密）
05-10
在IT行业中，Spring框架是Java领域最广泛使用的应用框架之一，尤其在开发RESTful API时。本文将深入探讨如何在Spring框架中结合REST API实现JSON数据的加密，以确保数据传输的安全性。"spring-json-crypt"项目正是...
spring boot RESTFul API拦截 以及Filter和interceptor 、Aspect区别
weixin_33963189的博客
06-27 2366
       今天学习一下RESTFul api拦截           大概有三种方式 一、通过Filter这个大家很熟悉了吧,这是java规范的一个过滤器，他会拦截请求。在springboot中一般有两种配置方式。         这种过滤器拦截并不知道你用的是哪一个Controller处理也不知道你用哪一个方法处理。   （1）第一种直接写类实现这个接口。代码如下这个要使用C...
网络通信和IO（7）：RESTfull梗概 / RESTfull和RPC的区别
qq_40373699的博客
06-19 441
RESTfull梗概 RESTFULL不是规范，也不是所谓的封装，RESTFULL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。将http协议用的更彻底了，比如http的put,delete提交方式，更加深刻了面向资源的概念，每一种URI代表一种资源并且支持get\post\put\delete动词。 RESTFUL特点包括： 1、每一个URI代表1种资源； 2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GE
Spring Boot使用过滤器和拦截器分别实现REST接口简易安全认证
weixin_34304013的博客
06-06 609
本文通过一个简易安全认证示例的开发实践，理解过滤器和拦截器的工作原理。 很多文章都将过滤器（Filter）、拦截器（Interceptor）和监听器（Listener）这三者和Spring关联起来讲解，并认为过滤器（Filter）、拦截器（Interceptor）和监听器（Listener）是Spring提供的应用广泛的组件功能。 但是严格来说，过滤器和监听器属于Servlet范畴的API，和...
RESTful Representational State Transfer 表现层状态转化
flancklin的博客
08-25 5914
说说WCF Rest [WCF REST] 一个简单的REST服务实例 RESTful        一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 概述 REST(英文:Representational State Transfer，简称
解决spring设置filter过滤器结合rest风格获取post请求body参数输入流问题
w36680130的博客
04-26 240
解决spring设置filter过滤器结合rest风格获取post请求body参数输入流问题
REST 表现层状态转换 架构说明
三心草的博客
10-09 2382
http://www.ruanyifeng.com/blog/2011/09/restful.html1、REST（Representational State Transfer）表现层状态转化，是Fielding对互联网软件的架构原则，REST的名称”表现层状态转化”中，省略了主语。”表现层”其实指的是”资源”（Resources）的”表现层”。2、资源（Reources），所谓“资源”就是网络上
Restful(表现层状态转移)
Tang_xiaochao的博客
01-01 263
Restful restful（表现层状态转移）是一种程序设计的风格基于HTTP，可以使用XML格式定义或JSON格式定义。 使用restful可以还原url的本质让请求到的地址只会显示一个单纯的url http的请求方式有很多 例 GET 获取 POST 添加 DELETE 删除 PUT 修改 PATCH 局部更新 ...
REST-表现层状态转换
Veritas_C的博客
02-17 739
REST，Representational State Transfer，即表现层状态转换，指的是一种为了让信息在互联网上顺利传递而设计的软件架构风格，即一种采用标准URI进行调用的方案。 REST的核心原则是将API拆分为逻辑上的资源，REST 的核心要素包括资源、表现层和状态转换这三个部分。 REST 是一种设计风格，而非协议或标准。而HTTP/HTTPS、HTML、XML等协议是 REST ...
Spring MVC：模拟请求方法与REST风格URL支持
- 请求地址映射是Spring MVC的核心功能之一，通过`@RequestMapping`注解，开发者可以明确地定义控制器类及其处理方法与URL的对应关系，如`@RequestMapping("/user")`表明该类负责处理"/user"路径下的请求。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值