cn.featherfly.web.spring.servlet.view.json

类 MappingJackson2JsonView

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractView

cn.featherfly.web.spring.servlet.view.json.MappingJackson2JsonView

所有已实现的接口:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.View

public class MappingJackson2JsonView
extends org.springframework.web.servlet.view.AbstractView

Spring MVC 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).

从以下版本开始:

3.1.2

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_CONTENT_TYPE Default content type: "application/json".

从类继承的字段 org.springframework.context.support.ApplicationObjectSupport

logger

从接口继承的字段 org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

构造器概要

构造器

构造器和说明
MappingJackson2JsonView() Construct a new MappingJackson2JsonView, setting the content type to application/json.

方法概要

方法

限定符和类型	方法和说明
protected java.lang.Object	filterModel(java.util.Map<java.lang.String,java.lang.Object> model) Filter out undesired attributes from the given model.
com.fasterxml.jackson.core.JsonEncoding	getEncoding() Return the JsonEncoding for this view.
java.util.Set<java.lang.String>	getModelKeys() Return the attributes in the model that should be rendered by this view.
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Return the ObjectMapper for this view.
java.util.Set<java.lang.String>	getRenderedAttributes() 已过时。 use getModelKeys() instead
protected void	prepareResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setDisableCaching(boolean disableCaching) Disables caching of the generated JSON.
void	setEncoding(com.fasterxml.jackson.core.JsonEncoding encoding) Set the JsonEncoding for 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(java.lang.String jsonPrefix) Specify a custom prefix to use for this view's JSON output.
void	setModelKey(java.lang.String modelKey) Set the attribute in the model that should be rendered by this view.
void	setModelKeys(java.util.Set<java.lang.String> modelKeys) Set the attributes in the model that should be rendered by this view.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Set the ObjectMapper for this view.
void	setPrefixJson(boolean prefixJson) Indicates whether the JSON output by this view should be prefixed with "{} && ".
void	setPrettyPrint(boolean prettyPrint) Whether to use the default pretty printer when writing JSON.
void	setRenderedAttributes(java.util.Set<java.lang.String> renderedAttributes) 已过时。 use setModelKeys(Set) instead
void	setUpdateContentLength(boolean updateContentLength) Whether to update the 'Content-Length' header of the response.
protected void	writeContent(java.io.OutputStream stream, java.lang.Object value, java.lang.String jsonPrefix) Write the actual JSON content to the stream.

从类继承的方法 org.springframework.web.servlet.view.AbstractView

addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse

从类继承的方法 org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

从类继承的方法 org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

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

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

字段详细资料

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE

Default content type: "application/json". Overridable through AbstractView.setContentType(java.lang.String).

另请参阅:

常量字段值

构造器详细资料

MappingJackson2JsonView

public MappingJackson2JsonView()

Construct a new MappingJackson2JsonView, setting the content type to application/json.

方法详细资料

setObjectMapper

public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Set the ObjectMapper for this view. If not set, a default ObjectMapper will be used.

Setting a custom-configured ObjectMapper is one way to take further control of the JSON serialization process. The other option is to use Jackson's provided annotations on the types to be serialized, in which case a custom-configured ObjectMapper is unnecessary.

getObjectMapper

public final com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Return the ObjectMapper for this view.

setEncoding

public void setEncoding(com.fasterxml.jackson.core.JsonEncoding encoding)

Set the JsonEncoding for this view. By default, UTF-8 is used.

getEncoding

public final com.fasterxml.jackson.core.JsonEncoding getEncoding()

Return the JsonEncoding for this view.

setJsonPrefix

public void setJsonPrefix(java.lang.String jsonPrefix)

Specify a custom prefix to use for this view's JSON output. Default is none.

另请参阅:

setPrefixJson(boolean)

setPrefixJson

public void setPrefixJson(boolean prefixJson)

Indicates whether the JSON output by this view should be prefixed with "{} && ". Default is 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 does not affect the evaluation of JSON, but if JSON validation is performed on the string, the prefix would need to be ignored.

另请参阅:

setJsonPrefix(java.lang.String)

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Whether to use the default pretty printer when writing JSON. This is a shortcut for setting up an ObjectMapper as follows:

 ObjectMapper mapper = new ObjectMapper();
 mapper.configure(SerializationFeature.INDENT_OUTPUT, true);
 

The default value is false.

setModelKey

public void setModelKey(java.lang.String modelKey)

Set the attribute in the model that should be rendered by this view. When set, all other model attributes will be ignored.

setModelKeys

public void setModelKeys(java.util.Set<java.lang.String> modelKeys)

Set the attributes in the model that should be rendered by this view. When set, all other model attributes will be ignored.

getModelKeys

public final java.util.Set<java.lang.String> getModelKeys()

Return the attributes in the model that should be rendered by this view.

setRenderedAttributes

@Deprecated
public void setRenderedAttributes(java.util.Set<java.lang.String> renderedAttributes)

已过时。 use setModelKeys(Set) instead

Set the attributes in the model that should be rendered by this view. When set, all other model attributes will be ignored.

getRenderedAttributes

@Deprecated
public final java.util.Set<java.lang.String> getRenderedAttributes()

已过时。 use getModelKeys() instead

Return the attributes in the model that should be rendered by this view.

setExtractValueFromSingleKeyModel

public 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.

The effect of setting this flag is similar to using MappingJackson2HttpMessageConverter with an @ResponseBody request-handling method.

Default is false.

setDisableCaching

public void setDisableCaching(boolean disableCaching)

Disables caching of the generated JSON.

Default is true, which will prevent the client from caching the generated JSON.

setUpdateContentLength

public void setUpdateContentLength(boolean updateContentLength)

Whether to update the 'Content-Length' header of the response. When set to true, the response is buffered in order to determine the content length and set the 'Content-Length' header of the response.

The default setting is false.

prepareResponse

protected void prepareResponse(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

覆盖:

prepareResponse 在类中 org.springframework.web.servlet.view.AbstractView

renderMergedOutputModel

protected void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                                throws java.lang.Exception

指定者:

renderMergedOutputModel 在类中 org.springframework.web.servlet.view.AbstractView

抛出:

java.lang.Exception

filterModel

protected java.lang.Object filterModel(java.util.Map<java.lang.String,java.lang.Object> model)

Filter out undesired attributes from the given model. The return value can be either another Map or a single value object.

The default implementation removes BindingResult instances and entries not included in the renderedAttributes property.

参数:

model - the model, as passed on to renderMergedOutputModel(java.util.Map<java.lang.String, java.lang.Object>, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

返回:

the value to be rendered

writeContent

protected void writeContent(java.io.OutputStream stream,
                java.lang.Object value,
                java.lang.String jsonPrefix)
                     throws java.io.IOException

Write the actual JSON content to the stream.

参数:

stream - the output stream to use

value - the value to be rendered, as returned from filterModel(java.util.Map<java.lang.String, java.lang.Object>)

jsonPrefix - the prefix for this view's JSON output (as indicated through setJsonPrefix(java.lang.String)/setPrefixJson(boolean))

抛出:

java.io.IOException - if writing failed