SpringMVC将请求和响应的数据转换为JSON格式的几种方式

2022-07-09 09:15:25

SpringMVC

RESTful

概述

REST：Representational State Transfer，表现层资源状态转移。

表现层：前端的视图页面和后端的控制层就是表现层

资源

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

URI ：统一资源标识符（Uniform Resource Identifier，URI)是一个用于标识某一互联网资源名称的字符串。
统一资源定位符（Uniform Resource Locator，URL）,统一资源名称（Uniform Resource Name，URN）是URI的子集。

资源的表述

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

状态转移

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

RESTful 的实现

  • 具体说，就是 HTTP 协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。
  • 它们分别对应四种基本操作：GET 用来获取资源，POST 用来新建资源，PUT 用来更新资源，DELETE 用来删除资源。
  • REST 风格提倡 URL 地址使用统一的风格设计，从前到后各个单词使用斜杠分开，不使用问号键值对方式携带请求参数，而是将要发送给服务器的数据作为 URL 地址的一部分，以保证整体风格的一致性。
操作传统方式REST风格
查询操作getUserById?id=1user/1–>get请求方式
保存操作saveUseruser–>post请求方式
删除操作deleteUser?id=1user/1–>delete请求方式
更新操作updateUseruser–>put请求方式

案例

  • 该案例我写在 demo3 中（也可创建一个新的项目），大致需要的文件如下：

    在这里插入图片描述

  • 创建 user.html 并编写用来测试的表单和超链接

    <!DOCTYPEhtml><htmllang="en"xmlns:th="http://www.thymeleaf.org"><head><metacharset="UTF-8"><title>使用RESTFul模拟操作用户资源（增删改查）</title></head><body><h1>使用RESTFul模拟操作用户资源（增删改查）</h1><ath:href="@{/user}">查询所有用户信息</a><br/><ath:href="@{/user/1}">根据用户ID查询用户信息</a><br/><formmethod="post"th:action="@{/user}">
        用户名：<inputtype="text"name="username"><br/>
        密码：<inputtype="text"name="password"><br/><inputtype="submit"value="添加用户信息"></form><formmethod="put"th:action="@{/user}">
        用户名：<inputtype="text"name="username"><br/>
        密码：<inputtype="text"name="password"><br/><inputtype="submit"value="根据用户ID修改用户信息"></form><formmethod="delete"th:action="@{/user}">
        用户ID：<inputtype="text"name="id"><br/><inputtype="submit"value="根据用户ID删除对应用户信息"></form></body></html>

  • 编写对应的控制器方法

    packagecom.laoyang.mvc.controller;importorg.springframework.stereotype.Controller;importorg.springframework.web.bind.annotation.*;/**
 * @ClassName UserController
 * @Description： 使用RESTFul模拟操作用户资源（增删改查）
 * @Author Laoyang
 * @Date 2022/1/13 15:53
 */@ControllerpublicclassUserController{/**
     * 查询所有用户信息
     * /user  --->  GET
     */@RequestMapping(value="/user", method=RequestMethod.GET)publicStringfindAllUser(){System.out.println("查询所有用户信息");return"success";}/**
     * 根据用户ID查询用户信息
     * /user/1  --->  GET
     */@RequestMapping(value="/user/{id}", method=RequestMethod.GET)publicStringfindByUserId(@PathVariable("id")Integer id){System.out.println("id="+ id);System.out.println("根据用户ID查询用户信息");return"success";}/**
     * 添加用户信息
     * /user  --->  POST
     */@RequestMapping(value="/user", method=RequestMethod.POST)publicStringsaveUser(String username,String password){System.out.println("username="+ username+";password="+ password);System.out.println("添加用户信息");return"success";}/**
     * 根据用户ID修改用户信息
     * /user  --->  PUT
     */@RequestMapping(value="/user", method=RequestMethod.PUT)publicStringupdateUser(String username,String password){System.out.println("username="+ username+"；password="+ password);System.out.println("根据用户ID修改用户信息");return"success";}/**
     * 根据用户ID删除对应用户信息
     * /user/1  --->  DELETE
     */@RequestMapping(value="/user", method=RequestMethod.DELETE)publicStringdeleteUser(Integer id){System.out.println("id="+ id);System.out.println("根据用户ID删除对应用户信息");return"success";}}

  • 在 spring-mvc.xml 文件中配置页面跳转

    <?xml version="1.0" encoding="UTF-8"?><beansxmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"xmlns:mvc="http://www.springframework.org/schema/mvc"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd"><!-- 扫描组件 --><context:component-scanbase-package="com.laoyang.mvc"/><!-- 配置 Thymeleaf 视图解析器 --><beanid="viewResolver"class="org.thymeleaf.spring5.view.ThymeleafViewResolver"><!-- 优先级 --><propertyname="order"value="1"/><!-- 字符编码 --><propertyname="characterEncoding"value="UTF-8"/><!-- 模板 --><propertyname="templateEngine"><beanclass="org.thymeleaf.spring5.SpringTemplateEngine"><propertyname="templateResolver"><beanclass="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver"><!-- 视图前缀 --><propertyname="prefix"value="/WEB-INF/templates/"/><!-- 视图后缀 --><propertyname="suffix"value=".html"/><!-- 模板模型 --><propertyname="templateMode"value="HTML5"/><!-- 页面编码格式 --><propertyname="characterEncoding"value="UTF-8"/></bean></property></bean></property></bean><!--
        path：设置处理的请求地址，该路径是和 @RequestMapping 注解中的地址是一样的
        简单理解：就是把 controller 中用来跳转页面的控制器方法写在了配置文件中
        view-controller：设置请求地址所对应的视图名称
    --><!-- 访问方式：http://localhost:8080/springmvc/ --><mvc:view-controllerpath="/"view-name="index"/><!-- 访问方式：http://localhost:8080/springmvc/doView --><mvc:view-controllerpath="/doView"view-name="view"/><!-- 访问方式：localhost:8080/springmvc/doUser，这一步是新增的代码 --><mvc:view-controllerpath="/doUser"view-name="user"/><!-- 开启 mvc 的注解驱动 --><mvc:annotation-driven/></beans>

  • 启动Tomcat查看效果（访问localhost:8080/springmvc/doUser）

    • 查询所有用户

    • 根据用户ID查询对应的用户信息

    • 添加用户信息

      在这里插入图片描述

      以上三个都是可以正常访问的，但是浏览器效果都是跳转到 success 页面，所以大家看控制台打印就可以看那个方法被执行了。

    • 根据用户ID修改用户信息

    • 根据用户ID删除对应用户信息

      在这里插入图片描述

      在这里插入图片描述

      这里截的图是修改的效果，目前是不满足我们的需求的，删除效果和这个差不多，就不另做演示了

  • 问题说明： 因为修改和删除的表单提交的请求方式是 put 和 delete，而浏览器基本上都只支持 get 和 post 请求，所以会导致无法通过 put 或 delete 方式进行处理，所以遇到这种情况的时候，浏览器默认会以 get 请求方式进行处理，所以修改和删除所映射到的控制器方法是 GET 类型的（查询所有用户，可以观察控制台打印的语句）

  • 解决方案： 可注册 HiddenHttpMethodFilter 过滤器处理除 get 和 post 之外的几种请求方式，通过这个过滤器就可以解决刚才的问题

    这里我先简单说明一下，如果想要在了解一些东西可以看后面的 HiddenHttpMethodFilter 解析

  • 在 web.xml 中配置 HiddenhttpMethodFilter

    <?xml version="1.0" encoding="UTF-8"?><web-appxmlns="http://xmlns.jcp.org/xml/ns/javaee"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"version="4.0"><!-- 配置HiddenHttpMethodFilter过滤器 --><filter><filter-name>hidden</filter-name><filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class></filter><!-- 注册前端控制器 DispatcherServlet --><servlet><servlet-name>springMVC</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><!-- 初始化参数 --><init-param><param-name>contextConfigLocation</param-name><param-value>classpath:spring-mvc.xml</param-value></init-param><!-- 初始化前端控制器，将前端控制器 DispatcherServlet 的初始化时间提前到服务器启动时 --><load-on-startup>1</load-on-startup></servlet><!--
     设置字符编码格式
     注意：设置编码格式之前不可以获取任何请求参数，如果获取了，就会导致设置的字符编码失效！从而导致拿到的数据是乱码。
     > 所以字符编码的 filter-mapping 标签一定要放在其它 filter-mapping 标签前面！！！
     --><filter><filter-name>encoding-filter</filter-name><filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class><!-- 指定要使用的编码格式 --><init-param><param-name>encoding</param-name><param-value>UTF-8</param-value></init-param><!-- 强制使用我们设置的编码格式，默认是false（不强制） --><init-param><param-name>forceEncoding</param-name><param-value>true</param-value></init-param></filter><!-- 字符编码的处理规则，必须在其他处理规则之前 --><filter-mapping><filter-name>encoding-filter</filter-name><url-pattern>/*</url-pattern></filter-mapping><!-- 前端控制器请求处理规则 --><servlet-mapping><servlet-name>springMVC</servlet-name><url-pattern>/</url-pattern></servlet-mapping><!-- 请求方式的处理规则 --><filter-mapping><filter-name>hidden</filter-name><url-pattern>/*</url-pattern></filter-mapping></web-app>

    注意： 编写 web.xml 文件的时候一定要注意，字符编码的处理规则一定要放在最上面！因为设置字符编码之前不可以获取到任何一个参数！如果你先让其它的处理规则先执行，那么这些请求规则就可能会带有参数，一旦带有参数，就会导致我们所设置的字符编码失效（简单来说，就是即使我们设置了字符编码，拿到的数据也还是乱码！），所以千万要注意！！！

    Ps：web.xml 文件基本上的配置就是这些，两个过滤器，一个 Servlet，只要是使用 SpringMVC，这几个配置就不能少！

  • 配置完之后还需要将提交方式修改为 POST，并且传一个参数_method，这个参数的值就是我们最终的提交方式，HiddenHttpMethodFilter 会根据这个参数进行处理

    <!DOCTYPEhtml><htmllang="en"xmlns:th="http://www.thymeleaf.org"><head><metacharset="UTF-8"><title>使用RESTFul模拟操作用户资源（增删改查）</title></head><body><h1>使用RESTFul模拟操作用户资源（增删改查）</h1><formmethod="post"th:action="@{/user}"><!-- 因为这个参数只是给过滤器进行处理的，所以我们使用隐藏域来传，这样就不会影响到用户使用了 --><inputtype="hidden"name="_method"value="PUT">
        用户名：<inputtype="text"name="username"><br/>
        密码：<inputtype="text"name="password"><br/><inputtype="submit"value="根据用户ID修改用户信息"></form><formmethod="post"th:action="@{/user}"><</
  • 作者：万能的小白。
  • 原文链接：https://blog.csdn.net/Cicci_/article/details/122610082
    更新时间：2022-07-09 09:15:25