JSONObject (hutool-码云(gitee.com))

java.lang.Object
- cn.hutool.json.JSONObject

All Implemented Interfaces:

BasicTypeGetter<String>, OptBasicTypeGetter<String>, OptNullBasicTypeFromObjectGetter<String>, OptNullBasicTypeGetter<String>, JSON, JSONGetter<String>, Serializable, Cloneable, Map<String,Object>
```
public class JSONObject
extends Object
implements JSON, JSONGetter<String>, Map<String,Object>
```
JSON对象
例：
```
 json = new JSONObject().put("JSON", "Hello, World!").toString();
 
```
Author:

looly

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_CAPACITY
默认初始大小

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CAPACITY` 默认初始大小

Constructor Summary

Constructors
Constructor and Description
`JSONObject()` 构造，初始容量为 `DEFAULT_CAPACITY`，KEY无序
`JSONObject(boolean isOrder)` 构造，初始容量为 `DEFAULT_CAPACITY`
`JSONObject(CharSequence source, boolean isOrder)` 从JSON字符串解析为JSON对象，对于排序单独配置参数
`JSONObject(int capacity, boolean isOrder)` 构造
`JSONObject(int capacity, boolean isIgnoreCase, boolean isOrder)` 构造
`JSONObject(int capacity, JSONConfig config)` 构造
`JSONObject(JSONConfig config)` 构造
`JSONObject(Object source)` 构建JSONObject，JavaBean默认忽略null值，其它对象不忽略，规则如下： value为Map，将键值对加入JSON对象 value为JSON字符串（CharSequence），使用JSONTokener解析 value为JSONTokener，直接解析 value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
`JSONObject(Object source, boolean ignoreNullValue)` 构建JSONObject，规则如下： value为Map，将键值对加入JSON对象 value为JSON字符串（CharSequence），使用JSONTokener解析 value为JSONTokener，直接解析 value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
`JSONObject(Object source, boolean ignoreNullValue, boolean isOrder)` 构建JSONObject，规则如下： value为Map，将键值对加入JSON对象 value为JSON字符串（CharSequence），使用JSONTokener解析 value为JSONTokener，直接解析 value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
`JSONObject(Object source, JSONConfig config)` 构建JSONObject，规则如下： value为Map，将键值对加入JSON对象 value为JSON字符串（CharSequence），使用JSONTokener解析 value为JSONTokener，直接解析 value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
`JSONObject(Object obj, String... names)` 构建指定name列表对应的键值对为新的JSONObject，情况如下：

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JSONObject`	`accumulate(String key, Object value)` 积累值。类似于set，当key对应value已经存在时，与value组成新的JSONArray.
`JSONObject`	`append(String key, Object value)` 追加值，如果key无对应值，就添加一个JSONArray，其元素只有value，如果值已经是一个JSONArray，则添加到值JSONArray中。
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object obj)`
`Object`	`get(Object key)`
`Object`	`getByPath(String expression)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值
`<T> T`	`getByPath(String expression, Class<T> resultType)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值
`JSONConfig`	`getConfig()` 获取JSON配置
`Object`	`getObj(String key, Object defaultValue)` 获取Object属性值
`int`	`hashCode()`
`JSONObject`	`increment(String key)` 对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
`boolean`	`isEmpty()`
`Set<String>`	`keySet()`
`JSONObject`	`put(String key, Object value)` Deprecated. 此方法存在歧义，原Map接口返回的是之前的值，重写后返回this了，未来版本此方法会修改，请使用`set(String, Object)`
`void`	`putAll(Map<? extends String,?> m)`
`void`	`putByPath(String expression, Object value)` 设置表达式指定位置（或filed对应）的值若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值
`JSONObject`	`putOnce(String key, Object value)` 一次性Put 键值对，如果key已经存在抛出异常，如果键值中有null值，忽略
`JSONObject`	`putOpt(String key, Object value)` 在键和值都为非空的情况下put到JSONObject中
`Object`	`remove(Object key)`
`JSONObject`	`set(String key, Object value)` 设置键值对到JSONObject中，在忽略null模式下，如果值为`null`，将此键移除
`JSONObject`	`setDateFormat(String format)` 设置转为字符串时的日期格式，默认为时间戳（null值）此方法设置的日期格式仅对转换为JSON字符串有效，对解析JSON为bean无效。
`int`	`size()`
`JSONArray`	`toJSONArray(Collection<String> names)` 将指定KEY列表的值组成新的JSONArray
`String`	`toString()` 返回JSON字符串如果解析错误，返回`null`
`Collection<Object>`	`values()`
`Writer`	`write(Writer writer, int indentFactor, int indent)` 将JSON内容写入Writer Warning: This method assumes that the data structure is acyclical.

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

Methods inherited from interface cn.hutool.json.JSON
toBean, toBean, toBean, toBean, toJSONString, toStringPretty, write

Methods inherited from interface cn.hutool.json.JSONGetter
get, get, getBean, getJSONArray, getJSONObject, getStrEscaped, getStrEscaped, isNull

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getShort, getStr

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort, getStr

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    默认初始大小
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JSONObject
```
public JSONObject()
```
    构造，初始容量为 DEFAULT_CAPACITY，KEY无序
  - JSONObject
```
public JSONObject(boolean isOrder)
```
    构造，初始容量为 DEFAULT_CAPACITY
    
    Parameters:
    
    isOrder - 是否有序
    
    Since:
    
    3.0.9
  - JSONObject
```
public JSONObject(int capacity,
                  boolean isOrder)
