クラス JsonSerializer<T>

java.lang.ObjectSE
org.springframework.kafka.support.serializer.JsonSerializer<T>
型パラメーター:
T - メッセージを表すエンティティのクラス
実装されているすべてのインターフェース:
CloseableSE、AutoCloseableSE、org.apache.kafka.common.serialization.Serializer<T>
@DeprecatedSE(forRemoval=true, since="4.0") public class JsonSerializer<T> extends ObjectSE implements org.apache.kafka.common.serialization.Serializer<T>
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
4.0 以降、Jackson 3 では JacksonJsonSerializer が優先されます。
Java オブジェクトを JSON として Kafka に送信するための汎用 Serializer。

IMPORTANT: 構成は、プロパティ setter を使用して、または configure(Map, boolean) を介して完全に行う必要があり、混合ではありません。setter が呼び出された場合、configure(Map, boolean) はノーオペレーションになります。

作成者:
Igor Stepanov, Artem Bilan, Gary Russell, Elliot Kennedy, Wang Zhiyang, Omer Celik

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    ADD_TYPE_INFO_HEADERS
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    型ヘッダーの追加を無効にするための Kafka 構成プロパティ。
    protected boolean
    addTypeInfo
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected final com.fasterxml.jackson.databind.ObjectMapper
    objectMapper
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    static final StringSE
    TYPE_MAPPINGS
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    型マッパーに型マッピングを追加するための Kafka 構成プロパティ: 'foo:com.Foo、bar:com.Bar'。
    protected Jackson2JavaTypeMapper
    typeMapper
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    JsonSerializer()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JsonSerializer(com.fasterxml.jackson.core.type.TypeReference<? super T> targetType)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JsonSerializer(com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JsonSerializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JsonSerializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    close()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    configure(MapSE<StringSE,?> configs, boolean isKey)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    <X> JsonSerializer<X>
    copyWithType(com.fasterxml.jackson.core.type.TypeReference<? super X> newTargetType)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    新しいターゲット型参照が使用されることを除いて、このシリアライザーを同じ構成でコピーします。
    <X> JsonSerializer<X>
    copyWithType(com.fasterxml.jackson.databind.JavaType newTargetType)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    新しいターゲット java 型が使用されることを除いて、同じ構成でこのシリアライザーをコピーします。
    <X> JsonSerializer<X>
    copyWithType(ClassSE<? super X> newTargetType)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    新しいターゲット型参照が使用されることを除いて、このシリアライザーを同じ構成でコピーします。
    protected static MapSE<StringSE,ClassSE<?>>
    createMappings(StringSE mappings)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JsonSerializer<T>
    forKeys()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    キーを直列化するためにこのシリアライザーを指定します（デフォルトは値です）。デフォルトの型マッパーが使用されている場合にのみ適用されます。
    Jackson2JavaTypeMapper
    getTypeMapper()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    boolean
    isAddTypeInfo()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JsonSerializer<T>
    noTypeInfo()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    型情報ヘッダーを含めないでください。
    byte[]
    serialize(StringSE topic, @Nullable T data)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    byte[]
    serialize(StringSE topic, org.apache.kafka.common.header.Headers headers, @Nullable T data)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    setAddTypeInfo(boolean addTypeInfo)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    型情報ヘッダーの追加を無効にするには、false に設定します。
    void
    setTypeMapper(Jackson2JavaTypeMapper typeMapper)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    カスタマイズされた型マッパーを設定します。
    void
    setUseTypeMapperForKey(boolean isKey)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    キー型ヘッダーを使用するようにデフォルトの Jackson2JavaTypeMapper を構成します。
    JsonSerializer<T>
    typeMapper(Jackson2JavaTypeMapper mapper)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    付属の Jackson2JavaTypeMapper を使用してください。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • フィールドの詳細

    • ADD_TYPE_INFO_HEADERS

      public static final StringSE ADD_TYPE_INFO_HEADERS
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      型ヘッダーの追加を無効にするための Kafka 構成プロパティ。
      関連事項:

    • TYPE_MAPPINGS

      public static final StringSE TYPE_MAPPINGS
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      型マッパーに型マッピングを追加するための Kafka 構成プロパティ: 'foo:com.Foo、bar:com.Bar'。
      関連事項:

    • objectMapper

      protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • addTypeInfo

      protected boolean addTypeInfo
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • typeMapper

      protected Jackson2JavaTypeMapper typeMapper
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • コンストラクターの詳細

    • JsonSerializer

      public JsonSerializer()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • JsonSerializer

      public JsonSerializer(com.fasterxml.jackson.core.type.TypeReference<? super T> targetType)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • JsonSerializer

      public JsonSerializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • JsonSerializer

      public JsonSerializer(com.fasterxml.jackson.core.type.TypeReference<? super T> targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • JsonSerializer

      public JsonSerializer(@Nullable com.fasterxml.jackson.databind.JavaType targetType, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドの詳細

    • isAddTypeInfo

      public boolean isAddTypeInfo()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • setAddTypeInfo

      public void setAddTypeInfo(boolean addTypeInfo)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      型情報ヘッダーの追加を無効にするには、false に設定します。
      パラメーター:
      addTypeInfo - ヘッダーを追加する場合は true。
      導入:
      2.1

    • getTypeMapper

      public Jackson2JavaTypeMapper getTypeMapper()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • setTypeMapper

      public void setTypeMapper(Jackson2JavaTypeMapper typeMapper)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      カスタマイズされた型マッパーを設定します。
      パラメーター:
      typeMapper - 型マッパー。
      導入:
      2.1

    • setUseTypeMapperForKey

      public void setUseTypeMapperForKey(boolean isKey)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      キー型ヘッダーを使用するようにデフォルトの Jackson2JavaTypeMapper を構成します。
      パラメーター:
      isKey - true の場合、キー型 ヘッダーを使用する
      導入:
      2.1.3

    • configure

      public void configure(MapSE<StringSE,?> configs, boolean isKey)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      次で指定:
      インターフェース org.apache.kafka.common.serialization.Serializer<T> の configure 

    • createMappings

      protected static MapSE<StringSE,ClassSE<?>> createMappings(StringSE mappings)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • serialize

      public byte[] serialize(StringSE topic, org.apache.kafka.common.header.Headers headers, @Nullable T data)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      次で指定:
      インターフェース org.apache.kafka.common.serialization.Serializer<T> の serialize 

    • serialize

      public byte[] serialize(StringSE topic, @Nullable T data)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      次で指定:
      インターフェース org.apache.kafka.common.serialization.Serializer<T> の serialize 

    • close

      public void close()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      次で指定:
      インターフェース AutoCloseableSE の close 
      次で指定:
      インターフェース CloseableSE の close 
      次で指定:
      インターフェース org.apache.kafka.common.serialization.Serializer<T> の close 

    • copyWithType

      public <X> JsonSerializer<X> copyWithType(ClassSE<? super X> newTargetType)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      新しいターゲット型参照が使用されることを除いて、このシリアライザーを同じ構成でコピーします。
      型パラメーター:
      X - 新しい直列化ソース型
      パラメーター:
      newTargetType - null ではなく、直列化のために強制された型参照
      戻り値:
      型が変更されたシリアライザーの新しいインスタンス
      導入:
      2.6

    • copyWithType

      public <X> JsonSerializer<X> copyWithType(com.fasterxml.jackson.core.type.TypeReference<? super X> newTargetType)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      新しいターゲット型参照が使用されることを除いて、このシリアライザーを同じ構成でコピーします。
      型パラメーター:
      X - 新しい直列化ソース型
      パラメーター:
      newTargetType - null ではなく、直列化のために強制された型参照
      戻り値:
      型が変更されたシリアライザーの新しいインスタンス
      導入:
      2.6

    • copyWithType

      public <X> JsonSerializer<X> copyWithType(com.fasterxml.jackson.databind.JavaType newTargetType)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      新しいターゲット java 型が使用されることを除いて、同じ構成でこのシリアライザーをコピーします。
      型パラメーター:
      X - 新しい直列化ソース型
      パラメーター:
      newTargetType - java 型は直列化を強制され、null ではありません
      戻り値:
      型が変更されたシリアライザーの新しいインスタンス
      導入:
      2.6

    • forKeys

      public JsonSerializer<T> forKeys()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      キーを直列化するためにこのシリアライザーを指定します（デフォルトは値です）。デフォルトの型マッパーが使用されている場合にのみ適用されます。
      戻り値:
      シリアライザー。
      導入:
      2.3
      関連事項:

    • noTypeInfo

      public JsonSerializer<T> noTypeInfo()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      型情報ヘッダーを含めないでください。
      戻り値:
      シリアライザー。
      導入:
      2.3
      関連事項:

    • typeMapper

      public JsonSerializer<T> typeMapper(Jackson2JavaTypeMapper mapper)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      付属の Jackson2JavaTypeMapper を使用してください。
      パラメーター:
      mapper - マッパー。
      戻り値:
      シリアライザー。
      導入:
      2.3
      関連事項: