JacksonMapper (myoss-starter-core 2.3.1.RELEASE API)

java.lang.Object
- app.myoss.cloud.core.utils.JacksonMapper

```
public class JacksonMapper
extends Object
```
简单封装Jackson，实现JSON String<->Java Object 的Mapper. 封装不同的输出风格, 使用不同的builder函数创建实例.

Since:

2018年5月4日下午6:43:13

Author:

Jerry.Chen

Field Summary

Fields
Modifier and Type	Field and Description
`static com.fasterxml.jackson.core.type.TypeReference<JsonObject>`	`JSON_OBJECT_TYPE_REFERENCE` `JsonObject` 类型转换器
`static com.fasterxml.jackson.core.type.TypeReference<LinkedHashMap<String,Object>>`	`LINKED_HASH_MAP_S2O_TYPE_REFERENCE` `LinkedHashMap` 类型转换器
`static com.fasterxml.jackson.core.type.TypeReference<SortedMap<String,String>>`	`SORTED_MAP_S2S_TYPE_REFERENCE` `SortedMap` 类型转换器

Constructor Summary

Constructors
Constructor and Description
`JacksonMapper()` 创建 Jackson Mapper 对象
`JacksonMapper(com.fasterxml.jackson.annotation.JsonInclude.Include include)` 创建 Jackson Mapper 对象

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JavaType`	`constructCollectionType(Class<? extends Collection> collectionClass, Class<?> elementClass)` 构造Collection类型.
`com.fasterxml.jackson.databind.JavaType`	`constructMapType(Class<? extends Map> mapClass, Class<?> keyClass, Class<?> valueClass)` 构造Map类型.
`<T> T`	`convert(Object object, Class<T> clazz)` 把object转出clazz对象，比如POJO和Map互换
`<T> T`	`convert(Object object, com.fasterxml.jackson.databind.JavaType toValueType)` 把object转出clazz对象，比如POJO和Map互换
`<T> T`	`convert(Object object, com.fasterxml.jackson.core.type.TypeReference<T> toValueTypeRef)` 把object转出clazz对象，比如POJO和Map互换
`void`	`enableEnumUseToString()` 设定是否使用Enum的toString函数来读写Enum, 为False时使用Enum的name()函數來读写Enum, 默认为False.
`JsonObject`	`fromJson(String jsonString)` 反序列化为Map对象
`<T> T`	`fromJson(String jsonString, Class<T> clazz)` 反序列化POJO或简单Collection如 `List<String>`.
`<T> T`	`fromJson(String jsonString, com.fasterxml.jackson.databind.JavaType javaType)` 反序列化复杂Collection如 `List<Bean>`, 先使用createCollectionType()或constructMapType()构造类型, 然后调用本函数.
`<T> T`	`fromJson(String jsonString, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)` 反序列化为Map对象
`JsonObject`	`json2Map(String json)` JSON转换成Java对象
`static JacksonMapper`	`nonDefaultMapper()` 创建只输出初始值被改变的属性到Json字符串的Mapper, 最节约的存储方式，建议在内部接口中使用。
`static JacksonMapper`	`nonEmptyMapper()` 创建只输出非Null且非Empty(如List.isEmpty)的属性到Json字符串的Mapper,建议在外部接口中使用.
`static JacksonMapper`	`nonNullMapper()` 创建只输出非Null的属性到Json字符串的Mapper,建议在外部接口中使用.
`String`	`toJson(Object object)` Object可以是POJO，也可以是Collection或数组。如果对象为Null, 返回"null".
`String`	`toJsonP(String functionName, Object object)` 输出JSONP格式数据.
`void`	`update(String jsonString, Object object)` 当JSON里只含有Bean的部分属性时，更新一個已存在Bean，只覆盖部分的属性.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SORTED_MAP_S2S_TYPE_REFERENCE
```
public static com.fasterxml.jackson.core.type.TypeReference<SortedMap<String,String>> SORTED_MAP_S2S_TYPE_REFERENCE
```
    SortedMap 类型转换器
  - LINKED_HASH_MAP_S2O_TYPE_REFERENCE
```
public static com.fasterxml.jackson.core.type.TypeReference<LinkedHashMap<String,Object>> LINKED_HASH_MAP_S2O_TYPE_REFERENCE
```
    LinkedHashMap 类型转换器
  - JSON_OBJECT_TYPE_REFERENCE
```
public static com.fasterxml.jackson.core.type.TypeReference<JsonObject> JSON_OBJECT_TYPE_REFERENCE
```
    JsonObject 类型转换器
- Constructor Detail
  - JacksonMapper
```
public JacksonMapper()
```
    创建 Jackson Mapper 对象
  - JacksonMapper
```
public JacksonMapper(com.fasterxml.jackson.annotation.JsonInclude.Include include)
```
    创建 Jackson Mapper 对象
    
    Parameters:
    
    include - 属性的风格
- Method Detail
  - nonNullMapper
```
public static JacksonMapper nonNullMapper()
```
    创建只输出非Null的属性到Json字符串的Mapper,建议在外部接口中使用.
    
    Returns:
    
    JacksonMapper
  - nonEmptyMapper
```
public static JacksonMapper nonEmptyMapper()
```
    创建只输出非Null且非Empty(如List.isEmpty)的属性到Json字符串的Mapper,建议在外部接口中使用.
    
    Returns:
    
    JacksonMapper
  - nonDefaultMapper
```
public static JacksonMapper nonDefaultMapper()
```
    创建只输出初始值被改变的属性到Json字符串的Mapper, 最节约的存储方式，建议在内部接口中使用。
    
    Returns:
    
    JacksonMapper
  - toJson
```
public String toJson(Object object)
```
    Object可以是POJO，也可以是Collection或数组。如果对象为Null, 返回"null". 如果集合为空集合, 返回"[]".
    
    Parameters:
    
    object - Java对象
    
    Returns:
    
    json字符串
  - fromJson
```
public <T> T fromJson(String jsonString,
                      Class<T> clazz)
