com.alibaba.fastjson

Class JSON

java.lang.Object

com.alibaba.fastjson.JSON

All Implemented Interfaces:

JSONAware, JSONStreamAware

Direct Known Subclasses:

JSONArray, JSONObject

public abstract class JSON
extends Object
implements JSONStreamAware, JSONAware

This is the main class for using Fastjson. You usually call these two methods toJSONString(Object) and parseObject(String, Class).

Here is an example of how fastjson is used for a simple Class:

 Model model = new Model();
 String json = JSON.toJSONString(model); // serializes model to Json
 Model model2 = JSON.parseObject(json, Model.class); // deserializes json into model2
 

If the object that your are serializing/deserializing is a ParameterizedType (i.e. contains at least one type parameter and may be an array) then you must use the toJSONString(Object) or parseObject(String, Type, Feature[]) method. Here is an example for serializing and deserialing a ParameterizedType:

 String json = "[{},...]";
 Type listType = new TypeReference<List<Model>>() {}.getType();
 List<Model> modelList = JSON.parseObject(json, listType);
 

Author:

wenshao[[email protected]]

See Also:

TypeReference

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_GENERATE_FEATURE
static int	DEFAULT_PARSER_FEATURE
static String	DEFAULT_TYPE_KEY
static Locale	defaultLocale
static TimeZone	defaultTimeZone
static String	DEFFAULT_DATE_FORMAT
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
JSON()

Method Summary

Modifier and Type	Method and Description
static <T> void	handleResovleTask(DefaultJSONParser parser, T value)
static Object	parse(byte[] input, Feature... features)
static Object	parse(byte[] input, int off, int len, CharsetDecoder charsetDecoder, Feature... features)
static Object	parse(byte[] input, int off, int len, CharsetDecoder charsetDecoder, int features)
static Object	parse(String text)
static Object	parse(String text, Feature... features)
static Object	parse(String text, int features)
static JSONArray	parseArray(String text)
static <T> List<T>	parseArray(String text, Class<T> clazz)
static List<Object>	parseArray(String text, Type[] types)
static <T> T	parseObject(byte[] input, int off, int len, CharsetDecoder charsetDecoder, Type clazz, Feature... features)
static <T> T	parseObject(byte[] bytes, int offset, int len, Charset charset, Type clazz, Feature... features)
static <T> T	parseObject(byte[] bytes, Type clazz, Feature... features)
static <T> T	parseObject(char[] input, int length, Type clazz, Feature... features)
static <T> T	parseObject(InputStream is, Charset charset, Type type, Feature... features)
static <T> T	parseObject(InputStream is, Type type, Feature... features)
static JSONObject	parseObject(String text)
static <T> T	parseObject(String text, Class<T> clazz)
static <T> T	parseObject(String json, Class<T> clazz, Feature... features) This method deserializes the specified Json into an object of the specified class.
static <T> T	parseObject(String text, Class<T> clazz, ParseProcess processor, Feature... features)
static JSONObject	parseObject(String text, Feature... features)
static <T> T	parseObject(String json, Type type, Feature... features) This method deserializes the specified Json into an object of the specified type.
static <T> T	parseObject(String input, Type clazz, int featureValues, Feature... features)
static <T> T	parseObject(String input, Type clazz, ParseProcess processor, Feature... features)
static <T> T	parseObject(String input, Type clazz, ParserConfig config, Feature... features)
static <T> T	parseObject(String input, Type clazz, ParserConfig config, int featureValues, Feature... features)
static <T> T	parseObject(String input, Type clazz, ParserConfig config, ParseProcess processor, int featureValues, Feature... features)
static <T> T	parseObject(String text, TypeReference<T> type, Feature... features) String jsonStr = "[{\"id\":1001,\"name\":\"Jobs\"}]"; List<Model> models = JSON.parseObject(jsonStr, new TypeReference<List<Model>>() {});
static void	setDefaultTypeKey(String typeKey) config default type key
<T> T	toJavaObject(Class<T> clazz)
static <T> T	toJavaObject(JSON json, Class<T> clazz)
<T> T	toJavaObject(Type type)
<T> T	toJavaObject(TypeReference typeReference)
static Object	toJSON(Object javaObject) This method serializes the specified object into its equivalent representation as a tree of JSONObjects.
static Object	toJSON(Object javaObject, ParserConfig parserConfig) Deprecated.
static Object	toJSON(Object javaObject, SerializeConfig config)
static byte[]	toJSONBytes(Object object, int defaultFeatures, SerializerFeature... features)
static byte[]	toJSONBytes(Object object, SerializeConfig config, int defaultFeatures, SerializerFeature... features)
static byte[]	toJSONBytes(Object object, SerializeConfig config, SerializerFeature... features)
static byte[]	toJSONBytes(Object object, SerializerFeature... features)
String	toJSONString()
static String	toJSONString(Object object) This method serializes the specified object into its equivalent Json representation.
static String	toJSONString(Object object, boolean prettyFormat)
static String	toJSONString(Object object, int defaultFeatures, SerializerFeature... features)
static String	toJSONString(Object object, SerializeConfig config, SerializeFilter[] filters, SerializerFeature... features)
static String	toJSONString(Object object, SerializeConfig config, SerializeFilter[] filters, String dateFormat, int defaultFeatures, SerializerFeature... features)
static String	toJSONString(Object object, SerializeConfig config, SerializeFilter filter, SerializerFeature... features)
static String	toJSONString(Object object, SerializeConfig config, SerializerFeature... features)
static String	toJSONString(Object object, SerializeFilter[] filters, SerializerFeature... features)
static String	toJSONString(Object object, SerializeFilter filter, SerializerFeature... features)
static String	toJSONString(Object object, SerializerFeature... features)
static String	toJSONStringWithDateFormat(Object object, String dateFormat, SerializerFeature... features)
static String	toJSONStringZ(Object object, SerializeConfig mapping, SerializerFeature... features) Deprecated.
String	toString()
void	writeJSONString(Appendable appendable) write JSON string to out.
static int	writeJSONString(OutputStream os, Charset charset, Object object, SerializeConfig config, SerializeFilter[] filters, String dateFormat, int defaultFeatures, SerializerFeature... features)
static int	writeJSONString(OutputStream os, Charset charset, Object object, SerializerFeature... features)
static int	writeJSONString(OutputStream os, Object object, int defaultFeatures, SerializerFeature... features)
static int	writeJSONString(OutputStream os, Object object, SerializerFeature... features) write object as json to OutputStream
static void	writeJSONString(Writer writer, Object object, int defaultFeatures, SerializerFeature... features)
static void	writeJSONString(Writer writer, Object object, SerializerFeature... features) This method serializes the specified object into its equivalent json representation.
static void	writeJSONStringTo(Object object, Writer writer, SerializerFeature... features) Deprecated. use writeJSONString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

