org.dromara.hutool.json

类 JSONObject

java.lang.Object

org.dromara.hutool.core.map.MapWrapper<String,Object>

org.dromara.hutool.json.JSONObject

所有已实现的接口:

Serializable, Cloneable, Iterable<Map.Entry<String,Object>>, Map<String,Object>, Converter, TypeGetter<String>, Wrapper<Map<String,Object>>, JSON, JSONGetter<String>

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

JSON对象
例：

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

作者:

looly

另请参阅:

序列化表格

嵌套类概要

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

Map.Entry<K,V>

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_CAPACITY 默认初始大小

从类继承的字段 org.dromara.hutool.core.map.MapWrapper

DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR

构造器概要

构造器

构造器和说明
JSONObject() 构造，初始容量为 DEFAULT_CAPACITY，KEY有序
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对象。
JSONObject(Object source, JSONConfig config) 构建JSONObject，规则如下： value为Map，将键值对加入JSON对象 value为JSON字符串（CharSequence），使用JSONTokener解析 value为JSONTokener，直接解析 value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。
JSONObject(Object source, JSONConfig config, Predicate<MutableEntry<String,Object>> predicate) 构建JSONObject，规则如下： value为Map，将键值对加入JSON对象 value为JSON字符串（CharSequence），使用JSONTokener解析 value为JSONTokener，直接解析 value为普通JavaBean，如果为普通的JavaBean，调用其getters方法（getXXX或者isXXX）获得值，加入到JSON对象。

方法概要

限定符和类型	方法和说明
JSONObject	append(String key, Object value) 追加值.
JSONObject	clone()
JSONConfig	config() 获取JSON配置
<P,T> T	get(SerFunction<P,T> func) 根据lambda的方法引用，获取
Object	getObj(String key, Object defaultValue)
JSONObject	increment(String key) 对值加一，如果值不存在，赋值1，如果为数字类型，做加一操作
Object	put(String key, Object value) PUT 键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
void	putAll(Map<? extends String,?> m)
JSONObject	set(String key, Object value) 设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
JSONObject	set(String key, Object value, Predicate<MutableEntry<String,Object>> predicate) 一次性Put 键值对，如果key已经存在抛出异常，如果键值中有null值，忽略
JSONObject	set(String key, Object value, Predicate<MutableEntry<String,Object>> predicate, boolean checkDuplicate) 设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除
JSONObject	setDateFormat(String format) 设置转为字符串时的日期格式，默认为时间戳（null值） 此方法设置的日期格式仅对转换为JSON字符串有效，对解析JSON为bean无效。
JSONObject	setFields(SerSupplier<?>... fields) 通过lambda批量设置值 实际使用时，可以使用getXXX的方法引用来完成键值对的赋值： User user = GenericBuilder.of(User::new).with(User::setUsername, "hutool").build(); (new JSONObject()).setFields(user::getNickname, user::getUsername);
JSONObject	setOpt(String key, Object value) 在键和值都为非空的情况下put到JSONObject中
JSONArray	toJSONArray(Collection<String> names) 将指定KEY列表的值组成新的JSONArray
String	toJSONString(int indentFactor, Predicate<MutableEntry<Object,Object>> predicate) 返回JSON字符串 支持过滤器，即选择哪些字段或值不写出
String	toString() 返回JSON字符串 如果解析错误，返回null
Writer	write(Writer writer, int indentFactor, int indent, Predicate<MutableEntry<Object,Object>> predicate) 将JSON内容写入Writer 支持过滤器，即选择哪些字段或值不写出

从类继承的方法 org.dromara.hutool.core.map.MapWrapper

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, getRaw, hashCode, isEmpty, iterator, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

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

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

从接口继承的方法 org.dromara.hutool.json.JSON

convert, getByPath, getByPath, putByPath, size, toBean, toJSONString, toStringPretty, write

从接口继承的方法 org.dromara.hutool.core.convert.Converter

convert

从接口继承的方法 org.dromara.hutool.json.JSONGetter

get, getBean, getBeanList, getJSONArray, getJSONObject, getStrEscaped, getStrEscaped, isNull

从接口继承的方法 org.dromara.hutool.core.lang.getter.TypeGetter

get, get, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBool, getBool, getByte, getByte, getBytes, getBytes, getChar, getChar, getDate, getDate, getDouble, getDouble, getEnum, getEnum, getFloat, getFloat, getInt, getInt, getLocalDate, getLocalDate, getLocalDateTime, getLocalDateTime, getLocalTime, getLocalTime, getLong, getLong, getNumber, getNumber, getObj, getShort, getShort, getSqlTime, getSqlTime, getSqlTimestamp, getSqlTimestamp, getStr, getStr

从接口继承的方法 java.lang.Iterable

forEach, spliterator

字段详细资料

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

默认初始大小

另请参阅:

常量字段值

构造器详细资料

JSONObject

public JSONObject()

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

JSONObject

public JSONObject(JSONConfig config)

构造

参数:

config - JSON配置项

从以下版本开始:

4.6.5

JSONObject

public JSONObject(int capacity,
                  JSONConfig config)

