请求信息通常都是通过输入流传给应用系统,又通过输出流将信息传递给客户。SpringMVC 就是通过 HttpMessageConverter<T> 将请求信息转换成一个对象(T类型),将对象(类型为T)输出为响应信息。
public interface HttpMessageConverter<T> {
/**
*指定类型转换器可以读取的对象类型,即转换器是否可将请求信息转换为clazz类型的对象,同时指定支持MIME类型(text/html,application/json等)
*/
boolean canRead(Class<?> clazz, MediaType mediaType);
/**
* 指定类型转换器是否可将clazz类型的对象写到响应流中,响应流支持的媒体类型在MediaType中定义
*/
boolean canWrite(Class<?> clazz, MediaType mediaType);
/**
* 该转换器支持的媒体类型
*/
List<MediaType> getSupportedMediaTypes();
/**
* 将请求信息流转换为T类型的对象
*/
T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
throws IOException, HttpMessageNotReadableException;
/**
* 将T类型的对象写到响应信息流中,同事指定相应的媒体类型为contentType
*/
void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
throws IOException, HttpMessageNotWritableException;
}
DispatcherServlet 默认情况下装配RequestMappingHandlerAdapter,而 RequestMappingHandlerAdapter 默认情况下装配的HttpMessageConverter有6个,而将jackson的jar包引入之后装配的多了一个利用MapperObject读写json的转换器。
实现类 | 功能说明 |
---|---|
ByteArrayHttpMessageConverter | 读写二进制数据 |
StringHttpMessageConverter | 将请求转换为字符串 |
ResourceHttpMessageConverter | 读写org.springframework.core.io.Resource对象 |
FormHttpMessageConverter | 将表单数据读取到MultiValueMap中 |
SourceHttpMessageConverter | 读写javax.xml.transform.Source类型的对象 |
Jaxb2RootElementHttpMessageConverter | 利用JAXB2读写xml消息,将请求消息转换为标准的XmlRootElement和XxmlType直接的类中 |
MappingJaskson2HttpMessageConverter | 利用Jaskson开源包的 MapperObject读写json数据 |
所以我们这里只需要将jaskson的jar包加到运行环境中就可以了。
/**
* 返回json
* @return
*/
@ResponseBody
@RequestMapping("/testJson")
public Collection<Employee> testJson() {
return employeeDao.getAll();
}
@ResponseBody
@RequestMapping("/testHttpMessageConverter")
public String testHttpMessageConverter(@RequestBody String body) {
System.out.println(body);
return "testHttpMessageConverter: " + new Date();
}
@RequestMapping("/testResponseEntity")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
ServletContext context = session.getServletContext();
InputStream input = context.getResourceAsStream("file/abc.txt");
byte[] body = new byte[input.available()];
input.read(body);
HttpHeaders headers = new HttpHeaders();
headers.add("Content-Disposition", "application;filename=abc.txt");
HttpStatus status = HttpStatus.OK;
ResponseEntity<byte[]> response = new ResponseEntity<byte[]>(body, headers, status);
return response;
}
使用 HttpMessageConverter 将请求信息转化并绑定到处理方法的入参或将响应结果转为对应类型的响应信息,SpringMVC提供了两种途径
- 使用@RequestBody/@ResponseBody对处理方法进行标注
- 使用@HttpEntity<T>/@ResponseEntity<T>作为处理方法的入参或返回值
当控制器处理方法使用到@RequestBody/@ResponseBody或@HttpEntity<T>/@ResponseEntity<T>时,Spring首先根据请求头或者响应头的Accept属性选择匹配的HttpMessageConverrter,进而根据参数类型或泛型类型的过滤得到匹配的HttpMessageConverrter,若找不到匹配的HttpMessageConverrter将报错。
@RequestBody和@ResponseBody不需要成对出现。