JSONFactory (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.json.JSONFactory

```
public class JSONFactory
extends Object
```
JSON工厂类，用于JSON创建、解析、转换为Bean等功能

Since:

6.0.0

Author:

looly

Constructor Summary

Constructors
Constructor and Description

JSONFactory(JSONConfig config, Predicate<MutableEntry<Object,Object>> predicate)
构造

Constructors
Constructor and Description
`JSONFactory(JSONConfig config, Predicate<MutableEntry<Object,Object>> predicate)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`doPredicate(MutableEntry<Object,Object> entry, Consumer<MutableEntry<Object,Object>> consumer)` 执行键值对过滤，如果提供的键值对执行`Predicate.test(Object)`返回`false`，则忽略此键值对；如果处理后返回`true`表示接受，调用`Consumer.accept(Object)`执行逻辑。
`JSONConfig`	`getConfig()` 获取配置项，始终非空
`static JSONFactory`	`getInstance()` 获取单例
`JSONMapper`	`getMapper()` 获取`JSONMapper`，用于实现Bean和JSON的转换此方法使用双重检查锁实现懒加载模式，只有mapper被使用时才初始化
`Predicate<MutableEntry<Object,Object>>`	`getPredicate()` 获取键值对过滤器 `Predicate.test(Object)` 返回`true`表示接受，`false`表示忽略同时`MutableEntry`为可变键值对，在判断逻辑中可同时修改键和值，修改后返回`true` entry中，key在JSONObject中为name，在JSONArray中为index
`static JSONFactory`	`of(JSONConfig config)` 创建JSON工厂
`static JSONFactory`	`of(JSONConfig config, Predicate<MutableEntry<Object,Object>> predicate)` 创建JSON工厂
`JSONArray`	`ofArray()` 创建JSONArray
`BeanPath<JSON>`	`ofBeanPath(String expression)` 创建BeanPath，用于使用路径方式访问或设置值
`JSONObject`	`ofObj()` 创建JSONObject
`JSONParser`	`ofParser(JSONTokener tokener)` 创建`JSONParser`，用于JSON解析
`JSONPrimitive`	`ofPrimitive(Object value)` 创建JSONPrimitive
`JSONWriter`	`ofWriter(Appendable appendable)` 创建`JSONWriter`，用于JSON写出
`JSONWriter`	`ofWriter(Appendable appendable, boolean prettyPrint)` 创建`JSONWriter`，用于JSON写出
`JSONWriter`	`ofWriter(Appendable appendable, int indentFactor)` 创建`JSONWriter`，用于JSON写出
`JSON`	`parse(Object obj)` 解析对象为JSON 支持的对象： String: 转换为相应的对象 Array、Iterable、Iterator：转换为JSONArray Bean对象：转为JSONObject 注意：与`toJSON(Object)`不同的是，对象如果为字符串，会被当作json字符串解析！
`JSONArray`	`parseArray(Object obj)` 对象转`JSONArray`，支持： `JSONObject` 遍历Entry，结果为：[{k1:v1}, {k2: v2}, ...]
`JSONObject`	`parseObj(Object obj)` 对象转`JSONObject`，支持： `CharSequence`，解析{...}字符串 Bean解析 Map解析
`JSONFactory`	`register(TypeAdapter typeAdapter)` 注册自定义类型适配器，用于自定义对象序列化和反序列化提供的适配器必须为实现`MatcherJSONSerializer`或`MatcherJSONDeserializer`接口当两个接口都实现时，同时注册序列化和反序列化器
`JSONFactory`	`register(Type type, TypeAdapter typeAdapter)` 注册自定义类型适配器，用于自定义对象序列化和反序列化
`<T> T`	`toBean(JSON json, Type type)` 将JSON转换为指定类型的Bean对象
`JSON`	`toJSON(Object obj)` 转换对象为JSON 支持的对象： String: 转换为`JSONPrimitive` Array、Iterable、Iterator：转换为JSONArray Bean对象：转为JSONObject 注意；与`parse(Object)`不同的是，对象如果为字符串，则返回`JSONPrimitive`，不会做二次解析

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

- Constructor Detail
  - JSONFactory
```
public JSONFactory(JSONConfig config,
                   Predicate<MutableEntry<Object,Object>> predicate)
```
    构造
    
    Parameters:
    
    config - 配置项
    
    predicate - 键值对过滤器，用于过滤掉不需要的键值对，例如：过滤掉值为null的键值对
- Method Detail
  - getInstance
```
public static JSONFactory getInstance()
```
    获取单例
    
    Returns:
    
    单例
  - of
```
public static JSONFactory of(JSONConfig config)
```
    创建JSON工厂
    
    Parameters:
    
    config - JSON配置
    
    Returns:
    
    JSON工厂
  - of
```
public static JSONFactory of(JSONConfig config,
                             Predicate<MutableEntry<Object,Object>> predicate)
```
    创建JSON工厂
    
    Parameters:
    
    config - JSON配置
    
    predicate - 键值对过滤器，null表示不过滤
    
    Returns:
    
    JSON工厂
  - getConfig
```
public JSONConfig getConfig()
```
    获取配置项，始终非空
    
    Returns:
    
    配置项
  - getPredicate
```
public Predicate<MutableEntry<Object,Object>> getPredicate()
```
    获取键值对过滤器
    Predicate.test(Object) 返回true表示接受，false表示忽略
    同时MutableEntry为可变键值对，在判断逻辑中可同时修改键和值，修改后返回true
    entry中，key在JSONObject中为name，在JSONArray中为index
    
    Returns:
    
    键值对过滤器
  - doPredicate
```
public void doPredicate(MutableEntry<Object,Object> entry,
                        Consumer<MutableEntry<Object,Object>> consumer)
```
    执行键值对过滤，如果提供的键值对执行Predicate.test(Object)返回false，则忽略此键值对；
    如果处理后返回true表示接受，调用Consumer.accept(Object)执行逻辑。
    如果用户未定义predicate，则接受所有键值对。
    
    Parameters:
    
    entry - 键值对
    
    consumer - 键值对处理逻辑，如果处理后返回true表示接受，false表示忽略
  - getMapper
```
public JSONMapper getMapper()
```
    获取JSONMapper，用于实现Bean和JSON的转换
    此方法使用双重检查锁实现懒加载模式，只有mapper被使用时才初始化
    
    Returns:
    
    JSONMapper
  - register
```
public JSONFactory register(Type type,
                            TypeAdapter typeAdapter)
```
    注册自定义类型适配器，用于自定义对象序列化和反序列化
    
    Parameters:
    
    type - 类型
    
    typeAdapter - 自定义序列化器，null表示移除
    
    Returns:
    
    this
  - register
```
public JSONFactory register(TypeAdapter typeAdapter)
```
    注册自定义类型适配器，用于自定义对象序列化和反序列化
    提供的适配器必须为实现MatcherJSONSerializer或MatcherJSONDeserializer接口
    当两个接口都实现时，同时注册序列化和反序列化器
    
    Parameters:
    
    typeAdapter - 自定义类型适配器
    
    Returns:
    
    this
  - ofObj
```
public JSONObject ofObj()
```
    创建JSONObject
    
    Returns:
    
    JSONObject
  - ofArray
```
public JSONArray ofArray()
```
    创建JSONArray
    
    Returns:
    
    JSONArray
  - ofPrimitive
```
public JSONPrimitive ofPrimitive(Object value)
```
    创建JSONPrimitive
    
    Parameters:
    
    value - 值，null则返回null
    
    Returns:
    
    JSONPrimitive
  - ofParser
```
public JSONParser ofParser(JSONTokener tokener)
```
    创建JSONParser，用于JSON解析
    
    Parameters:
    
    tokener - JSONTokener
    
    Returns:
    
    JSONParser
  - ofWriter
```
public JSONWriter ofWriter(Appendable appendable)
```
    创建JSONWriter，用于JSON写出
    
    Parameters:
    
    appendable - Appendable
    
    Returns:
    
    JSONWriter
  - ofWriter
```
public JSONWriter ofWriter(Appendable appendable,
                           boolean prettyPrint)
```
    创建JSONWriter，用于JSON写出
    
    Parameters:
    
    appendable - Appendable
    
    prettyPrint - 是否格式化输出
    
    Returns:
    
    JSONWriter
  - ofWriter
```
public JSONWriter ofWriter(Appendable appendable,
                           int indentFactor)
```
    创建JSONWriter，用于JSON写出
    
    Parameters:
    
    appendable - Appendable
    
    indentFactor - 缩进因子，定义每一级别增加的缩进量，用于格式化输出
    
    Returns:
    
    JSONWriter
  - ofBeanPath
```
public BeanPath<JSON> ofBeanPath(String expression)
```
    创建BeanPath，用于使用路径方式访问或设置值
    
    Parameters:
    
    expression - BeanPath表达式
    
    Returns:
    
    BeanPath
  - parseObj
```
public JSONObject parseObj(Object obj)
```
    对象转JSONObject，支持：
    - CharSequence，解析{...}字符串
    - Bean解析
    - Map解析
    Parameters:
    
    obj - Bean对象或者Map
    
    Returns:
    
    JSONObject
  - parseArray
```
public JSONArray parseArray(Object obj)
```
    对象转JSONArray，支持：
    - JSONObject 遍历Entry，结果为：[{k1:v1}, {k2: v2}, ...]
    - CharSequence，解析[...]字符串
    - 其它支持和自定义的对象（如集合、数组等）
    Parameters:
    
    obj - 数组或集合对象
    
    Returns:
    
    JSONArray
  - parse
```
public JSON parse(Object obj)
```
    解析对象为JSON
    支持的对象：
    - String: 转换为相应的对象
    - Array、Iterable、Iterator：转换为JSONArray
    - Bean对象：转为JSONObject
    注意：与toJSON(Object)不同的是，对象如果为字符串，会被当作json字符串解析！
    Parameters:
    
    obj - 对象
    
    Returns:
    
    JSON（JSONObject or JSONArray）
  - toJSON
```
public JSON toJSON(Object obj)
```
    转换对象为JSON
    支持的对象：
    - String: 转换为JSONPrimitive
    - Array、Iterable、Iterator：转换为JSONArray
    - Bean对象：转为JSONObject
    注意；与parse(Object)不同的是，对象如果为字符串，则返回JSONPrimitive，不会做二次解析
    Parameters:
    
    obj - 对象
    
    Returns:
    
    JSON（JSONObject or JSONArray）
  - toBean
```
public <T> T toBean(JSON json,
                    Type type)
```
    将JSON转换为指定类型的Bean对象
    
    Type Parameters:
    
    T - 泛型类型
    
    Parameters:
    
    json - JSON
    
    type - Bean类型，泛型对象使用TypeReference
    
    Returns:
    
    Bean对象

Class JSONFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JSONFactory

Method Detail

getInstance

of

of

getConfig

getPredicate

doPredicate

getMapper

register

register

ofObj

ofArray

ofPrimitive

ofParser

ofWriter

ofWriter

ofWriter

ofBeanPath

parseObj

parseArray

parse

toJSON

toBean