defaultTimeZone

public static TimeZone defaultTimeZone

defaultLocale

public static Locale defaultLocale

DEFAULT_TYPE_KEY

public static String DEFAULT_TYPE_KEY

DEFFAULT_DATE_FORMAT

public static String DEFFAULT_DATE_FORMAT

DEFAULT_PARSER_FEATURE

public static int DEFAULT_PARSER_FEATURE

DEFAULT_GENERATE_FEATURE

public static int DEFAULT_GENERATE_FEATURE

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

JSON

public JSON()

Method Detail

setDefaultTypeKey

public static void setDefaultTypeKey(String typeKey)

config default type key

Since:

1.2.14

parse

public static Object parse(String text)

parse

public static Object parse(String text,
                           int features)

parse

public static Object parse(byte[] input,
                           Feature... features)

parse

public static Object parse(byte[] input,
                           int off,
                           int len,
                           CharsetDecoder charsetDecoder,
                           Feature... features)

parse

public static Object parse(byte[] input,
                           int off,
                           int len,
                           CharsetDecoder charsetDecoder,
                           int features)

parse

public static Object parse(String text,
                           Feature... features)

parseObject

public static JSONObject parseObject(String text,
                                     Feature... features)

parseObject

public static JSONObject parseObject(String text)

parseObject

public static <T> T parseObject(String text,
                                TypeReference<T> type,
                                Feature... features)

 String jsonStr = "[{\"id\":1001,\"name\":\"Jobs\"}]";
 List<Model> models = JSON.parseObject(jsonStr, new TypeReference<List<Model>>() {});
 

Parameters:

text - json string

type - type refernce

features -

Returns:

parseObject

