cn.hutool.json

类 JSONObject

java.lang.Object

cn.hutool.core.getter.OptNullBasicTypeGetter<K>

cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter<K>

cn.hutool.json.JSONGetter<String>

cn.hutool.json.JSONObject

所有已实现的接口:

BasicTypeGetter<String>, OptBasicTypeGetter<String>, JSON, Serializable, Map<String,Object>

public class JSONObject
extends JSONGetter<String>
implements JSON, Map<String,Object>

JSON对象
例：

 json = new JSONObject().put("JSON", "Hello, World!").toString();
 

作者:

looly

另请参阅:

序列化表格

嵌套类概要

从接口继承的嵌套类/接口 java.util.Map

Map.Entry<K,V>

构造器概要

构造器

构造器和说明
JSONObject() 构造，初始容量为 DEFAULT_CAPACITY，KEY无序
JSONObject(boolean isOrder) 构造，初始容量为 DEFAULT_CAPACITY
JSONObject(CharSequence source) 从JSON字符串解析为JSON对象
JSONObject(int capacity, boolean isOrder) 构造
JSONObject(int capacity, boolean isIgnoreCase, boolean isOrder) 构造
JSONObject(JSONObject jsonObject, String... names) 使用其他JSONObject构造新的JSONObject，并只加入指定name对应的键值对。
JSONObject(JSONTokener x) 使用JSONTokener构建
JSONObject(JSONTokener x, boolean isOrder) 使用JSONTokener构建
JSONObject(Object source) 构建JSONObject，如果给定值为Map，将键值对加入JSON对象; 如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象 例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三" 此方法会忽略空值，但是对JSON字符串不影响
JSONObject(Object source, boolean ignoreNullValue) 构建JSONObject，如果给定值为Map，将键值对加入JSON对象; 如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象 例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
JSONObject(Object pojo, String[] names) 使用反射方式获取public字段名和字段值，构建JSONObject对象 KEY或VALUE任意一个为null则不加入，字段不存在也不加入

方法概要

方法

限定符和类型	方法和说明
JSONObject	accumulate(String key, Object value) 积累值。
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	getByExp(String expression) 已过时。 请使用getByPath(String)
<T> T	getByExp(String expression, Class<T> resultType) 已过时。 请使用getByPath(String, Class)
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 获取表达式对应值后转换为对应类型的值
Object	getObj(String key, Object defaultValue)
int	hashCode()
JSONObject	increment(String key) 对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
boolean	isEmpty()
boolean	isNull(String key) key对应值是否为null或无此key
Set<String>	keySet()
JSONObject	put(String key, Object value) PUT 键值对到JSONObject中，如果值为null，将此键移除
void	putAll(Map<? extends String,? extends Object> m)
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
JSONObject	putOnce(String key, Object value) Put a key/value pair in the JSONObject, but only if the key and the value are both non-null, and only if there is not already a member with that name.
JSONObject	putOpt(String key, Object value) 在键和值都为非空的情况下put到JSONObject中
Object	remove(Object key)
int	size()
<T> T	toBean(Class<T> clazz) 转为实体类对象，转换异常将被抛出
<T> T	toBean(Class<T> clazz, boolean ignoreError) 转为实体类对象
<T> T	toBean(T bean) 转为实体类对象，转换异常将被抛出
<T> T	toBean(T bean, boolean ignoreError) 转为实体类对象
<T> T	toBean(Type type) 转为实体类对象，转换异常将被抛出
<T> T	toBean(Type type, boolean ignoreError) 转为实体类对象
JSONArray	toJSONArray(Collection<String> names) 将指定KEY列表的值组成新的JSONArray
String	toJSONString(int indentFactor) 格式化输出JSON字符串
String	toString() 返回JSON字符串 如果解析错误，返回null
String	toStringPretty() 格式化打印JSON，缩进为4个空格
Collection<Object>	values()
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.

从类继承的方法 cn.hutool.json.JSONGetter

get, get, getBean, getJSONArray, getJSONObject, getStr

从类继承的方法 cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter

getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getEnum, getFloat, getInt, getLong, getShort

从类继承的方法 cn.hutool.core.getter.OptNullBasicTypeGetter

getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort, getStr

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

JSONObject

public JSONObject()

构造，初始容量为 DEFAULT_CAPACITY，KEY无序

JSONObject

public JSONObject(boolean isOrder)

构造，初始容量为 DEFAULT_CAPACITY

参数:

isOrder - 是否有序

从以下版本开始:

3.0.9

JSONObject

public JSONObject(int capacity,
          boolean isOrder)

构造

参数:

capacity - 初始大小

isOrder - 是否有序

从以下版本开始:

3.0.9

JSONObject

public JSONObject(int capacity,
          boolean isIgnoreCase,
          boolean isOrder)

构造

参数:

capacity - 初始大小

isIgnoreCase - 是否忽略KEY大小写

isOrder - 是否有序

从以下版本开始:

3.3.1

JSONObject

public JSONObject(JSONObject jsonObject,
          String... names)

使用其他JSONObject构造新的JSONObject，并只加入指定name对应的键值对。
此构造方法并不忽略空值

参数:

jsonObject - A JSONObject.

names - 需要的name列表

JSONObject

public JSONObject(JSONTokener x)
           throws JSONException

使用JSONTokener构建

参数:

x - JSONTokener

抛出:

JSONException - 语法错误

JSONObject

public JSONObject(JSONTokener x,
          boolean isOrder)
           throws JSONException

使用JSONTokener构建

参数:

x - JSONTokener

isOrder - 是否有序

抛出:

JSONException - 语法错误

从以下版本开始:

4.0.10

JSONObject

public JSONObject(Object source)

构建JSONObject，如果给定值为Map，将键值对加入JSON对象;
如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象
例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"
此方法会忽略空值，但是对JSON字符串不影响

参数:

source - JavaBean或者Map对象或者String

JSONObject

public JSONObject(Object source,
          boolean ignoreNullValue)

构建JSONObject，如果给定值为Map，将键值对加入JSON对象;
如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象
例如：如果JavaBean对象中有个方法getName()，值为"张三"，获得的键值对为：name: "张三"

参数:

source - JavaBean或者Map对象或者String

ignoreNullValue - 是否忽略空值，如果source为JSON字符串，不忽略空值

从以下版本开始:

3.0.9

JSONObject

public JSONObject(Object pojo,
          String[] names)

使用反射方式获取public字段名和字段值，构建JSONObject对象
KEY或VALUE任意一个为null则不加入，字段不存在也不加入

参数:

pojo - 包含需要字段的Bean对象

names - 需要构建JSONObject的字段名列表

JSONObject

public JSONObject(CharSequence source)
           throws JSONException

从JSON字符串解析为JSON对象

参数:

source - 以大括号 {} 包围的字符串，其中KEY和VALUE使用 : 分隔，每个键值对使用逗号分隔

抛出:

JSONException - JSON字符串语法错误

方法详细资料

isNull

public boolean isNull(String key)

key对应值是否为null或无此key

参数:

key - 键

返回:

true 无此key或值为null或JSONNull.NULL返回false，其它返回true

toJSONArray

public JSONArray toJSONArray(Collection<String> names)
                      throws JSONException

将指定KEY列表的值组成新的JSONArray

参数:

names - KEY列表

返回:

A JSONArray of values.

抛出:

JSONException - If any of the values are non-finite numbers.

toBean

public <T> T toBean(Class<T> clazz)

转为实体类对象，转换异常将被抛出

类型参数:

T - Bean类型

参数:

clazz - 实体类

返回:

实体类对象

toBean

public <T> T toBean(Class<T> clazz,
           boolean ignoreError)

转为实体类对象

类型参数:

T - Bean类型

参数:

clazz - 实体类

ignoreError - 是否忽略转换错误

返回:

实体类对象

toBean

public <T> T toBean(Type type)

转为实体类对象，转换异常将被抛出

类型参数:

T - Bean类型

参数:

type - Type

返回:

实体类对象