```
    构造
    
    Parameters:
    
    capacity - 初始大小
    
    isOrder - 是否有序
    
    Since:
    
    3.0.9
  - JSONObject
```
public JSONObject(int capacity,
                  boolean isIgnoreCase,
                  boolean isOrder)
```
    构造
    
    Parameters:
    
    capacity - 初始大小
    
    isIgnoreCase - 是否忽略KEY大小写
    
    isOrder - 是否有序
    
    Since:
    
    3.3.1
  - JSONObject
```
public JSONObject(JSONConfig config)
```
    构造
    
    Parameters:
    
    config - JSON配置项
    
    Since:
    
    4.6.5
  - JSONObject
```
public JSONObject(int capacity,
                  JSONConfig config)
```
    构造
    
    Parameters:
    
    capacity - 初始大小
    
    config - JSON配置项，null表示默认配置
    
    Since:
    
    4.1.19
  - JSONObject
```
public JSONObject(Object source)
```
    构建JSONObject，JavaBean默认忽略null值，其它对象不忽略，规则如下：
    1. value为Map，将键值对加入JSON对象
    2. value为JSON字符串（CharSequence），使用JSONTokener解析
    3. value为JSONTokener，直接解析
    4. value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
    Parameters:
    
    source - JavaBean或者Map对象或者String
  - JSONObject
```
public JSONObject(Object source,
                  boolean ignoreNullValue)
```
    构建JSONObject，规则如下：
    1. value为Map，将键值对加入JSON对象
    2. value为JSON字符串（CharSequence），使用JSONTokener解析
    3. value为JSONTokener，直接解析
    4. value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
    Parameters:
    
    source - JavaBean或者Map对象或者String
    
    ignoreNullValue - 是否忽略空值
    
    Since:
    
    3.0.9
  - JSONObject
```
public JSONObject(Object source,
                  boolean ignoreNullValue,
                  boolean isOrder)
```
    构建JSONObject，规则如下：
    1. value为Map，将键值对加入JSON对象
    2. value为JSON字符串（CharSequence），使用JSONTokener解析
    3. value为JSONTokener，直接解析
    4. value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
    Parameters:
    
    source - JavaBean或者Map对象或者String
    
    ignoreNullValue - 是否忽略空值，如果source为JSON字符串，不忽略空值
    
    isOrder - 是否有序
    
    Since:
    
    4.2.2
  - JSONObject
```
public JSONObject(Object source,
                  JSONConfig config)
