com.feilong.json.JsonUtil Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.0.8

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feilong.json;

import static com.feilong.core.DatePattern.COMMON_DATE;
import static com.feilong.core.DatePattern.COMMON_DATE_AND_TIME;
import static com.feilong.core.DatePattern.COMMON_TIME;
import static com.feilong.core.Validator.isNullOrEmpty;
import static com.feilong.core.lang.StringUtil.EMPTY;
import static com.feilong.core.util.CollectionsUtil.newArrayList;
import static com.feilong.core.util.MapUtil.newLinkedHashMap;
import static java.util.Collections.emptyMap;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.feilong.core.Validate;
import com.feilong.core.bean.ConvertUtil;
import com.feilong.core.lang.ArrayUtil;
import com.feilong.core.lang.ClassUtil;
import com.feilong.core.lang.reflect.FieldUtil;
import com.feilong.json.builder.JavaToJsonConfigBuilder;
import com.feilong.json.builder.JsonConfigBuilder;
import com.feilong.json.builder.JsonToJavaConfigBuilder;
import com.feilong.json.processor.SensitiveWordsJsonValueProcessor;
import com.feilong.lib.ezmorph.MorpherRegistry;
import com.feilong.lib.ezmorph.object.DateMorpher;
import com.feilong.lib.json.JSON;
import com.feilong.lib.json.JSONArray;
import com.feilong.lib.json.JSONNull;
import com.feilong.lib.json.JSONObject;
import com.feilong.lib.json.JSONObjectBuilder;
import com.feilong.lib.json.JSONObjectToBeanUtil;
import com.feilong.lib.json.JsonConfig;
import com.feilong.lib.json.util.JSONUtils;
import com.feilong.lib.lang3.StringUtils;
import com.feilong.tools.slf4j.Slf4jUtil;

