org.dromara.hutool.json.serializer

Class JSONMapper

java.lang.Object

org.dromara.hutool.json.serializer.JSONMapper

All Implemented Interfaces:

Serializable

public class JSONMapper
extends Object
implements Serializable

对象和JSON值映射器，用于Java对象和JSON对象互转

• Java对象转JSON：toJSON(Object, boolean)
• JSON转Java对象：toBean(JSON, Type)

转换依赖于JSONSerializer和JSONDeserializer的实现，通过TypeAdapterManager统一管理
序列化和反序列化定义于两个作用域，首先查找本类中定义的，如果没有，使用TypeAdapterManager.getInstance() 查找全局定义的。

Since:

6.0.0

Author:

looly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JSONMapper(JSONFactory factory) 构造

Method Summary

Modifier and Type	Method and Description
TypeAdapterManager	getTypeAdapterManager() 获取自定义类型转换器，用于将自定义类型转换为JSONObject
static JSONMapper	of(JSONFactory factory) 创建JSONMapper
JSONMapper	register(TypeAdapter typeAdapter) 注册自定义类型适配器，用于自定义对象序列化和反序列化 提供的适配器必须为实现MatcherJSONSerializer或MatcherJSONDeserializer接口 当两个接口都实现时，同时注册序列化和反序列化器
JSONMapper	register(Type type, TypeAdapter typeAdapter) 注册自定义类型适配器，用于自定义对象序列化和反序列化
JSONMapper	setTypeAdapterManager(TypeAdapterManager typeAdapterManager) 设置自定义类型转换器，用于将自定义类型转换为JSONObject
<T> T	toBean(JSON json, Type type) 转为实体类对象
JSON	toJSON(Object obj, boolean parseIfString) 在需要的时候转换映射对象 包装包括： array or collection =》 JSONArray map or bean =》 JSONObject standard property (number boolean or char) =》 JSONPrimitive String =》 parseIfString为true时解析为JSON，false直接包装为JSONPrimitive 其它 =》 尝试包装为JSONObject，否则返回null
JSONArray	toJSONArray(Object obj) 在需要的时候转换映射对象 包装包括： array or collection =》 JSONArray
JSONObject	toJSONObject(Object obj) 在需要的时候转换映射对象 包装包括： map =》 JSONObject 其它 =》 尝试包装为JSONObject，否则返回null

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONMapper

public JSONMapper(JSONFactory factory)

构造

Parameters:

factory - JSONFactory

Method Detail

of

public static JSONMapper of(JSONFactory factory)

创建JSONMapper

Parameters:

factory - JSONFactory

Returns:

ObjectMapper

getTypeAdapterManager

public TypeAdapterManager getTypeAdapterManager()

获取自定义类型转换器，用于将自定义类型转换为JSONObject

Returns:

类型转换器管理器

setTypeAdapterManager

public JSONMapper setTypeAdapterManager(TypeAdapterManager typeAdapterManager)

设置自定义类型转换器，用于将自定义类型转换为JSONObject

Parameters:

typeAdapterManager - 类型转换器管理器，不能为空

Returns:

this

register

public JSONMapper register(Type type,
                           TypeAdapter typeAdapter)

注册自定义类型适配器，用于自定义对象序列化和反序列化

Parameters:

type - 类型

typeAdapter - 自定义序列化器，null表示移除

Returns:

this

register

public JSONMapper register(TypeAdapter typeAdapter)

注册自定义类型适配器，用于自定义对象序列化和反序列化
提供的适配器必须为实现MatcherJSONSerializer或MatcherJSONDeserializer接口
当两个接口都实现时，同时注册序列化和反序列化器

Parameters:

typeAdapter - 自定义类型适配器

Returns:

this

toBean

public <T> T toBean(JSON json,
                    Type type)

转为实体类对象

Type Parameters:

T - Bean类型

Parameters:

json - JSON

type - Type

Returns:

实体类对象

toJSON

public JSON toJSON(Object obj,
                   boolean parseIfString)

在需要的时候转换映射对象
包装包括：

• array or collection =》 JSONArray
• map or bean =》 JSONObject
• standard property (number boolean or char) =》 JSONPrimitive
• String =》 parseIfString为true时解析为JSON，false直接包装为JSONPrimitive
• 其它 =》 尝试包装为JSONObject，否则返回null

Parameters:

obj - 被映射的对象

parseIfString - 如果提供的是字符串，是否解析为JSON，false则直接包装为JSONPrimitive

Returns:

映射后的值，null表示此值需被忽略

toJSONObject

public JSONObject toJSONObject(Object obj)

在需要的时候转换映射对象
包装包括：

• map =》 JSONObject
• 其它 =》 尝试包装为JSONObject，否则返回null

Parameters:

obj - 被映射的对象

Returns:

映射后的值，null表示此值需被忽略

toJSONArray

public JSONArray toJSONArray(Object obj)

在需要的时候转换映射对象
包装包括：

• array or collection =》 JSONArray

Parameters:

obj - 被映射的对象

Returns:

映射后的值，null表示此值需被忽略