जैक्सन को क्रमांकन के दौरान फ़ील्ड मान को अनदेखा करने के लिए कैसे कॉन्फ़िगर किया जा सकता है यदि उस फ़ील्ड का मान शून्य है।
उदाहरण के लिए:
public class SomeClass {
// what jackson annotation causes jackson to skip over this value if it is null but will
// serialize it otherwise
private String someValue;
}जवाबों:
जैक्सन> 2.0 का उपयोग करते हुए अशक्त मूल्यों के साथ क्रमबद्ध गुणों को दबाने के लिए, आप सीधे कॉन्फ़िगरObjectMapper कर सकते हैं , या @JsonIncludeएनोटेशन का उपयोग कर सकते हैं :
mapper.setSerializationInclusion(Include.NON_NULL);या:
@JsonInclude(Include.NON_NULL)
class Foo
{
String bar;
}वैकल्पिक रूप से, आप उपयोग कर सकते हैं @JsonInclude एक गटर में ताकि मूल्य शून्य होने पर विशेषता दिखाई जाए।
मेरे उत्तर में एक अधिक संपूर्ण उदाहरण उपलब्ध है कैसे एक मैप के अंदर अशक्त मूल्यों को रोकने के लिए और जैक्सन के बिना धारावाहिक से एक सेम के अंदर अशक्त क्षेत्रों को रोका जाए ।
@JsonIncludeसंकेतन काम नहीं करता है, लेकिन यह एक आकर्षण की तरह काम करता है: @JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) (मैं वसंत 3.2.2 के साथ जैक्सन 1.9.12 का उपयोग कर रहा हूं।)
@JsonSerializeसिंटैक्स से बदल दिया गया था @JsonInclude। पुराने सिंटेक्स को हटा दिया जाता है।
जैक्सन के साथ 1.9.11 और <2.x का उपयोग @JsonSerializeएनोटेशन करने के लिए करते हैं:
@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)
@JsonSerialize(using = FooSerializer.class, include = JsonSerialize.Inclusion.NON_NULL)काम नहीं करता है। अशक्त मूल्य क्रमबद्ध हैं।
बस अन्य उत्तरों पर विस्तार करने के लिए - यदि आपको प्रति-फ़ील्ड आधार पर शून्य मानों की चूक को नियंत्रित करने की आवश्यकता है, तो प्रश्न में फ़ील्ड को एनोटेट करें (या वैकल्पिक रूप से फ़ील्ड के 'गेट्टर' को एनोटेट करें)।
उदाहरण - यहाँ केवल fieldOneजुबान से ommitted किया जाएगा यदि यह अशक्त है। fieldTwoहमेशा की परवाह किए बिना शामिल किया जाएगा अगर यह शून्य है।
public class Foo {
@JsonInclude(JsonInclude.Include.NON_NULL)
private String fieldOne;
private String fieldTwo;
}एक डिफ़ॉल्ट के रूप में कक्षा में सभी अशक्त मूल्यों को छोड़ने के लिए, वर्ग को एनोटेट करें। यदि आवश्यक हो तो इस डिफ़ॉल्ट को ओवरराइड करने के लिए प्रति-फ़ील्ड / गेट्टर एनोटेशन का उपयोग किया जा सकता है।
उदाहरण - यहाँ fieldOneऔर fieldTwoअगर वे क्रमशः अशक्त हैं, तो उन्हें json से हटा दिया जाएगा, क्योंकि यह वर्ग एनोटेशन द्वारा निर्धारित डिफ़ॉल्ट है। fieldThreeहालाँकि, डिफ़ॉल्ट को ओवरराइड करेगा और फ़ील्ड में एनोटेशन के कारण हमेशा शामिल रहेगा।
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Foo {
private String fieldOne;
private String fieldTwo;
@JsonInclude(JsonInclude.Include.ALWAYS)
private String fieldThree;
}अपडेट करें
ऊपर जैक्सन 2 के लिए है । जैक्सन के पुराने संस्करणों के लिए आपको उपयोग करने की आवश्यकता है:
@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) के बजाय
@JsonInclude(JsonInclude.Include.NON_NULL)यदि यह अपडेट उपयोगी है, तो कृपया नीचे दिए गए ZiglioUK के उत्तर को बढ़ाएं, इसने नए जैक्सन 2 एनोटेशन को इंगित किया, इससे पहले कि मैंने इसका उपयोग करने के लिए अपना उत्तर अपडेट किया!
@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) पदावनत किया जाता है
जैक्सन में 2.x, का उपयोग करें:
@JsonInclude(JsonInclude.Include.NON_NULL)com.fasterxml.jackson.annotation- जैक्सन 1.x थाorg.codehaus.jackson.annoation
आप निम्न मैपर कॉन्फ़िगरेशन का उपयोग कर सकते हैं:
mapper.getSerializationConfig().setSerializationInclusion(Inclusion.NON_NULL);2.5 के बाद से आप उपयोगकर्ता कर सकते हैं:
mapper.setSerializationInclusion(Include.NON_NULL);getSerializationConfig() कहते हैं:Note that since instances are immutable, you can NOT change settings by accessing an instance and calling methods: this will simply create new instance of config object.
mapper.setSerializationInclusion(Include.NON_NULL);
आप सेट कर सकते हैं application.properties:
spring.jackson.default-property-inclusion=non_nullया application.yaml:
spring:
jackson:
default-property-inclusion: non_nullhttp://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html
मेरे मामले में
@JsonInclude(Include.NON_EMPTY)यह काम किया।
{ }अशक्त के लिए कुछ ऐसा मिलेगा , जो उपभोक्ता के लिए जावा मुहावरे को इंगित करता है। AtomicReference के साथ भी - उपभोक्ता को परवाह नहीं है कि डेवलपर ने प्रतिक्रिया के आंतरिक प्रतिनिधित्व पर थ्रेड सुरक्षा को लागू करने के लिए कैसे चुना।
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonInclude(JsonInclude.Include.NON_EMPTY)कार्य करना चाहिए।
Include.NON_EMPTYइंगित करता है कि संपत्ति को क्रमबद्ध किया गया है यदि उसका मूल्य शून्य नहीं है और खाली नहीं है।
Include.NON_NULLसंकेत करता है कि यदि संपत्ति का मूल्य कम है, तो उसे अनुक्रमित किया जाता है।
JsonInclude.Include.NON_EMPTY- यह पर्याप्त नहीं है क्योंकि इसमें NOT_NULL मामला शामिल है
यदि आप जैक्सन 2.6+ में सभी मॉडलों में इस नियम को जोड़ना चाहते हैं:
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);यदि स्प्रिंग बूट में , आप जैकसन को अनुकूलित कर सकते हैंObjectMapper सीधे संपत्ति फ़ाइलों के माध्यम से हैं।
उदाहरण application.yml:
spring:
jackson:
default-property-inclusion: non_null # only include props if non-nullसंभावित मूल्य हैं:
always|non_null|non_absent|non_default|non_emptyयह स्प्रिंग स्प्रिंग 2.0.3+ और जैक्सन 2.0+ में काम करेगा
import com.fasterxml.jackson.annotation.JsonInclude;
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ApiDTO
{
// your class variable and
// methods
}@JsonInclude(JsonInclude.Include.NON_NULL)ने मेरे लिए स्प्रिंग बूट 2.1.2 और जैक्सन एनोटेशन 2.9.0
जैक्सन 2.5 के लिए उपयोग करें:
@JsonInclude(content=Include.NON_NULL)यह मुझे काफी समय से परेशान कर रहा है और आखिरकार मुझे यह मुद्दा मिल गया है। मुद्दा गलत आयात के कारण था। पहले मैं उपयोग कर रहा था
com.fasterxml.jackson.databind.annotation.JsonSerializeजिसे हटा दिया गया था। बस आयात को प्रतिस्थापित करें
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion;और इसका उपयोग करें
@JsonSerialize(include=Inclusion.NON_NULL)वैश्विक विन्यास यदि आप स्प्रिंग का उपयोग करते हैं
@Configuration
public class JsonConfigurations {
@Bean
public Jackson2ObjectMapperBuilder objectMapperBuilder() {
Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
builder.serializationInclusion(JsonInclude.Include.NON_NULL);
builder.serializationInclusion(JsonInclude.Include.NON_EMPTY);
builder.failOnUnknownProperties(false);
return builder;
}
}public Jackson2ObjectMapperBuilder serializationInclusion(JsonInclude.Include serializationInclusion) { this.serializationInclusion = serializationInclusion; return this; }; एक को समावेश समावेशन के अधिक से अधिक त्रिज्या का उपयोग करना चाहिए। जैसे NON_ABSENT में NON_NULL और NON_EMPTY दोनों शामिल हैं। इस प्रकार यह केवल builder.serializationInclusion(JsonInclude.Include.NON_EMPTY); जैक्सनInclude डॉक्टर
यदि आप ऑब्जेक्ट की एक सूची को क्रमबद्ध करने की कोशिश कर रहे हैं और उनमें से एक शून्य है, तो आप इसे JAIL में भी शून्य आइटम सहित समाप्त कर देंगे
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);में परिणाम होगा:
[{myObject},null]इसे पाने के लिए:
[{myObject}]कुछ ऐसा कर सकते हैं:
mapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
@Override
public void serialize(Object obj, JsonGenerator jsonGen, SerializerProvider unused)
throws IOException
{
//IGNORES NULL VALUES!
}
});TIP: यदि आप DropWizard का उपयोग कर रहे हैं, तो आप ObjectMapperजर्सी द्वारा उपयोग किए जा रहे उपयोग को पुनः प्राप्त कर सकते हैंenvironment.getObjectMapper()
हमारे पास इस प्रश्न के बहुत से उत्तर हैं। यह उत्तर कुछ परिदृश्यों में मददगार हो सकता है। यदि आप अशक्त मूल्यों को अनदेखा करना चाहते हैं तो आप कक्षा स्तर में NOT_NULL का उपयोग कर सकते हैं। नीचे के अनुसार
@JsonInclude(Include.NON_NULL)
class Foo
{
String bar;
}कुछ बार आपको खाली मानों को नजरअंदाज करने की आवश्यकता हो सकती है जैसे कि आपने सरणी सूची को प्रारंभ किया हो सकता है, लेकिन उस सूची में कोई तत्व नहीं हैं। उस समय में उन खाली मान फ़ील्ड को अनदेखा करने के लिए NOT_EMPTY एनोटेशन का उपयोग किया जा सकता है
@JsonInclude(Include.NON_EMPTY)
class Foo
{
String bar;
}जैक्सन 2.x + उपयोग
mapper.getSerializationConfig().withSerializationInclusion(JsonInclude.Include.NON_NULL);.withSerializationInclusion(JsonInclude.Include.NON_NULL)इसके बजाय सही है?
getSerializationConfig()कहते हैं:Note that since instances are immutable, you can NOT change settings by accessing an instance and calling methods: this will simply create new instance of config object.
इसके अलावा, आपको मानचित्र myVariable का उपयोग करते समय अपना दृष्टिकोण बदलना होगा जैसा कि दस्तावेज़ों में विवरण को शून्य करने के लिए वर्णित किया गया है:
From documentation:
com.fasterxml.jackson.annotation.JsonInclude
@JacksonAnnotation
@Target(value={ANNOTATION_TYPE, FIELD, METHOD, PARAMETER, TYPE})
@Retention(value=RUNTIME)
Annotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized. Without annotation property values are always included, but by using this annotation one can specify simple exclusion rules to reduce amount of properties to write out.
*Note that the main inclusion criteria (one annotated with value) is checked on Java object level, for the annotated type, and NOT on JSON output -- so even with Include.NON_NULL it is possible that JSON null values are output, if object reference in question is not `null`. An example is java.util.concurrent.atomic.AtomicReference instance constructed to reference null value: such a value would be serialized as JSON null, and not filtered out.
To base inclusion on value of contained value(s), you will typically also need to specify content() annotation; for example, specifying only value as Include.NON_EMPTY for a {link java.util.Map} would exclude Maps with no values, but would include Maps with `null` values. To exclude Map with only `null` value, you would use both annotations like so:
public class Bean {
@JsonInclude(value=Include.NON_EMPTY, content=Include.NON_NULL)
public Map<String,String> entries;
}
Similarly you could Maps that only contain "empty" elements, or "non-default" values (see Include.NON_EMPTY and Include.NON_DEFAULT for more details).
In addition to `Map`s, `content` concept is also supported for referential types (like java.util.concurrent.atomic.AtomicReference). Note that `content` is NOT currently (as of Jackson 2.9) supported for arrays or java.util.Collections, but supported may be added in future versions.
Since:
2.0केस एक
@JsonInclude(JsonInclude.Include.NON_NULL)
private String someString;केस दो
@JsonInclude(JsonInclude.Include.NON_EMPTY)
private String someString;यदि someStringअशक्त है, तो इसे दोनों मामलों पर ध्यान नहीं दिया जाएगा। अगर someString"" यह केवल मामले दो पर ध्यान नहीं दिया जाना चाहिए।
के लिए समान List = nullयाList.size() = 0
@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL):; किसी तरह आपका एनोटेशन उपलब्ध नहीं था।