JSONUtil (hutool-json 4.6.11 API)

java.lang.Object
- cn.hutool.json.JSONUtil

public final class JSONUtil
extends Object

JSON工具类

作者:: Looly

构造器概要

构造器
构造器和说明

JSONUtil()

构造器
构造器和说明
`JSONUtil()`

方法概要

方法
限定符和类型	方法和说明
`static JSONArray`	`createArray()` 创建 JSONArray
`static JSONObject`	`createObj()` 创建JSONObject
`static String`	`escape(String str)` 转义显示不可见字符
`static String`	`formatJsonStr(String jsonStr)` 格式化JSON字符串，此方法并不严格检查JSON的格式正确与否
`static Object`	`getByPath(JSON json, String expression)` 通过表达式获取JSON中嵌套的对象 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name
`static boolean`	`isJson(String str)` 是否为JSON字符串，首尾都为大括号或中括号判定为JSON字符串
`static boolean`	`isJsonArray(String str)` 是否为JSONArray字符串，首尾都为中括号判定为JSONArray字符串
`static boolean`	`isJsonObj(String str)` 是否为JSONObject字符串，首尾都为大括号判定为JSONObject字符串
`static boolean`	`isNull(Object obj)` 是否为null对象，null的情况包括： 1.
`static JSON`	`parse(Object obj)` 转换对象为JSON 支持的对象： String: 转换为相应的对象 Array Collection：转换为JSONArray Bean对象：转为JSONObject
`static JSONArray`	`parseArray(Object arrayOrCollection)` JSON字符串转JSONArray
`static JSONArray`	`parseArray(Object arrayOrCollection, boolean ignoreNullValue)` JSON字符串转JSONArray
`static JSONArray`	`parseArray(String jsonStr)` JSON字符串转JSONArray
`static JSONObject`	`parseFromMap(Map<?,?> map)` Map转化为JSONObject
`static JSONObject`	`parseFromResourceBundle(ResourceBundle bundle)` ResourceBundle转化为JSONObject
`static JSONObject`	`parseFromXml(String xmlStr)` XML字符串转为JSONObject
`static JSONObject`	`parseObj(Object obj)` JSON字符串转JSONObject对象此方法会忽略空值，但是对JSON字符串不影响
`static JSONObject`	`parseObj(Object obj, boolean ignoreNullValue)` JSON字符串转JSONObject对象
`static JSONObject`	`parseObj(Object obj, boolean ignoreNullValue, boolean isOrder)` JSON字符串转JSONObject对象
`static JSONObject`	`parseObj(String jsonStr)` JSON字符串转JSONObject对象
`static void`	`putByPath(JSON json, String expression, Object value)` 设置表达式指定位置（或filed对应）的值若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值注意：如果为JSONArray，则设置值得下标不能大于已有JSONArray的长度 .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值 []表达式，可以获取集合等对象中对应index的值表达式栗子： persion persion.name persons[3] person.friends[5].name
`static void`	`putDeserializer(Type type, JSONDeserializer<?> deserializer)` 加入自定义的反序列化器
`static void`	`putSerializer(Type type, JSONArraySerializer<?> serializer)` 加入自定义的序列化器
`static void`	`putSerializer(Type type, JSONObjectSerializer<?> serializer)` 加入自定义的序列化器
`static String`	`quote(String string)` 对所有双引号做转义处理（使用双反斜杠做转义）为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
`static String`	`quote(String string, boolean isWrap)` 对所有双引号做转义处理（使用双反斜杠做转义）为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
`static Writer`	`quote(String str, Writer writer)` 对所有双引号做转义处理（使用双反斜杠做转义）为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
`static Writer`	`quote(String str, Writer writer, boolean isWrap)` 对所有双引号做转义处理（使用双反斜杠做转义）为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
`static JSON`	`readJSON(File file, Charset charset)` 读取JSON
`static JSONArray`	`readJSONArray(File file, Charset charset)` 读取JSONArray
`static JSONObject`	`readJSONObject(File file, Charset charset)` 读取JSONObject
`static <T> T`	`toBean(JSONObject json, Class<T> beanClass)` 转为实体类对象，转换异常将被抛出
`static <T> T`	`toBean(JSONObject json, Type beanType, boolean ignoreError)` 转为实体类对象
`static <T> T`	`toBean(JSONObject json, TypeReference<T> typeReference, boolean ignoreError)` 转为实体类对象
`static <T> T`	`toBean(String jsonString, Class<T> beanClass)` JSON字符串转为实体类对象，转换异常将被抛出
`static <T> T`	`toBean(String jsonString, Type beanType, boolean ignoreError)` JSON字符串转为实体类对象，转换异常将被抛出
`static <T> T`	`toBean(String jsonString, TypeReference<T> typeReference, boolean ignoreError)` JSON字符串转为实体类对象，转换异常将被抛出
`static String`	`toJsonPrettyStr(JSON json)` 转为JSON字符串
`static String`	`toJsonPrettyStr(Object obj)` 转换为格式化后的JSON字符串
`static String`	`toJsonStr(JSON json)` 转为JSON字符串
`static String`	`toJsonStr(JSON json, int indentFactor)` 转为JSON字符串
`static String`	`toJsonStr(Object obj)` 转换为JSON字符串
`static <T> List<T>`	`toList(JSONArray jsonArray, Class<T> elementType)` 将JSONArray转换为Bean的List，默认为ArrayList
`static String`	`toXmlStr(JSON json)` 转换为XML字符串
`static Object`	`wrap(Object object, JSONConfig jsonConfig)` 在需要的时候包装对象包装包括： `null` =》 `JSONNull.NULL` array or collection =》 JSONArray map =》 JSONObject standard property (Double, String, et al) =》原对象来自于java包 =》字符串其它 =》尝试包装为JSONObject，否则返回`null`
`static JSONObject`	`xmlToJson(String xml)` XML转JSONObject 转换过程中一些信息可能会丢失，JSON中无法区分节点和属性，相同的节点将被处理为JSONArray。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - JSONUtil
```
public JSONUtil()
```
- 方法详细资料
  - createObj
