mirror of
https://gitee.com/chinabugotech/hutool.git
synced 2025-05-09 23:51:34 +08:00
581 lines
15 KiB
Java
Executable File
581 lines
15 KiB
Java
Executable File
package cn.hutool.json;
|
||
|
||
import cn.hutool.core.collection.CollUtil;
|
||
import cn.hutool.core.convert.Convert;
|
||
import cn.hutool.core.convert.impl.ArrayConverter;
|
||
import cn.hutool.core.lang.mutable.Mutable;
|
||
import cn.hutool.core.lang.mutable.MutableEntry;
|
||
import cn.hutool.core.lang.mutable.MutableObj;
|
||
import cn.hutool.core.text.StrJoiner;
|
||
import cn.hutool.core.util.ObjUtil;
|
||
import cn.hutool.json.mapper.ArrayMapper;
|
||
import cn.hutool.json.serialize.JSONWriter;
|
||
|
||
import java.io.StringWriter;
|
||
import java.io.Writer;
|
||
import java.lang.reflect.Type;
|
||
import java.util.ArrayList;
|
||
import java.util.Collection;
|
||
import java.util.Iterator;
|
||
import java.util.List;
|
||
import java.util.ListIterator;
|
||
import java.util.RandomAccess;
|
||
import java.util.function.Predicate;
|
||
|
||
/**
|
||
* JSON数组<br>
|
||
* JSON数组是表示中括号括住的数据表现形式<br>
|
||
* 对应的JSON字符串格格式例如:
|
||
*
|
||
* <pre>
|
||
* ["a", "b", "c", 12]
|
||
* </pre>
|
||
*
|
||
* @author looly
|
||
*/
|
||
public class JSONArray implements JSON, JSONGetter<Integer>, List<Object>, RandomAccess {
|
||
private static final long serialVersionUID = 2664900568717612292L;
|
||
|
||
/**
|
||
* 默认初始大小
|
||
*/
|
||
public static final int DEFAULT_CAPACITY = 10;
|
||
|
||
/**
|
||
* 持有原始数据的List
|
||
*/
|
||
private List<Object> rawList;
|
||
/**
|
||
* 配置项
|
||
*/
|
||
private final JSONConfig config;
|
||
|
||
// region Constructors
|
||
|
||
/**
|
||
* 构造<br>
|
||
* 默认使用{@link ArrayList} 实现
|
||
*/
|
||
public JSONArray() {
|
||
this(DEFAULT_CAPACITY);
|
||
}
|
||
|
||
/**
|
||
* 构造<br>
|
||
* 默认使用{@link ArrayList} 实现
|
||
*
|
||
* @param initialCapacity 初始大小
|
||
* @since 3.2.2
|
||
*/
|
||
public JSONArray(final int initialCapacity) {
|
||
this(initialCapacity, JSONConfig.of());
|
||
}
|
||
|
||
/**
|
||
* 构造<br>
|
||
* 默认使用{@link ArrayList} 实现
|
||
*
|
||
* @param config JSON配置项
|
||
* @since 4.6.5
|
||
*/
|
||
public JSONArray(final JSONConfig config) {
|
||
this(DEFAULT_CAPACITY, config);
|
||
}
|
||
|
||
/**
|
||
* 构造<br>
|
||
* 默认使用{@link ArrayList} 实现
|
||
*
|
||
* @param initialCapacity 初始大小
|
||
* @param config JSON配置项
|
||
* @since 4.1.19
|
||
*/
|
||
public JSONArray(final int initialCapacity, final JSONConfig config) {
|
||
this.rawList = new ArrayList<>(initialCapacity);
|
||
this.config = ObjUtil.defaultIfNull(config, JSONConfig::of);
|
||
}
|
||
|
||
/**
|
||
* 从对象构造，忽略{@code null}的值<br>
|
||
* 支持以下类型的参数：
|
||
*
|
||
* <pre>
|
||
* 1. 数组
|
||
* 2. {@link Iterable}对象
|
||
* 3. JSON数组字符串
|
||
* </pre>
|
||
*
|
||
* @param object 数组或集合或JSON数组字符串
|
||
* @throws JSONException 非数组或集合
|
||
*/
|
||
public JSONArray(final Object object) throws JSONException {
|
||
this(object, JSONConfig.of());
|
||
}
|
||
|
||
/**
|
||
* 从对象构造<br>
|
||
* 支持以下类型的参数：
|
||
*
|
||
* <pre>
|
||
* 1. 数组
|
||
* 2. {@link Iterable}对象
|
||
* 3. JSON数组字符串
|
||
* </pre>
|
||
*
|
||
* @param object 数组或集合或JSON数组字符串
|
||
* @param jsonConfig JSON选项
|
||
* @throws JSONException 非数组或集合
|
||
* @since 4.6.5
|
||
*/
|
||
public JSONArray(final Object object, final JSONConfig jsonConfig) throws JSONException {
|
||
this(object, jsonConfig, null);
|
||
}
|
||
|
||
/**
|
||
* 从对象构造<br>
|
||
* 支持以下类型的参数：
|
||
*
|
||
* <pre>
|
||
* 1. 数组
|
||
* 2. {@link Iterable}对象
|
||
* 3. JSON数组字符串
|
||
* </pre>
|
||
*
|
||
* @param object 数组或集合或JSON数组字符串
|
||
* @param jsonConfig JSON选项
|
||
* @param predicate 键值对过滤编辑器，可以通过实现此接口，完成解析前对值的过滤和修改操作，{@code null}表示不过滤，{@link Predicate#test(Object)}为{@code true}保留
|
||
* @throws JSONException 非数组或集合
|
||
* @since 5.8.0
|
||
*/
|
||
public JSONArray(final Object object, final JSONConfig jsonConfig, final Predicate<Mutable<Object>> predicate) throws JSONException {
|
||
this(DEFAULT_CAPACITY, jsonConfig);
|
||
ArrayMapper.of(object, predicate).mapTo(this);
|
||
}
|
||
// endregion
|
||
|
||
@Override
|
||
public JSONConfig getConfig() {
|
||
return this.config;
|
||
}
|
||
|
||
/**
|
||
* 设置转为字符串时的日期格式，默认为时间戳（null值）
|
||
*
|
||
* @param format 格式，null表示使用时间戳
|
||
* @return this
|
||
* @since 4.1.19
|
||
*/
|
||
public JSONArray setDateFormat(final String format) {
|
||
this.config.setDateFormat(format);
|
||
return this;
|
||
}
|
||
|
||
/**
|
||
* JSONArray转为以{@code separator}为分界符的字符串
|
||
*
|
||
* @param separator 分界符
|
||
* @return a string.
|
||
* @throws JSONException If the array contains an invalid number.
|
||
*/
|
||
public String join(final String separator) throws JSONException {
|
||
return StrJoiner.of(separator)
|
||
.append(this, InternalJSONUtil::valueToString).toString();
|
||
}
|
||
|
||
@Override
|
||
public Object get(final int index) {
|
||
return this.rawList.get(index);
|
||
}
|
||
|
||
@Override
|
||
public Object getObj(final Integer index, final Object defaultValue) {
|
||
return (index < 0 || index >= this.size()) ? defaultValue : this.rawList.get(index);
|
||
}
|
||
|
||
/**
|
||
* Append an object value. This increases the array's length by one. <br>
|
||
* 加入元素，数组长度+1，等同于 {@link JSONArray#add(Object)}
|
||
*
|
||
* @param value 值，可以是： Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL。
|
||
* @return this.
|
||
* @see #set(Object)
|
||
*/
|
||
public JSONArray put(final Object value) {
|
||
return set(value);
|
||
}
|
||
|
||
/**
|
||
* Append an object value. This increases the array's length by one. <br>
|
||
* 加入元素，数组长度+1，等同于 {@link JSONArray#add(Object)}
|
||
*
|
||
* @param value 值，可以是： Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONNull.NULL。
|
||
* @return this.
|
||
* @since 5.2.5
|
||
*/
|
||
public JSONArray set(final Object value) {
|
||
this.add(value);
|
||
return this;
|
||
}
|
||
|
||
/**
|
||
* 加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
|
||
*
|
||
* @param index 位置
|
||
* @param value 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
|
||
* @return this.
|
||
* @throws JSONException index < 0 或者非有限的数字
|
||
* @see #set(int, Object)
|
||
*/
|
||
public JSONArray put(final int index, final Object value) throws JSONException {
|
||
this.set(index, value);
|
||
return this;
|
||
}
|
||
|
||
@Override
|
||
public <T> T toBean(final Type type) {
|
||
return JSON.super.toBean(type);
|
||
}
|
||
|
||
/**
|
||
* 根据给定名列表，与其位置对应的值组成JSONObject
|
||
*
|
||
* @param names 名列表，位置与JSONArray中的值位置对应
|
||
* @return A JSONObject，无名或值返回null
|
||
* @throws JSONException 如果任何一个名为null
|
||
*/
|
||
public JSONObject toJSONObject(final JSONArray names) throws JSONException {
|
||
if (names == null || names.size() == 0 || this.size() == 0) {
|
||
return null;
|
||
}
|
||
final JSONObject jo = new JSONObject(this.config);
|
||
for (int i = 0; i < names.size(); i += 1) {
|
||
jo.set(names.getStr(i), this.getObj(i));
|
||
}
|
||
return jo;
|
||
}
|
||
|
||
@Override
|
||
public int hashCode() {
|
||
final int prime = 31;
|
||
int result = 1;
|
||
result = prime * result + ((rawList == null) ? 0 : rawList.hashCode());
|
||
return result;
|
||
}
|
||
|
||
@Override
|
||
public boolean equals(final Object obj) {
|
||
if (this == obj) {
|
||
return true;
|
||
}
|
||
if (obj == null) {
|
||
return false;
|
||
}
|
||
if (getClass() != obj.getClass()) {
|
||
return false;
|
||
}
|
||
final JSONArray other = (JSONArray) obj;
|
||
if (rawList == null) {
|
||
return other.rawList == null;
|
||
} else {
|
||
return rawList.equals(other.rawList);
|
||
}
|
||
}
|
||
|
||
@Override
|
||
public Iterator<Object> iterator() {
|
||
return rawList.iterator();
|
||
}
|
||
|
||
/**
|
||
* 当此JSON列表的每个元素都是一个JSONObject时，可以调用此方法返回一个Iterable，便于使用foreach语法遍历
|
||
*
|
||
* @return Iterable
|
||
* @since 4.0.12
|
||
*/
|
||
public Iterable<JSONObject> jsonIter() {
|
||
return new JSONObjectIter(iterator());
|
||
}
|
||
|
||
@Override
|
||
public int size() {
|
||
return rawList.size();
|
||
}
|
||
|
||
@Override
|
||
public boolean isEmpty() {
|
||
return rawList.isEmpty();
|
||
}
|
||
|
||
@Override
|
||
public boolean contains(final Object o) {
|
||
return rawList.contains(o);
|
||
}
|
||
|
||
@Override
|
||
public Object[] toArray() {
|
||
return rawList.toArray();
|
||
}
|
||
|
||
@Override
|
||
@SuppressWarnings({"unchecked"})
|
||
public <T> T[] toArray(final T[] a) {
|
||
return (T[]) ArrayConverter.INSTANCE.convert(a.getClass().getComponentType(), this);
|
||
}
|
||
|
||
@Override
|
||
public boolean add(final Object e) {
|
||
return add(e, null);
|
||
}
|
||
|
||
/**
|
||
* 增加元素
|
||
*
|
||
* @param e 元素对象，自动根据对象类型转换为JSON中的对象
|
||
* @param predicate 键值对过滤编辑器，可以通过实现此接口，完成解析前对值的过滤和修改操作，{@code null}表示不过滤，{@link Predicate#test(Object)}为{@code true}保留
|
||
* @return 是否加入成功
|
||
*/
|
||
public boolean add(final Object e, final Predicate<Mutable<Object>> predicate) {
|
||
return addRaw(InternalJSONUtil.wrap(e, this.config), predicate);
|
||
}
|
||
|
||
@Override
|
||
public Object remove(final int index) {
|
||
return index >= 0 && index < this.size() ? this.rawList.remove(index) : null;
|
||
}
|
||
|
||
@Override
|
||
public boolean remove(final Object o) {
|
||
return rawList.remove(o);
|
||
}
|
||
|
||
@SuppressWarnings({"NullableProblems", "SlowListContainsAll"})
|
||
@Override
|
||
public boolean containsAll(final Collection<?> c) {
|
||
return rawList.containsAll(c);
|
||
}
|
||
|
||
@Override
|
||
public boolean addAll(final Collection<?> c) {
|
||
if (CollUtil.isEmpty(c)) {
|
||
return false;
|
||
}
|
||
for (final Object obj : c) {
|
||
this.add(obj);
|
||
}
|
||
return true;
|
||
}
|
||
|
||
@Override
|
||
public boolean addAll(final int index, final Collection<?> c) {
|
||
if (CollUtil.isEmpty(c)) {
|
||
return false;
|
||
}
|
||
final ArrayList<Object> list = new ArrayList<>(c.size());
|
||
for (final Object object : c) {
|
||
if (null == object && config.isIgnoreNullValue()) {
|
||
continue;
|
||
}
|
||
this.add(index);
|
||
list.add(InternalJSONUtil.wrap(object, this.config));
|
||
}
|
||
return rawList.addAll(index, list);
|
||
}
|
||
|
||
@Override
|
||
public boolean removeAll(final Collection<?> c) {
|
||
return this.rawList.removeAll(c);
|
||
}
|
||
|
||
@Override
|
||
public boolean retainAll(final Collection<?> c) {
|
||
return this.rawList.retainAll(c);
|
||
}
|
||
|
||
@Override
|
||
public void clear() {
|
||
this.rawList.clear();
|
||
|
||
}
|
||
|
||
/**
|
||
* 加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
|
||
*
|
||
* @param index 位置
|
||
* @param element 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
|
||
* @return 替换的值，即之前的值
|
||
*/
|
||
@Override
|
||
public Object set(final int index, final Object element) {
|
||
return set(index, element, null);
|
||
}
|
||
|
||
/**
|
||
* 加入或者替换JSONArray中指定Index的值，如果index大于JSONArray的长度，将在指定index设置值，之前的位置填充JSONNull.Null
|
||
*
|
||
* @param index 位置
|
||
* @param element 值对象. 可以是以下类型: Boolean, Double, Integer, JSONArray, JSONObject, Long, String, or the JSONNull.NULL.
|
||
* @param filter 过滤器，可以修改值，key（index）无法修改，{@link Predicate#test(Object)}为{@code true}保留，null表示全部保留。
|
||
* @return 替换的值，即之前的值
|
||
* @since 5.8.0
|
||
*/
|
||
public Object set(final int index, Object element, final Predicate<MutableEntry<Integer, Object>> filter) {
|
||
// 添加前置过滤，通过MutablePair实现过滤、修改键值对等
|
||
if (null != filter) {
|
||
final MutableEntry<Integer, Object> pair = new MutableEntry<>(index, element);
|
||
if (filter.test(pair)) {
|
||
// 使用修改后的值
|
||
element = pair.getValue();
|
||
}
|
||
}
|
||
|
||
// 越界则追加到指定位置
|
||
if (index >= size()) {
|
||
add(index, element);
|
||
return null;
|
||
}
|
||
if (null == element && config.isIgnoreNullValue()) {
|
||
return null;
|
||
}
|
||
return this.rawList.set(index, InternalJSONUtil.wrap(element, this.config));
|
||
}
|
||
|
||
@Override
|
||
public void add(int index, final Object element) {
|
||
if (null == element && config.isIgnoreNullValue()) {
|
||
return;
|
||
}
|
||
if (index < this.size()) {
|
||
if (index < 0) {
|
||
index = 0;
|
||
}
|
||
this.rawList.add(index, InternalJSONUtil.wrap(element, this.config));
|
||
} else {
|
||
if (false == config.isIgnoreNullValue()) {
|
||
while (index != this.size()) {
|
||
// 非末尾，则填充null
|
||
this.add(null);
|
||
}
|
||
}
|
||
this.add(element);
|
||
}
|
||
|
||
}
|
||
|
||
@Override
|
||
public int indexOf(final Object o) {
|
||
return this.rawList.indexOf(o);
|
||
}
|
||
|
||
@Override
|
||
public int lastIndexOf(final Object o) {
|
||
return this.rawList.lastIndexOf(o);
|
||
}
|
||
|
||
@Override
|
||
public ListIterator<Object> listIterator() {
|
||
return this.rawList.listIterator();
|
||
}
|
||
|
||
@Override
|
||
public ListIterator<Object> listIterator(final int index) {
|
||
return this.rawList.listIterator(index);
|
||
}
|
||
|
||
@Override
|
||
public List<Object> subList(final int fromIndex, final int toIndex) {
|
||
return this.rawList.subList(fromIndex, toIndex);
|
||
}
|
||
|
||
/**
|
||
* 转为Bean数组
|
||
*
|
||
* @param arrayClass 数组元素类型
|
||
* @return 实体类对象
|
||
*/
|
||
public Object toArray(final Class<?> arrayClass) {
|
||
return ArrayConverter.INSTANCE.convert(arrayClass, this);
|
||
}
|
||
|
||
/**
|
||
* 转为{@link ArrayList}
|
||
*
|
||
* @param <T> 元素类型
|
||
* @param elementType 元素类型
|
||
* @return {@link ArrayList}
|
||
* @since 3.0.8
|
||
*/
|
||
public <T> List<T> toList(final Class<T> elementType) {
|
||
return Convert.toList(elementType, this);
|
||
}
|
||
|
||
/**
|
||
* 转为JSON字符串，无缩进
|
||
*
|
||
* @return JSONArray字符串
|
||
*/
|
||
@Override
|
||
public String toString() {
|
||
return this.toJSONString(0);
|
||
}
|
||
|
||
/**
|
||
* 返回JSON字符串<br>
|
||
* 支持过滤器，即选择哪些字段或值不写出
|
||
*
|
||
* @param indentFactor 每层缩进空格数
|
||
* @param predicate 过滤器，可以修改值，key（index）无法修改，{@link Predicate#test(Object)}为{@code true}保留
|
||
* @return JSON字符串
|
||
* @since 5.7.15
|
||
*/
|
||
public String toJSONString(final int indentFactor, final Predicate<MutableEntry<Object, Object>> predicate) {
|
||
final StringWriter sw = new StringWriter();
|
||
synchronized (sw.getBuffer()) {
|
||
return this.write(sw, indentFactor, 0, predicate).toString();
|
||
}
|
||
}
|
||
|
||
@Override
|
||
public Writer write(final Writer writer, final int indentFactor, final int indent, final Predicate<MutableEntry<Object, Object>> predicate) throws JSONException {
|
||
final JSONWriter jsonWriter = JSONWriter.of(writer, indentFactor, indent, config).beginArray();
|
||
|
||
CollUtil.forEach(this, (value, index) -> jsonWriter.writeField(new MutableEntry<>(index, value), predicate));
|
||
jsonWriter.end();
|
||
// 此处不关闭Writer，考虑writer后续还需要填内容
|
||
return writer;
|
||
}
|
||
|
||
@Override
|
||
public Object clone() throws CloneNotSupportedException {
|
||
final JSONArray clone = (JSONArray) super.clone();
|
||
clone.rawList = ObjUtil.clone(this.rawList);
|
||
return clone;
|
||
}
|
||
|
||
/**
|
||
* 原始添加，添加的对象不做任何处理
|
||
*
|
||
* @param obj 添加的对象
|
||
* @param predicate 键值对过滤编辑器，可以通过实现此接口，完成解析前对值的过滤和修改操作，{@code null}表示不过滤，{@link Predicate#test(Object)}为{@code true}保留
|
||
* @return 是否加入成功
|
||
* @since 5.8.0
|
||
*/
|
||
protected boolean addRaw(Object obj, final Predicate<Mutable<Object>> predicate) {
|
||
// 添加前置过滤，通过MutablePair实现过滤、修改键值对等
|
||
if (null != predicate) {
|
||
final Mutable<Object> mutable = new MutableObj<>(obj);
|
||
if (predicate.test(mutable)) {
|
||
// 使用修改后的值
|
||
obj = mutable.get();
|
||
} else {
|
||
// 键值对被过滤
|
||
return false;
|
||
}
|
||
}
|
||
if (null == obj && config.isIgnoreNullValue()) {
|
||
// 忽略空则不添加
|
||
return false;
|
||
}
|
||
return this.rawList.add(obj);
|
||
}
|
||
}
|