org.dromara.hutool.json.reader

Class JSONTokener

java.lang.Object

java.io.Reader

org.dromara.hutool.core.io.ReaderWrapper

org.dromara.hutool.json.reader.JSONTokener

All Implemented Interfaces:

Closeable, AutoCloseable, Readable, Wrapper<Reader>

Direct Known Subclasses:

XMLTokener

public class JSONTokener
extends ReaderWrapper

JSON解析器
用于解析JSON字符串，支持流式解析，即逐个字符解析，而不是一次性解析整个字符串。

Author:

from JSON.org

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOF 定义结束（End of stream）为：0

Fields inherited from class org.dromara.hutool.core.io.ReaderWrapper

raw

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
JSONTokener(CharSequence s, boolean ignoreZeroWithChar) 从字符串中构建
JSONTokener(InputStream inputStream, boolean ignoreZeroWithChar) 从InputStream中构建，使用UTF-8编码
JSONTokener(Reader reader, boolean ignoreZeroWithChar) 从Reader中构建

Method Summary

Modifier and Type	Method and Description
void	back() 将标记回退到第一个字符，重新开始解析新的JSON
void	checkEnd() 检查是否到了结尾 如果读取完毕后还有未读的字符，报错
boolean	end()
protected char	getPrevious() 获取上一个读取的字符，如果没有读取过则返回'\0'
boolean	more() 源字符串是否有更多的字符
char	next() 获得源字符串中的下一个字符
char[]	next(int n) 获得接下来的n个字符
char	nextClean() 获得下一个字符，跳过空白符
char	nextColon() 获取下一个冒号，非冒号则抛出异常
String	nextKey(char c) 读取下一个JSON中的key，支持不带引号的key
String	nextString() 读取一个字符串，包括： 使用引号包裹的字符串，自动反转义。
char	nextTokenChar() 获取下一个token字符
char	nextUnicode() 获取16进制unicode转义符对应的字符值，如： '4f60' -> '你'
String	nextUnwrapString(char c) 获得下一个字符串，此字符串不以引号包围，不会处理转义符，主要解析： 非严格的key（无引号包围的key） boolean值的字符串表示 Number值的字符串表示 null的字符串表示
String	nextWrapString(char quote) 返回当前位置到指定引号前的所有字符，反斜杠的转义符也会被处理。
JSONException	syntaxError(String message) Make a JSONException to signal a syntax error.
String	toString() Make a printable string of this JSONTokener.

Methods inherited from class org.dromara.hutool.core.io.ReaderWrapper

close, getRaw, mark, markSupported, read, read, read, read, ready, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EOF

public static final int EOF

定义结束（End of stream）为：0

See Also:

Constant Field Values

Constructor Detail

JSONTokener

public JSONTokener(InputStream inputStream,
                   boolean ignoreZeroWithChar)
            throws JSONException

从InputStream中构建，使用UTF-8编码

Parameters:

inputStream - InputStream

ignoreZeroWithChar - 是否忽略零宽字符

Throws:

JSONException - JSON异常，包装IO异常

JSONTokener

public JSONTokener(CharSequence s,
                   boolean ignoreZeroWithChar)

从字符串中构建

Parameters:

s - JSON字符串

ignoreZeroWithChar - 是否忽略零宽字符

JSONTokener

public JSONTokener(Reader reader,
                   boolean ignoreZeroWithChar)

从Reader中构建

Parameters:

reader - Reader

ignoreZeroWithChar - 是否忽略零宽字符

Method Detail

back

public void back()
          throws JSONException

将标记回退到第一个字符，重新开始解析新的JSON

Throws:

JSONException - JSON异常，包装IO异常

end

public boolean end()

Returns:

是否进入结尾

checkEnd

public void checkEnd()

检查是否到了结尾
如果读取完毕后还有未读的字符，报错

more

public boolean more()
             throws JSONException

源字符串是否有更多的字符

Returns:

如果未达到结尾返回true，否则false

Throws:

JSONException - JSON异常，包装IO异常

next

public char next()
          throws JSONException

获得源字符串中的下一个字符

Returns:

下一个字符, or 0 if past the end of the source string.

Throws:

JSONException - JSON异常，包装IO异常

getPrevious

protected char getPrevious()

获取上一个读取的字符，如果没有读取过则返回'\0'

Returns:

上一个读取的字符

nextUnicode

public char nextUnicode()

获取16进制unicode转义符对应的字符值，如：

 '4f60' -> '你'

Returns:

字符

next

public char[] next(int n)
            throws JSONException

获得接下来的n个字符

Parameters:

n - 字符数

Returns:

获得的n个字符组成的字符串

Throws:

JSONException - 如果源中余下的字符数不足以提供所需的字符数，抛出此异常

nextTokenChar

public char nextTokenChar()
                   throws JSONException

获取下一个token字符

Returns:

token字符

Throws:

JSONException - 非Token字符

nextClean

public char nextClean()
               throws JSONException

获得下一个字符，跳过空白符

Returns:

获得的字符，0表示没有更多的字符

Throws:

JSONException - 获得下一个字符时抛出的异常

nextKey

public String nextKey(char c)
               throws JSONException

读取下一个JSON中的key，支持不带引号的key

Parameters:

c - 当前字符

Returns:

键字符串

Throws:

JSONException - 非引号包裹的字符串

nextColon

public char nextColon()
               throws JSONException

获取下一个冒号，非冒号则抛出异常

Returns:

冒号字符

Throws:

JSONException - 非冒号字符

nextString

public String nextString()
                  throws JSONException

读取一个字符串，包括：

• 使用引号包裹的字符串，自动反转义。
• 无包装的字符串，不转义

Returns:

截止到引号前的字符串

Throws:

JSONException - 出现无结束的字符串时抛出此异常

nextUnwrapString

public String nextUnwrapString(char c)
                        throws JSONException

获得下一个字符串，此字符串不以引号包围，不会处理转义符，主要解析：

• 非严格的key（无引号包围的key）
• boolean值的字符串表示
• Number值的字符串表示
• null的字符串表示

Parameters:

c - 首个字符

Returns:

字符串

Throws:

JSONException - 读取空串时抛出此异常

nextWrapString

public String nextWrapString(char quote)
                      throws JSONException

返回当前位置到指定引号前的所有字符，反斜杠的转义符也会被处理。
标准的JSON是不允许使用单引号包含字符串的，但是此实现允许。

Parameters:

quote - 字符引号, 包括 "（双引号） 或 '（单引号）。

Returns:

截止到引号前的字符串

Throws:

JSONException - 出现无结束的字符串时抛出此异常

syntaxError

public JSONException syntaxError(String message)

Make a JSONException to signal a syntax error.
构建 JSONException 用于表示语法错误

Parameters:

message - 错误消息

Returns:

A JSONException object, suitable for throwing

toString

public String toString()

Make a printable string of this JSONTokener.

Overrides:

toString in class Object

Returns:

" at {index} [character {character} line {line}]"