类 ResourceHttpMessageWriter
- java.lang.Object
- org.springframework.http.codec.ResourceHttpMessageWriter
- 所有已实现的接口:
HttpMessageWriter<Resource>
public class ResourceHttpMessageWriter extends Object implements HttpMessageWriter<Resource>
HttpMessageWriterthat can write aResource.Also an implementation of
HttpMessageWriterwith support for writing one or moreResourceRegion's based on the HTTP ranges specified in the request.For reading to a Resource, use
ResourceDecoderwrapped withDecoderHttpMessageReader.- 从以下版本开始:
- 5.0
- 作者:
- Arjen Poutsma, Brian Clozel, Rossen Stoyanchev
- 另请参阅:
ResourceEncoder,ResourceRegionEncoder,HttpRange
构造器概要
构造器 构造器 说明 ResourceHttpMessageWriter()ResourceHttpMessageWriter(int bufferSize)
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 booleancanWrite(ResolvableType elementType, MediaType mediaType)Whether the given object type is supported by this writer.List<MediaType>getWritableMediaTypes()Return theMediaType's that this writer supports.reactor.core.publisher.Mono<Void>write(org.reactivestreams.Publisher<? extends Resource> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String,Object> hints)Server-side only alternative toHttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)with additional context available.reactor.core.publisher.Mono<Void>write(org.reactivestreams.Publisher<? extends Resource> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, Map<String,Object> hints)Write an given stream of object to the output message.
构造器详细资料
ResourceHttpMessageWriter
public ResourceHttpMessageWriter()
ResourceHttpMessageWriter
public ResourceHttpMessageWriter(int bufferSize)
方法详细资料
canWrite
public boolean canWrite(ResolvableType elementType, @Nullable MediaType mediaType)
从接口复制的说明:HttpMessageWriterWhether the given object type is supported by this writer.- 指定者:
canWrite在接口中HttpMessageWriter<Resource>- 参数:
elementType- the type of object to checkmediaType- the media type for the write (possiblynull)- 返回:
trueif writable,falseotherwise
getWritableMediaTypes
public List<MediaType> getWritableMediaTypes()
从接口复制的说明:HttpMessageWriterReturn theMediaType's that this writer supports.- 指定者:
getWritableMediaTypes在接口中HttpMessageWriter<Resource>
write
public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends Resource> inputStream, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, Map<String,Object> hints)
从接口复制的说明:HttpMessageWriterWrite an given stream of object to the output message.- 指定者:
write在接口中HttpMessageWriter<Resource>- 参数:
inputStream- the objects to writeelementType- the type of objects in the stream which must have been previously checked viaHttpMessageWriter.canWrite(ResolvableType, MediaType)mediaType- the content type for the write (possiblynullto indicate that the default content type of the writer must be used)message- the message to write tohints- additional information about how to encode and write- 返回:
- indicates completion or error
write
public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends Resource> inputStream, @Nullable ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, Map<String,Object> hints)
从接口复制的说明:HttpMessageWriterServer-side only alternative toHttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)with additional context available.- 指定者:
write在接口中HttpMessageWriter<Resource>actualType- the actual return type of the method that returned the value; for annotated controllers, theMethodParametercan be accessed viaResolvableType.getSource().elementType- the type of Objects in the input streammediaType- the content type to use (possiblynullindicating the default content type of the writer should be used)request- the current requestresponse- the current response- 返回:
- a
Monothat indicates completion of writing or error