public static <T> T parseObject(String json,
                                Class<T> clazz,
                                Feature... features)

This method deserializes the specified Json into an object of the specified class. It is not suitable to use if the specified class is a generic type since it will not have the generic type information because of the Type Erasure feature of Java. Therefore, this method should not be used if the desired type is a generic type. Note that this method works fine if the any of the fields of the specified object are generics, just the object itself should not be a generic type. For the cases when the object is of generic type, invoke parseObject(String, Type, Feature[]). If you have the Json in a InputStream instead of a String, use parseObject(InputStream, Type, Feature[]) instead.

Parameters:

json - the string from which the object is to be deserialized

clazz - the class of T

features - parser features

Returns:

an object of type T from the string classOfT

parseObject

public static <T> T parseObject(String text,
                                Class<T> clazz,
                                ParseProcess processor,
                                Feature... features)

parseObject

public static <T> T parseObject(String json,
                                Type type,
                                Feature... features)

This method deserializes the specified Json into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, use parseObject(String, Class, Feature[]) instead. If you have the Json in a InputStream instead of a String, use parseObject(InputStream, Type, Feature[]) instead.

Type Parameters:

T - the type of the desired object

Parameters:

json - the string from which the object is to be deserialized

type - The specific genericized type of src. You can obtain this type by using the TypeReference class. For example, to get the type for Collection<Foo>, you should use:

 Type type = new TypeReference<Collection<Foo>>(){}.getType();
 

Returns:

an object of type T from the string

parseObject

public static <T> T parseObject(String input,
                                Type clazz,
                                ParseProcess processor,
                                Feature... features)

parseObject

public static <T> T parseObject(String input,
                                Type clazz,
                                int featureValues,
                                Feature... features)

parseObject

public static <T> T parseObject(String input,
                                Type clazz,
                                ParserConfig config,
                                Feature... features)

Since:

1.2.11

parseObject

public static <T> T parseObject(String input,
                                Type clazz,
                                ParserConfig config,
                                int featureValues,
                                Feature... features)

parseObject

public static <T> T parseObject(String input,
                                Type clazz,
                                ParserConfig config,
                                ParseProcess processor,
                                int featureValues,
                                Feature... features)

parseObject

public static <T> T parseObject(byte[] bytes,
                                Type clazz,
                                Feature... features)

parseObject

public static <T> T parseObject(byte[] bytes,
                                int offset,
                                int len,
                                Charset charset,
                                Type clazz,
                                Feature... features)

Since:

1.2.11

parseObject

public static <T> T parseObject(byte[] input,
                                int off,
                                int len,
                                CharsetDecoder charsetDecoder,
                                Type clazz,
                                Feature... features)

parseObject

public static <T> T parseObject(char[] input,
                                int length,
                                Type clazz,
                                Feature... features)

parseObject

public static <T> T parseObject(InputStream is,
                                Type type,
                                Feature... features)
                         throws IOException

Throws:

IOException

Since:

1.2.11

parseObject

public static <T> T parseObject(InputStream is,
                                Charset charset,
                                Type type,
                                Feature... features)
                         throws IOException

Throws:

IOException

Since:

1.2.11

parseObject

public static <T> T parseObject(String text,
                                Class<T> clazz)

parseArray

public static JSONArray parseArray(String text)

parseArray

public static <T> List<T> parseArray(String text,
                                     Class<T> clazz)

parseArray

public static List<Object> parseArray(String text,
                                      Type[] types)

toJSONString

public static String toJSONString(Object object)

This method serializes the specified object into its equivalent Json representation. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If you want to write out the object to a Writer, use writeJSONString(Writer, Object, SerializerFeature[]) instead.

Parameters:

object - the object for which json representation is to be created setting for fastjson

Returns:

Json representation of object.

toJSONString

public static String toJSONString(Object object,
                                  SerializerFeature... features)

toJSONString

public static String toJSONString(Object object,
                                  int defaultFeatures,
                                  SerializerFeature... features)

Since:

1.2.11

toJSONStringWithDateFormat

public static String toJSONStringWithDateFormat(Object object,
                                                String dateFormat,
                                                SerializerFeature... features)

Since:

1.1.14

toJSONString

public static String toJSONString(Object object,
                                  SerializeFilter filter,
                                  SerializerFeature... features)

toJSONString

