org.dromara.hutool.json.engine

Interface JSONEngine

All Known Implementing Classes:

AbstractJSONEngine, FastJSON2Engine, GsonEngine, HutoolJSONEngine, JacksonEngine, MoshiEngine

public interface JSONEngine

JSON引擎接口，提供API：

• serialize： JSON序列化， 将Bean对象序列化为JSON字符串
• deserialize：JSON反序列化，将JSON字符串解析为Bean对象

init(JSONEngineConfig)用于使用公共配置，初始化引擎。

Since:

6.0.0

Author:

Looly

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(Reader reader, Object type) 解析JSON数据（反序列化），用于从Reader中读取JSON字符串，转换为Bean对象 type此处定义为Object，因为不同引擎对Type的定义不同，尤其是出现泛型定义时，需要传入引擎自身实现的TypeReference
default <T> T	fromJsonString(String jsonStr, Object type) 将JSON字符串转换为Java Bean（POJO）对象
JSONEngine	init(JSONEngineConfig config) 初始化配置 在引擎被加载时，如果需要自定义引擎，可以首先调用此方法 调用此方法前，需要清除已经生成的引擎内容
void	serialize(Object bean, OutputStream out) 生成JSON数据（序列化），用于将指定的Bean对象通过Writer写出为JSON字符串
default String	toJsonString(Object bean) 将Java Bean（POJO）对象转换为JSON字符串

Method Detail

init

JSONEngine init(JSONEngineConfig config)

初始化配置
在引擎被加载时，如果需要自定义引擎，可以首先调用此方法
调用此方法前，需要清除已经生成的引擎内容

Parameters:

config - 配置

Returns:

this

serialize

void serialize(Object bean,
               OutputStream out)

生成JSON数据（序列化），用于将指定的Bean对象通过Writer写出为JSON字符串

Parameters:

bean - Java Bean（POJO）对象

out - 写出到的OutputStream

deserialize

<T> T deserialize(Reader reader,
                  Object type)

解析JSON数据（反序列化），用于从Reader中读取JSON字符串，转换为Bean对象
type此处定义为Object，因为不同引擎对Type的定义不同，尤其是出现泛型定义时，需要传入引擎自身实现的TypeReference

Type Parameters:

T - Java Bean对象类型

Parameters:

reader - 读取JSON的Reader

type - Java Bean（POJO）对象类型，可以为Class<T>或者TypeReference

Returns:

Java Bean（POJO）对象

toJsonString

default String toJsonString(Object bean)

将Java Bean（POJO）对象转换为JSON字符串

Parameters:

bean - Java Bean（POJO）对象

Returns:

JSON字符串

fromJsonString

default <T> T fromJsonString(String jsonStr,
                             Object type)

将JSON字符串转换为Java Bean（POJO）对象

Type Parameters:

T - Java Bean对象类型

Parameters:

jsonStr - JSON字符串

type - Java Bean（POJO）对象类型，可以为Class<T>或者TypeReference

Returns:

Java Bean（POJO）对象