类 AbstractJackson2Encoder

构造器详细资料

• AbstractJackson2Encoder

  protected AbstractJackson2Encoder​(ObjectMapper mapper,
                                    MimeType... mimeTypes)

  Constructor with a Jackson ObjectMapper to use.

方法详细资料

• setStreamingMediaTypes

  public void setStreamingMediaTypes​(List<MediaType> mediaTypes)

  Configure "streaming" media types for which flushing should be performed automatically vs at the end of the stream.

  By default this is set to MediaType.APPLICATION_STREAM_JSON.

  参数:

  mediaTypes - one or more media types to add to the list

  另请参阅:

  HttpMessageEncoder.getStreamingMediaTypes()

• canEncode

  public boolean canEncode​(ResolvableType elementType,
                           @Nullable
                           MimeType mimeType)

  从接口复制的说明: Encoder
  Whether the encoder supports the given source element type and the MIME type for the output stream.

  指定者:

  canEncode 在接口中 Encoder<Object>

  参数:

  elementType - the type of elements in the source stream

  mimeType - the MIME type for the output stream (can be null if not specified)

  返回:

  true if supported, false otherwise

• encode

  public reactor.core.publisher.Flux<DataBuffer> encode​(org.reactivestreams.Publisher<?> inputStream,
                                                        DataBufferFactory bufferFactory,
                                                        ResolvableType elementType,
                                                        @Nullable
                                                        MimeType mimeType,
                                                        @Nullable
                                                        Map<String,​Object> hints)

  从接口复制的说明: Encoder
  Encode a stream of Objects of type T into a DataBuffer output stream.

  指定者:

  encode 在接口中 Encoder<Object>

  参数:

  inputStream - the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance of Mono should be used.

  bufferFactory - for creating output stream DataBuffer's

  elementType - the expected type of elements in the input stream; this type must have been previously passed to the Encoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.

  mimeType - the MIME type for the output content (optional)

  hints - additional information about how to encode

  返回:

  the output stream

• encodeValue

  public DataBuffer encodeValue​(Object value,
                                DataBufferFactory bufferFactory,
                                ResolvableType valueType,
                                @Nullable
                                MimeType mimeType,
                                @Nullable
                                Map<String,​Object> hints)

  从接口复制的说明: Encoder
  Encode an Object of type T to a data buffer. This is useful for scenarios, that distinct messages (or events) are encoded and handled individually, in fully aggregated form.

  By default this method raises UnsupportedOperationException and it is expected that some encoders cannot produce a single buffer or cannot do so synchronously (e.g. encoding a Resource).

  指定者:

  encodeValue 在接口中 Encoder<Object>

  参数:

  value - the value to be encoded

  bufferFactory - for creating the output DataBuffer

  valueType - the type for the value being encoded

  mimeType - the MIME type for the output content (optional)

  hints - additional information about how to encode

  返回:

  the encoded content

• customizeWriter

  protected ObjectWriter customizeWriter​(ObjectWriter writer,
                                         @Nullable
                                         MimeType mimeType,
                                         ResolvableType elementType,
                                         @Nullable
                                         Map<String,​Object> hints)

• getJsonEncoding

  protected JsonEncoding getJsonEncoding​(@Nullable
                                         MimeType mimeType)

  Determine the JSON encoding to use for the given mime type.

  参数:

  mimeType - the mime type as requested by the caller

  返回:

  the JSON encoding to use (never null)

  从以下版本开始:

  5.0.5

• getEncodableMimeTypes

  public List<MimeType> getEncodableMimeTypes()

  从接口复制的说明: Encoder
  Return the list of mime types this encoder supports.

  指定者:

  getEncodableMimeTypes 在接口中 Encoder<Object>

• getStreamingMediaTypes

  public List<MediaType> getStreamingMediaTypes()

  从接口复制的说明: HttpMessageEncoder
  Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.

  指定者:

  getStreamingMediaTypes 在接口中 HttpMessageEncoder<Object>

• getEncodeHints

  public Map<String,​Object> getEncodeHints​(@Nullable
                                                 ResolvableType actualType,
                                                 ResolvableType elementType,
                                                 @Nullable
                                                 MediaType mediaType,
                                                 ServerHttpRequest request,
                                                 ServerHttpResponse response)

  从接口复制的说明: HttpMessageEncoder
  Get decoding hints based on the server request or annotations on the target controller method parameter.

  指定者:

  getEncodeHints 在接口中 HttpMessageEncoder<Object>

  参数:

  actualType - the actual source type to encode, possibly a reactive wrapper and sourced from MethodParameter, i.e. providing access to method annotations.

  elementType - the element type within Flux/Mono that we're trying to encode.

  request - the current request

  response - the current response

  返回:

  a Map with hints, possibly empty

• getAnnotation

  protected <A extends Annotation> A getAnnotation​(MethodParameter parameter,
                                                   Class<A> annotType)

  指定者:

  getAnnotation 在类中 Jackson2CodecSupport