REST风格及SpringMVC拦截静态资源处理

于 2023-05-20 14:04:48 发布
阅读量255 收藏 2
点赞数 1
分类专栏： SpringMVC学习笔记 文章标签： spring 分布式 mvc restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_62912377/article/details/130773882
版权

一、REST风格简介

REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格

传统风格资源描述形式

  • http://localhost/user/getById?id=1 查询id为1的用户信息
  • http://localhost/user/saveUser 保存用户信息

REST风格描述形式

  • http://localhost/user/1
  • http://localhost/user

REST的优点

  • 隐藏资源的访问行为，无法通过地址得知对资源是何种操作
  • 书写简化

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作

  • http://localhost/users 查询全部用户信息 GET（查询）
  • http://localhost/users/1 查询指定用户信息 GET（查询）
  • http://localhost/users 添加用户信息 POST（新增/保存）
  • http://localhost/users 修改用户信息 PUT（修改/更新）
  • http://localhost/users/1 删除用户信息 DELETE（删除）

上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范

根据REST风格对资源进行访问称为RESTful

  1. 使用客户/服务器(b/s、 c/s)模型。客户和服务器之间通过一个统一的接口来互相通讯。
  2. 层次化的系统。在一个REST系统中，客户端并不会固定地与一个服务器打交道。
  3. 无状态。在一个REST系统中，服务端并不会保存有关客户的任何状态。也就是说，客户端自身负责用户状态的维持，并在每次发送请求时都需要提供足够的信息。
  4. 可缓存。REST系统需要能够恰当地缓存请求，以尽量减少服务端和客户端之间的信息传输，以提高性能。
  5. 统一的接口。一个REST系统需要使用一个统一的接口来完成子系统之间以及服务与用户之间的交互。这使得REST系统中的各个子系统可以独自完成演化。

如果一个系统满足了上面所列出的五条约束，那么该系统就被称为是RESTful的。 

二、RESTFUL入门

1.环境准备

创建一个web的Maven项目，在pom.xml中添加相关依赖

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>SpringMVC_07</groupId>
    <artifactId>SpringMVC_07</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>SpringMVC_07 Maven Webapp</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>


    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>16</maven.compiler.source>
        <maven.compiler.target>16</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.0</version>
        </dependency>

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.1</version>
                <configuration>
                    <port>80</port>
                    <path>/</path>
                    <uriEncoding>UTF-8</uriEncoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

创建对应的配置类

ServletContainersInitConfig

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMVCConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //乱码处理
    protected Filter[] getServletFilters(){
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

SpringMVCConfig

@Configuration
@ComponentScan("com.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMVCConfig {
}

编写模型类User

public class User {
    private String name;
    private int age;

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

编写UserController控制类

@Controller
public class UserController {
    @RequestMapping("/save")
    @ResponseBody
    public String save(User user) {
        System.out.println("user save ..." + user);
        return "{'module':'user save'}";
    }

    @RequestMapping("/delete")
    @ResponseBody
    public String delete(Integer id) {
        System.out.println("user delete ..." + id);
        return "{'module':'user delete'}";
    }

    @RequestMapping("/update")
    @ResponseBody
    public String update(User user) {
        System.out.println("uesr update ..." + user);
        return "{'module':'user update'}";
    }

    @RequestMapping("/getById")
    @ResponseBody
    public String getById(Integer id) {
        System.out.println("user getById ..." + id);
        return "{'module':'user getById'}";
    }

    @RequestMapping("/findAll")
    @ResponseBody
    public String getAll() {
        System.out.println("user getAll ...");
        return "{'module':'user getAll'}";
    }
}

最终结构如下

删除web.xml，配置Tomcat环境，具体操作可见此处

2.新增

在UserController中修改save方法

    //设置当前请求方法为POST，表示REST风格中的添加操作
    @RequestMapping(value = "/users", method = RequestMethod.POST)
    @ResponseBody
    public String save(User user) {
        System.out.println("user save ..." + user);
        return "{'module':'user save'}";
    }

将请求路径更改为/users

在apifox中发送post请求

控制台输出

3.删除

在UserController中修改delete方法

    //设置当前请求方法为DELETE，表示REST风格中的删除操作
    @RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id) {
        System.out.println("user delete ..." + id);
        return "{'module':'user delete'}";
    }

当方法形参的名称和路径{}中的值不一致时，可以使用@PathVariable注解解决

    //设置当前请求方法为DELETE，表示REST风格中的删除操作
    @RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable("id") Integer userid) {
        System.out.println("user delete ..." + userid);
        return "{'module':'user delete'}";
    }

