JSON (JavaScript Object Notation) est le format standard pour les API REST et les integrations modernes. ABAP offre plusieurs possibilites pour le traitement JSON : /ui2/cl_json, les bibliotheques XCO et la transformation ABAP native.
Apercu des methodes
| Methode | Disponibilite | Recommandation |
|---|---|---|
/ui2/cl_json | A partir de 7.40 | Simple, largement utilise |
| XCO (Cloud) | ABAP Cloud | Moderne, type-safe |
| Simple Transformation | Tous | Performant, plus d’effort |
| sXML | Tous | Bas niveau |
/ui2/cl_json - Le classique
1. Structure vers JSON (Serialisation)
TYPES: BEGIN OF ty_customer, id TYPE i, name TYPE string, email TYPE string, active TYPE abap_bool, END OF ty_customer.
DATA: ls_customer TYPE ty_customer.
ls_customer = VALUE #( id = 1001 name = 'Max Mustermann" active = abap_true).
" Convertir la structure en JSONDATA(lv_json) = /ui2/cl_json=>serialize( data = ls_customer compress = abap_true " Pas de valeurs nulles/champs vides pretty_name = /ui2/cl_json=>pretty_mode-camel_case).
WRITE: / lv_json." {"id":1001,"name":"Max Mustermann","email":"[email protected]","active":true}2. JSON vers structure (Deserialisation)
DATA: lv_json TYPE string.DATA: ls_customer TYPE ty_customer.
" Convertir JSON en structure/ui2/cl_json=>deserialize( EXPORTING json = lv_json pretty_name = /ui2/cl_json=>pretty_mode-camel_case CHANGING data = ls_customer).
WRITE: / 'ID :', ls_customer-id.WRITE: / 'Nom :', ls_customer-name.WRITE: / 'E-Mail :', ls_customer-email.3. Table interne vers JSON
DATA: lt_customers TYPE TABLE OF ty_customer.
lt_customers = VALUE #().
DATA(lv_json) = /ui2/cl_json=>serialize( data = lt_customers compress = abap_true pretty_name = /ui2/cl_json=>pretty_mode-camel_case).
WRITE: / lv_json." [{"id":1,"name":"Muller",...},{"id":2,...},{"id":3,...}]4. Tableau JSON vers table
DATA: lv_json TYPE string.DATA: lt_customers TYPE TABLE OF ty_customer.
lv_json = '[{"id":1,"name":"A"},{"id":2,"name":"B"},{"id":3,"name":"C"}]'.
/ui2/cl_json=>deserialize( EXPORTING json = lv_json CHANGING data = lt_customers).
LOOP AT lt_customers INTO DATA(ls_cust). WRITE: / ls_cust-id, ls_cust-name.ENDLOOP.5. Options Pretty-Name
DATA: ls_data TYPE ty_customer.
" Noms ABAP originaux (MAJUSCULES)DATA(lv_json1) = /ui2/cl_json=>serialize( data = ls_data pretty_name = /ui2/cl_json=>pretty_mode-none)." {"ID":1001,"NAME":"Max",...}
" camelCaseDATA(lv_json2) = /ui2/cl_json=>serialize( data = ls_data pretty_name = /ui2/cl_json=>pretty_mode-camel_case)." {"id":1001,"name":"Max",...}
" Minuscules avec underscoresDATA(lv_json3) = /ui2/cl_json=>serialize( data = ls_data pretty_name = /ui2/cl_json=>pretty_mode-low_case)." {"id":1001,"name":"Max",...}6. Structures imbriquees
TYPES: BEGIN OF ty_address, street TYPE string, city TYPE string, zip TYPE string, END OF ty_address.
TYPES: BEGIN OF ty_person, name TYPE string, age TYPE i, address TYPE ty_address, END OF ty_person.
DATA: ls_person TYPE ty_person.
ls_person = VALUE #( name = 'Max" age = 30 address = VALUE #( street = 'Rue Principale 1" city = 'Berlin" zip = '10115" )).
DATA(lv_json) = /ui2/cl_json=>serialize( data = ls_person pretty_name = /ui2/cl_json=>pretty_mode-camel_case).
" {"name":"Max","age":30,"address":{"street":"Rue Principale 1","city":"Berlin","zip":"10115"}}7. Sortie formatee (Pretty Print)
DATA(lv_json) = /ui2/cl_json=>serialize( data = ls_customer pretty_name = /ui2/cl_json=>pretty_mode-camel_case format_output = abap_true " Indente/formate).
" {" "id": 1001," "name": "Max Mustermann"," "email": "[email protected]"" }8. Parsing generique (sans type)
DATA: lv_json TYPE string.DATA: lr_data TYPE REF TO data.FIELD-SYMBOLS: <data> TYPE any.
lv_json = '{"name":"Max","age":30,"items":[1,2,3]}'.
" Parser generiquement/ui2/cl_json=>deserialize( EXPORTING json = lv_json CHANGING data = lr_data).
" Le resultat est une structure dynamiqueASSIGN lr_data->* TO <data>.9. Mapping de noms
TYPES: BEGIN OF ty_abap_struct, customer_id TYPE i, customer_name TYPE string, END OF ty_abap_struct.
DATA: ls_data TYPE ty_abap_struct.
" JSON avec des noms de champs differentsDATA: lv_json TYPE string VALUE '{"customerId":1,"customerName":"Test"}'.
" Mapping de noms via PRETTY_NAME/ui2/cl_json=>deserialize( EXPORTING json = lv_json pretty_name = /ui2/cl_json=>pretty_mode-camel_case CHANGING data = ls_data).
WRITE: / ls_data-customer_id, ls_data-customer_name.XCO - ABAP Cloud
10. Serialisation JSON XCO
" Disponible uniquement dans ABAP Cloud / SteampunkDATA: ls_customer TYPE ty_customer.
" SerialiserDATA(lv_json) = xco_cp_json=>data->from_abap( ls_customer )->apply( VALUE #( ( xco_cp_json=>transformation->camel_case ) ) )->to_string( ).
" Deserialiserxco_cp_json=>data->from_string( lv_json )->apply( VALUE #( ( xco_cp_json=>transformation->underscore_case ) ) )->write_to( REF #( ls_customer ) ).Simple Transformation
11. JSON avec Simple Transformation
" Creer la transformation Z_JSON_CUSTOMER (STRANS)
" <?sap.transform simple?>" <tt:transform xmlns:tt="http://www.sap.com/transformation-templates"" template="main">" <tt:root name="CUSTOMER"/>" <tt:template>" <object>" <str name="id"><tt:value ref="CUSTOMER.ID"/></str>" <str name="name"><tt:value ref="CUSTOMER.NAME"/></str>" </object>" </tt:template>" </tt:transform>
DATA: ls_customer TYPE ty_customer, lv_json TYPE string.
ls_customer = VALUE #( id = 1 name = 'Max' ).
" ABAP vers JSONCALL TRANSFORMATION z_json_customer SOURCE customer = ls_customer RESULT XML lv_json OPTIONS data_refs = 'embedded'.
" JSON vers ABAPCALL TRANSFORMATION z_json_customer SOURCE XML lv_json RESULT customer = ls_customer.Exemples pratiques
12. Appel API REST
DATA: lv_response TYPE string, ls_result TYPE ty_api_response.
" Requete HTTPDATA(lo_client) = cl_web_http_client_manager=>create_by_http_destination( i_destination = cl_http_destination_provider=>create_by_url( 'https://api.example.com' )).
DATA(lo_request) = lo_client->get_http_request( ).lo_request->set_uri_path( '/api/customers/1' ).
DATA(lo_response) = lo_client->execute( if_web_http_client=>get ).lv_response = lo_response->get_text( ).
" Parser la reponse JSON/ui2/cl_json=>deserialize( EXPORTING json = lv_response CHANGING data = ls_result).
lo_client->close( ).13. Requete POST JSON
TYPES: BEGIN OF ty_request, action TYPE string, payload TYPE string, END OF ty_request.
DATA: ls_request TYPE ty_request.
ls_request = VALUE #( action = 'create" payload = 'test data").
" Creer le corps de la requeteDATA(lv_json_body) = /ui2/cl_json=>serialize( data = ls_request pretty_name = /ui2/cl_json=>pretty_mode-camel_case).
" HTTP POSTDATA(lo_client) = cl_web_http_client_manager=>create_by_http_destination( i_destination = cl_http_destination_provider=>create_by_url( 'https://api.example.com' )).
DATA(lo_request) = lo_client->get_http_request( ).lo_request->set_uri_path( '/api/process' ).lo_request->set_header_field( i_name = 'Content-Type' i_value = 'application/json' ).lo_request->set_text( lv_json_body ).
DATA(lo_response) = lo_client->execute( if_web_http_client=>post ).14. Gestion des erreurs
DATA: lv_json TYPE string VALUE '{"invalid json'.DATA: ls_data TYPE ty_customer.
TRY. /ui2/cl_json=>deserialize( EXPORTING json = lv_json CHANGING data = ls_data ). CATCH cx_sy_move_cast_error INTO DATA(lx_error). WRITE: / 'Erreur de parsing JSON :', lx_error->get_text( ).ENDTRY.15. Date/Heure en JSON
TYPES: BEGIN OF ty_event, name TYPE string, event_date TYPE d, event_time TYPE t, timestamp TYPE timestamp, END OF ty_event.
DATA: ls_event TYPE ty_event.
ls_event = VALUE #( name = 'Reunion" event_date = sy-datum event_time = sy-uzeit timestamp = utclong_current( )).
" Standard : Date comme YYYYMMDDDATA(lv_json) = /ui2/cl_json=>serialize( data = ls_event pretty_name = /ui2/cl_json=>pretty_mode-camel_case).
" Pour format ISO : Conversion personnalisee necessaire16. Tableaux de types primitifs
DATA: lt_ids TYPE TABLE OF i.
lt_ids = VALUE #( ( 1 ) ( 2 ) ( 3 ) ( 4 ) ( 5 ) ).
DATA(lv_json) = /ui2/cl_json=>serialize( data = lt_ids ).WRITE: / lv_json. " [1,2,3,4,5]
" RetourDATA: lt_parsed TYPE TABLE OF i./ui2/cl_json=>deserialize( EXPORTING json = lv_json CHANGING data = lt_parsed).17. Gestion des valeurs null
TYPES: BEGIN OF ty_nullable, name TYPE string, value TYPE i, END OF ty_nullable.
DATA: ls_data TYPE ty_nullable.
ls_data = VALUE #( name = 'Test' ). " value reste initial (0)
" Avec compress = true : Omettre les valeurs initialesDATA(lv_compressed) = /ui2/cl_json=>serialize( data = ls_data compress = abap_true)." {"name":"Test"}
" Sans compress : Tous les champsDATA(lv_full) = /ui2/cl_json=>serialize( data = ls_data compress = abap_false)." {"name":"Test","value":0}18. Valeurs booleennes
TYPES: BEGIN OF ty_flags, enabled TYPE abap_bool, visible TYPE abap_bool, END OF ty_flags.
DATA: ls_flags TYPE ty_flags.
ls_flags = VALUE #( enabled = abap_true visible = abap_false).
DATA(lv_json) = /ui2/cl_json=>serialize( data = ls_flags pretty_name = /ui2/cl_json=>pretty_mode-camel_case).
WRITE: / lv_json. " {"enabled":true,"visible":false}Conseils pour l’integration API
" 1. Definir des types correspondant a l'APITYPES: BEGIN OF ty_api_error, code TYPE string, message TYPE string, END OF ty_api_error.
TYPES: BEGIN OF ty_api_response, success TYPE abap_bool, data TYPE ty_customer, error TYPE ty_api_error, END OF ty_api_response.
" 2. Traiter la reponseDATA(lv_status) = lo_response->get_status( )-code.DATA(lv_body) = lo_response->get_text( ).
DATA: ls_response TYPE ty_api_response./ui2/cl_json=>deserialize( EXPORTING json = lv_body CHANGING data = ls_response).
IF ls_response-success = abap_true. " Traiter le succesELSE. " Gerer l'erreur WRITE: / 'Erreur :', ls_response-error-message.ENDIF.Remarques importantes / Bonnes pratiques
/ui2/cl_jsonest le standard pour JSON en ABAP classique.- pretty_name pour la conversion de noms (camelCase, lowercase).
- compress = abap_true supprime les champs vides/initiaux.
- Pour ABAP Cloud : Utiliser les bibliotheques XCO.
- Simple Transformations pour une performance maximale.
- Les noms de champs ABAP avec underscores sont convertis en camelCase.
- Testez les structures JSON avec des outils en ligne (jsonlint.com).
- Definissez des types ABAP correspondants pour les reponses API.
- Gestion des erreurs avec TRY-CATCH pour le JSON invalide.
- Boolean :
abap_true/abap_falsedevienttrue/false.