```
    构建JSONObject，规则如下：
    1. value为Map，将键值对加入JSON对象
    2. value为JSON字符串（CharSequence），使用JSONTokener解析
    3. value为JSONTokener，直接解析
    4. value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
    如果给定值为Map，将键值对加入JSON对象;
    如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象
    例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
    Parameters:
    
    source - JavaBean或者Map对象或者String
    
    config - JSON配置文件
    
    Since:
    
    4.2.2
  - JSONObject
```
public JSONObject(Object obj,
                  String... names)
```
    构建指定name列表对应的键值对为新的JSONObject，情况如下：
```
 1. 若obj为Map，则获取name列表对应键值对
 2. 若obj为普通Bean，使用反射方式获取字段名和字段值
 
```
    KEY或VALUE任意一个为null则不加入，字段不存在也不加入
    若names列表为空，则字段全部加入
    Parameters:
    
    obj - 包含需要字段的Bean对象或者Map对象
    
    names - 需要构建JSONObject的字段名列表
  - JSONObject
```
public JSONObject(CharSequence source,
                  boolean isOrder)
           throws JSONException
```
    从JSON字符串解析为JSON对象，对于排序单独配置参数
    
    Parameters:
    
    source - 以大括号 {} 包围的字符串，其中KEY和VALUE使用 : 分隔，每个键值对使用逗号分隔
    
    isOrder - 是否有序
    
    Throws:
    
    JSONException - JSON字符串语法错误
    
    Since:
    
    4.2.2
- Method Detail
  - getConfig
```
public JSONConfig getConfig()
```
    Description copied from interface: JSONGetter
    
    获取JSON配置
    
    Specified by:
    
    getConfig in interface JSONGetter<String>
    
    Returns:
    
    JSONConfig
  - setDateFormat
```
public JSONObject setDateFormat(String format)
```
    设置转为字符串时的日期格式，默认为时间戳（null值）
    此方法设置的日期格式仅对转换为JSON字符串有效，对解析JSON为bean无效。
    
    Parameters:
    
    format - 格式，null表示使用时间戳
    
    Returns:
    
    this
    
    Since:
    
    4.1.19
  - toJSONArray
```
public JSONArray toJSONArray(Collection<String> names)
                      throws JSONException
```
    将指定KEY列表的值组成新的JSONArray
    
    Parameters:
    
    names - KEY列表
    
    Returns:
    
    A JSONArray of values.
    
    Throws:
    
    JSONException - If any of the values are non-finite numbers.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,Object>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,Object>
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<String,Object>
  - getObj
```
public Object getObj(String key,
                     Object defaultValue)
```
    Description copied from interface: OptBasicTypeGetter
    
    获取Object属性值
    
    Specified by:
    
    getObj in interface OptBasicTypeGetter<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值，无对应值返回defaultValue
  - getByPath
```
public Object getByPath(String expression)
```
    Description copied from interface: JSON
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    Specified by:
    
    getByPath in interface JSON
    
    Parameters:
    
    expression - 表达式
    
    Returns:
    
    对象
    
    See Also:
    
    BeanPath.get(Object)
  - getByPath
```
public <T> T getByPath(String expression,
                       Class<T> resultType)
```
    Description copied from interface: JSON
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    获取表达式对应值后转换为对应类型的值
    Specified by:
    
    getByPath in interface JSON
    
    Type Parameters:
    
    T - 返回值类型
    
    Parameters:
    
    expression - 表达式
    
    resultType - 返回值类型
    
    Returns:
    
    对象
    
    See Also:
    
    BeanPath.get(Object)
  - putByPath
```
public void putByPath(String expression,
                      Object value)
