com.wl4g.infra.common.remoting.parse.MappingJackson2HttpMessageParser Maven / Gradle / Ivy
/*
* Copyright 2017 ~ 2025 the original author or authors. James Wong
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.wl4g.infra.common.remoting.parse;
import java.io.IOException;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.wl4g.infra.common.remoting.standard.HttpMediaType;
import com.wl4g.infra.common.serialize.JacksonUtils;
/**
* Implementation that can read and write JSON using
* Jackson 2.x's
* {@link ObjectMapper}.
*
*
* This converter can be used to bind to typed beans, or untyped {@code HashMap}
* instances.
*
*
* By default, this converter supports {@code application/json} and
* {@code application/*+json} with {@code UTF-8} character set. This can be
* overridden by setting the {@link #setSupportedMediaTypes supportedMediaTypes}
* property.
*
*
* The default constructor uses the default configuration provided by
* {@link Jackson2ObjectMapperBuilder}.
*
*
*/
public class MappingJackson2HttpMessageParser extends AbstractJackson2HttpMessageParser {
private String jsonPrefix;
/**
* Construct a new {@link MappingJackson2HttpMessageParser} using default
* configuration provided by {@link Jackson2ObjectMapperBuilder}.
*/
public MappingJackson2HttpMessageParser() {
// TODO 当启用扩展支持时，反序列化时会报错 cast exception:
// com.fasterxml.jackson.databind.cfg.ContextAttributes.Impl to
// com.wl4g.infra.common.serialize.JacksonUtils.TransformContextAttributes
// ???
this(JacksonUtils.newDefaultObjectMapper(false));
}
/**
* Construct a new {@link MappingJackson2HttpMessageParser} with a custom
* {@link ObjectMapper}. You can use {@link Jackson2ObjectMapperBuilder} to
* build it easily.
*
* @see Jackson2ObjectMapperBuilder#json()
*/
@SuppressWarnings("deprecation")
public MappingJackson2HttpMessageParser(ObjectMapper objectMapper) {
super(objectMapper, HttpMediaType.APPLICATION_JSON, HttpMediaType.APPLICATION_JSON_UTF8,
new HttpMediaType("application", "*+json"));
}
/**
* Specify a custom prefix to use for this view's JSON output. Default is
* none.
*
* @see #setPrefixJson
*/
public void setJsonPrefix(String jsonPrefix) {
this.jsonPrefix = jsonPrefix;
}
/**
* Indicate 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 should be stripped
* before parsing the string as JSON.
*
* @see #setJsonPrefix
*/
public void setPrefixJson(boolean prefixJson) {
this.jsonPrefix = (prefixJson ? ")]}', " : null);
}
@Override
protected void writePrefix(JsonGenerator generator, Object object) throws IOException {
if (this.jsonPrefix != null) {
generator.writeRaw(this.jsonPrefix);
}
String jsonpFunction = (object instanceof MappingJacksonValue ? ((MappingJacksonValue) object).getJsonpFunction() : null);
if (jsonpFunction != null) {
generator.writeRaw("/**/");
generator.writeRaw(jsonpFunction + "(");
}
}
@Override
protected void writeSuffix(JsonGenerator generator, Object object) throws IOException {
String jsonpFunction = (object instanceof MappingJacksonValue ? ((MappingJacksonValue) object).getJsonpFunction() : null);
if (jsonpFunction != null) {
generator.writeRaw(");");
}
}
}