com.alibaba.fastjson2.support.jaxrs.javax

Class FastJson2Provider

java.lang.Object

com.alibaba.fastjson2.support.jaxrs.javax.FastJson2Provider

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyReader<java.lang.Object>, javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

@Provider
 @Consumes(value="*/*")
 @Produces(value="*/*")
public class FastJson2Provider
extends java.lang.Object
implements javax.ws.rs.ext.MessageBodyReader<java.lang.Object>, javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

Fastjson for JAX-RS Provider. 参考：com.alibaba.fastjson.support.jaxrs.FastJsonProvider

Since:

2024/10/16

See Also:

MessageBodyReader, MessageBodyWriter

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<?>[]	clazzes allow serialize/deserialize types in clazzes
static java.lang.Class<?>[]	DEFAULT_UNREADABLES These are classes that we never use for reading (never try to deserialize instances of these types).
static java.lang.Class<?>[]	DEFAULT_UNWRITABLES These are classes that we never use for writing (never try to serialize instances of these types).
private FastJsonConfig	fastJsonConfig with fastJson config
protected javax.ws.rs.ext.Providers	providers Injectable context object used to locate configured instance of FastJsonConfig to use for actual serialization.

Constructor Summary

Constructors

Constructor and Description
FastJson2Provider() Can serialize/deserialize all types.
FastJson2Provider(java.lang.Class<?>[] clazzes) Only serialize/deserialize all types in clazzes.

Method Summary

Modifier and Type	Method and Description
protected boolean	hasNotMatchingMediaType(javax.ws.rs.core.MediaType mediaType) Check media type like "application/json".
protected boolean	isNotAssignableFrom(java.lang.Class<?> type, java.lang.Class<?>[] classes) Check some are interface/abstract classes to exclude.
boolean	isReadable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether values of given type (and media type) can be deserialized by this provider.
protected boolean	isValidType(java.lang.Class<?> type, java.lang.annotation.Annotation[] classAnnotations) Check whether a class can be serialized or deserialized.
boolean	isWriteable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether given value (of specified type) can be serialized by this provider.
protected FastJsonConfig	locateConfigProvider(java.lang.Class<?> type, javax.ws.rs.core.MediaType mediaType) Helper method that is called if no config has been explicitly configured.
java.lang.Object	readFrom(java.lang.Class<java.lang.Object> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> httpHeaders, java.io.InputStream entityStream) Method that JAX-RS container calls to deserialize given value.
void	writeTo(java.lang.Object object, java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders, java.io.OutputStream entityStream) Method that JAX-RS container calls to serialize given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.ws.rs.ext.MessageBodyWriter

getSize

Field Detail

DEFAULT_UNREADABLES

public static final java.lang.Class<?>[] DEFAULT_UNREADABLES

These are classes that we never use for reading (never try to deserialize instances of these types).

DEFAULT_UNWRITABLES

public static final java.lang.Class<?>[] DEFAULT_UNWRITABLES

These are classes that we never use for writing (never try to serialize instances of these types).

providers

@Context
protected javax.ws.rs.ext.Providers providers

Injectable context object used to locate configured instance of FastJsonConfig to use for actual serialization.

fastJsonConfig

private FastJsonConfig fastJsonConfig

with fastJson config

clazzes

private java.lang.Class<?>[] clazzes

allow serialize/deserialize types in clazzes

Constructor Detail

FastJson2Provider

public FastJson2Provider()

Can serialize/deserialize all types.

FastJson2Provider

public FastJson2Provider(java.lang.Class<?>[] clazzes)

Only serialize/deserialize all types in clazzes.

Method Detail

isNotAssignableFrom

protected boolean isNotAssignableFrom(java.lang.Class<?> type,
                                      java.lang.Class<?>[] classes)

Check some are interface/abstract classes to exclude.

Parameters:

type - the type

classes - the classes

Returns:

the boolean

isValidType

protected boolean isValidType(java.lang.Class<?> type,
                              java.lang.annotation.Annotation[] classAnnotations)

Check whether a class can be serialized or deserialized. It can check based on packages, annotations on entities or explicit classes.

Parameters:

type - class need to check

Returns:

true if valid

hasNotMatchingMediaType

protected boolean hasNotMatchingMediaType(javax.ws.rs.core.MediaType mediaType)

Check media type like "application/json".

Parameters:

mediaType - media type

Returns:

true if the media type is valid

isWriteable

public boolean isWriteable(java.lang.Class<?> type,
                           java.lang.reflect.Type genericType,
                           java.lang.annotation.Annotation[] annotations,
                           javax.ws.rs.core.MediaType mediaType)

Method that JAX-RS container calls to try to check whether given value (of specified type) can be serialized by this provider.

Specified by:

isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

writeTo

public void writeTo(java.lang.Object object,
                    java.lang.Class<?> type,
                    java.lang.reflect.Type genericType,
                    java.lang.annotation.Annotation[] annotations,
                    javax.ws.rs.core.MediaType mediaType,
                    javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders,
                    java.io.OutputStream entityStream)
             throws java.io.IOException,
                    javax.ws.rs.WebApplicationException

Method that JAX-RS container calls to serialize given value.

Specified by:

writeTo in interface javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

Throws:

java.io.IOException

javax.ws.rs.WebApplicationException

isReadable

public boolean isReadable(java.lang.Class<?> type,
                          java.lang.reflect.Type genericType,
                          java.lang.annotation.Annotation[] annotations,
                          javax.ws.rs.core.MediaType mediaType)

Method that JAX-RS container calls to try to check whether values of given type (and media type) can be deserialized by this provider.

Specified by:

isReadable in interface javax.ws.rs.ext.MessageBodyReader<java.lang.Object>

readFrom

public java.lang.Object readFrom(java.lang.Class<java.lang.Object> type,
                                 java.lang.reflect.Type genericType,
                                 java.lang.annotation.Annotation[] annotations,
                                 javax.ws.rs.core.MediaType mediaType,
                                 javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> httpHeaders,
                                 java.io.InputStream entityStream)
                          throws java.io.IOException,
                                 javax.ws.rs.WebApplicationException

Method that JAX-RS container calls to deserialize given value.

Specified by:

readFrom in interface javax.ws.rs.ext.MessageBodyReader<java.lang.Object>

Throws:

java.io.IOException

javax.ws.rs.WebApplicationException

locateConfigProvider

protected FastJsonConfig locateConfigProvider(java.lang.Class<?> type,
                                              javax.ws.rs.core.MediaType mediaType)

Helper method that is called if no config has been explicitly configured.