类 AbstractJackson2HttpMessageConverter

字段详细资料

• DEFAULT_CHARSET

  @Nullable
  @Deprecated
  public static final Charset DEFAULT_CHARSET

  已过时。
  The default charset used by the converter.

• objectMapper

  protected ObjectMapper objectMapper

构造器详细资料

• AbstractJackson2HttpMessageConverter

  protected AbstractJackson2HttpMessageConverter​(ObjectMapper objectMapper)

• AbstractJackson2HttpMessageConverter

  protected AbstractJackson2HttpMessageConverter​(ObjectMapper objectMapper,
                                                 MediaType supportedMediaType)

• AbstractJackson2HttpMessageConverter

  protected AbstractJackson2HttpMessageConverter​(ObjectMapper objectMapper,
                                                 MediaType... supportedMediaTypes)

方法详细资料

• setObjectMapper

  public void setObjectMapper​(ObjectMapper objectMapper)

  Set the ObjectMapper for this view. If not set, a default ObjectMapper is used.

  Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. For example, an extended SerializerFactory can be configured that provides custom serializers for specific types. The other option for refining the serialization process is to use Jackson's provided annotations on the types to be serialized, in which case a custom-configured ObjectMapper is unnecessary.

• getObjectMapper

  public ObjectMapper getObjectMapper()

  Return the underlying ObjectMapper for this view.

• setPrettyPrint

  public void setPrettyPrint​(boolean prettyPrint)

  Whether to use the DefaultPrettyPrinter when writing JSON. This is a shortcut for setting up an ObjectMapper as follows:

   ObjectMapper mapper = new ObjectMapper();
   mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
   converter.setObjectMapper(mapper);
   

• canRead

  public boolean canRead​(Class<?> clazz,
                         @Nullable
                         MediaType mediaType)

  从类复制的说明: AbstractHttpMessageConverter
  This implementation checks if the given class is supported, and if the supported media typesinclude the given media type.

  指定者:

  canRead 在接口中 HttpMessageConverter<Object>

  覆盖:

  canRead 在类中 AbstractHttpMessageConverter<Object>

  参数:

  clazz - the class to test for readability

  mediaType - the media type to read (can be null if not specified); typically the value of a Content-Type header.

  返回:

  true if readable; false otherwise

• canRead

  public boolean canRead​(Type type,
                         @Nullable
                         Class<?> contextClass,
                         @Nullable
                         MediaType mediaType)

  从接口复制的说明: GenericHttpMessageConverter
  Indicates whether the given type can be read by this converter. This method should perform the same checks than HttpMessageConverter.canRead(Class, MediaType) with additional ones related to the generic type.

  指定者:

  canRead 在接口中 GenericHttpMessageConverter<Object>

  覆盖:

  canRead 在类中 AbstractGenericHttpMessageConverter<Object>

  参数:

  type - the (potentially generic) type to test for readability

  contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)

  mediaType - the media type to read, can be null if not specified. Typically the value of a Content-Type header.

  返回:

  true if readable; false otherwise

• canWrite

  public boolean canWrite​(Class<?> clazz,
                          @Nullable
                          MediaType mediaType)

  从类复制的说明: AbstractHttpMessageConverter
  This implementation checks if the given class is supported, and if the supported media types include the given media type.

  指定者:

  canWrite 在接口中 HttpMessageConverter<Object>

  覆盖:

  canWrite 在类中 AbstractHttpMessageConverter<Object>

  参数:

  clazz - the class to test for writability

  mediaType - the media type to write (can be null if not specified); typically the value of an Accept header.

  返回:

  true if writable; false otherwise

• logWarningIfNecessary

  protected void logWarningIfNecessary​(Type type,
                                       @Nullable
                                       Throwable cause)

  Determine whether to log the given exception coming from a ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) check.

  参数:

  type - the class that Jackson tested for (de-)serializability

  cause - the Jackson-thrown exception to evaluate (typically a JsonMappingException)

  从以下版本开始:

  4.3