```
    反序列化POJO或简单Collection如 List<String>. 如果JSON字符串为Null或"null"字符串, 返回Null. 如果JSON字符串为"[]", 返回空集合. 如需反序列化复杂Collection如 List<MyBean>, 请使用fromJson(String, JavaType)
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    jsonString - json字符串
    
    clazz - class
    
    Returns:
    
    POJO对象
    
    See Also:
    
    fromJson(String, JavaType)
  - fromJson
```
public <T> T fromJson(String jsonString,
                      com.fasterxml.jackson.databind.JavaType javaType)
```
    反序列化复杂Collection如 List<Bean>, 先使用createCollectionType()或constructMapType()构造类型, 然后调用本函数.
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    jsonString - json字符串
    
    javaType - JavaType
    
    Returns:
    
    POJO对象
  - fromJson
```
public <T> T fromJson(String jsonString,
                      com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
```
    反序列化为Map对象
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    jsonString - json字符串
    
    typeReference - 目标类型
    
    Returns:
    
    Map对象
  - fromJson
```
public JsonObject fromJson(String jsonString)
```
    反序列化为Map对象
    
    Parameters:
    
    jsonString - json字符串
    
    Returns:
    
    Map对象
    
    See Also:
    
    fromJson(String, TypeReference)
  - json2Map
```
public JsonObject json2Map(String json)
```
    JSON转换成Java对象
    
    Parameters:
    
    json - JSON字符串
    
    Returns:
    
    Java对象
  - convert
```
public <T> T convert(Object object,
                     Class<T> clazz)
```
    把object转出clazz对象，比如POJO和Map互换
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    object - 原对象
    
    clazz - 目标类型
    
    Returns:
    
    Java对象
  - convert
```
public <T> T convert(Object object,
                     com.fasterxml.jackson.databind.JavaType toValueType)
```
    把object转出clazz对象，比如POJO和Map互换
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    object - 原对象
    
    toValueType - 目标类型
    
    Returns:
    
    Java对象
  - convert
```
public <T> T convert(Object object,
                     com.fasterxml.jackson.core.type.TypeReference<T> toValueTypeRef)
```
    把object转出clazz对象，比如POJO和Map互换
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    object - 原对象
    
    toValueTypeRef - 目标类型
    
    Returns:
    
    Java对象
  - constructCollectionType
```
public com.fasterxml.jackson.databind.JavaType constructCollectionType(Class<? extends Collection> collectionClass,
                                                                       Class<?> elementClass)
```
    构造Collection类型.
    
    Parameters:
    
    collectionClass - 集合类型class
    
    elementClass - 集合中元素类型class
    
    Returns:
    
    JavaType
  - constructMapType
```
public com.fasterxml.jackson.databind.JavaType constructMapType(Class<? extends Map> mapClass,
                                                                Class<?> keyClass,
                                                                Class<?> valueClass)
```
    构造Map类型.
    
    Parameters:
    
    mapClass - Map类型class
    
    keyClass - Key类型class
    
    valueClass - Value类型class
    
    Returns:
    
    JavaType
  - update
```
public void update(String jsonString,
                   Object object)
```
    当JSON里只含有Bean的部分属性时，更新一個已存在Bean，只覆盖部分的属性.
    
    Parameters:
    
    jsonString - json字符串
    
    object - Java对象
  - toJsonP
```
public String toJsonP(String functionName,
                      Object object)
```
    输出JSONP格式数据.
    
    Parameters:
    
    functionName - JavaScript function name
    
    object - Java对象
    
    Returns:
    
    json字符串
  - enableEnumUseToString
```
public void enableEnumUseToString()
```
    设定是否使用Enum的toString函数来读写Enum, 为False时使用Enum的name()函數來读写Enum, 默认为False. 注意本函數一定要在Mapper创建后, 所有的读写动作之前调用.

Class JacksonMapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SORTED_MAP_S2S_TYPE_REFERENCE

LINKED_HASH_MAP_S2O_TYPE_REFERENCE

JSON_OBJECT_TYPE_REFERENCE

Constructor Detail

JacksonMapper

JacksonMapper

Method Detail

nonNullMapper

nonEmptyMapper

nonDefaultMapper

toJson

fromJson

fromJson

fromJson

fromJson

json2Map

convert

convert

convert

constructCollectionType

constructMapType

update

toJsonP

enableEnumUseToString