@PathVariable：用于接收路径参数，使用{参数名称}描述路径参数

将请求路径更改为/users/1

在apifox中发送delete请求

控制台输出

4.修改

在UserController中修改update方法

    //设置当前请求方法为PUT，表示REST风格中的修改操作
    @RequestMapping(value = "/users", method = RequestMethod.PUT)
    @ResponseBody
    public String update(@RequestBody User user) {
        System.out.println("uesr update ..." + user);
        return "{'module':'user update'}";
    }

将请求路径更改为/users

在apifox中发送put请求

控制台输出

5.按ID查询

在UserController中修改saveById方法

    //设置当前请求方法为GET，表示REST风格中的查询操作
    @RequestMapping(value = "/users/{id}", method = RequestMethod.GET)
    @ResponseBody
    public String getById(@PathVariable Integer id) {
        System.out.println("user getById ..." + id);
        return "{'module':'user getById'}";
    }

将请求路径更改为/users/1

在apifox中发送get请求

控制台输出

6.查询所有 

在UserController中修改saveAll方法

    //设置当前请求方法为GET，表示REST风格中的查询操作
    @RequestMapping(value = "/users", method = RequestMethod.GET)
    @ResponseBody
    public String getAll() {
        System.out.println("user getAll ...");
        return "{'module':'user getAll'}";
    }

将请求路径更改为/users

在apifox中发送get请求

控制台输出

对于解@RequestBody、@RequestParam、@PathVariable三个形参注解的区别

  • @RequestParam：用于接收url地址传参或表单传参
  • @RequestBody：用于接收json数据
  • @PathVariable：用于接收路径参数，使用{参数名称描述路径}
  • 后期开发中，发送请求参数超过一个时，以json格式为主，@RequestBody应用较广
  • 如果发送非json格式数据，选用@RequestParam接收请求参数
  • 采用RESTful进行开发，当参数数量较少时，例如一个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

三、RESTFUL快速开发

在RESTFUL入门中，我们可以发现每个方法都定义了访问路径/users，每个@RequestMapping注解都要使用method属性定义请求方法，每个方法响应json都需要加上@ResponseBody注解，这些操作都有很高的重复性，于是，SpringMVC为我们提供了如下解决方案

//@Controller
@RestController
@RequestMapping("/users")
public class UserController {
    //设置当前请求方法为POST，表示REST风格中的添加操作
    //@RequestMapping(value = "/users", method = RequestMethod.POST)
    //@ResponseBody
    @PostMapping
    public String save(User user) {
        System.out.println("user save ..." + user);
        return "{'module':'user save'}";
    }

    //设置当前请求方法为DELETE，表示REST风格中的删除操作
    //@RequestMapping(value = "/users/{id}", method = RequestMethod.DELETE)
    //@ResponseBody
    @DeleteMapping("/{id}")
    public String delete(@PathVariable("id") Integer userid) {
        System.out.println("user delete ..." + userid);
        return "{'module':'user delete'}";
    }

    //设置当前请求方法为PUT，表示REST风格中的修改操作
    //@RequestMapping(value = "/users", method = RequestMethod.PUT)
    //@ResponseBody
    @PutMapping
    public String update(@RequestBody User user) {
        System.out.println("uesr update ..." + user);
        return "{'module':'user update'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    //@RequestMapping(value = "/users/{id}", method = RequestMethod.GET)
    //@ResponseBody
    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id) {
        System.out.println("user getById ..." + id);
        return "{'module':'user getById'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    //@RequestMapping(value = "/users", method = RequestMethod.GET)
    //@ResponseBody
    @GetMapping
    public String getAll() {
        System.out.println("user getAll ...");
        return "{'module':'user getAll'}";
    }
}

@RestController：设置当前控制器类为RESTful风格，等同于@Conrtroller与@ResponseBody两个注解组合功能

