JSONConfig (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.json.JSONConfig

All Implemented Interfaces:

Serializable
```
public class JSONConfig
extends Object
implements Serializable
```
JSON配置项

Since:

4.1.19

Author:

looly

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JSONConfig.DuplicateMode
重复key或重复对象处理方式
只针对JSONObject，检查在put时key的重复情况

Nested Classes
Modifier and Type	Class and Description
`static class`	`JSONConfig.DuplicateMode` 重复key或重复对象处理方式只针对`JSONObject`，检查在put时key的重复情况

Constructor Summary

Constructors
Constructor and Description

JSONConfig()

Constructors
Constructor and Description
`JSONConfig()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDateFormat()` 日期格式，null表示默认的时间戳
`JSONConfig.DuplicateMode`	`getDuplicateMode()` 获取key重复策略
`Comparator<String>`	`getKeyComparator()` 获取键排序规则键排序规则，`null`表示不排序，不排序情况下，按照加入顺序排序
`NumberWriteMode`	`getNumberWriteMode()` 获取Number写出模式
`boolean`	`isIgnoreCase()` 是否忽略键的大小写
`boolean`	`isIgnoreError()` 是否忽略转换过程中的异常
`boolean`	`isIgnoreNullValue()` 是否忽略null值
`boolean`	`isIgnoreZeroWithChar()` 是否忽略零宽字符，这些字符可能会导致解析安全问题，这些字符包括：零宽空格：零宽非换行空：`‌` 零宽连接符：`‍` 零宽无断空格：
`boolean`	`isStripTrailingZeros()` 是否去除末尾多余0，例如如果为true,5.0返回5
`boolean`	`isTransientSupport()` 是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
`static JSONConfig`	`of()` 创建默认的配置项
`JSONConfig`	`set(JSONConfig.DuplicateMode duplicateMode)` 设置key重复策略
`JSONConfig`	`setDateFormat(String dateFormat)` 设置日期格式，null表示默认的时间戳此方法设置的日期格式仅对转换为JSON字符串有效，对解析JSON为bean无效。
`JSONConfig`	`setIgnoreCase(boolean ignoreCase)` 设置是否忽略键的大小写
`JSONConfig`	`setIgnoreError(boolean ignoreError)` 设置是否忽略转换过程中的异常
`JSONConfig`	`setIgnoreNullValue(boolean ignoreNullValue)` 设置是否忽略null值此选项主要作用于两个阶段： Java对象或JSON字符串转为JSON时 JSON写出或转为JSON字符串时
`JSONConfig`	`setIgnoreZeroWithChar(boolean ignoreZeroWithChar)` 设置是否忽略零宽字符，这些字符可能会导致解析安全问题，这些字符包括：零宽空格：零宽非换行空：`‌` 零宽连接符：`‍` 零宽无断空格：
`JSONConfig`	`setKeyComparator(Comparator<String> keyComparator)` 设置键排序规则键排序规则，`null`表示不排序，不排序情况下，按照加入顺序排序
`JSONConfig`	`setNatureKeyComparator()` 设置自然排序，即按照字母顺序排序
`JSONConfig`	`setNumberWriteMode(NumberWriteMode numberWriteMode)` 设置数字写出模式考虑到在JS或其他环境中，Number超过一定长度会丢失精度，因此针对Number类型值，可选写出规则
`JSONConfig`	`setStripTrailingZeros(boolean stripTrailingZeros)` 设置是否去除末尾多余0，例如如果为true,5.0返回5
`JSONConfig`	`setTransientSupport(boolean transientSupport)` 设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JSONConfig
```
public JSONConfig()
```
- Method Detail
  - of
```
public static JSONConfig of()
```
    创建默认的配置项
    
    Returns:
    
    JSONConfig
  - getKeyComparator
```
public Comparator<String> getKeyComparator()
```
    获取键排序规则
    键排序规则，null表示不排序，不排序情况下，按照加入顺序排序
    
    Returns:
    
    键排序规则
    
    Since:
    
    5.7.21
  - setNatureKeyComparator
```
public JSONConfig setNatureKeyComparator()
```
    设置自然排序，即按照字母顺序排序
    
    Returns:
    
    this
    
    Since:
    
    5.7.21
  - setKeyComparator
```
public JSONConfig setKeyComparator(Comparator<String> keyComparator)
```
    设置键排序规则
    键排序规则，null表示不排序，不排序情况下，按照加入顺序排序
    
    Parameters:
    
    keyComparator - 键排序规则
    
    Returns:
    
    this
    
    Since:
    
    5.7.21
  - isIgnoreError
```
public boolean isIgnoreError()
```
    是否忽略转换过程中的异常
    
    Returns:
    
    是否忽略转换过程中的异常
  - setIgnoreError
```
public JSONConfig setIgnoreError(boolean ignoreError)
```
    设置是否忽略转换过程中的异常
    
    Parameters:
    
    ignoreError - 是否忽略转换过程中的异常
    
    Returns:
    
    this
  - isIgnoreCase
```
public boolean isIgnoreCase()
```
    是否忽略键的大小写
    
    Returns:
    
    是否忽略键的大小写
  - setIgnoreCase
```
public JSONConfig setIgnoreCase(boolean ignoreCase)
```
    设置是否忽略键的大小写
    
    Parameters:
    
    ignoreCase - 是否忽略键的大小写
    
    Returns:
    
    this
  - getDateFormat
```
public String getDateFormat()
```
    日期格式，null表示默认的时间戳
    
    Returns:
    
    日期格式，null表示默认的时间戳
  - setDateFormat
```
public JSONConfig setDateFormat(String dateFormat)
```
    设置日期格式，null表示默认的时间戳
    此方法设置的日期格式仅对转换为JSON字符串有效，对解析JSON为bean无效。
    
    Parameters:
    
    dateFormat - 日期格式，null表示默认的时间戳
    
    Returns:
    
    this
  - isIgnoreNullValue
```
public boolean isIgnoreNullValue()
```
    是否忽略null值
    
    Returns:
    
    是否忽略null值
  - setIgnoreNullValue
```
public JSONConfig setIgnoreNullValue(boolean ignoreNullValue)
```
    设置是否忽略null值
    此选项主要作用于两个阶段：
    1. Java对象或JSON字符串转为JSON时
    2. JSON写出或转为JSON字符串时
    Parameters:
    
    ignoreNullValue - 是否忽略null值
    
    Returns:
    
    this
  - isTransientSupport
```
public boolean isTransientSupport()
```
    是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
    
    Returns:
    
    是否支持
    
    Since:
    
    5.4.2
  - setTransientSupport
```
public JSONConfig setTransientSupport(boolean transientSupport)
```
    设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
    
    Parameters:
    
    transientSupport - 是否支持
    
    Returns:
    
    this
    
    Since:
    
    5.4.2
  - isStripTrailingZeros
```
public boolean isStripTrailingZeros()
```
    是否去除末尾多余0，例如如果为true,5.0返回5
    
    Returns:
    
    是否去除末尾多余0，例如如果为true,5.0返回5
    
    Since:
    
    5.6.2
  - setStripTrailingZeros
```
public JSONConfig setStripTrailingZeros(boolean stripTrailingZeros)
```
    设置是否去除末尾多余0，例如如果为true,5.0返回5
    
    Parameters:
    
    stripTrailingZeros - 是否去除末尾多余0，例如如果为true,5.0返回5
    
    Returns:
    
    this
    
    Since:
    
    5.6.2
  - getDuplicateMode
```
public JSONConfig.DuplicateMode getDuplicateMode()
```
    获取key重复策略
    
    Returns:
    
    key重复策略
  - set
```
public JSONConfig set(JSONConfig.DuplicateMode duplicateMode)
```
    设置key重复策略
    
    Parameters:
    
    duplicateMode - key重复策略
    
    Returns:
    
    this
  - getNumberWriteMode
```
public NumberWriteMode getNumberWriteMode()
```
    获取Number写出模式
    
    Returns:
    
    Number写出模式
    
    Since:
    
    6.0.0
  - setNumberWriteMode
```
public JSONConfig setNumberWriteMode(NumberWriteMode numberWriteMode)
```
    设置数字写出模式
    考虑到在JS或其他环境中，Number超过一定长度会丢失精度，因此针对Number类型值，可选写出规则
    
    Parameters:
    
    numberWriteMode - Number写出模式
    
    Returns:
    
    this
    
    Since:
    
    6.0.0
  - isIgnoreZeroWithChar
```
public boolean isIgnoreZeroWithChar()
```
    是否忽略零宽字符，这些字符可能会导致解析安全问题，这些字符包括：
    - 零宽空格：
    - 零宽非换行空：‌
    - 零宽连接符：‍
    - 零宽无断空格：
    Returns:
    
    此值为false，则转义，否则去除
  - setIgnoreZeroWithChar
```
public JSONConfig setIgnoreZeroWithChar(boolean ignoreZeroWithChar)
```
    设置是否忽略零宽字符，这些字符可能会导致解析安全问题，这些字符包括：
    - 零宽空格：
    - 零宽非换行空：‌
    - 零宽连接符：‍
    - 零宽无断空格：
    Parameters:
    
    ignoreZeroWithChar - 此值为false，则转义，否则去除
    
    Returns:
    
    this

Class JSONConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JSONConfig

Method Detail

of

getKeyComparator

setNatureKeyComparator

setKeyComparator

isIgnoreError

setIgnoreError

isIgnoreCase

setIgnoreCase

getDateFormat

setDateFormat

isIgnoreNullValue

setIgnoreNullValue

isTransientSupport

setTransientSupport

isStripTrailingZeros

setStripTrailingZeros

getDuplicateMode

set

getNumberWriteMode

setNumberWriteMode

isIgnoreZeroWithChar

setIgnoreZeroWithChar