org.dromara.hutool.json.writer

类 JSONWriter

java.lang.Object

java.io.Writer

org.dromara.hutool.json.writer.JSONWriter

所有已实现的接口:

Closeable, Flushable, Appendable, AutoCloseable

public class JSONWriter
extends Writer

JSON数据写出器
通过简单的append方式将JSON的键值对等信息写出到Writer中。

作者:

looly

从以下版本开始:

5.7.3

字段概要

从类继承的字段 java.io.Writer

lock

构造器概要

构造器

构造器和说明
JSONWriter(Writer writer, int indentFactor, int indent, JSONConfig config) 构造

方法概要

限定符和类型	方法和说明
JSONWriter	beginArray() JSONArray写出开始，默认写出"["
JSONWriter	beginObj() JSONObject写出开始，默认写出"{"
void	close()
JSONWriter	end() 结束，默认根据开始的类型，补充"}"或"]"
void	flush()
JSONConfig	getConfig() 获取JSON配置
static JSONWriter	of(Writer writer, int indentFactor, int indent, JSONConfig config) 创建JSONWriter
void	write(char[] cbuf, int off, int len)
JSONWriter	writeField(MutableEntry<Object,Object> pair, Predicate<MutableEntry<Object,Object>> predicate) 写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容 在arrayMode 为 true 时，key是数字，此时不写出键，只写值
JSONWriter	writeKey(String key) 写出键，自动处理分隔符和缩进，并包装键名
JSONWriter	writeLF() 写出换行符
void	writeQuoteStrValue(String csq) 写出字符串值，并包装引号并转义字符 对所有双引号做转义处理（使用双反斜杠做转义） 为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
JSONWriter	writeRaw(char c) 写入原始字符值，不做任何处理
JSONWriter	writeRaw(String csq) 写入原始字符串值，不做任何处理
void	writeSpace(int count) 写出空格

从类继承的方法 java.io.Writer

append, append, append, write, write, write, write

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

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

构造器详细资料

JSONWriter

public JSONWriter(Writer writer,
                  int indentFactor,
                  int indent,
                  JSONConfig config)

构造

参数:

writer - Writer

indentFactor - 缩进因子，定义每一级别增加的缩进量

indent - 本级别缩进量

config - JSON选项

方法详细资料

of

public static JSONWriter of(Writer writer,
                            int indentFactor,
                            int indent,
                            JSONConfig config)

创建JSONWriter

参数:

writer - Writer

indentFactor - 缩进因子，定义每一级别增加的缩进量

indent - 本级别缩进量

config - JSON选项

返回:

JSONWriter

getConfig

public JSONConfig getConfig()

获取JSON配置

返回:

JSONConfig

beginObj

public JSONWriter beginObj()

JSONObject写出开始，默认写出"{"

返回:

this

beginArray

public JSONWriter beginArray()

JSONArray写出开始，默认写出"["

返回:

this

end

public JSONWriter end()

结束，默认根据开始的类型，补充"}"或"]"

返回:

this

writeField

public JSONWriter writeField(MutableEntry<Object,Object> pair,
                             Predicate<MutableEntry<Object,Object>> predicate)

写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容
在arrayMode 为 true 时，key是数字，此时不写出键，只写值

参数:

pair - 键值对

predicate - 过滤修改器

返回:

this

从以下版本开始:

6.0.0

writeKey

public JSONWriter writeKey(String key)

写出键，自动处理分隔符和缩进，并包装键名

参数:

key - 键名

返回:

this

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

指定者:

write 在类中 Writer

抛出:

IOException

flush

public void flush()

指定者:

flush 在接口中 Flushable

指定者:

flush 在类中 Writer

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在类中 Writer

抛出:

IOException

writeQuoteStrValue

public void writeQuoteStrValue(String csq)

写出字符串值，并包装引号并转义字符
对所有双引号做转义处理（使用双反斜杠做转义）
为了能在HTML中较好的显示，会将</转义为<\/
JSON字符串中不能包含控制字符和未经转义的引号和反斜杠

参数:

csq - 字符串

writeSpace

public void writeSpace(int count)

写出空格

参数:

count - 空格数

writeLF

public JSONWriter writeLF()

写出换行符

返回:

this

writeRaw

public JSONWriter writeRaw(String csq)

写入原始字符串值，不做任何处理

参数:

csq - 字符串

返回:

this

writeRaw

public JSONWriter writeRaw(char c)

写入原始字符值，不做任何处理

参数:

c - 字符

返回:

this