JSON (hutool 5.8.35 API)

All Superinterfaces:

Cloneable, IJSONTypeConverter, Serializable

All Known Implementing Classes:

JSONArray, JSONObject
```
public interface JSON
extends Cloneable, Serializable, IJSONTypeConverter
```
JSON接口

Author:

Looly

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`getByPath(String expression)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name
`<T> T`	`getByPath(String expression, Class<T> resultType)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name 获取表达式对应值后转换为对应类型的值
`<T> T`	`getByPath(String expression, TypeReference<T> targetType)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name 获取表达式对应值后转换为对应类型的值
`JSONConfig`	`getConfig()` 获取JSON配置
`void`	`putByPath(String expression, Object value)` 设置表达式指定位置（或filed对应）的值若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name
`default <T> T`	`toBean(Class<T> clazz)` 转为实体类对象，转换异常将被抛出
`default <T> T`	`toBean(Type type)` 转为实体类对象
`default <T> T`	`toBean(Type type, boolean ignoreError)` Deprecated. 请使用 `toBean(Type)`, ignoreError在JSONConfig中生效
`default <T> T`	`toBean(TypeReference<T> reference)` 转为实体类对象，转换异常将被抛出
`default String`	`toJSONString(int indentFactor)` 格式化输出JSON字符串
`default String`	`toStringPretty()` 格式化打印JSON，缩进为4个空格
`default Writer`	`write(Writer writer)` 将JSON内容写入Writer，无缩进 Warning: This method assumes that the data structure is acyclical.
`Writer`	`write(Writer writer, int indentFactor, int indent)` 将JSON内容写入Writer Warning: This method assumes that the data structure is acyclical.

- Method Detail
  - getConfig
```
JSONConfig getConfig()
```
    获取JSON配置
    
    Returns:
    
    JSONConfig
    
    Since:
    
    5.8.6
  - getByPath
```
Object getByPath(String expression)
```
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    Parameters:
    
    expression - 表达式
    
    Returns:
    
    对象
    
    Since:
    
    4.0.6
    
    See Also:
    
    BeanPath.get(Object)
  - putByPath
```
void putByPath(String expression,
               Object value)
```
    设置表达式指定位置（或filed对应）的值
    若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值
    注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    Parameters:
    
    expression - 表达式
    
    value - 值
  - getByPath
```
<T> T getByPath(String expression,
                Class<T> resultType)
```
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    获取表达式对应值后转换为对应类型的值
    Type Parameters:
    
    T - 返回值类型
    
    Parameters:
    
    expression - 表达式
    
    resultType - 返回值类型
    
    Returns:
    
    对象
    
    Since:
    
    4.0.6
    
    See Also:
    
    BeanPath.get(Object)
  - getByPath
```
<T> T getByPath(String expression,
                TypeReference<T> targetType)
```
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    获取表达式对应值后转换为对应类型的值
    Parameters:
    
    expression - 表达式
    
    targetType - 返回值类型
    
    Returns:
    
    对象
    
    Since:
    
    5.8.34
    
    See Also:
    
    BeanPath.get(Object)
  - toStringPretty
```
default String toStringPretty()
                       throws JSONException
```
    格式化打印JSON，缩进为4个空格
    
    Returns:
    
    格式化后的JSON字符串
    
    Throws:
    
    JSONException - 包含非法数抛出此异常
    
    Since:
    
    3.0.9
  - toJSONString
```
default String toJSONString(int indentFactor)
                     throws JSONException
```
    格式化输出JSON字符串
    
    Parameters:
    
    indentFactor - 每层缩进空格数
    
    Returns:
    
    JSON字符串
    
    Throws:
    
    JSONException - 包含非法数抛出此异常
  - write
```
default Writer write(Writer writer)
              throws JSONException
```
    将JSON内容写入Writer，无缩进
    Warning: This method assumes that the data structure is acyclical.
    
    Parameters:
    
    writer - Writer
    
    Returns:
    
    Writer
    
    Throws:
    
    JSONException - JSON相关异常
  - write
```
Writer write(Writer writer,
             int indentFactor,
             int indent)
      throws JSONException
```
    将JSON内容写入Writer
    Warning: This method assumes that the data structure is acyclical.
    
    Parameters:
    
    writer - writer
    
    indentFactor - 缩进因子，定义每一级别增加的缩进量
    
    indent - 本级别缩进量
    
    Returns:
    
    Writer
    
    Throws:
    
    JSONException - JSON相关异常
  - toBean
```
default <T> T toBean(Class<T> clazz)
```
    转为实体类对象，转换异常将被抛出
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    clazz - 实体类
    
    Returns:
    
    实体类对象
  - toBean
```
default <T> T toBean(TypeReference<T> reference)
```
    转为实体类对象，转换异常将被抛出
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    reference - TypeReference类型参考子类，可以获取其泛型参数中的Type类型
    
    Returns:
    
    实体类对象
    
    Since:
    
    4.2.2
  - toBean
```
default <T> T toBean(Type type)
```
    转为实体类对象
    
    Specified by:
    
    toBean in interface IJSONTypeConverter
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    type - Type
    
    Returns:
    
    实体类对象
    
    Since:
    
    3.0.8
  - toBean
```
@Deprecated
default <T> T toBean(Type type,
                                  boolean ignoreError)
```
    Deprecated. 请使用 toBean(Type), ignoreError在JSONConfig中生效
    
    转为实体类对象
    
    Type Parameters:
    
    T - Bean类型
    
    Parameters:
    
    type - Type
    
    ignoreError - 是否忽略转换错误
    
    Returns:
    
    实体类对象
    
    Since:
    
    4.3.2

Interface JSON

Method Summary

Method Detail

getConfig

getByPath

putByPath

getByPath

getByPath

toStringPretty

toJSONString

write

write

toBean

toBean

toBean

toBean