```
public static JSONObject createObj()
```
    创建JSONObject
    
    返回:
    JSONObject
  - createArray
```
public static JSONArray createArray()
```
    创建 JSONArray
    
    返回:
    JSONArray
  - parseObj
```
public static JSONObject parseObj(String jsonStr)
```
    JSON字符串转JSONObject对象
    
    参数:
    jsonStr - JSON字符串
    
    返回:
    JSONObject
  - parseObj
```
public static JSONObject parseObj(Object obj)
```
    JSON字符串转JSONObject对象
    此方法会忽略空值，但是对JSON字符串不影响
    
    参数:
    obj - Bean对象或者Map
    
    返回:
    JSONObject
  - parseObj
```
public static JSONObject parseObj(Object obj,
                  boolean ignoreNullValue)
```
    JSON字符串转JSONObject对象
    
    参数:
    obj - Bean对象或者Map
    ignoreNullValue - 是否忽略空值，如果source为JSON字符串，不忽略空值
    
    返回:
    JSONObject
    从以下版本开始:
    
    3.0.9
  - parseObj
```
public static JSONObject parseObj(Object obj,
                  boolean ignoreNullValue,
                  boolean isOrder)
```
    JSON字符串转JSONObject对象
    
    参数:
    obj - Bean对象或者Map
    ignoreNullValue - 是否忽略空值，如果source为JSON字符串，不忽略空值
    isOrder - 是否有序
    
    返回:
    JSONObject
    从以下版本开始:
    
    4.2.2
  - parseArray
```
public static JSONArray parseArray(String jsonStr)
```
    JSON字符串转JSONArray
    
    参数:
    jsonStr - JSON字符串
    
    返回:
    JSONArray
  - parseArray
```
public static JSONArray parseArray(Object arrayOrCollection)
```
    JSON字符串转JSONArray
    
    参数:
    arrayOrCollection - 数组或集合对象
    
    返回:
    JSONArray
    从以下版本开始:
    
    3.0.8
  - parseArray
```
public static JSONArray parseArray(Object arrayOrCollection,
                   boolean ignoreNullValue)
```
    JSON字符串转JSONArray
    
    参数:
    arrayOrCollection - 数组或集合对象
    ignoreNullValue - 是否忽略空值
    
    返回:
    JSONArray
    从以下版本开始:
    
    3.2.3
  - parse
