public class MappingJackson2JsonView extends AbstractJackson2View
View
that renders JSON content by serializing the model for the current request
using Jackson 2's ObjectMapper
.
By default, the entire contents of the model map (with the exception of framework-specific classes)
will be encoded as JSON. If the model contains only one key, you can have it extracted encoded as JSON
alone via setExtractValueFromSingleKeyModel(boolean)
.
The default constructor uses the default configuration provided by Jackson2ObjectMapperBuilder
.
Compatible with Jackson 2.9 to 2.12, as of Spring 5.3.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_CONTENT_TYPE
Default content type: "application/json".
|
updateContentLength
logger
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
Constructor and Description |
---|
MappingJackson2JsonView()
Construct a new
MappingJackson2JsonView using default configuration
provided by Jackson2ObjectMapperBuilder and setting the content type
to application/json . |
MappingJackson2JsonView(ObjectMapper objectMapper)
Construct a new
MappingJackson2JsonView using the provided
ObjectMapper and setting the content type to application/json . |
Modifier and Type | Method and Description |
---|---|
protected Object |
filterModel(Map<String,Object> model)
Filter out undesired attributes from the given model.
|
Set<String> |
getModelKeys()
Return the attributes in the model that should be rendered by this view.
|
void |
setExtractValueFromSingleKeyModel(boolean extractValueFromSingleKeyModel)
Set whether to serialize models containing a single attribute as a map or
whether to extract the single value from the model and serialize it directly.
|
void |
setJsonPrefix(String jsonPrefix)
Specify a custom prefix to use for this view's JSON output.
|
void |
setModelKey(String modelKey)
Set the attribute in the model that should be rendered by this view.
|
void |
setModelKeys(Set<String> modelKeys)
Set the attributes in the model that should be rendered by this view.
|
void |
setPrefixJson(boolean prefixJson)
Indicates whether the JSON output by this view should be prefixed with ")]}', ".
|
protected void |
writePrefix(JsonGenerator generator,
Object object)
Write a prefix before the main content.
|
filterAndWrapModel, getEncoding, getObjectMapper, prepareResponse, renderMergedOutputModel, setDisableCaching, setEncoding, setObjectMapper, setPrettyPrint, setUpdateContentLength, writeContent, writeSuffix
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
public static final String DEFAULT_CONTENT_TYPE
AbstractView.setContentType(java.lang.String)
.public MappingJackson2JsonView()
MappingJackson2JsonView
using default configuration
provided by Jackson2ObjectMapperBuilder
and setting the content type
to application/json
.public MappingJackson2JsonView(ObjectMapper objectMapper)
MappingJackson2JsonView
using the provided
ObjectMapper
and setting the content type to application/json
.public void setJsonPrefix(String jsonPrefix)
setPrefixJson(boolean)
public void setPrefixJson(boolean prefixJson)
false
.
Prefixing the JSON string in this manner is used to help prevent JSON Hijacking. The prefix renders the string syntactically invalid as a script so that it cannot be hijacked. This prefix should be stripped before parsing the string as JSON.
setJsonPrefix(java.lang.String)
public void setModelKey(String modelKey)
setModelKey
in class AbstractJackson2View
public void setModelKeys(@Nullable Set<String> modelKeys)
@Nullable public final Set<String> getModelKeys()
public void setExtractValueFromSingleKeyModel(boolean extractValueFromSingleKeyModel)
The effect of setting this flag is similar to using
MappingJackson2HttpMessageConverter
with an @ResponseBody
request-handling method.
Default is false
.
protected Object filterModel(Map<String,Object> model)
Map
or a single value object.
The default implementation removes BindingResult
instances and entries
not included in the modelKeys
property.
filterModel
in class AbstractJackson2View
model
- the model, as passed on to AbstractJackson2View.renderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
protected void writePrefix(JsonGenerator generator, Object object) throws IOException
AbstractJackson2View
writePrefix
in class AbstractJackson2View
generator
- the generator to use for writing content.object
- the object to write to the output message.IOException