ResponseEntity
ResponseEntity
对象是Spring
对请求响应的封装。它集成了HttpEntity
对象,包含了http的响应码(httpstatus)、响应头(header)、响应体(body)三个部分。一个获取用户信息的Spring MVC接口通常我们直接返回实体即可(配合@RestController
)
1 |
|
等同于使用ResponseEntity
作为控制器接口的返回值:
1 |
|
但是使用ResponseEntity
时我们可以做更多事情
自定义响应码
上面的ResponseEntity.ok
已经包含了返回200
Http响应码,我们还可以通过ResponseEntity.status(HttpStatus|int)
来自定义返回的响应码
自定义响应体
放置响应的响应体,通常就是我们接口的数据,这里是一个例子:
1 | ResponseEntity.status(HttpStatus.ok).body(Object) |
响应头
通常我们制定Spring MVC接口的响应头是通过@RequestMapping
和其Restful系列注解中的header()
、consumes
、produces()
这几个属性设置。如果你使用了ResponseEntity
,可以通过链式调用来设置:
1 | ResponseEntity.status(HttpStatus.ok) |
所有的标准请求头都有对应的设置方法,你也可以通过header(String headerName, String... headerValues)
设置自定义请求头
大致原理
我们来看一个用来处理Spring MVC控制器接口返回值的抽象接口HandlerMethodReturnValueHandler
1 | public interface HandlerMethodReturnValueHandler { |
它的一个重要实现HttpEntityMethodProcessor
就是处理返回类型为HttpEntity
的控制器方法的处理器。它会把ResponseEntity
携带的三种信息交给ServletServerHttpResponse
对象渲染视图,并设置处理标志以指示已直接处理响应,后续的其他方法不处理了,优先级非常高
实战运用
通常让你写个下载文件接口都是拿到HttpServletResponse
对象,然后配置好Content-Type
往里面写流。如果用ResponseEntity
会更加简单优雅
1 |
|
上面是一个把Spring Boot配置文件application.yml
下载下来的例子。主要分为三步:
将要下载的文件封装成
org.springframework.core.io.Resource
对象,它有很多实现。这里用了ClassPathResource
,其他InputStreamResource
、PathResource
都是常用的实现。然后配置下载请求头
Content-Disposition
。针对下载它有两种模式:inline
表示在浏览器直接展示文件内容;attachment
表示下载为文件。另外下载后的文件名也在这里指定,请不要忘记文件扩展名,例如这里application.yml
。如果不指定Content-Disposition
,你需要根据文件扩展名设置对应的Content-Type
,会麻烦一些。最后是组装
ResponseEntity<Resource>
返回。
转载自@felord.cn