```
public static JSON parse(Object obj)
```
    转换对象为JSON
    支持的对象：
    String: 转换为相应的对象
    Array Collection：转换为JSONArray
    Bean对象：转为JSONObject
    
    参数:
    obj - 对象
    
    返回:
    JSON
  - parseFromXml
```
public static JSONObject parseFromXml(String xmlStr)
```
    XML字符串转为JSONObject
    
    参数:
    xmlStr - XML字符串
    
    返回:
    JSONObject
  - parseFromMap
```
public static JSONObject parseFromMap(Map<?,?> map)
```
    Map转化为JSONObject
    
    参数:
    map - Map
    
    返回:
    JSONObject
  - parseFromResourceBundle
```
public static JSONObject parseFromResourceBundle(ResourceBundle bundle)
```
    ResourceBundle转化为JSONObject
    
    参数:
    bundle - ResourceBundle文件
    
    返回:
    JSONObject
  - readJSON
```
public static JSON readJSON(File file,
            Charset charset)
                     throws IORuntimeException
```
    读取JSON
    
    参数:
    file - JSON文件
    charset - 编码
    
    返回:
    JSON（包括JSONObject和JSONArray）
    
    抛出:
    
    IORuntimeException - IO异常
  - readJSONObject
```
public static JSONObject readJSONObject(File file,
                        Charset charset)
                                 throws IORuntimeException
```
    读取JSONObject
    
    参数:
    file - JSON文件
    charset - 编码
    
    返回:
    JSONObject
    
    抛出:
    
    IORuntimeException - IO异常
  - readJSONArray
```
public static JSONArray readJSONArray(File file,
                      Charset charset)
                               throws IORuntimeException
```
    读取JSONArray
    
    参数:
    file - JSON文件
    charset - 编码
    
    返回:
    JSONArray
    
    抛出:
    
    IORuntimeException - IO异常
  - toJsonStr
```
public static String toJsonStr(JSON json,
               int indentFactor)
```
    转为JSON字符串
    
    参数:
    json - JSON
    indentFactor - 每一级别的缩进
    
    返回:
    JSON字符串
  - toJsonStr
```
public static String toJsonStr(JSON json)
```
    转为JSON字符串
    
    参数:
    json - JSON
    
    返回:
    JSON字符串
  - toJsonPrettyStr
```
public static String toJsonPrettyStr(JSON json)
```
    转为JSON字符串
    
    参数:
    json - JSON
    
    返回:
    JSON字符串
  - toJsonStr
```
public static String toJsonStr(Object obj)
```
    转换为JSON字符串
    
    参数:
    obj - 被转为JSON的对象
    
    返回:
    JSON字符串
  - toJsonPrettyStr
```
public static String toJsonPrettyStr(Object obj)
```
    转换为格式化后的JSON字符串
    
    参数:
    obj - Bean对象
    
    返回:
    JSON字符串
  - toXmlStr
```
public static String toXmlStr(JSON json)
```
    转换为XML字符串
    
    参数:
    json - JSON
    
    返回:
    XML字符串
  - toBean
```
public static <T> T toBean(String jsonString,
           Class<T> beanClass)
```
    JSON字符串转为实体类对象，转换异常将被抛出
    
    类型参数:
    T - Bean类型
    参数:
    jsonString - JSON字符串
    beanClass - 实体类对象
    
    返回:
    实体类对象
    从以下版本开始:
    
    3.1.2
  - toBean
```
public static <T> T toBean(JSONObject json,
           Class<T> beanClass)
```
    转为实体类对象，转换异常将被抛出
    
    类型参数:
    T - Bean类型
    参数:
    json - JSONObject
    beanClass - 实体类对象
    
    返回:
    实体类对象
  - toBean
```
public static <T> T toBean(String jsonString,
           TypeReference<T> typeReference,
           boolean ignoreError)
```
    JSON字符串转为实体类对象，转换异常将被抛出
    
    类型参数:
    T - Bean类型
    参数:
    jsonString - JSON字符串
    typeReference - TypeReference类型参考子类，可以获取其泛型参数中的Type类型
    ignoreError - 是否忽略错误
    
    返回:
    实体类对象
    从以下版本开始:
    
    4.3.2
  - toBean