  1. 将每个方法的@ResponseBody提到类上面，让所有的方法都有@ResponseBody的功能，而@RestController注解替换了@Controller与@ResponseBody注解，简化书写
  2. 将@RequesMapping提到类上面，用来定义所有方法共同的访问路径
  3. 使用@GetMapping、@PostMapping、@PutMapping、@DeleteMapping代替@RequestMapping中的method属性定义请求

四、SpringMVC拦截静态资源处理

当我们项目中有静态页面时

test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>测试静态页面拦截</h1>
</body>
</html>

此时我们运行服务器，访问http://localhost/pages/test.html

控制台报错

这是因为SpringMVC拦截了静态资源，根据/pages/test.html去controller找对应的方法，找不到所以会报404的错误

SpringMVC拦截静态资源的原因是因为在ServletContainersInitConfig中配置的是/，http://localhost/pages/test.html满足这个规则

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

我们可以通过配置SpringMVCSupport将静态资源放行

@Configuration
public class SpringMVCSupport extends WebMvcConfigurationSupport {
    //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/???的时候，从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }
}

具体项目是css，js等静态资源都需配置放行

在SpringMVCConfig中添加可以扫描到SpringMVCSupport的包

@Configuration
@ComponentScan({"com.controller","com.config"})
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMVCConfig {
}

此时重启服务器，访问http://localhost/pages/test.htm

王二hhh
关注
专栏目录
【SSM_SpringMVC】学习笔记05拦截器、静态资源放行、RESTFUL风格
多啦CCCC梦的百宝袋
03-05 731
一、拦截器 SpringMVC中的拦截器： 1、SpringMVC拦截器帮我们按照一定规则拦截请求，后根据开发人员自定义的拦截逻辑进行处理； 2、自定义拦截器需要实现HandlerInterceptor接口； 3、自定义的拦截器实现类需要在SpringMVC配置文件中配置； 4、可以配置多个拦截器，配置的顺序会影响到拦截器的执行顺序，先配先执行 5、HandlerInterceptor...
SpringMVC拦截器拦截静态资源的解决方法
DmxExcalibur的博客
05-24 2711
最近写项目，添加了某个拦截器之后，发现css、js、img等静态资源被拦截： 现象：项目添加登录验证的拦截器之后，清空浏览器缓存数据，再次运行项目，login页面会丢失样式、图片、js等静态资源，如果成功登录，以上静态资源会被浏览器加载并缓存，再次跳转到login.jsp会发现静态资源都已正常。 原因：第一次登录静态资源被拦截，因此样式乱。 解决方案：拦截器中遇到静态资源请求放行： Str...
详解springmvc拦截器拦截静态资源
08-31
本篇文章主要介绍了详解springmvc拦截器拦截静态资源，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
防止SpringMVC拦截器拦截js等静态资源文件
weixin_30575309的博客
05-05 158
SpringMVC提供<mvc:resources>来设置静态资源，但是增加该设置如果采用通配符的方式增加拦截器的话仍然会被拦截器拦截，可采用如下方案进行解决： 方案一、拦截器中增加针对静态资源不进行过滤(涉及spring-mvc.xml) 1 <mvc:resources location="/" mapping="/**/*.js"/> 2 ...
SpringMVC 静态资源拦截
qq_42692592的博客
07-17 257
有三种方式： 方式一：手动排除法 在我们的web.xml添加如下配置 <servlet-mapping> <servlet-name>default</servlet-name> <url-pattern>*.jpg</url-pattern> </servlet-mapping> 其他地方保持不变，这个粒度显然是比<url-pattern>/</url-pattern>更小的，它会将*.
springmvc 拦截器拦截静态资源
热门推荐
西木风落
09-13 1万+
springmvc拦截器interceptors springmvc拦截器能够对请求的资源路径进行拦截，极大的简化了拦截器的书写。但是，千万千万要注意一点：静态资源的放行。 上代码： &lt;mvc:resources mapping="/resources/**" location="/static/resources" /&gt; &lt;mvc:resources mappin...
springmvc拦截静态资源的几个解决方案
CodeWhite
07-07 373
解决方法1：在web.xml中配置： <servlet-mapping> <!--配置不过滤的静态资源,以下结尾--> <servlet-name>default</servlet-name> <url-pattern>*.jpg</url-pattern> <url-pattern>*.png</url-pattern> &
SpringMVC精品资源--RestSpringMVCDemo项目是一个基于Spring的符合REST风格的项目，.zip
最新发布
02-18
**SpringMVC与REST风格详解** SpringMVC是Spring框架的一部分，它是一个用于构建Web应用程序的模型-视图-控制器（MVC）架构。在Java世界中，SpringMVC因其强大的功能、高度的可配置性和良好的社区支持而备受青睐。...
springMVC配置静态资源放行四种方式（前两种堪称经典）以及分析
;
07-20 2601
springMVC配置静态资源放行四种方式（前两种堪称经典）以及分析 <mvc:default-servlet-handler/>的作用 <mvc:resources/>的作用 Rest风格
SpringMVC(三)文件上传_json接收_handler方法参数_静态资源处理_拦截器的实现
looperjustice的博客
11-23 581
1.1.5文件 1.1.5.1引入依赖 commons-io/commons-fileupload <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.4</version&gt
防止SpringMVC拦截器拦截js等静态资源文件的解决方法
10-19
本篇文章主要介绍了防止SpringMVC拦截器拦截js等静态资源文件的解决方法，具有一定的参考价值，有兴趣的同学可以了解一下
静态资源访问与拦截
cws1214的专栏
09-11 1万+
静态资源访问映射： 先调整web.xml中的DispatcherServlet的配置，使其可以捕获所有的请求： 1 2 3 4 5 6 7 8 9         springMVC         class>org.springframework.web.servlet.Disp
SpringMVC中静态资源拦截问题以及SpringMVC中文件的上传流程、细节
qq_50313418的博客
03-14 2991
1. SpringMVC中静态资源拦截问题 # springmvc中静态资源拦截问题 1. 出现静态资源拦截问题的原因 注意：由于在web.xml中配置springmvc的核心servlet DispatcherServlet 时url-pattern 配置为“/”， 因此会导致项目中所有 / 开头请求，均被视为控制器请求处理，这样会导致项目中的静态资源(css,js,imp) 被拦截 解决方案： 1. url-pattern / 导致静态资源拦截 *.ac
springMVC 将拦截的静态资源的释放
爱码者的博客
04-29 1195
将拦截的静态资源的释放 当springMVC配置前端控制器拦截的所有请求时，去掉静态资源的拦截 1、前端控制器的配置 <!-- springmvc的前端控制器 --> <servlet> <servlet-name>springMVC</servlet-name> <...
SpringMVC默认拦截静态资源解决
揣金磊 的博客
01-03 378
No mapping found for HTTP request with URI[/ResponseBodyTest/js/jquery-1.11.0.min.js] in DispathcherServlet with name’springmvc 查看静态资源路径：发现请求路径并没有写错,出错的原因是什么呢？ 原因：核心控制器拦截的路径是/，/表示“http://localhost:...
SpringMVC过滤静态资源四种方式
weixin_34000916的博客
05-28 3788
2019独角兽企业重金招聘Python工程师标准>>> ...
SpringMVC框架|静态资源无法访问问题
匿名攻城狮
02-21 1812
文章目录静态资源无法访问问题说明解决方案 静态资源无法访问问题说明 使用restful开发风格会遇到静态资源无法访问问题，比如下面项目中的一张图片，当直接在浏览器中访问http://localhost:8080/SpringMVC02/img/img01.jpg会出现404的情况。 这是restful开发风格的一个自带问题，因为使用了restful开发风格，当访问静态资源时，被前端控制器拦截...
关于SpringBoot增加@EnableWebMvc导致静态资源无法访问
SSL 的博客
01-21 1009
问题描述 当Springboot项目中配置SpringMVC配置之后原来能访问的静态资源均失效 WebConfig @Configuration @EnableWebMvc public class WebConfig implements WebMvcConfigurer { } 静态资源失效 问题原因 在配置MVC的时候加入了@EnableWebMvc导致Springboot自动配置的MVC被我们自定义的配置文件替代，SpringBoot自动配置中将St...
关于@requestMapping跳转页面静态资源无法加载问题
qq_36903109的博客
06-05 2672
只需在jsp页面加上一下代码即可 String path = request.getContextPath(); String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + path + "/"; %>    "
SpringMVC 3.0：静态资源处理与REST风格URL支持详解
总结来说，Spring MVC的静态资源处理是通过配置和利用其核心组件来实现的，包括合理的URL映射、适配器的选择以及对REST风格API的支持。理解这些原理有助于开发人员更有效地构建和管理Web应用，提升项目的整体性能...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值