All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
cn.hutool.json.JSONUtil Maven / Gradle / Ivy
package cn.hutool.json;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.reflect.Type;
import java.nio.charset.Charset;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;
import cn.hutool.core.io.IORuntimeException;
import cn.hutool.core.io.file.FileReader;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.HexUtil;
import cn.hutool.core.util.ObjectUtil;
import cn.hutool.core.util.StrUtil;
/**
* JSON工具类
*
* @author Looly
*
*/
public final class JSONUtil {
// -------------------------------------------------------------------- Pause start
/**
* 创建JSONObject
*
* @return JSONObject
*/
public static JSONObject createObj() {
return new JSONObject();
}
/**
* 创建 JSONArray
*
* @return JSONArray
*/
public static JSONArray createArray() {
return new JSONArray();
}
/**
* JSON字符串转JSONObject对象
*
* @param jsonStr JSON字符串
* @return JSONObject
*/
public static JSONObject parseObj(String jsonStr) {
return new JSONObject(jsonStr);
}
/**
* JSON字符串转JSONObject对象 keys = bundle.getKeys();
while (keys.hasMoreElements()) {
String key = keys.nextElement();
if (key != null) {
InternalJSONUtil.propertyPut(jsonObject, key, bundle.getString(key));
}
}
return jsonObject;
}
// -------------------------------------------------------------------- Pause end
// -------------------------------------------------------------------- Read start
/**
* 读取JSON
*
* @param file JSON文件
* @param charset 编码
* @return JSON（包括JSONObject和JSONArray）
* @throws IORuntimeException IO异常
*/
public static JSON readJSON(File file, Charset charset) throws IORuntimeException {
return parse(FileReader.create(file, charset).readString());
}
/**
* 读取JSONObject
*
* @param file JSON文件
* @param charset 编码
* @return JSONObject
* @throws IORuntimeException IO异常
*/
public static JSONObject readJSONObject(File file, Charset charset) throws IORuntimeException {
return parseObj(FileReader.create(file, charset).readString());
}
/**
* 读取JSONArray
*
* @param file JSON文件
* @param charset 编码
* @return JSONArray
* @throws IORuntimeException IO异常
*/
public static JSONArray readJSONArray(File file, Charset charset) throws IORuntimeException {
return parseArray(FileReader.create(file, charset).readString());
}
// -------------------------------------------------------------------- Read end
// -------------------------------------------------------------------- toString start
/**
* 转为JSON字符串
*
* @param json JSON
* @param indentFactor 每一级别的缩进
* @return JSON字符串
*/
public static String toJsonStr(JSON json, int indentFactor) {
if (null == json) {
return null;
}
return json.toJSONString(indentFactor);
}
/**
* 转为JSON字符串
*
* @param json JSON
* @return JSON字符串
*/
public static String toJsonStr(JSON json) {
if (null == json) {
return null;
}
return json.toJSONString(0);
}
/**
* 转为JSON字符串
*
* @param json JSON
* @return JSON字符串
*/
public static String toJsonPrettyStr(JSON json) {
if (null == json) {
return null;
}
return json.toJSONString(4);
}
/**
* 转换为JSON字符串
*
* @param obj 被转为JSON的对象
* @return JSON字符串
*/
public static String toJsonStr(Object obj) {
if (null == obj) {
return null;
}
if (obj instanceof String) {
return (String) obj;
}
return toJsonStr(parse(obj));
}
/**
* 转换为格式化后的JSON字符串
*
* @param obj Bean对象
* @return JSON字符串
*/
public static String toJsonPrettyStr(Object obj) {
return toJsonPrettyStr(parse(obj));
}
/**
* 转换为XML字符串
*
* @param json JSON
* @return XML字符串
*/
public static String toXmlStr(JSON json) {
return XML.toXml(json);
}
// -------------------------------------------------------------------- toString end
// -------------------------------------------------------------------- toBean start
/**
* JSON字符串转为实体类对象，转换异常将被抛出
*
* @param Bean类型
* @param jsonString JSON字符串
* @param beanClass 实体类对象
* @return 实体类对象
* @since 3.1.2
*/
public static T toBean(String jsonString, Class beanClass) {
return toBean(parseObj(jsonString), beanClass);
}
/**
* 转为实体类对象，转换异常将被抛出
*
* @param Bean类型
* @param json JSONObject
* @param beanClass 实体类对象
* @return 实体类对象
*/
public static T toBean(JSONObject json, Class beanClass) {
return null == json ? null : json.toBean(beanClass);
}
/**
* JSON字符串转为实体类对象，转换异常将被抛出
*
* @param Bean类型
* @param jsonString JSON字符串
* @param beanType 实体类对象类型
* @return 实体类对象
* @since 4.3.2
*/
public static T toBean(String jsonString, Type beanType, boolean ignoreError) {
return toBean(parseObj(jsonString), beanType, ignoreError);
}
/**
* 转为实体类对象
*
* @param Bean类型
* @param json JSONObject
* @param beanType 实体类对象类型
* @param ignoreError 是否忽略转换错误
* @return 实体类对象
* @since 4.3.2
*/
public static T toBean(JSONObject json, Type beanType, boolean ignoreError) {
if (null == json) {
return null;
}
return json.toBean(beanType, ignoreError);
}
// -------------------------------------------------------------------- toBean end
/**
* 将JSONArray转换为Bean的List，默认为ArrayList
*
* @param jsonArray JSONArray
* @param elementType List中元素类型
* @return List
* @since 4.0.7
*/
public static List toList(JSONArray jsonArray, Class elementType) {
return null == jsonArray ? null : jsonArray.toList(elementType);
}
/**
* 通过表达式获取JSON中嵌套的对象
* .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
* []表达式，可以获取集合等对象中对应index的值
*
*
* 表达式栗子：
*
*
* persion
* persion.name
* persons[3]
* person.friends[5].name
*
*
* @param json {@link JSON}
* @param expression 表达式
* @return 对象
* @see JSON#getByPath(String)
*/
public static Object getByPath(JSON json, String expression) {
return (null == json || StrUtil.isBlank(expression)) ? null : json.getByPath(expression);
}
/**
* 设置表达式指定位置（或filed对应）的值
* .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
* []表达式，可以获取集合等对象中对应index的值
*
*
* 表达式栗子：
*
*
* persion
* persion.name
* persons[3]
* person.friends[5].name
*
*
* @param json JSON，可以为JSONObject或JSONArray
* @param expression 表达式
* @param value 值
*/
public static void putByPath(JSON json, String expression, Object value) {
json.putByPath(expression, value);
}
/**
* 对所有双引号做转义处理（使用双反斜杠做转义）
* null =》 JSONNull.NULLarray or collection =》 JSONArray
* map =》 JSONObject
* standard property (Double, String, et al) =》 原对象
* 来自于java包 =》 字符串
* 其它 =》 尝试包装为JSONObject，否则返回null
*
*
* @param object 被包装的对象
* @param ignoreNullValue 是否忽略{@code null} 值
* @return 包装后的值，null表示此值需被忽略
*/
public static Object wrap(Object object, boolean ignoreNullValue) {
if (object == null) {
return ignoreNullValue ? null : JSONNull.NULL;
}
if (object instanceof JSON //
|| JSONNull.NULL.equals(object) //
|| object instanceof JSONString //
|| object instanceof CharSequence //
|| object instanceof Number //
|| ObjectUtil.isBasicType(object) //
) {
return object;
}
try {
// JSONArray
if (object instanceof Iterable || ArrayUtil.isArray(object)) {
return new JSONArray(object, ignoreNullValue);
}
// JSONObject
if (object instanceof Map) {
return new JSONObject(object, ignoreNullValue);
}
// 日期类型原样保存，便于格式化
if (object instanceof Date || object instanceof Calendar) {
return object;
}
if (object instanceof Calendar) {
return ((Calendar) object).getTimeInMillis();
}
// 枚举类保存其字符串形式（4.0.2新增）
if (object instanceof Enum) {
return object.toString();
}
// Java内部类不做转换
final Class objectClass = object.getClass();
final Package objectPackage = objectClass.getPackage();
final String objectPackageName = objectPackage != null ? objectPackage.getName() : "";
if (objectPackageName.startsWith("java.") || objectPackageName.startsWith("javax.") || objectClass.getClassLoader() == null) {
return object.toString();
}
// 默认按照JSONObject对待
return new JSONObject(object, ignoreNullValue);
} catch (Exception exception) {
return null;
}
}
/**
* 格式化JSON字符串，此方法并不严格检查JSON的格式正确与否
*
* @param jsonStr JSON字符串
* @return 格式化后的字符串
* @since 3.1.2
*/
public static String formatJsonStr(String jsonStr) {
return JSONStrFormater.format(jsonStr);
}
/**
* 是否为JSON字符串，首尾都为大括号或中括号判定为JSON字符串
*
* @param str 字符串
* @return 是否为JSON字符串
* @since 3.3.0
*/
public static boolean isJson(String str) {
return isJsonObj(str) || isJsonArray(str);
}
/**
* 是否为JSONObject字符串，首尾都为大括号或中括号判定为JSON字符串
*
* @param str 字符串
* @return 是否为JSON字符串
* @since 3.3.0
*/
public static boolean isJsonObj(String str) {
if (StrUtil.isBlank(str)) {
return false;
}
return StrUtil.isWrap(str.trim(), '{', '}');
}
/**
* 是否为JSONObject字符串，首尾都为大括号或中括号判定为JSON字符串
*
* @param str 字符串
* @return 是否为JSON字符串
* @since 3.3.0
*/
public static boolean isJsonArray(String str) {
if (StrUtil.isBlank(str)) {
return false;
}
return StrUtil.isWrap(str.trim(), '[', ']');
}
/**
* 是否为null对象，null的情况包括：
*
*
* 1. {@code null}
* 2. {@link JSONNull}
*
*
* @param obj 对象
* @return 是否为null
* @since 4.5.7
*/
public static boolean isNull(Object obj) {
return null == obj || obj instanceof JSONNull;
}
/**
* XML转JSONObject