```
public static <T> T toBean(String jsonString,
           Type beanType,
           boolean ignoreError)
```
    JSON字符串转为实体类对象，转换异常将被抛出
    
    类型参数:
    T - Bean类型
    参数:
    jsonString - JSON字符串
    beanType - 实体类对象类型
    ignoreError - 是否忽略错误
    
    返回:
    实体类对象
    从以下版本开始:
    
    4.3.2
  - toBean
```
public static <T> T toBean(JSONObject json,
           TypeReference<T> typeReference,
           boolean ignoreError)
```
    转为实体类对象
    
    类型参数:
    T - Bean类型
    参数:
    json - JSONObject
    typeReference - TypeReference类型参考子类，可以获取其泛型参数中的Type类型
    ignoreError - 是否忽略转换错误
    
    返回:
    实体类对象
    从以下版本开始:
    
    4.6.2
  - toBean
```
public static <T> T toBean(JSONObject json,
           Type beanType,
           boolean ignoreError)
```
    转为实体类对象
    
    类型参数:
    T - Bean类型
    参数:
    json - JSONObject
    beanType - 实体类对象类型
    ignoreError - 是否忽略转换错误
    
    返回:
    实体类对象
    从以下版本开始:
    
    4.3.2
  - toList
```
public static <T> List<T> toList(JSONArray jsonArray,
                 Class<T> elementType)
```
    将JSONArray转换为Bean的List，默认为ArrayList
    
    类型参数:
    T - Bean类型
    参数:
    jsonArray - JSONArray
    elementType - List中元素类型
    
    返回:
    List
    从以下版本开始:
    
    4.0.7
  - getByPath
```
public static Object getByPath(JSON json,
               String expression)
```
    通过表达式获取JSON中嵌套的对象
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    参数:
    json - JSON
    expression - 表达式
    
    返回:
    对象
    另请参阅:
    JSON.getByPath(String)
  - putByPath
```
public static void putByPath(JSON json,
             String expression,
             Object value)
```
    设置表达式指定位置（或filed对应）的值
    若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值
    注意：如果为JSONArray，则设置值得下标不能大于已有JSONArray的长度
    1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. []表达式，可以获取集合等对象中对应index的值
    表达式栗子：
```
 persion
 persion.name
 persons[3]
 person.friends[5].name
 
```
    参数:
    json - JSON，可以为JSONObject或JSONArray
    expression - 表达式
    value - 值
  - quote
```
public static String quote(String string)
```
    对所有双引号做转义处理（使用双反斜杠做转义）
    为了能在HTML中较好的显示，会将</转义为<\/
    JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
    
    参数:
    string - 字符串
    
    返回:
    适合在JSON中显示的字符串
  - quote
```
public static String quote(String string,
           boolean isWrap)
```
    对所有双引号做转义处理（使用双反斜杠做转义）
    为了能在HTML中较好的显示，会将</转义为<\/
    JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
    
    参数:
    string - 字符串
    isWrap - 是否使用双引号包装字符串
    
    返回:
    适合在JSON中显示的字符串
    从以下版本开始:
    
    3.3.1
  - quote
```
public static Writer quote(String str,
           Writer writer)
                    throws IOException
```
    对所有双引号做转义处理（使用双反斜杠做转义）
    为了能在HTML中较好的显示，会将</转义为<\/
    JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
    
    参数:
    str - 字符串
    writer - Writer
    
    返回:
    Writer
    
    抛出:
    
    IOException - IO异常
  - quote
```
public static Writer quote(String str,
           Writer writer,
           boolean isWrap)
                    throws IOException
```
    对所有双引号做转义处理（使用双反斜杠做转义）
    为了能在HTML中较好的显示，会将</转义为<\/
    JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
    
    参数:
    str - 字符串
    writer - Writer
    isWrap - 是否使用双引号包装字符串
    
    返回:
    Writer
    
    抛出:
    
    IOException - IO异常
    从以下版本开始:
    
    3.3.1
  - escape
```
public static String escape(String str)
```
    转义显示不可见字符
    
    参数:
    str - 字符串
    
    返回:
    转义后的字符串
  - wrap
