SpringMVC-RESTful与HttpMessageConverter

zl979899

已于 2025-02-21 19:56:11 修改

阅读量702

点赞数 21

分类专栏： SSM 文章标签： restful 后端 spring

于 2025-02-17 00:45:51 首次发布

本文链接：https://blog.youkuaiyun.com/zl979899/article/details/122286016

版权

SSM 专栏收录该内容

23 篇文章

订阅专栏

RESTful

REST：Representational State Transfer，表现层资源状态转移。
资源：是一种看待服务器的方式，即，将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。一个资源可以由一个或多个URI来标识。URI既是资源的名称，也是资源在Web上的地址。
资源的表述：是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移（交换）。资源的表述可以有多种格式，例如HTML/XML/JSON/纯文本/图片/视频/音频等
状态转移：在客户端和服务器端之间转移（transfer）代表资源状态的表述

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请求方式

HiddenHttpMethodFilter

HiddenHttpMethodFilter将 POST 请求转换为 DELETE 或 PUT 请求
当前请求的请求方式必须为post
当前请求必须传输请求参数_method
web.xml中注册HiddenHttpMethodFilter
SpringMVC中提供了两个过滤器：CharacterEncodingFilter和HiddenHttpMethodFilter

在web.xml中注册时，必须先注册CharacterEncodingFilter，再注册HiddenHttpMethodFilter

在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的，该方法要求前面不能有任何获取请求参数的操作

而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作：
String paramValue = request.getParameter(this.methodParam);

<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>

HttpMessageConverter

报文信息转换器，将请求报文转换为Java对象，或将Java对象转换为响应报文
提供了两个注解和两个类型：@RequestBody，@ResponseBody，RequestEntity，ResponseEntity

@RequestBody

设置一个形参，使用@RequestBody进行标识，当前请求的请求体就会为当前注解所标识的形参赋值

@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String requestBody){
    System.out.println("requestBody:"+requestBody);
    return "success";
}

RequestEntity

设置该类型的形参，当前请求的请求报文就会赋值给该形参
可以通过getHeaders()获取请求头信息，通过getBody()获取请求体信息

@RequestMapping("/testRequestEntity")
public String testRequestEntity(RequestEntity<String> requestEntity){
    System.out.println("requestHeader:"+requestEntity.getHeaders());
    System.out.println("requestBody:"+requestEntity.getBody());
    return "success";
}

@ResponseBody

@ResponseBody用于标识一个控制器方法
可以将该方法的返回值直接作为响应报文的响应体响应到浏览器，浏览器页面显示返回的内容
使用步骤如下：

导入jackson的依赖

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

配置文件中开启mvc的注解驱动，此时在HandlerAdaptor中会自动装配一个消息转换器：MappingJackson2HttpMessageConverter，可以将响应到浏览器的Java对象转换为Json格式的字符串
```
<mvc:annotation-driven />
```
在处理器方法上使用@ResponseBody注解进行标识

将Java对象直接作为控制器方法的返回值返回，就会自动转换为Json格式的字符串

@RequestMapping("/testResponseUser")
@ResponseBody
public User testResponseUser(){
    return new User(1001,"admin","123456",23,"男");
}

@RestController

相当于为类添加了@Controller注解，并且为其中的每个方法添加了@ResponseBody注解

ResponseEntity

用于控制器方法的返回值类型，该控制器方法的返回值就是响应到浏览器的响应报文
可以使用ResponseEntity实现下载文件的功能