• read

  public Object read​(Type type,
                     @Nullable
                     Class<?> contextClass,
                     HttpInputMessage inputMessage)
              throws IOException,
                     HttpMessageNotReadableException

  从接口复制的说明: GenericHttpMessageConverter
  Read an object of the given type form the given input message, and returns it.

  参数:

  type - the (potentially generic) type of object to return. This type must have previously been passed to the canRead method of this interface, which must have returned true.

  contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)

  inputMessage - the HTTP input message to read from

  返回:

  the converted object

  抛出:

  IOException - in case of I/O errors

  HttpMessageNotReadableException - in case of conversion errors

• readInternal

  protected Object readInternal​(Class<?> clazz,
                                HttpInputMessage inputMessage)
                         throws IOException,
                                HttpMessageNotReadableException

  从类复制的说明: AbstractHttpMessageConverter
  Abstract template method that reads the actual object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage).

  指定者:

  readInternal 在类中 AbstractHttpMessageConverter<Object>

  参数:

  clazz - the type of object to return

  inputMessage - the HTTP input message to read from

  返回:

  the converted object

  抛出:

  IOException - in case of I/O errors

  HttpMessageNotReadableException - in case of conversion errors

• getCharset

  protected Charset getCharset​(@Nullable
                               MediaType contentType)

  Determine the charset to use for JSON input.

  By default this is either the charset from the input MediaType or otherwise falling back on UTF-8. Can be overridden in subclasses.

  参数:

  contentType - the content type of the HTTP input message

  返回:

  the charset to use

  从以下版本开始:

  5.1.18

• writeInternal

  protected void writeInternal​(Object object,
                               @Nullable
                               Type type,
                               HttpOutputMessage outputMessage)
                        throws IOException,
                               HttpMessageNotWritableException

  从类复制的说明: AbstractGenericHttpMessageConverter
  Abstract template method that writes the actual body. Invoked from AbstractGenericHttpMessageConverter.write(T, java.lang.reflect.Type, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage).

  指定者:

  writeInternal 在类中 AbstractGenericHttpMessageConverter<Object>

  参数:

  object - the object to write to the output message

  type - the type of object to write (may be null)

  outputMessage - the HTTP output message to write to

  抛出:

  IOException - in case of I/O errors

  HttpMessageNotWritableException - in case of conversion errors

• writePrefix

  protected void writePrefix​(JsonGenerator generator,
                             Object object)
                      throws IOException

  Write a prefix before the main content.

  参数:

  generator - the generator to use for writing content.

  object - the object to write to the output message.

  抛出:

  IOException

• writeSuffix

  protected void writeSuffix​(JsonGenerator generator,
                             Object object)
                      throws IOException

  Write a suffix after the main content.

  参数:

  generator - the generator to use for writing content.

  object - the object to write to the output message.

  抛出:

  IOException

• getJavaType

  protected JavaType getJavaType​(Type type,
                                 @Nullable
                                 Class<?> contextClass)

  Return the Jackson JavaType for the specified type and context class.

  参数:

  type - the generic type to return the Jackson JavaType for

  contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)

  返回:

  the Jackson JavaType

• getJsonEncoding

  protected JsonEncoding getJsonEncoding​(@Nullable
                                         MediaType contentType)

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

  参数:

  contentType - the media type as requested by the caller

  返回:

  the JSON encoding to use (never null)

• getDefaultContentType

  @Nullable
  protected MediaType getDefaultContentType​(Object object)
                                     throws IOException

  从类复制的说明: AbstractHttpMessageConverter
  Returns the default content type for the given type. Called when AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) is invoked without a specified content type parameter.

  By default, this returns the first element of the supportedMediaTypes property, if any. Can be overridden in subclasses.

  覆盖:

  getDefaultContentType 在类中 AbstractHttpMessageConverter<Object>

  参数:

  object - the type to return the content type for

  返回:

  the content type, or null if not known

  抛出:

  IOException

• getContentLength

  protected Long getContentLength​(Object object,
                                  @Nullable
                                  MediaType contentType)
                           throws IOException

  从类复制的说明: AbstractHttpMessageConverter
  Returns the content length for the given type.

  By default, this returns null, meaning that the content length is unknown. Can be overridden in subclasses.

  覆盖:

  getContentLength 在类中 AbstractHttpMessageConverter<Object>

  参数:

  object - the type to return the content length for

  返回:

  the content length, or null if not known

  抛出:

  IOException