文章目录
一、HttpMessageConverter简介
HttpMessageConverter,报文信息转换器,将请求报文转换为Java对象,或将Java对象转换为响应报文
HttpMessageConverter提供了两个注解和两个类型:@RequestBody,@ResponseBody,RequestEntity,ResponseEntity。
二、用法
1. @RequestBody
@RequestBody可以获取请求体,需要在控制器方法设置一个形参,使用@RequestBody进行标识,当前请求的请求体
就会为当前注解所标识的形参赋值。
前端:
<form th:action="@{/requestBody}" method="post">
<input type="text" name="username" value="admin">
<input type="text" name="password" value="123123">
<input type="submit" value="提交">
</form>
后端:
@PostMapping("/requestBody")
public String requestBody(@RequestBody String reqBody){
System.out.println(reqBody);//username=admin&password=123123
return "success";
}
2. RequestEntity
RequestEntity封装请求报文的一种类型,需要在控制器方法的形参中设置该类型的形参,当前请求的请求报文
就会赋值给该形参,可以通过getHeaders()获取请求头信息,通过getBody()获取请求体信息。
前端:
<form th:action="@{/requestEntity}" method="post">
<input type="text" name="username" value="admin">
<input type="text" name="password" value="123123">
<input type="submit" value="requestEntity">
</form>
后端:
@PostMapping("/requestEntity")
public String requestEntity(RequestEntity<String> requestEntity) {
//获取请求头
System.out.println(requestEntity.getHeaders());
//获取请求体
System.out.println(requestEntity.getBody());
return "success";
}
3. @ResponseBody
@ResponseBody用于标识一个控制器方法,可以将该方法的返回值直接作为响应报文的响应体
响应到浏览器
前端:
<a th:href="@{/testResponse}">testResponse</a><br>
<a th:href="@{/testResponseBody}">testResponseBody</a>
后端:
@RequestMapping("testResponse")
public void testResponse(HttpServletResponse response){
try {
response.getWriter().write("hello");
} catch (IOException e) {
e.printStackTrace();
}
}
@RequestMapping("testResponseBody")
@ResponseBody//加上注解后不再跳转到页面,而是返回响应体,跟上面代码效果一致
public String testResponse(){
return "hello";
}
3.1 @ResponseBody 将java对象转为json字符串
- 导入jar包
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.12.1</version>
</dependency>
- 在SpringMVC的核心配置文件中开启mvc的注解驱动,此时在HandlerAdaptor中会自动装配一个消息转换器:MappingJackson2HttpMessageConverter,可以将响应到浏览器的Java对象转换为Json格式的字符串
<mvc:annotation-driven />
- 在处理器方法上使用@ResponseBody注解进行标识
- 将Java对象直接作为控制器方法的返回值返回,就会自动转换为Json格式的字符串
@RequestMapping("testJson")
@ResponseBody
public User testJson() {
return new User(1, "张三", "男", 123456);
}
3.2 @ResponseBody 处理ajax
前端:
<div id="app">
<a @click="testAxios" th:href="@{/testAxios}">testAxios</a><br>
</div>
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<script type="text/javascript" th:src="@{/static/js/axios.min.js}"></script>
<script type="text/javascript">
new Vue({
el:"#app",
methods:{
testAxios:function (event) {
axios({
method:"post",
url:event.target.href,
params:{
username:"admin",
password:"123456"
}
}).then(function (response) {
alert(response.data);
});
event.preventDefault();
}
}
});
</script>
后端:
@RequestMapping("/testAxios")
@ResponseBody
public String testAxios(String username, String password) {
System.out.println(username + "," + password);
return "hello,ajax";
}
4. @RestController注解
@RestController注解是springMVC提供的一个复合注解,标识在控制器的类上,就相当于为类添加了@Controller注解,并且为其中的每个方法添加了@ResponseBody注解
5. ResponseEntity实现文件上传下载
ResponseEntity用于控制器方法的返回值类型,该控制器方法的返回值就是响应到浏览器的响应报文
5.1 下载
@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
//获取ServletContext对象
ServletContext servletContext = session.getServletContext();
//获取服务器中文件的真实路径
String realPath = servletContext.getRealPath("/static/img/1.png");
//创建输入流
InputStream is = new FileInputStream(realPath);
//创建字节数组
byte[] bytes = new byte[is.available()];
//将流读到字节数组中
is.read(bytes);
//创建HttpHeaders对象设置响应头信息
MultiValueMap<String, String> headers = new HttpHeaders();
//设置要下载方式以及下载文件的名字
headers.add("Content-Disposition", "attachment;filename=1.png");
//设置响应状态码
HttpStatus statusCode = HttpStatus.OK;
//创建ResponseEntity对象
ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
//关闭输入流
is.close();
return responseEntity;
}
5.2 上传
- 添加依赖
<!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.1</version>
</dependency>xml
- spring配置文件中配置文件上传解析器
<!--配置文件上传解析器,必须标注id-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"></bean>
- 前端请求
<!--必须要设置enctype="multipart/form-data才可以上传文件,否则默认格式为key=value&key=value-->
<form th:action="@{/testUp}" method="post" enctype="multipart/form-data">
<input type="file" name="photo">
<input type="submit" value="提交">
</form>
- 后端处理
@RequestMapping(value = "testUp")
public String testUp(MultipartFile photo, HttpSession session) throws IOException {
//获取文件名
String filename = photo.getOriginalFilename();
//获取部署的路径
ServletContext servletContext = session.getServletContext();
String photoPath = servletContext.getRealPath("photo");
File photoFile = new File(photoPath);
//如果没有目录不存在则创建
if (!photoFile.exists()) {
photoFile.mkdir();
}
//上传文件到指定位置
photo.transferTo(new File(photoPath + File.separator + filename));
return "success";
}
5.3 防止文件名重复
@RequestMapping(value = "testUp")
public String testUp(MultipartFile photo, HttpSession session) throws IOException {
//获取文件名
String filename = photo.getOriginalFilename();
//获取文件后缀名
String suffixName = filename.substring(filename.lastIndexOf("."));
//创建uuid,避免文件名重复,内容被覆盖
UUID uuid = UUID.randomUUID();
//把UUID与后缀名拼接起来
filename = uuid + suffixName;
//获取p服务器中photo目录的路径
ServletContext servletContext = session.getServletContext();
String photoPath = servletContext.getRealPath("photo");
File photoFile = new File(photoPath);
//如果路径不存在则创建
if (!photoFile.exists()) {
photoFile.mkdir();
}
//上传文件到指定位置
photo.transferTo(new File(photoPath + File.separator + filename));
return "success";
}