@Since एनोटेशन का उपयोग GsonBuilder क्लास के setVersion() मेथड के साथ किया जा सकता है। यह एनोटेशन जावा क्लास में फील्ड पर लागू किया जा सकता है और फ्लोट को आर्गुमेंट के रूप में स्वीकार करता है। यह आर्गुमेंट उस वर्जन नंबर को दर्शाता है जिसमें फील्ड सीरियलाइज्ड हुई है। वही डीसीरियलाइजेशन प्रक्रिया पर भी लागू होता है।
सिंटैक्स
@Documented
@Retention(value=RUNTIME)
@Target(value={FIELD,TYPE})
public @interface Since
उदाहरण
import com.google.gson.annotations.Since;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
public class GsonSinceAnnotationTest {
public static void main(String[] args) {
Employee emp = new Employee();
emp.setEmployeeName("Raja Ramesh");
emp.setEmployeeId(125);
emp.setEmployeeTechnology("Java");
emp.setEmploeeAddress("Hyderabad");
System.out.println("Since version 0.5");
GsonBuilder gsonBuilder = new GsonBuilder();
Gson gson = gsonBuilder.setPrettyPrinting().setVersion(0.5).create();
String jsonString = gson.toJson(emp);
System.out.println(jsonString);
System.out.println("Since version 1.0");
gsonBuilder = new GsonBuilder();
gson = gsonBuilder.setPrettyPrinting().setVersion(1.0).create();
jsonString = gson.toJson(emp);
System.out.println(jsonString);
System.out.println("Since version 1.1");
gsonBuilder = new GsonBuilder();
gson = gsonBuilder.setPrettyPrinting().setVersion(1.1).create();
jsonString = gson.toJson(emp);
System.out.println(jsonString);
}
}
// Employee क्लास
class Employee {
private String empName;
private int empId;
@Since(1.0)
private String empTech;
@Since(1.1)
private String empAddress;
// गेटर्स और सेटर्स...
public String getEmployeeName() { return empName; }
public void setEmployeeName(String empName) { this.empName = empName; }
public int getEmployeeId() { return empId; }
public void setEmployeeId(int empId) { this.empId = empId; }
public String getEmployeeTechnology() { return empTech; }
public void setEmployeeTechnology(String empTech) { this.empTech = empTech; }
public String getEmploeeAddress() { return empAddress; }
public void setEmploeeAddress(String empAddress) { this.empAddress = empAddress; }
}
आउटपुट
Since version 0.5
{
"empName": "Raja Ramesh",
"empId": 125
}
Since version 1.0
{
"empName": "Raja Ramesh",
"empId": 125,
"empTech": "Java"
}
Since version 1.1
{
"empName": "Raja Ramesh",
"empId": 125,
"empTech": "Java",
"empAddress": "Hyderabad"
}
कैसे काम करता है
- वर्जन तुलना: फील्ड का @Since वर्जन ≤ Gson वर्जन होने पर फील्ड शामिल होता है
- डिफ़ॉल्ट वर्जन: @Since के बिना फील्ड्स का वर्जन 0.0 माना जाता है (हमेशा शामिल)
- क्लास लेवल: @Since क्लास पर भी लागू किया जा सकता है
@Until के साथ संयोजन
@Since(1.0)
@Until(2.0)
private String field; // केवल वर्जन 1.0 से 2.0 (एक्सक्लूसिव) तक शामिल
उपयोग के मामले
- API वर्जनिंग: अलग-अलग API वर्जन्स के लिए अलग JSON आउटपुट
- फीचर फ्लैग्स: नए फील्ड्स को धीरे-धीरे रोल आउट करना
- बैकवर्ड कम्पैटिबिलिटी: पुराने क्लाइंट्स को नए फील्ड्स न भेजना
- माइग्रेशन: फील्ड्स को डिप्रीकेट करते समय धीरे-धीरे हटाना
डीसीरियलाइजेशन पर प्रभाव
डीसीरियलाइजेशन के दौरान, @Since वर्जन के आधार पर अज्ञात फील्ड्स को इग्नोर किया जाता है। यदि JSON में ऐसा फील्ड है जिसका @Since वर्जन करंट Gson वर्जन से अधिक है, तो उसे इग्नोर कर दिया जाता है (एरर के बजाय)।