从以下版本开始:

3.0.8

toBean

public <T> T toBean(Type type,
           boolean ignoreError)

转为实体类对象

类型参数:

T - Bean类型

参数:

type - Type

ignoreError - 是否忽略转换错误

返回:

实体类对象

从以下版本开始:

3.0.8

toBean

public <T> T toBean(T bean)

转为实体类对象，转换异常将被抛出

类型参数:

T - Bean类型

参数:

bean - 实体类

返回:

实体类对象

toBean

public <T> T toBean(T bean,
           boolean ignoreError)

转为实体类对象

类型参数:

T - Bean类型

参数:

bean - 实体类

ignoreError - 是否忽略转换错误

返回:

实体类对象

size

public int size()

指定者:

size 在接口中 Map<String,Object>

isEmpty

public boolean isEmpty()

指定者:

isEmpty 在接口中 Map<String,Object>

containsKey

public boolean containsKey(Object key)

指定者:

containsKey 在接口中 Map<String,Object>

containsValue

public boolean containsValue(Object value)

指定者:

containsValue 在接口中 Map<String,Object>

get

public Object get(Object key)

指定者:

get 在接口中 Map<String,Object>

getObj

public Object getObj(String key,
            Object defaultValue)

指定者:

getObj 在接口中 OptBasicTypeGetter<String>

指定者:

getObj 在类中 OptNullBasicTypeFromObjectGetter<String>

getByExp

@Deprecated
public Object getByExp(String expression)

已过时。 请使用getByPath(String)

通过表达式获取JSON中嵌套的对象

1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
2. []表达式，可以获取集合等对象中对应index的值

表达式栗子：

 persion
 persion.name
 persons[3]
 person.friends[5].name
 

指定者:

getByExp 在接口中 JSON

参数:

expression - 表达式

返回:

对象

另请参阅:

BeanPath.get(Object)

getByExp

@Deprecated
public <T> T getByExp(String expression,
                        Class<T> resultType)

已过时。 请使用getByPath(String, Class)

通过表达式获取JSON中嵌套的对象

1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
2. []表达式，可以获取集合等对象中对应index的值

表达式栗子：

 persion
 persion.name
 persons[3]
 person.friends[5].name
 

获取表达式对应值后转换为对应类型的值

指定者:

getByExp 在接口中 JSON

类型参数:

T - 返回值类型

参数:

expression - 表达式

resultType - 返回值类型

返回:

对象

从以下版本开始:

3.1.0

另请参阅:

BeanPath.get(Object)

getByPath

public Object getByPath(String expression)

从接口复制的说明: JSON

通过表达式获取JSON中嵌套的对象

1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
2. []表达式，可以获取集合等对象中对应index的值

表达式栗子：

 persion
 persion.name
 persons[3]
 person.friends[5].name
 

指定者:

getByPath 在接口中 JSON

参数:

expression - 表达式

返回:

对象

另请参阅:

BeanPath.get(Object)

getByPath

public <T> T getByPath(String expression,
              Class<T> resultType)

从接口复制的说明: JSON

通过表达式获取JSON中嵌套的对象

1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
2. []表达式，可以获取集合等对象中对应index的值

表达式栗子：

 persion
 persion.name
 persons[3]
 person.friends[5].name
 

获取表达式对应值后转换为对应类型的值

指定者:

getByPath 在接口中 JSON

类型参数:

T - 返回值类型

参数:

expression - 表达式

resultType - 返回值类型

返回:

对象

另请参阅:

BeanPath.get(Object)

putByPath

public void putByPath(String expression,
             Object value)

从接口复制的说明: JSON

设置表达式指定位置（或filed对应）的值
若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值
注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值

1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
2. []表达式，可以获取集合等对象中对应index的值

表达式栗子：

 persion
 persion.name
 persons[3]
 person.friends[5].name
 

指定者:

putByPath 在接口中 JSON

参数:

expression - 表达式

value - 值

put

public JSONObject put(String key,
             Object value)
               throws JSONException

PUT 键值对到JSONObject中，如果值为null，将此键移除