/**
 * json处理工具类.
 * 
 * 提供以下主要方法:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 方法: 说明:
{@link #format(Object)} 将对象格式化成json字符串
 * 
 * 
 * json-lib format map的时候或者 json转成对象/数组/map等的时候
 * 
 * 
 * 
 * key不能是null
 * key也不能是"null" 字符串
 * 
 * 
 *

方法:	说明:
{@link #format(Object)}	将对象格式化成json字符串


*
* 
*
* @author feilong
* @since 1.0.5
* @since 3.0.0 change package name
*/
@SuppressWarnings("squid:S1192") //String literals should not be duplicated
public final class JsonUtil{
/** The Constant LOGGER. */
private static final Logger LOGGER = LoggerFactory.getLogger(JsonUtil.class);
/** Don't let anyone instantiate this class. */
private JsonUtil(){
//AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
//see 《Effective Java》 2nd
throw new AssertionError("No " + getClass().getName() + " instances for you!");
}
//---------------------------------------------------------------
/**
* 设置日期转换格式.
*/
static{
// 可转换的日期格式,即Json串中可以出现以下格式的日期与时间
// 注意:此处的代码不能移到 JsonHelper,否则json转成 java的时候 日期格式会出错
MorpherRegistry morpherRegistry = JSONUtils.getMorpherRegistry();
morpherRegistry.registerMorpher(new DateMorpher(ConvertUtil.toArray(COMMON_DATE_AND_TIME, COMMON_TIME, COMMON_DATE)));
}
//---------------------------------------------------------------
//format
// [start] format
/**
* 将对象 obj 格式化成json字符串.
*
* 
* 该方法还可以格式化json字符串成缩进形式的格式
* 
*
* 示例:
* 
*
*     {"userAddresseList":[{"address":"上海市地址1"},{"address":"上海市地址2"}],"userAddresses":[{"address":"上海市地址1"},{"address":"上海市地址2"}],"date":"2016-06-09 17:40:28","password":"******","id":8,"nickName":[],"age":0,"name":"feilong","money":99999999,"attrMap":null,"userInfo":{"age":10},"loves":["桔子","香蕉"]}
     * 
*
* 返回:
*
*     {
            "userAddresseList":         [
                {"address": "上海市地址1"},
                {"address": "上海市地址2"}
            ],
            "userAddresses":         [
                {"address": "上海市地址1"},
                {"address": "上海市地址2"}
            ],
            "date": "2016-06-09 17:40:28",
            "password": "******",
            "id": 8,
            "nickName": [],
            "age": 0,
            "name": "feilong",
            "money": 99999999,
            "attrMap": null,
            "userInfo": {"age": 10},
            "loves":         [
                "桔子",
                "香蕉"
            ]
        }
     * 
     * 
*
* 
*
* 关于 indent缩进:
*
* 
* 
* 默认使用 toString(4,4) 缩进
* 
*
* 
* 如果不需要 indent缩进,你可以调用 {@link #format(Object, int, int)}或者 {@link #format(Object, JavaToJsonConfig, int, int)}
* 
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* @see #format(Object, JavaToJsonConfig)
*/
public static String format(Object obj){
return format(obj, (JavaToJsonConfig) null);
}
/**
* 将对象 obj 格式化成json字符串,支持 isIgnoreNullValueElement 参数控制是否输出 null 值元素.
*
* 示例:
* 
*
*      *     {"userAddresseList":[{"address":"上海市地址1"},{"address":"上海市地址2"}],"userAddresses":[{"address":"上海市地址1"},{"address":"上海市地址2"}],"date":"2016-06-09 17:40:28","password":"******","id":8,"nickName":[],"age":0,"name":"feilong","money":99999999,"attrMap":null,"userInfo":{"age":10},"loves":["桔子","香蕉"]}
     * 
*
* 
* 如果 com.feilong.json.JsonUtil.format(Object, false) ,不过滤 null 值
* 
*
* 返回:
*
*      *     {
     *             "userAddresseList":         [
     *                 {"address": "上海市地址1"},
     *                 {"address": "上海市地址2"}
     *             ],
     *             "userAddresses":         [
     *                 {"address": "上海市地址1"},
     *                 {"address": "上海市地址2"}
     *             ],
     *             "date": "2016-06-09 17:40:28",
     *             "password": "******",
     *             "id": 8,
     *             "nickName": [],
     *             "age": 0,
     *             "name": "feilong",
     *             "money": 99999999,
     *             "attrMap": null,
     *             "userInfo": {"age": 10},
     *             "loves":         [
     *                 "桔子",
     *                 "香蕉"
     *             ]
     *         }
     * 
     * 
*
* 
* 如果 com.feilong.json.JsonUtil.format(Object, true),过滤 null 值元素
* 
*
* 返回:
*
*     {
        "userAddresseList":         [
            {"address": "上海市地址1"},
            {"address": "上海市地址2"}
        ],
        "userAddresses":         [
            {"address": "上海市地址1"},
            {"address": "上海市地址2"}
        ],
        "date": "2019-09-05 18:59:26",
        "password": "******",
        "id": 8,
        "name": "feilong",
        "money": "99999999.00",
        "userInfo": {"age": 10},
        "ageInt": 0,
        "loves":         [
            "桔子",
            "香蕉"
        ]
    }
     * 
     * 
*
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param isIgnoreNullValueElement
* 是否忽略 null value 元素,true 表示忽略
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* @see #format(Object, JavaToJsonConfig)
* @see com.feilong.json.JavaToJsonConfig#JavaToJsonConfig(boolean)
* @since 2.0.0
*/
public static String format(Object obj,boolean isIgnoreNullValueElement){
return format(obj, new JavaToJsonConfig(isIgnoreNullValueElement));
}
//---------------------------------------------------------------
/**
* 有些map 值很复杂,比如带有request信息, 这样的map转成json很可能由于一些级联关系而抛异常.
*
* 注意:
*
* 
* 
* 此方法 将inputMap转成 simpleMap(原始inputMap不会变更)
* 此方法转换的simpleMap是 {@link TreeMap}类型,转换的json key经过排序的
* 
* 
*
* 转换规则:
*
* 
* 
* 如果value 是isPrimitiveOrWrapper类型, 那么会直接取到值 设置到 新的simpleMap中
* 否则 使用 {@link String#valueOf(Object)} 转换到simpleMap中
* 
* .
*
* @param 
* the key type
* @param 
* the value type
* @param inputMap
* the input map
* @return 如果 inputMap 是null,返回 {@link StringUtils#EMPTY}

* @since 1.3.0
*/
public static  String formatSimpleMap(Map inputMap){
return null == inputMap ? EMPTY : formatSimpleMap(inputMap, (Class) null);
}
/**
* 有些map 值很复杂,比如带有request信息, 这样的map转成json很可能由于一些级联关系而抛异常.
*
* 注意:
*
* 
* 
* 此方法 将inputMap转成 simpleMap(原始inputMap不会变更)
* 此方法转换的simpleMap是 {@link TreeMap}类型,转换的json key经过排序的
* 
* 
*
* 转换规则:
*
* 
* 
* 如果value是isPrimitiveOrWrapper类型,那么会直接取到值设置到新的simpleMap中
* 否则使用{@link String#valueOf(Object)}转换到simpleMap中
* 
* .
*
* @param 
* the key type
* @param 
* the value type
* @param inputMap
* the input map
* @param allowFormatClassTypes
* 除了基本类型,数组之外允许的类型,请确保该类型可以被json format输出
* @return 如果 inputMap 是null,返回 {@link StringUtils#EMPTY}

* @since 1.3.0
*/
public static  String formatSimpleMap(Map inputMap,Class...allowFormatClassTypes){
if (null == inputMap){
return EMPTY;
}
//---------------------------------------------------------------
Map simpleMap = new TreeMap<>();
for (Map.Entry entry : inputMap.entrySet()){
V value = entry.getValue();
simpleMap.put(entry.getKey(), JsonHelper.isAllowFormatType(value, allowFormatClassTypes) ? value : String.valueOf(value)); //注意 String.valueOf(value)如果value是null 那么会输出 "null"字符串
}
return format(simpleMap);
}
//---------------------------------------------------------------
/**
* 将对象格式化 成json字符串(排除指定名称的属性 excludes),并且 toString(4, 4) 输出.
*
* 
* 和该方法对应的有,仅仅包含某些属性,see {@link #formatWithIncludes(Object, String...)}
* 
*
* 示例:
*
* 
*
*      * 
     * User user = new User();
     * 
     * user.setPassword("123456");
     * user.setId(8L);
     * user.setName("feilong");
     * user.setDate(now());
     * user.setMoney(toBigDecimal("99999999.00"));
     * 
     * user.setLoves(toArray("桔子", "香蕉"));
     * user.setUserInfo(new UserInfo(10));
     * 
     * UserAddress userAddress1 = new UserAddress("上海市地址1");
     * UserAddress userAddress2 = new UserAddress("上海市地址2");
     * 
     * user.setUserAddresses(toArray(userAddress1, userAddress2));
     * user.setUserAddresseList(toList(userAddress1, userAddress2));
     * 
     * LOGGER.debug(JsonUtil.format(USER, "name", "loves", "attrMap", "userInfo", "userAddresses"));
     * 
     * 
*
* 返回:
*
*      *  {
        "userAddresseList":         [
            {"address": "上海市地址1"},
            {"address": "上海市地址2"}
        ],
        "date": "2016-07-17 16:04:35",
        "password": "******",
        "id": 8,
        "age": 0,
        "money": 99999999,
        "nickNames": []
    }
     * 
*
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param excludes
* 排除需要序列化成json的属性,如果 excludes isNotNullOrEmpty,那么不会setExcludes
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* @see java.lang.ClassCastException: JSON keys must be strings
* @since 3.0.5 change param type {@code String[]excludes} to {@code String...excludes}
*/
public static String format(Object obj,String...excludes){
return format(obj, excludes, 4, 4);
}
/**
* 将对象格式化 成json字符串(排除指定名称的属性 excludes),并且按照指定的缩进(indentFactor和 indent) 输出.
*
* 
* 和该方法对应的有,仅仅包含某些属性,see {@link #formatWithIncludes(Object, String...)}
* 
*
* 示例:
*
* 
*
*      * 
     * User user = new User();
     * 
     * user.setPassword("123456");
     * user.setId(8L);
     * user.setName("feilong");
     * user.setDate(now());
     * user.setMoney(toBigDecimal("99999999.00"));
     * 
     * user.setLoves(toArray("桔子", "香蕉"));
     * user.setUserInfo(new UserInfo(10));
     * 
     * UserAddress userAddress1 = new UserAddress("上海市地址1");
     * UserAddress userAddress2 = new UserAddress("上海市地址2");
     * 
     * user.setUserAddresses(toArray(userAddress1, userAddress2));
     * user.setUserAddresseList(toList(userAddress1, userAddress2));
     * 
     * LOGGER.debug(JsonUtil.format(USER, toArray("name", "loves", "attrMap", "userInfo", "userAddresses"), 0, 0));
     * 
     * 
*
* 返回:
*
*     {"userAddresseList":[{"address":"上海市地址1"},{"address":"上海市地址2"}],"date":"2016-07-17 16:05:34","password":"******","id":8,"age":0,"money":99999999,"nickNames":[]}
     * 
*
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param excludes
* 排除需要序列化成json的属性,如果 excludes isNotNullOrEmpty,那么不会setExcludes
* @param indentFactor
* the indent factor
* @param indent
* the indent
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* @see #format(Object, JavaToJsonConfig)
* @see JavaToJsonConfigBuilder#build(String[], String[])
*/
public static String format(Object obj,String[] excludes,int indentFactor,int indent){
return null == obj ? EMPTY : format(obj, JavaToJsonConfigBuilder.build(excludes, null), indentFactor, indent);
}
/**
* 将对象格式化成json字符串(仅仅包含指定名称的属性 includes).
*
* 
* 和该方法对应的有,仅仅排除某些属性,see {@link #format(Object, String[])}以及 {@link #format(Object, String[], int, int)}
* 
*
* 示例:
*
* 
*
*      * 
     * User user1 = new User("feilong1", 24);
     * user1.setNickNames(toArray("xin.jin", "shuai.ge"));
     * User user2 = new User("feilong2", 240);
     * user2.setNickNames(toArray("xin.jin", "shuai.ge"));
     * 
     * List{@code } list = toList(user1, user2);
     * 
     * LOGGER.debug(JsonUtil.formatWithIncludes(list, "name", "age"));
     * 
     * 
*
* 返回:
*
*     [{
                "age": 24,
                "name": "feilong1"
            },
                    {
                "age": 240,
                "name": "feilong2"
            }
        ]
     * 
*
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param includes
* the includes
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* @see #format(Object, JavaToJsonConfig)
* @see JavaToJsonConfigBuilder#build(String[], String[])
* @since 1.0.8
*/
public static String formatWithIncludes(Object obj,final String...includes){
return null == obj ? EMPTY : format(obj, JavaToJsonConfigBuilder.build(null, includes));
}
/**
* 将obj格式化成json字符串,并且按照指定的缩进(indentFactor和 indent) 输出.
*
* 示例:
*
* 
*
*      * 
     * //查询{@code  >10} 的元素
     * Predicate{@code } predicate = new ComparatorPredicate{@code }(10, ComparatorUtils.{@code } naturalComparator(), Criterion.LESS);
     * 
     * List{@code } result = CollectionsUtil.select(toList(1, 5, 10, 30, 55, 88, 1, 12, 3), predicate);
     * LOGGER.debug(JsonUtil.format(result, 0, 0));
     * 
     * 
*
* 返回:
*
*      * [30,55,88,12]
     * 
*
* 
*
*      * LOGGER.debug(JsonUtil.format(result, 4, 4));// = LOGGER.debug(JsonUtil.format(result))
     * 
*
* 返回:
*
*      * [
     * 30,
     * 55,
     * 88,
     * 12
     * ]
     * 
*
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param indentFactor
* the indent factor
* @param indent
* the indent
* @return the string
* @since 1.2.2
*/
public static String format(Object obj,int indentFactor,int indent){
return format(obj, (JavaToJsonConfig) null, indentFactor, indent);
}
/**
* 使用配置 JavaToJsonConfig 来格式化成json字符串.
*
* 示例:
*
* 
*
*      * 
     * User user = new User("feilong1", 24);
     * user.setPassword("123456");
     * user.setMoney(toBigDecimal("99999999.00"));
     * 
     * Map{@code } propertyNameAndJsonValueProcessorMap = new HashMap{@code <>}();
     * propertyNameAndJsonValueProcessorMap.put("password", new SensitiveWordsJsonValueProcessor());
     * propertyNameAndJsonValueProcessorMap.put("money", new BigDecimalJsonValueProcessor());
     * 
     * JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig();
     * javaToJsonConfig.setPropertyNameAndJsonValueProcessorMap(propertyNameAndJsonValueProcessorMap);
     * 
     * LOGGER.debug(JsonUtil.format(user, javaToJsonConfig));
     * 
     * 
*
* 返回:
*
*      * {
     * "userAddresseList": [],
     * "userAddresses": [],
     * "date": null,
     * "password": "******",
     * "id": 0,
     * "age": 24,
     * "name": "feilong1",
     * "money": "99999999.00",
     * "attrMap": null,
     * "userInfo": {"age": 0},
     * "nickNames": [],
     * "loves": []
     * }
     * 
*
* 
* 当然上述示例中,password属性默认就是由 {@link SensitiveWordsJsonValueProcessor} 来处理
* 
*
* 
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param javaToJsonConfig
* the json format config
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* @since 1.2.2
*/
public static String format(Object obj,JavaToJsonConfig javaToJsonConfig){
return format(obj, javaToJsonConfig, 4, 4);
}
/**
* Format.
*
* @param obj
* 可以是数组,字符串,枚举,集合,map,Java bean,Iterator等类型,内部自动识别转成{@link JSONArray}还是{@link JSONObject}
* @param javaToJsonConfig
* the json format config
* @param indentFactor
* the indent factor
* @param indent
* the indent
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* 如果 javaToJsonConfig 是null,将使用默认的,参见
* {@link JavaToJsonConfigBuilder#buildUseJavaToJsonConfig(Object, JavaToJsonConfig)} 

* @since 1.2.2
*/
public static String format(Object obj,JavaToJsonConfig javaToJsonConfig,int indentFactor,int indent){
if (null == obj){
return EMPTY;
}
//since 1.14.0
if (JsonHelper.isCommonString(obj)){
return (String) obj;
}
//---------------------------------------------------------------
JavaToJsonConfig useJavaToJsonConfig = JavaToJsonConfigBuilder.buildUseJavaToJsonConfig(obj, javaToJsonConfig);
JsonConfig jsonConfig = JsonConfigBuilder.build(obj, useJavaToJsonConfig);
//---------------------------------------------------------------
JSON json = JsonHelper.toJSON(obj, jsonConfig);
return json.toString(indentFactor, indent);
}
//---------------------------------------------------------------
/**
* 格式化一个对象 obj 里面所有的field 的名字和值.
*
* 代码流程:
*
* 
* 
* 如果field上 标识了 {@link SensitiveWords}注解,那么会使用 {@link SensitiveWordsJsonValueProcessor}混淆敏感数据的输出
* 
* 
*
* @param obj
* 可以是Java bean
* @return 如果 obj 是null,返回 {@link StringUtils#EMPTY}

* 否则取到该对象 所有field 的name 和value值 map {@link FieldUtil#getAllFieldNameAndValueMap(Object, String...)} 调用
* {@link #format(Object, JavaToJsonConfig)},再次过程中,会处理 {@link SensitiveWords}
* @see FieldUtil#getAllFieldNameAndValueMap(Object, String...)
* @see com.feilong.lib.lang3.reflect.FieldUtils#getFieldsListWithAnnotation(Class, Class)
* @since 1.5.6
*/
public static String formatObjectFieldsNameAndValueMap(Object obj){
return null == obj ? EMPTY
: format(FieldUtil.getAllFieldNameAndValueMap(obj), JavaToJsonConfigBuilder.buildDefaultJavaToJsonConfig(obj));
}
// [end]
//---------------------------------------------------------------
// [start]toArray
/**
* 把一个json数组串转换成实体数组,数组元素的属性可以含有另外实例Bean.
*
* 示例:
* 
*
* 比如有 Person.class,代码如下
*
*      * public class Person{
     * 
     *     private String name;
     * 
     *     private Date dateAttr;
     * 
     *     // setter /getter 略
     * }
     * 
*
* 此时,
*
*      * String json = "[{'name':'get'},{'name':'set'}]";
     * Person[] persons = JsonUtil.toArray(json, new JsonToJavaConfig(Person.class));
     * 
     * LOGGER.debug(JsonUtil.format(persons));
     * 
*
* 返回:
*
*     [{
            "dateAttr": null,
            "name": "get"
        },
                {
            "dateAttr": null,
            "name": "set"
        }]
     * 
*
* 又如,又有MyBean.class
*
*      * public class MyBean{
     * 
     *     private Long id;
     * 
     *     private List{@code