Convertisseur JSON en Apex
Collez un JSON valide ci-dessous et l'Apex correspondant sera généré. Si l'un de vos clés JSON résulte en un Apex invalide, comme mots-clés réservés, un analyseur personnalisé sera généré.
public class GeneratedApex {
public UserProfile userProfile;
public class UserProfile {
public Integer userId; // 1001
public PersonalInfo personalInfo;
public Contact contact;
public Address address;
public List<SocialMediaProfiles> socialMediaProfiles;
}
public class PersonalInfo {
public String firstName; // "Jane"
public String lastName; // "Doe"
public Integer age; // 28
}
public class Contact {
public String email; // "jane.doe@example.com"
public Phone phone;
}
public class Phone {
public String home; // "555-1234"
public String work; // "555-5678"
}
public class Address {
public String street; // "123 Main St"
public String city; // "Springfield"
public String state; // "IL"
public String postalCode; // "62701"
}
public class SocialMediaProfiles {
public String platform; // "Twitter"
public String username; // "janedoe"
}
public static GeneratedApex parse(String jsonString) {
return (GeneratedApex) JSON.deserialize(jsonString, GeneratedApex.class);
}
}
Créé par Wes Nolte.Dernière mise à jour Nov 18, 2024. Références.Comment utiliser le convertisseur JSON vers Apex
Commencez par coller vos données JSON dans la zone de texte sur le côté gauche. L'outil analyse le JSON et génère les classes Apex correspondantes, qui sont affichées dans la zone de texte à droite. Ces classes représentent la structure des données JSON, y compris les objets et tableaux imbriqués, dans un format compatible avec le langage de programmation Apex de Salesforce. Parfois, les propriétés de la charge utile JSON utilisent des mots-clés réservés par Apex. Dans ce cas, un analyseur personnalisé est généré car la désérialisation directe n’est pas possible. Dans tous les cas, il vous suffit de passer une chaîne JSON valide à la méthode GeneratedApex.parse() pour générer la structure Apex correspondante.
Comment utiliser l'Apex généré
Générer Apex est une chose, mais savoir l’utiliser en est une autre. Regardons deux exemples. Nous commençons par le cas d’utilisation le plus simple où le JSON suivant génère une classe Apex qui peut être désérialisée directement :
JSON
{
"userProfile": {
"userId": 1001,
"personalInfo": {
"firstName": "Jane",
"lastName": "Doe",
"age": 28
},
"contact": {
"email": "jane.doe@example.com",
"phone": {
"home": "555-1234",
"work": "555-5678"
}
},
"address": {
"street": "123 Main St",
"city": "Springfield",
"state": "IL",
"postalCode": "62701"
},
"socialMediaProfiles": [
{
"platform": "Twitter",
"username": "janedoe"
},
{
"platform": "LinkedIn",
"url": "https://www.linkedin.com/in/janedoe/"
}
]
}
}Apex généré
public class GeneratedApex {
public UserProfile userProfile;
public class UserProfile {
public Integer userId; // 1001
public PersonalInfo personalInfo;
public Contact contact;
public Address address;
public List<SocialMediaProfiles> socialMediaProfiles;
}
public class PersonalInfo {
public String firstName; // "Jane"
public String lastName; // "Doe"
public Integer age; // 28
}
public class Contact {
public String email; // "jane.doe@example.com"
public Phone phone;
}
public class Phone {
public String home; // "555-1234"
public String work; // "555-5678"
}
public class Address {
public String street; // "123 Main St"
public String city; // "Springfield"
public String state; // "IL"
public String postalCode; // "62701"
}
public class SocialMediaProfiles {
public String platform; // "Twitter"
public String username; // "janedoe"
}
public static GeneratedApex parse(String jsonString) {
return (GeneratedApex) JSON.deserialize(jsonString, GeneratedApex.class);
}
}Utiliser la classe générée pour désérialiser la charge utile JSON entrante est simple une fois la structure en place. Vous trouverez ci-dessous un exemple complet d'appel d'une API, puis de désérialisation de la réponse JSON. La désérialisation nécessite cependant seulement une ligne de code.
public class ApiService {
public static GeneratedApex fetchUserData() {
// Create an HTTP request and response
Http http = new Http();
HttpRequest request = new HttpRequest();
request.setEndpoint('https://api.example.com/userdata'); // Replace with your API endpoint
request.setMethod('GET');
request.setHeader('Content-Type', 'application/json');
try {
// Send the HTTP request and get the response
HttpResponse response = http.send(request);
// Check if the request was successful
if (response.getStatusCode() == 200) {
// Deserialize the JSON response into the GeneratedApex object
GeneratedApex result = (GeneratedApex) JSON.deserialize(response.getBody(), GeneratedApex.class);
return result;
} else {
// Handle the error scenario
System.debug('Error: ' + response.getStatusCode() + ' - ' + response.getStatus());
return null;
}
} catch (Exception e) {
// Handle any exceptions that occur during the HTTP request
System.debug('Exception: ' + e.getMessage());
return null;
}
}
}L'exemple ci-dessus est simple et ne nécessite pas d'analyseur personnalisé. Cependant, si l'Apex généré contient un reserved keyword ou des caractères invalides, un analyseur personnalisé est requis. C'est le sujet de la section suivante.
Désérialiser JSON avec un analyseur personnalisé
JSON est simplement une collection de paires clé-valeur qui peuvent être imbriquées. Si l'une de ces clés est un mot-clé réservé par Apex ou contient des caractères invalides, comme un soulignement initial, alors l'Apex généré à l'aide de la méthode ci-dessus ne sera pas compilé.
Notre convertisseur détecte ces problèmes et génère automatiquement un code Apex qui inclut un analyseur personnalisé. Vous trouverez ci-dessous un exemple où les noms de clés JSON qui auraient posé problème dans Apex sont nettoyés avec des préfixes d'espace de noms NS_ et ns.
JSON
{
"user": {
"userId": "user_456",
"email": "user@example.com",
"log-id": "abc123",
"_object": "accountActivation"
}
}Apex généré
public class GeneratedApex {
public NS_User nsUser;
public class NS_User {
public String userid;
public String email;
public String logid;
public String nsObject;
}
public static GeneratedApex parse(String jsonString) {
JSONParser parser = JSON.createParser(jsonString);
if (parser.nextToken() != null) {
return parseGeneratedApex(parser);
} else {
return null;
}
}
private static GeneratedApex parseGeneratedApex(JSONParser parser) {
GeneratedApex obj = new GeneratedApex();
while (parser.nextToken() != System.JSONToken.END_OBJECT) {
if (parser.getCurrentToken() == System.JSONToken.FIELD_NAME) {
String fieldName = parser.getText();
if (parser.nextToken() != System.JSONToken.VALUE_NULL) {
if (fieldName == 'user') {
obj.nsUser = parseNS_User(parser);
} else {
System.debug(LoggingLevel.WARN, 'Unknown field: ' + fieldName);
consumeObject(parser);
}
}
}
}
return obj;
}
private static NS_User parseNS_User(JSONParser parser) {
NS_User obj = new NS_User();
while (parser.nextToken() != System.JSONToken.END_OBJECT) {
if (parser.getCurrentToken() == System.JSONToken.FIELD_NAME) {
String fieldName = parser.getText();
if (parser.nextToken() != System.JSONToken.VALUE_NULL) {
if (fieldName == 'userId') {
obj.userid = parser.getText();
} else if (fieldName == 'email') {
obj.email = parser.getText();
} else if (fieldName == 'log-id') {
obj.logid = parser.getText();
} else if (fieldName == '_object') {
obj.nsObject = parser.getText();
} else {
System.debug(LoggingLevel.WARN, 'Unknown field: ' + fieldName);
consumeObject(parser);
}
}
}
}
return obj;
}
private static void consumeObject(JSONParser parser) {
Integer depth = 0;
do {
System.JSONToken curr = parser.getCurrentToken();
if (curr == System.JSONToken.START_OBJECT || curr == System.JSONToken.START_ARRAY) {
depth++;
} else if (curr == System.JSONToken.END_OBJECT || curr == System.JSONToken.END_ARRAY) {
depth--;
}
} while (depth > 0 && parser.nextToken() != null);
}
}L'Apex généré est généralement plus long car il y a plus de travail impliqué dans la traduction du JSON en Apex, mais il s'utilise de la même manière que dans l'exemple ci-dessus.
public class ApiService {
// Method to fetch and parse JSON from the API
public static GeneratedApex fetchAndParseUser(String endpointUrl) {
Http http = new Http();
HttpRequest request = new HttpRequest();
request.setEndpoint(endpointUrl);
request.setMethod('GET');
try {
HttpResponse response = http.send(request);
if (response.getStatusCode() == 200) {
String jsonResponse = response.getBody();
System.debug('API Response: ' + jsonResponse);
// Deserialize JSON using GeneratedApex class
GeneratedApex parsedData = GeneratedApex.parse(jsonResponse);
System.debug('Parsed Data: ' + parsedData);
return parsedData;
} else {
System.debug('Error: HTTP response code ' + response.getStatusCode());
return null;
}
} catch (Exception e) {
System.debug('Error in API call: ' + e.getMessage());
return null;
}
}
}
Références
- Apex Reference Guide: JSON Class