ExclusionStrategy इंटरफेस का उपयोग सीरियलाइजेशन और डीसीरियलाइजेशन के दौरान किसी भी फील्ड को एक्सक्लूड करने के लिए किया जा सकता है। हम ExclusionStrategy इंटरफेस का कस्टम इम्प्लीमेंटेशन प्रदान कर सकते हैं और इसे GsonBuilder के साथ setExclusionStrategies() मेथड का उपयोग करके रजिस्टर करने की आवश्यकता होती है। यह Gson को सीरियलाइजेशन और डीसीरियलाइजेशन के दौरान एक्सक्लूजन स्ट्रेटेजीज के सेट को लागू करने के लिए कॉन्फिगर करता है।
सिंटैक्स
public GsonBuilder setExclusionStrategies(ExclusionStrategy... strategies)
उदाहरण
import com.google.gson.*;
import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;
public class ExclusionStrategyTest {
public static void main(String args[]) throws Exception {
Gson gson = new GsonBuilder()
.setExclusionStrategies(new CustomExclusionStrategy())
.create();
Person person = new Person();
person.setFirstName("Adithya");
person.setLastName("Sai");
person.setAddress("Hyderabad");
String jsonString = gson.toJson(person);
System.out.println("Serialize a JSON: \n" + jsonString);
String inputJson = "{\"firstName\":\"Raja\", \"lastName\":\"Ramesh\", \"address\":\"Hyderabad\"}";
person = gson.fromJson(inputJson, Person.class);
System.out.println("Deserialize a JSON:\n" + person);
}
}
// CustomExclusionStrategy क्लास
class CustomExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
if (f.getName().equals("firstName")) {
return true; // इस फील्ड को स्किप करें
}
return false;
}
@Override
public boolean shouldSkipClass(Class<?> aClass) {
return false; // किसी क्लास को स्किप न करें
}
}
// Person क्लास
class Person {
private String firstName, lastName, address;
public String getFirstName() { return firstName; }
public void setFirstName(String firstName) { this.firstName = firstName; }
public String getLastName() { return lastName; }
public void setLastName(String lastName) { this.lastName = lastName; }
public String getAddress() { return address; }
public void setAddress(String address) { this.address = address; }
public String toString() {
return "Person [" + firstName + " " + lastName + " " + address + "]";
}
}
आउटपुट
Serialize a JSON:
{"lastName":"Sai","address":"Hyderabad"}
Deserialize a JSON:
Person [null Ramesh Hyderabad]
ExclusionStrategy के दो मेथड्स
| मेथड | पैरामीटर | रिटर्न | उद्देश्य |
|---|---|---|---|
| shouldSkipField() | FieldAttributes | boolean | फील्ड को स्किप करना है या नहीं |
| shouldSkipClass() | Class<?> | boolean | पूरी क्लास को स्किप करना है या नहीं |
FieldAttributes उपयोगी मेथड्स
f.getName() // फील्ड नाम
f.getDeclaredClass() // डिक्लेयरिंग क्लास
f.getDeclaringClass() // डिक्लेयरिंग क्लास (समान)
f.getAnnotation(Ann.class) // एनोटेशन प्राप्त करें
f.hasAnnotation(Ann.class) // एनोटेशन चेक करें
एनोटेशन-आधारित एक्सक्लूजन
// कस्टम एनोटेशन
@Retention(RUNTIME)
@Target(FIELD)
public @interface InternalOnly {}
// स्ट्रेटेजी
class AnnotationExclusionStrategy implements ExclusionStrategy {
@Override
public boolean shouldSkipField(FieldAttributes f) {
return f.hasAnnotation(InternalOnly.class);
}
@Override
public boolean shouldSkipClass(Class<?> clazz) {
return false;
}
}
// उपयोग
class User {
public String name;
@InternalOnly
private String internalId;
}
मल्टीपल स्ट्रेटेजीज
Gson gson = new GsonBuilder()
.setExclusionStrategies(
new AnnotationExclusionStrategy(),
new CustomExclusionStrategy()
)
.create();
सीरियलाइजेशन vs डीसीरियलाइजेशन के लिए अलग स्ट्रेटेजी
// Gson 2.7+ के लिए
Gson gson = new GsonBuilder()
.addSerializationExclusionStrategy(new SerializeOnlyStrategy())
.addDeserializationExclusionStrategy(new DeserializeOnlyStrategy())
.create();
उपयोग के मामले
- संवेदनशील डेटा: पासवर्ड, टोकन, PII को ऑटोमैटिकली एक्सक्लूड करना
- आंतरिक फील्ड्स: @InternalOnly एनोटेशन के साथ मार्क किए गए फील्ड्स
- वर्जनिंग: API वर्जन के आधार पर फील्ड्स एक्सक्लूड करना
- सर्कुलर रेफरेंस: बैक-रेफरेंस फील्ड्स को स्किप करना