构造

参数:

capacity - 初始大小

config - JSON配置项，null则使用默认配置

从以下版本开始:

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: "张三"

参数:

source - JavaBean或者Map对象或者String

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: "张三"

参数:

source - JavaBean或者Map对象或者String

config - JSON配置文件，null则使用默认配置

从以下版本开始:

4.2.2

JSONObject

public JSONObject(Object source,
                  JSONConfig config,
                  Predicate<MutableEntry<String,Object>> predicate)

构建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: "张三"

参数:

source - JavaBean或者Map对象或者String

config - JSON配置文件，null则使用默认配置

predicate - 键值对过滤编辑器，可以通过实现此接口，完成解析前对键值对的过滤和修改操作，null表示不过滤，Predicate.test(Object)为true保留

从以下版本开始:

5.8.0

方法详细资料

config

public JSONConfig config()

从接口复制的说明: JSON

获取JSON配置

指定者:

config 在接口中 JSON

指定者:

config 在接口中 JSONGetter<String>

返回:

JSONConfig

setDateFormat

public JSONObject setDateFormat(String format)

设置转为字符串时的日期格式，默认为时间戳（null值）
此方法设置的日期格式仅对转换为JSON字符串有效，对解析JSON为bean无效。

参数:

format - 格式，null表示使用时间戳

返回:

this

从以下版本开始:

4.1.19

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.

getObj

public Object getObj(String key,
                     Object defaultValue)

指定者:

getObj 在接口中 TypeGetter<String>

get

public <P,T> T get(SerFunction<P,T> func)

根据lambda的方法引用，获取

类型参数:

P - 参数类型

T - 返回值类型

参数:

func - 方法引用

返回:

获取表达式对应属性和返回的对象

put

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

PUT 键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除

指定者:

put 在接口中 Map<String,Object>

覆盖:

put 在类中 MapWrapper<String,Object>

参数:

key - 键

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

返回:

this.

抛出:

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

set

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

设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除

参数:

key - 键

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

返回:

this.

抛出:

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

setFields

public JSONObject setFields(SerSupplier<?>... fields)

通过lambda批量设置值
实际使用时，可以使用getXXX的方法引用来完成键值对的赋值：

     User user = GenericBuilder.of(User::new).with(User::setUsername, "hutool").build();
     (new JSONObject()).setFields(user::getNickname, user::getUsername);
 

参数:

fields - lambda,不能为空

返回:

this

set

public JSONObject set(String key,
                      Object value,
                      Predicate<MutableEntry<String,Object>> predicate)
               throws JSONException

一次性Put 键值对，如果key已经存在抛出异常，如果键值中有null值，忽略

参数:

key - 键

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

predicate - 键值对过滤编辑器，可以通过实现此接口，完成解析前对键值对的过滤和修改操作，null表示不过滤，Predicate.test(Object)为true保留

返回:

this

抛出:

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

从以下版本开始:

5.8.0

set

public JSONObject set(String key,
                      Object value,
                      Predicate<MutableEntry<String,Object>> predicate,
                      boolean checkDuplicate)
               throws JSONException

设置键值对到JSONObject中，在忽略null模式下，如果值为null，将此键移除

参数:

key - 键

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

predicate - 键值对过滤编辑器，可以通过实现此接口，完成解析前对键值对的过滤和修改操作，null表示不过滤，Predicate.test(Object)为true保留

checkDuplicate - 是否检查重复键，如果为true，则出现重复键时抛出JSONException异常

返回:

this.

抛出:

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

从以下版本开始:

5.8.0

setOpt

public JSONObject setOpt(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,?> m)

指定者:

putAll 在接口中 Map<String,Object>

覆盖:

putAll 在类中 MapWrapper<String,Object>

append

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

追加值.

• 如果键值对不存在或对应值为null，则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.

toString

public String toString()

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

覆盖:

toString 在类中 MapWrapper<String,Object>

返回:

JSON字符串

toJSONString

public String toJSONString(int indentFactor,
                           Predicate<MutableEntry<Object,Object>> predicate)

返回JSON字符串
支持过滤器，即选择哪些字段或值不写出

参数:

indentFactor - 每层缩进空格数

predicate - 过滤器，同时可以修改编辑键和值，Predicate.test(Object)为true保留

返回:

JSON字符串

从以下版本开始:

5.7.15

write

public Writer write(Writer writer,
                    int indentFactor,
                    int indent,
                    Predicate<MutableEntry<Object,Object>> predicate)
             throws JSONException

将JSON内容写入Writer
支持过滤器，即选择哪些字段或值不写出

指定者:

write 在接口中 JSON

参数:

writer - writer

indentFactor - 缩进因子，定义每一级别增加的缩进量

indent - 本级别缩进量

predicate - 过滤器，同时可以修改编辑键和值

返回:

Writer

抛出:

JSONException - JSON相关异常

从以下版本开始:

5.7.15

clone

public JSONObject clone()
                 throws CloneNotSupportedException

覆盖:

clone 在类中 MapWrapper<String,Object>

抛出:

CloneNotSupportedException