```
    Description copied from interface: JSON
    设置表达式指定位置（或filed对应）的值
    若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值
    注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    Specified by:
    
    putByPath in interface JSON
    
    Parameters:
    
    expression - 表达式
    
    value - 值
  - put
```
@Deprecated
public JSONObject put(String key,
                                  Object value)
                           throws JSONException
```
    Deprecated. 此方法存在歧义，原Map接口返回的是之前的值，重写后返回this了，未来版本此方法会修改，请使用set(String, Object)
    
    PUT 键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Specified by:
    
    put in interface Map<String,Object>
    
    Parameters:
    
    key - 键
    
    value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - set
```
public JSONObject set(String key,
                      Object value)
               throws JSONException
```
    设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
    
    Parameters:
    
    key - 键
    
    value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字抛出此异常
  - putOnce
```
public JSONObject putOnce(String key,
                          Object value)
                   throws JSONException
```
    一次性Put 键值对，如果key已经存在抛出异常，如果键值中有null值，忽略
    
    Parameters:
    
    key - 键
    
    value - 值对象，可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字、键重复抛出异常
  - putOpt
```
public JSONObject putOpt(String key,
                         Object value)
                  throws JSONException
```
    在键和值都为非空的情况下put到JSONObject中
    
    Parameters:
    
    key - 键
    
    value - 值对象，可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 值是无穷数字
  - putAll
```
public void putAll(Map<? extends String,?> m)
```
    Specified by:
    
    putAll in interface Map<String,Object>
  - accumulate
```
public JSONObject accumulate(String key,
                             Object value)
                      throws JSONException
```
    积累值。类似于set，当key对应value已经存在时，与value组成新的JSONArray.
    如果只有一个值，此值就是value，如果多个值，则是添加到新的JSONArray中
    
    Parameters:
    
    key - 键
    
    value - 被积累的值
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 如果给定键为null或者键对应的值存在且为非JSONArray
  - append
```
public JSONObject append(String key,
                         Object value)
                  throws JSONException
```
    追加值，如果key无对应值，就添加一个JSONArray，其元素只有value，如果值已经是一个JSONArray，则添加到值JSONArray中。
    
    Parameters:
    
    key - 键
    
    value - 值
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 如果给定键为null或者键对应的值存在且为非JSONArray
  - increment
```
public JSONObject increment(String key)
                     throws JSONException
```
    对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
    
    Parameters:
    
    key - A key string.
    
    Returns:
    
    this.
    
    Throws:
    
    JSONException - 如果存在值非Integer, Long, Double, 或 Float.
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,Object>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,Object>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,Object>
  - values
```
public Collection<Object> values()
```
    Specified by:
    
    values in interface Map<String,Object>
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,Object>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,Object>
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Map<String,Object>
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    返回JSON字符串
    如果解析错误，返回null
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    JSON字符串
  - write
```
public Writer write(Writer writer,
                    int indentFactor,
                    int indent)
             throws JSONException
```
    Description copied from interface: JSON
    
    将JSON内容写入Writer
    Warning: This method assumes that the data structure is acyclical.
    
    Specified by:
    
    write in interface JSON
    
    Parameters:
    
    writer - writer
    
    indentFactor - 缩进因子，定义每一级别增加的缩进量
    
    indent - 本级别缩进量
    
    Returns:
    
    Writer
    
    Throws:
    
    JSONException - JSON相关异常

Class JSONObject

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cn.hutool.json.JSON

Methods inherited from interface cn.hutool.json.JSONGetter

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter

Methods inherited from interface cn.hutool.core.getter.OptNullBasicTypeGetter

Methods inherited from interface java.util.Map

Field Detail

DEFAULT_CAPACITY

Constructor Detail

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

JSONObject

Method Detail

getConfig

setDateFormat

toJSONArray

size

isEmpty

containsKey

containsValue

get

getObj

getByPath

getByPath

putByPath

put

set

putOnce

putOpt

putAll

accumulate

append

increment

remove

clear

keySet

values

entrySet

hashCode

equals

toString

write