クラス GsonHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<T>
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
- 関連事項:
Gson
GsonBuilder
setGson(com.google.gson.Gson)
フィールドサマリー
クラス org.springframework.http.converter.json.AbstractJsonHttpMessageConverter から継承されたフィールド
DEFAULT_CHARSET
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクターコンストラクター説明デフォルトの構成で新しいGsonHttpMessageConverter
を構築します。GsonHttpMessageConverter
(com.google.gson.Gson gson) 指定されたデリゲートで新しいGsonHttpMessageConverter
を構築します。方法の概要
修飾子と型メソッド説明com.google.gson.Gson
getGson()
このコンバーターの構成済みGson
インスタンスを返します。protected ObjectSE
readInternal
(TypeSE resolvedType, ReaderSE reader) 指定されたReader
SE から JSON バインドオブジェクトを読み取るテンプレートメソッド。void
setGson
(com.google.gson.Gson gson) 使用するGson
インスタンスを設定します。protected boolean
このメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。protected void
writeInternal
(ObjectSE object, TypeSE type, WriterSE writer) JSON にバインドされたオブジェクトを指定されたWriter
SE に書き込むテンプレートメソッド。クラス org.springframework.http.converter.json.AbstractJsonHttpMessageConverter から継承されたメソッド
read, readInternal, setJsonPrefix, setPrefixJson, writeInternal
クラス org.springframework.http.converter.AbstractGenericHttpMessageConverter から継承されたメソッド
canRead, canWrite, supports, write, writeInternal
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.converter.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
指定されたReader
SE から JSON バインドオブジェクトを読み取るテンプレートメソッド。- 次で指定:
- クラス
AbstractJsonHttpMessageConverter
のreadInternal
- パラメーター:
resolvedType
- 解決されたジェネリクス型reader
- 使用するリーダー- 戻り値:
- JSON にバインドされたオブジェクト
- 例外:
ExceptionSE
- 読み取り / 解析の失敗の場合
writeInternal
protected void writeInternal(ObjectSE object, @Nullable TypeSE type, WriterSE writer) throws ExceptionSE クラスからコピーされた説明:AbstractJsonHttpMessageConverter
JSON にバインドされたオブジェクトを指定されたWriter
SE に書き込むテンプレートメソッド。- 次で指定:
- クラス
AbstractJsonHttpMessageConverter
のwriteInternal
- パラメーター:
object
- 出力メッセージに書き込むオブジェクトtype
- 書き込むオブジェクトの型 (null
の場合があります)writer
- 使用するライター- 例外:
ExceptionSE
- 書き込みエラーの場合
supportsRepeatableWrites
クラスからコピーされた説明:AbstractHttpMessageConverter
このメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。デフォルトの実装は
false
を返します。- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>
のsupportsRepeatableWrites
- パラメーター:
o
- オブジェクト t- 戻り値:
-
t
を繰り返し書き込める場合はtrue
。それ以外の場合はfalse