指定者:

put 在接口中 Map<String,Object>

参数:

key - 键

value - 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.

返回:

this.

抛出:

JSONException - 值是无穷数字抛出此异常

putOnce

public JSONObject putOnce(String key,
                 Object value)
                   throws JSONException

Put a key/value pair in the JSONObject, but only if the key and the value are both non-null,
and only if there is not already a member with that name. 一次性Put 键值对，如果key已经存在抛出异常，如果键值中有null值，忽略

参数:

key - 键

value - 值对象，可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.

返回:

this.

抛出:

JSONException - 值是无穷数字、键重复抛出异常

putOpt

public JSONObject putOpt(String key,
                Object value)
                  throws JSONException

在键和值都为非空的情况下put到JSONObject中

参数:

key - 键

value - 值对象，可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.

返回:

this.

抛出:

JSONException - 值是无穷数字

putAll

public void putAll(Map<? extends String,? extends Object> m)

指定者:

putAll 在接口中 Map<String,Object>

accumulate

public JSONObject accumulate(String key,
                    Object value)
                      throws JSONException

积累值。类似于put，当key对应value已经存在时，与value组成新的JSONArray.
如果只有一个值，此值就是value，如果多个值，则是添加到新的JSONArray中

参数:

key - 键

value - 被积累的值

返回:

this.

抛出:

JSONException - 如果给定键为null或者键对应的值存在且为非JSONArray

append

public JSONObject append(String key,
                Object value)
                  throws JSONException

追加值，如果key无对应值，就添加一个JSONArray，其元素只有value，如果值已经是一个JSONArray，则添加到值JSONArray中。

参数:

key - 键

value - 值

返回:

this.

抛出:

JSONException - 如果给定键为null或者键对应的值存在且为非JSONArray

increment

public JSONObject increment(String key)
                     throws JSONException

对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作

参数:

key - A key string.

返回:

this.

抛出:

JSONException - 如果存在值非Integer, Long, Double, 或 Float.

remove

public Object remove(Object key)

指定者:

remove 在接口中 Map<String,Object>

clear

public void clear()

指定者:

clear 在接口中 Map<String,Object>

keySet

public Set<String> keySet()

指定者:

keySet 在接口中 Map<String,Object>

values

public Collection<Object> values()

指定者:

values 在接口中 Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

指定者:

entrySet 在接口中 Map<String,Object>

hashCode

public int hashCode()

指定者:

hashCode 在接口中 Map<String,Object>

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object obj)

指定者:

equals 在接口中 Map<String,Object>

覆盖:

equals 在类中 Object

toString

public String toString()

返回JSON字符串
如果解析错误，返回null

覆盖:

toString 在类中 Object

返回:

JSON字符串

toStringPretty

public String toStringPretty()
                      throws JSONException

格式化打印JSON，缩进为4个空格

指定者:

toStringPretty 在接口中 JSON

返回:

格式化后的JSON字符串

抛出:

JSONException - 包含非法数抛出此异常

从以下版本开始:

3.0.9

toJSONString

public String toJSONString(int indentFactor)
                    throws JSONException

格式化输出JSON字符串

指定者:

toJSONString 在接口中 JSON

参数:

indentFactor - 每层缩进空格数

返回:

JSON字符串

抛出:

JSONException - 包含非法数抛出此异常

write

public Writer write(Writer writer)
             throws JSONException

从接口复制的说明: JSON

将JSON内容写入Writer，无缩进
Warning: This method assumes that the data structure is acyclical.

指定者:

write 在接口中 JSON

参数:

writer - Writer

返回:

Writer

抛出:

JSONException - JSON相关异常

write

public Writer write(Writer writer,
           int indentFactor,
           int indent)
             throws JSONException

从接口复制的说明: JSON

将JSON内容写入Writer
Warning: This method assumes that the data structure is acyclical.

指定者:

write 在接口中 JSON

参数:

writer - writer

indentFactor - 每一级别的缩进量

indent - 顶级别缩进量

返回:

Writer

抛出:

JSONException - JSON相关异常