public static String toJSONString(Object object,
                                  SerializeFilter[] filters,
                                  SerializerFeature... features)

toJSONBytes

public static byte[] toJSONBytes(Object object,
                                 SerializerFeature... features)

toJSONBytes

public static byte[] toJSONBytes(Object object,
                                 int defaultFeatures,
                                 SerializerFeature... features)

Since:

1.2.11

toJSONString

public static String toJSONString(Object object,
                                  SerializeConfig config,
                                  SerializerFeature... features)

toJSONString

public static String toJSONString(Object object,
                                  SerializeConfig config,
                                  SerializeFilter filter,
                                  SerializerFeature... features)

toJSONString

public static String toJSONString(Object object,
                                  SerializeConfig config,
                                  SerializeFilter[] filters,
                                  SerializerFeature... features)

toJSONString

public static String toJSONString(Object object,
                                  SerializeConfig config,
                                  SerializeFilter[] filters,
                                  String dateFormat,
                                  int defaultFeatures,
                                  SerializerFeature... features)

Returns:

Since:

1.2.9

toJSONStringZ

public static String toJSONStringZ(Object object,
                                   SerializeConfig mapping,
                                   SerializerFeature... features)

Deprecated.

toJSONBytes

public static byte[] toJSONBytes(Object object,
                                 SerializeConfig config,
                                 SerializerFeature... features)

toJSONBytes

public static byte[] toJSONBytes(Object object,
                                 SerializeConfig config,
                                 int defaultFeatures,
                                 SerializerFeature... features)

Since:

1.2.11

toJSONString

public static String toJSONString(Object object,
                                  boolean prettyFormat)

writeJSONStringTo

public static void writeJSONStringTo(Object object,
                                     Writer writer,
                                     SerializerFeature... features)

Deprecated. use writeJSONString

writeJSONString

public static void writeJSONString(Writer writer,
                                   Object object,
                                   SerializerFeature... features)

This method serializes the specified object into its equivalent json representation.

Parameters:

writer - Writer to which the json representation needs to be written

object - the object for which json representation is to be created setting for fastjson

features - serializer features

Since:

1.2.11

writeJSONString

public static void writeJSONString(Writer writer,
                                   Object object,
                                   int defaultFeatures,
                                   SerializerFeature... features)

Since:

1.2.11

writeJSONString

public static final int writeJSONString(OutputStream os,
                                        Object object,
                                        SerializerFeature... features)
                                 throws IOException

write object as json to OutputStream

Parameters:

os - output stream

object -

features - serializer features

Throws:

IOException

Since:

1.2.11

writeJSONString

public static final int writeJSONString(OutputStream os,
                                        Object object,
                                        int defaultFeatures,
                                        SerializerFeature... features)
                                 throws IOException

Throws:

IOException

Since:

1.2.11

writeJSONString

public static final int writeJSONString(OutputStream os,
                                        Charset charset,
                                        Object object,
                                        SerializerFeature... features)
                                 throws IOException

Throws:

IOException

writeJSONString

public static final int writeJSONString(OutputStream os,
                                        Charset charset,
                                        Object object,
                                        SerializeConfig config,
                                        SerializeFilter[] filters,
                                        String dateFormat,
                                        int defaultFeatures,
                                        SerializerFeature... features)
                                 throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface JSONAware

Returns:

JSON text

writeJSONString

public void writeJSONString(Appendable appendable)

Description copied from interface: JSONStreamAware

write JSON string to out.

Specified by:

writeJSONString in interface JSONStreamAware

toJSON

public static Object toJSON(Object javaObject)

This method serializes the specified object into its equivalent representation as a tree of JSONObjects.

toJSON

public static Object toJSON(Object javaObject,
                            ParserConfig parserConfig)

Deprecated.

toJSON

public static Object toJSON(Object javaObject,
                            SerializeConfig config)

toJavaObject

public static <T> T toJavaObject(JSON json,
                                 Class<T> clazz)

toJavaObject

public <T> T toJavaObject(Class<T> clazz)

Since:

1.2.9

toJavaObject

public <T> T toJavaObject(Type type)

Since:

1.2.33

toJavaObject

public <T> T toJavaObject(TypeReference typeReference)

Since:

1.2.33

handleResovleTask

public static <T> void handleResovleTask(DefaultJSONParser parser,
                                         T value)