```
public static Object wrap(Object object,
          JSONConfig jsonConfig)
```
    在需要的时候包装对象
    包装包括：
    - null =》 JSONNull.NULL
    - array or collection =》 JSONArray
    - map =》 JSONObject
    - standard property (Double, String, et al) =》原对象
    - 来自于java包 =》字符串
    - 其它 =》尝试包装为JSONObject，否则返回null
    参数:
    object - 被包装的对象
    jsonConfig - JSON选项
    
    返回:
    包装后的值，null表示此值需被忽略
  - formatJsonStr
```
public static String formatJsonStr(String jsonStr)
```
    格式化JSON字符串，此方法并不严格检查JSON的格式正确与否
    
    参数:
    jsonStr - JSON字符串
    
    返回:
    格式化后的字符串
    从以下版本开始:
    
    3.1.2
  - isJson
```
public static boolean isJson(String str)
```
    是否为JSON字符串，首尾都为大括号或中括号判定为JSON字符串
    
    参数:
    str - 字符串
    
    返回:
    是否为JSON字符串
    从以下版本开始:
    
    3.3.0
  - isJsonObj
```
public static boolean isJsonObj(String str)
```
    是否为JSONObject字符串，首尾都为大括号判定为JSONObject字符串
    
    参数:
    str - 字符串
    
    返回:
    是否为JSON字符串
    从以下版本开始:
    
    3.3.0
  - isJsonArray
```
public static boolean isJsonArray(String str)
```
    是否为JSONArray字符串，首尾都为中括号判定为JSONArray字符串
    
    参数:
    str - 字符串
    
    返回:
    是否为JSON字符串
    从以下版本开始:
    
    3.3.0
  - isNull
```
public static boolean isNull(Object obj)
```
    是否为null对象，null的情况包括：
```
 1. null
 2. JSONNull
 
```
    参数:
    obj - 对象
    
    返回:
    是否为null
    从以下版本开始:
    
    4.5.7
  - xmlToJson
```
public static JSONObject xmlToJson(String xml)
```
    XML转JSONObject
    转换过程中一些信息可能会丢失，JSON中无法区分节点和属性，相同的节点将被处理为JSONArray。
    
    参数:
    xml - XML字符串
    
    返回:
    JSONObject
    从以下版本开始:
    
    4.0.8
  - putSerializer
```
public static void putSerializer(Type type,
                 JSONArraySerializer<?> serializer)
```
    加入自定义的序列化器
    
    参数:
    type - 对象类型
    serializer - 序列化器实现
    从以下版本开始:
    
    4.6.5
    
    另请参阅:
    GlobalSerializeMapping.put(Type, JSONArraySerializer)
  - putSerializer
```
public static void putSerializer(Type type,
                 JSONObjectSerializer<?> serializer)
```
    加入自定义的序列化器
    
    参数:
    type - 对象类型
    serializer - 序列化器实现
    从以下版本开始:
    
    4.6.5
    
    另请参阅:
    GlobalSerializeMapping.put(Type, JSONObjectSerializer)
  - putDeserializer
```
public static void putDeserializer(Type type,
                   JSONDeserializer<?> deserializer)
```
    加入自定义的反序列化器
    
    参数:
    type - 对象类型
    deserializer - 反序列化器实现
    从以下版本开始:
    
    4.6.5
    
    另请参阅:
    GlobalSerializeMapping.put(Type, JSONDeserializer)

类 JSONUtil

构造器概要

方法概要

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

构造器详细资料

JSONUtil

方法详细资料

createObj

createArray

parseObj

parseObj

parseObj

parseObj

parseArray

parseArray

parseArray

parse

parseFromXml

parseFromMap

parseFromResourceBundle

readJSON

readJSONObject

readJSONArray

toJsonStr

toJsonStr

toJsonPrettyStr

toJsonStr

toJsonPrettyStr

toXmlStr

toBean

toBean

toBean

toBean

toBean

toBean

toList

getByPath

putByPath

quote

quote

quote

quote

escape

wrap

formatJsonStr

isJson

isJsonObj

isJsonArray

isNull

xmlToJson

putSerializer

putSerializer

putDeserializer