クラス GsonHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<ObjectSE>
org.springframework.http.converter.AbstractGenericHttpMessageConverter<ObjectSE>
org.springframework.http.converter.json.AbstractJsonHttpMessageConverter
org.springframework.http.converter.json.GsonHttpMessageConverter
- 実装済みのインターフェース一覧:
GenericHttpMessageConverter<ObjectSE>, HttpMessageConverter<ObjectSE>
Google グソンライブラリを使用して JSON を読み書きできる
HttpMessageConverter の実装。 このコンバーターは、型指定された Bean または型指定されていない HashMap にバインドするために使用できます。デフォルトでは、UTF-8 文字セットで application/json および application/*+json をサポートします。
Gson 2.8 に対してテスト済み。Gson 2.0 以上と互換性があります。
- 導入:
- 4.1
- 作成者:
- Roy Clarkson, Juergen Hoeller
- 関連事項:
フィールド概要
クラス AbstractJsonHttpMessageConverter から継承されたフィールド
DEFAULT_CHARSETクラス AbstractHttpMessageConverter から継承されたフィールド
loggerコンストラクター概要
コンストラクターコンストラクター説明デフォルトの構成で新しいGsonHttpMessageConverterを構築します。GsonHttpMessageConverter(com.google.gson.Gson gson) 指定されたデリゲートで新しいGsonHttpMessageConverterを構築します。方法の概要
修飾子と型メソッド説明com.google.gson.GsongetGson()このコンバーターの構成済みGsonインスタンスを返します。protected ObjectSEreadInternal(TypeSE resolvedType, ReaderSE reader) 指定されたReaderSE から JSON バインドオブジェクトを読み取るテンプレートメソッド。voidsetGson(com.google.gson.Gson gson) 使用するGsonインスタンスを設定します。protected booleanこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。protected voidwriteInternal(ObjectSE object, @Nullable TypeSE type, WriterSE writer) JSON にバインドされたオブジェクトを指定されたWriterSE に書き込むテンプレートメソッド。クラス AbstractJsonHttpMessageConverter から継承されたメソッド
read, readInternal, setJsonPrefix, setPrefixJson, writeInternalクラス AbstractGenericHttpMessageConverter から継承されたメソッド
canRead, canWrite, supports, write, writeInternalクラス AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, writeクラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース HttpMessageConverter から継承されたメソッド
canRead, canWrite, getSupportedMediaTypes, getSupportedMediaTypes, read, write
コンストラクターの詳細
GsonHttpMessageConverter
public GsonHttpMessageConverter()デフォルトの構成で新しいGsonHttpMessageConverterを構築します。GsonHttpMessageConverter
public GsonHttpMessageConverter(com.google.gson.Gson gson) 指定されたデリゲートで新しいGsonHttpMessageConverterを構築します。- パラメーター:
gson- 使用する Gson インスタンス- 導入:
- 5.0
メソッドの詳細
setGson
public void setGson(com.google.gson.Gson gson) 使用するGsonインスタンスを設定します。設定しない場合、デフォルトのGsonインスタンスが使用されます。カスタム構成された
Gsonを設定することは、JSON 直列化プロセスをさらに制御する 1 つの方法です。- 関連事項:
getGson
public com.google.gson.Gson getGson()このコンバーターの構成済みGsonインスタンスを返します。readInternal
クラスからコピーされた説明:AbstractJsonHttpMessageConverter指定されたReaderSE から JSON バインドオブジェクトを読み取るテンプレートメソッド。- 次で指定:
- クラス
AbstractJsonHttpMessageConverterのreadInternal - パラメーター:
resolvedType- 解決されたジェネリクス型reader- 使用するReader- 戻り値:
- JSON にバインドされたオブジェクト
- 例外:
ExceptionSE- 読み取り / 解析の失敗の場合
writeInternal
protected void writeInternal(ObjectSE object, @Nullable TypeSE type, WriterSE writer) throws ExceptionSE クラスからコピーされた説明:AbstractJsonHttpMessageConverterJSON にバインドされたオブジェクトを指定されたWriterSE に書き込むテンプレートメソッド。- 次で指定:
- クラス
AbstractJsonHttpMessageConverterのwriteInternal - パラメーター:
object- 出力メッセージに書き込むオブジェクトtype- 書き込むオブジェクトの型 (nullの場合があります)writer- 使用するWriter- 例外:
ExceptionSE- 書き込みエラーの場合
supportsRepeatableWrites
クラスからコピーされた説明:AbstractHttpMessageConverterこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。デフォルトの実装は
falseを返します。- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のsupportsRepeatableWrites - パラメーター:
o- オブジェクト t- 戻り値:
-
tを繰り返し書き込める場合はtrue。それ以外の場合はfalse